mikera.matrixx.impl

Class ScalarMatrix

java.lang.Object

mikera.arrayz.impl.AbstractArray<AVector>

mikera.matrixx.AMatrix

mikera.matrixx.impl.ABandedMatrix

mikera.matrixx.impl.ASingleBandMatrix

mikera.matrixx.impl.ADiagonalMatrix

mikera.matrixx.impl.ScalarMatrix

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<INDArray>, java.lang.Iterable<AVector>, INDArray, ISparse, IMatrix, IFastBands

public class ScalarMatrix
extends ADiagonalMatrix

Immutable scalar matrix class - a diagonal matrix with an identical value along the leading diagonal. When used to transform a vector, multiplies every component by a constant factor

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ScalarMatrix(int dimensions, double scale)

Method Summary

Modifier and Type	Method and Description
static ScalarMatrix	create(int dimensions, double scale)
double	diagonalProduct() Computes the product of entries on the main diagonal of a matrix
double	elementSum() Returns the sum of all elements in this matrix
ScalarMatrix	exactClone() Creates a deep clone of an array, using the same class implementation as the original array
double	get(int row, int column) Returns the double value at the specified position in a 2D matrix
RepeatedElementVector	getLeadingDiagonal() Returns a vector view of the leading diagonal values of the matrix
AMatrix	innerProduct(AMatrix m) Computes the inner product of this matrix with another.
boolean	isFullyMutable() If this method returns true, the INDArray is guaranteed to be fully mutable in all positions i.e.
boolean	isMutable() Returns true if the INDArray is mutable (at least partially)
AMatrix	multiplyCopy(double d) Returns a copy of the array with all elements multiplied by a single constant value
long	nonZeroCount() Returns the number of non-zero elements in the array.
double	trace() Computes the trace of a matrix, i.e.
void	transformInPlace(ADenseArrayVector v)
void	transformInPlace(AVector v)
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

addCopy, addOuterProductSparse, addToArray, checkSquare, clone, columnCount, copyColumnTo, copyRowTo, determinant, dimensions, elementAbsPowSum, elementMax, elementMin, elementPowSum, elementSquaredSum, equalsTranspose, getBand, getColumn, getDiagonalValue, getNonZeroBand, getRow, getTranspose, getTransposeView, hasUncountable, innerProduct, isBoolean, isDiagonal, isIdentity, isLowerTriangular, isRectangularDiagonal, isSameShape, isSameShape, isSquare, isSymmetric, isUpperTriangular, isZero, lowerBandwidthLimit, nonZeroBand, rank, rowCount, rowDotProduct, set, setSparse, toDoubleArray, toMatrix, toMatrixTranspose, transform, transposeInnerProduct, transposeInPlace, unsafeGetDiagonalValue, upperBandwidthLimit, validate

Methods inherited from class mikera.matrixx.impl.ASingleBandMatrix

isSparse, subMatrix

Methods inherited from class mikera.matrixx.impl.ABandedMatrix

density, fill, getRowView, lowerBandwidth, multiply, upperBandwidth

Methods inherited from class mikera.matrixx.AMatrix

abs, add, add, add, add, add2, addAt, addCopy, addCopy, addCopy, addCopy, addInnerProduct, addInnerProduct, addInnerProduct, addMultiple, addMultiple, addMultiple, addOuterProduct, addOuterProduct, addOuterProductSparse, addRowMultiple, addSparse, addSparse, applyOp, applyOp, applyOp, applyOp, applyOp, applyOp, applyOpCopy, asDoubleArray, asElementList, asVector, bandIndex, bandLength, bandPosition, bandStartColumn, bandStartRow, broadcast, broadcastCloneLike, broadcastCopyLike, broadcastLike, broadcastLike, checkColumn, checkRow, clamp, composeWith, copy, dense, denseClone, dimensionality, divide, divide, divide, divide, divideCopy, elementCount, elementIterator, elementsEqual, ensureMutable, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, equals, equalsArray, exp, get, get, get, get, getBandWrapped, getColumnClone, getColumns, getColumnView, getElement, getElements, getLongShape, getRowClone, getRows, getShape, getShape, getShapeClone, getSlices, getSlices, getSliceViews, getTransposeCopy, hashCode, hasOrthonormalColumns, hasOrthonormalRows, immutable, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, inputDimensions, inverse, isElementConstrained, isHermitian, isInvertible, isOrthogonal, isOrthogonal, isPositiveDefinite, isSameShape, isView, iterator, join, log, mul, multiply, multiply, multiply, multiplyRow, mutable, negate, outerProduct, outputDimensions, pow, reciprocal, reduce, reduce, reduceSlices, reduceSlices, reorder, reorder, replaceColumn, replaceRow, reshape, reshape, rotateView, scaleAdd, scaleAdd, set, set, set, set, set, set, set, set, setApplyOp, setApplyOp, setColumn, setElements, setElements, setMultiple, setMultiple, setMultiple, setMultiple, setMultiple, setRow, setSparse, setSparse, signum, slice, slice, sliceCount, sparse, sparseClone, sqrt, square, sub, sub, sub, subArray, subCopy, swapColumns, swapRows, toAffineTransform, toDoubleBuffer, toMutableMatrix, toNestedDoubleArrays, toSliceArray, toString, toStringFull, toVector, transform, transposeInnerProduct, unsafeSet

Methods inherited from class mikera.arrayz.impl.AbstractArray

absCopy, absDiff, absDiffCopy, add, addApplyOp, addAt, addCopy, addInnerProduct, addInnerProduct, addMultipleSparse, addPower, addPower, addSparse, broadcastLike, compareTo, componentCount, divideCopy, elementMaxAbs, elementProduct, epsilonEquals, equals, equalsArray, get, get, get, get, getComponent, getComponents, getElements, getElements, getElements, isDense, join, multiplyCopy, negateCopy, reciprocalCopy, scale, scaleCopy, setElements, setInnerProduct, signumCopy, sliceValue, squareCopy, sub, sub, subCopy, withComponents

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface mikera.arrayz.ISparse

density

Methods inherited from interface mikera.arrayz.INDArray

absCopy, absDiff, absDiffCopy, addApplyOp, addAt, addInnerProduct, addMultipleSparse, addPower, addPower, addSparse, broadcastLike, componentCount, divideCopy, elementMaxAbs, elementProduct, epsilonEquals, equalsArray, get, get, get, get, getComponent, getComponents, getElements, getElements, getElements, isDense, join, multiplyCopy, negateCopy, reciprocalCopy, scale, scaleCopy, setElements, setInnerProduct, signumCopy, sliceValue, squareCopy, sub, subCopy, withComponents

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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 ADiagonalMatrix

elementSum

public double elementSum()

Description copied from class: AMatrix

Returns the sum of all elements in this matrix

Specified by:

elementSum in interface INDArray

Overrides:

elementSum in class ADiagonalMatrix

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

isFullyMutable

public boolean isFullyMutable()

Description copied from interface: INDArray

If this method returns true, the INDArray is guaranteed to be fully mutable in all positions i.e. every position can store any valid double value

Specified by:

isFullyMutable in interface INDArray

Overrides:

isFullyMutable in class ADiagonalMatrix

innerProduct

public AMatrix innerProduct(AMatrix m)

Description copied from interface: IMatrix

Computes the inner product of this matrix with another. Equivalent to matrix x matrix multiplication

Specified by:

innerProduct in interface IMatrix

Overrides:

innerProduct in class ADiagonalMatrix

Returns:

get

public double get(int row,
                  int column)

Description copied from interface: INDArray

Returns the double value at the specified position in a 2D matrix

Specified by:

get in interface INDArray

Specified by:

get in interface IMatrix

Specified by:

get in class AMatrix

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 RepeatedElementVector getLeadingDiagonal()

Description copied from class: AMatrix

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

Specified by:

getLeadingDiagonal in class ADiagonalMatrix

Returns:

create

public static ScalarMatrix create(int dimensions,
                                  double scale)

trace

public double trace()

Description copied from interface: IMatrix

Computes the trace of a matrix, i.e. the sum of all elements on the leading diagonal

Specified by:

trace in interface IMatrix

Overrides:

trace in class ADiagonalMatrix

Returns:

diagonalProduct

public double diagonalProduct()

Description copied from class: AMatrix

Computes the product of entries on the main diagonal of a matrix

Specified by:

diagonalProduct in interface IMatrix

Overrides:

diagonalProduct in class ADiagonalMatrix

Returns:

multiplyCopy

public AMatrix multiplyCopy(double d)

Description copied from interface: INDArray

Returns a copy of the array with all elements multiplied by a single constant value

Specified by:

multiplyCopy in interface INDArray

Overrides:

multiplyCopy in class AMatrix

Parameters:

d - A scalar factor

Returns:

A new array, with all element values scaled by the given factor

transformInPlace

public void transformInPlace(AVector v)

Specified by:

transformInPlace in interface IMatrix

Overrides:

transformInPlace in class ADiagonalMatrix

transformInPlace

public void transformInPlace(ADenseArrayVector v)

Overrides:

transformInPlace in class ADiagonalMatrix

exactClone

public ScalarMatrix exactClone()

Description copied from interface: INDArray

Creates a deep clone of an array, using the same class implementation as the original array

Specified by:

exactClone in interface INDArray

Specified by:

exactClone in class ADiagonalMatrix

Returns:

A clone of the original array