mikera.matrixx.impl

Class ScalarMatrix

java.lang.Object

mikera.transformz.ATransform

mikera.transformz.AAffineTransform

mikera.transformz.ALinearTransform

mikera.matrixx.AMatrix

mikera.matrixx.impl.ABandedMatrix

mikera.matrixx.impl.ADiagonalMatrix

mikera.matrixx.impl.ScalarMatrix

All Implemented Interfaces:

Cloneable, Iterable<AVector>, INDArray, ISparse, IMatrix, ITransform

public class ScalarMatrix
extends ADiagonalMatrix

Scalar matrix class - i.e. multiplies every component by a constant factor

Author:

Mike

Field Summary

Fields inherited from class mikera.matrixx.impl.ADiagonalMatrix

dimensions

Constructor Summary

Constructors

Constructor and Description
ScalarMatrix(int dimensions, double scale)

Method Summary

Methods

Modifier and Type	Method and Description
static AMatrix	create(int dimensions, double scale)
double	elementSum() Returns the sum of all elements in the matrix
ScalarMatrix	exactClone() Returns an exact deep clone of an array (i.e.
double	get(int row, int column) Returns a specified element in the matrix
AVector	getLeadingDiagonal() Returns a vector view of the leading diagonal values of the matrix
boolean	isMutable() Returns true if the INDArray is mutable (at least partially)
void	multiply(double factor) Multiplies all elements of the array by a given double value
long	nonZeroCount() Returns the number of non-zero elements in the array.
double	trace()
void	transformInPlace(AArrayVector v)
void	transformInPlace(AVector v) Transforms a vector destructively.
double	unsafeGet(int row, int column) Gets an element in the matrix in an unsafe fashion, without performing bound checks The result is undefined if the row and column are out of bounds.

Methods inherited from class mikera.matrixx.impl.ADiagonalMatrix

calculateElement, columnCount, copyColumnTo, copyRowTo, density, determinant, dimensions, getBand, getDiagonalValue, getTranspose, getTransposeView, innerProduct, innerProduct, innerProduct, isBoolean, isDiagonal, isFullyMutable, isIdentity, isLowerTriangular, isRectangularDiagonal, isSquare, isSymmetric, isUpperTriangular, lowerBandwidthLimit, rowCount, set, toMatrix, toMatrixTranspose, transform, transposeInnerProduct, transposeInPlace, unsafeGetDiagonalValue, upperBandwidthLimit, validate

Methods inherited from class mikera.matrixx.impl.ABandedMatrix

elementSquaredSum, fill, getRow, lowerBandwidth, upperBandwidth

Methods inherited from class mikera.matrixx.AMatrix

abs, add, add, add, add, add, addAt, addMultiple, addRowMultiple, applyOp, applyOp, asDoubleArray, asElementList, asVector, bandIndex, bandLength, bandLength, bandPosition, broadcast, broadcastCloneLike, broadcastLike, broadcastLike, calculateElement, clamp, clone, cloneRow, compose, compose, composeWith, composeWith, copyOfMatrix, copyOfTranslationVector, copyTo, dimensionality, divide, divide, elementCount, elementDiv, elementIterator, elementMul, ensureMutable, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, equals, equals, exp, get, get, get, getBandWrapped, getColumn, getElements, getLongShape, getMatrixComponent, getShape, getShape, getSlices, getSliceViews, getTransposeCopy, hashCode, hasOrthonormalColumns, hassOrthonormalRows, innerProduct, innerProduct, innerProduct, innerProduct, inputDimensions, inverse, isElementConstrained, isHermitian, isInvertible, isOrthogonal, isPositiveDefinite, isSameShape, isSameShape, isView, isZero, iterator, log, mul, multiply, multiplyRow, negate, outerProduct, outputDimensions, pow, reciprocal, reshape, reshape, scale, scaleAdd, set, set, set, set, set, set, setColumn, setElements, setElements, setRow, signum, slice, slice, sliceCount, sqrt, square, sub, sub, sub, sub, sub, subMatrix, swapColumns, swapRows, toAffineTransform, toArray, toDoubleArray, toDoubleBuffer, toMutableMatrix, toString, toVector, transform, transform, transform, transposeInnerProduct, unsafeSet

Methods inherited from class mikera.transformz.ALinearTransform

getTranslationComponent, isLinear

Methods inherited from class mikera.transformz.AAffineTransform

compose, transformNormal

Methods inherited from class mikera.transformz.ATransform

takeComponents, takeComponents, takeComponents

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ScalarMatrix

public ScalarMatrix(int dimensions,
            double scale)

Method Detail

nonZeroCount

public long nonZeroCount()

Description copied from interface: INDArray

Returns the number of non-zero elements in the array.

Specified by:

nonZeroCount in interface INDArray

Overrides:

nonZeroCount in class ABandedMatrix

Returns:

elementSum

public double elementSum()

Description copied from class: AMatrix

Returns the sum of all elements in the matrix

Specified by:

elementSum in interface INDArray

Overrides:

elementSum in class ABandedMatrix

Returns:

isMutable

public boolean isMutable()

Description copied from interface: INDArray

Returns true if the INDArray is mutable (at least partially)

Specified by:

isMutable in interface INDArray

Specified by:

isMutable in class ADiagonalMatrix

Returns:

get

public double get(int row,
         int column)

Description copied from class: AMatrix

Returns a specified element in the matrix

Specified by:

get in interface INDArray

Specified by:

get in interface IMatrix

Specified by:

get in class AMatrix

Returns:

unsafeGet

public double unsafeGet(int row,
               int column)

Description copied from class: AMatrix

Gets an element in the matrix in an unsafe fashion, without performing bound checks The result is undefined if the row and column are out of bounds.

Overrides:

unsafeGet in class AMatrix

Returns:

getLeadingDiagonal

public AVector getLeadingDiagonal()

Description copied from class: AMatrix

Returns a vector view of the leading diagonal values of the matrix

Overrides:

getLeadingDiagonal in class AMatrix

Returns:

create

public static AMatrix create(int dimensions,
             double scale)

multiply

public void multiply(double factor)

Description copied from interface: INDArray

Multiplies all elements of the array by a given double value

Specified by:

multiply in interface INDArray

Overrides:

multiply in class AMatrix

trace

public double trace()

Overrides:

trace in class AMatrix

transformInPlace

public void transformInPlace(AVector v)

Description copied from class: ATransform

Transforms a vector destructively. Intended for fast non-allocating transforms

Overrides:

transformInPlace in class ADiagonalMatrix

transformInPlace

public void transformInPlace(AArrayVector v)

Overrides:

transformInPlace in class ADiagonalMatrix

exactClone

public ScalarMatrix exactClone()

Description copied from interface: INDArray

Returns an exact deep clone of an array (i.e. of the same class as the original).

Specified by:

exactClone in interface INDArray

Specified by:

exactClone in class AMatrix

Returns: