mikera.matrixx.impl

Class DenseColumnMatrix

java.lang.Object

mikera.arrayz.impl.AbstractArray<AVector>

mikera.matrixx.AMatrix

mikera.matrixx.impl.ARectangularMatrix

mikera.matrixx.impl.AArrayMatrix

mikera.matrixx.impl.AStridedMatrix

mikera.matrixx.impl.DenseColumnMatrix

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<INDArray>, java.lang.Iterable<AVector>, IDense, IStridedArray, INDArray, IMatrix, IFastColumns

public final class DenseColumnMatrix
extends AStridedMatrix
implements IFastColumns, IDense

A densely packed matrix organised in column-major format. Transposes to/from a regular dense Matrix This class is useful if your main performance requirement is fast access to columns of a matrix. This is frequently true when the matrix is used as the *second* argument in matrix/matrix operations.

See Also:

Serialized Form

Field Summary

Fields inherited from class mikera.matrixx.impl.AArrayMatrix

data

Method Summary

Modifier and Type	Method and Description
void	abs() Replaces all elements of this array with their absolute values, according to Math.abs(double)
void	add(double d) Adds a double value to all elements in this array.
void	addAt(int i, int j, double d) Adds a value at a specific position in the matrix, mutating the matrix Does not perform bounds checking - this in an unsafe operation
void	addMultiple(AMatrix m, double factor) Adds a scalar multiple of another matrix to this matrix
void	addOuterProduct(AVector a, AVector b) Adds the outer product of two vectors to this matrix
void	applyOp(Op op) Applies a unary operator to all elements of the array (in-place)
void	clamp(double min, double max) Clamps all the elements of this array within the specified [min,max] range
int	columnStride() Gets the column stride for this strided matrix.
DenseColumnMatrix	copy() Returns a defensive copy of the array data.
void	copyColumnTo(int j, double[] dest, int destOffset) Copies the elements in a selected row of this matrix to a double array
void	copyRowTo(int i, double[] dest, int destOffset) Copies the elements in a selected row of this matrix to a double array
static DenseColumnMatrix	create(AMatrix m)
DenseColumnMatrix	dense() Coerces this INDArray to a dense format, without changing its element values.
double	elementMax() Returns the maximum element value in this array.
double	elementMin() Returns the maximum element value in this array.
double	elementSquaredSum() Returns the squared sum of all elements in this matrix
double	elementSum() Returns the sum of all elements in this matrix
DenseColumnMatrix	exactClone() Creates a deep clone of an array, using the same class implementation as the original array
void	exp() Computes the function e^x (in-place) for all array elements
void	fill(double value) Fills this array with a single double value.
double	get(int i, int j) Returns the double value at the specified position in a 2D matrix
int	getArrayOffset() Gets the data array offset for the first element of this strided array
ArraySubVector	getColumn(int j) Returns a column of the matrix.
Matrix	getTranspose() Returns the transpose of this array.
Matrix	getTransposeView() Returns a transposed view of the array.
boolean	isBoolean() Returns true if the array is boolean (contains only 0.0 or 1.0 values)
boolean	isFullyMutable() If this method returns true, the INDArray is guaranteed to be fully mutable in all positions i.e.
boolean	isPackedArray() Returns true if the data array is fully packed by this matrix in row-major order
boolean	isZero() Returns true if the matrix is the zero matrix (all components zero)
void	log() Computes the natural logarithm (in-place) for all array elements
void	multiply(double factor) Multiplies all elements of the array in place by a given double value
long	nonZeroCount() Returns the number of non-zero elements in the array.
void	reciprocal() Replaces all elements in the array with their reciprocal
int	rowStride() Gets the row stride for this strided matrix.
void	set(AMatrix m) Sets this matrix with the element values from another matrix.
void	set(int i, int j, double value) Sets a value at a given position in a mutable 2D array
void	setColumn(int j, AVector col) Sets a column in a matrix.
void	setRow(int i, AVector row) Sets a row in a matrix to the value specified by the given vector
void	signum() Calculates the signum of all elements of this mutable array Sets each component of the array to its sign value (-1, 0 or 1)
void	square() Squares all elements of the array in place
Matrix	toMatrixTranspose() Coerces the transpose of a matrix to the standard mutable Matrix type in row major order.
double	unsafeGet(int i, int j) 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.
void	unsafeSet(int i, int j, double value) Sets an element value in the matrix in an unsafe fashion, without performing bound checks The result is undefined if the row and column are out of bounds.
static DenseColumnMatrix	wrap(int rows, int cols, double[] data)

Methods inherited from class mikera.matrixx.impl.AStridedMatrix

add, add, addToArray, applyOpCopy, asDoubleArray, clone, diagonalProduct, elementIterator, getBand, getColumnView, getRow, getRowView, getStride, getStrides, reduce, rowDotProduct, subMatrix, trace

Methods inherited from class mikera.matrixx.impl.AArrayMatrix

getArray, getTransposeCopy

Methods inherited from class mikera.matrixx.impl.ARectangularMatrix

bandLength, checkColumn, checkRow, checkSquare, columnCount, elementCount, getElement, getShape, getShape, getShapeClone, isSameShape, isSameShape, isSameShape, isSquare, rowCount

Methods inherited from class mikera.matrixx.AMatrix

add, add2, addCopy, addCopy, addCopy, addCopy, addCopy, addInnerProduct, addInnerProduct, addInnerProduct, addMultiple, addMultiple, addOuterProduct, addOuterProductSparse, addOuterProductSparse, addRowMultiple, addSparse, addSparse, applyOp, applyOp, applyOp, applyOp, applyOp, asElementList, asVector, bandIndex, bandPosition, bandStartColumn, bandStartRow, broadcast, broadcastCloneLike, broadcastCopyLike, broadcastLike, broadcastLike, composeWith, denseClone, determinant, dimensionality, divide, divide, divide, divide, divideCopy, elementsEqual, ensureMutable, epsilonEquals, epsilonEquals, epsilonEquals, equals, equals, equals, equalsArray, equalsTranspose, get, get, get, get, getBandWrapped, getColumnClone, getColumns, getElements, getLeadingDiagonal, getLongShape, getRowClone, getRows, getSlices, getSlices, getSliceViews, hashCode, hasOrthonormalColumns, hasOrthonormalRows, hasUncountable, immutable, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, innerProduct, inputDimensions, inverse, isDiagonal, isElementConstrained, isHermitian, isIdentity, isInvertible, isLowerTriangular, isMutable, isOrthogonal, isOrthogonal, isPositiveDefinite, isRectangularDiagonal, isSymmetric, isUpperTriangular, isView, iterator, join, lowerBandwidth, lowerBandwidthLimit, mul, multiply, multiply, multiply, multiplyCopy, multiplyRow, mutable, negate, outerProduct, outputDimensions, pow, rank, reduce, reduceSlices, reduceSlices, reorder, reorder, replaceColumn, replaceRow, reshape, reshape, rotateView, scaleAdd, scaleAdd, set, set, set, set, set, set, set, setApplyOp, setApplyOp, setElements, setElements, setMultiple, setMultiple, setMultiple, setMultiple, setMultiple, setSparse, setSparse, slice, slice, sliceCount, sparse, sparseClone, sqrt, sub, sub, sub, subArray, subCopy, swapColumns, swapRows, toAffineTransform, toDoubleArray, toDoubleBuffer, toMatrix, toMutableMatrix, toNestedDoubleArrays, toSliceArray, toString, toStringFull, toVector, transform, transform, transformInPlace, transformInPlace, transposeInnerProduct, transposeInnerProduct, transposeInPlace, upperBandwidth, upperBandwidthLimit, validate

Methods inherited from class mikera.arrayz.impl.AbstractArray

absCopy, absDiff, absDiffCopy, add, addApplyOp, addAt, addCopy, addInnerProduct, addInnerProduct, addMultipleSparse, addPower, addPower, addSparse, broadcastLike, compareTo, componentCount, density, divideCopy, elementAbsPowSum, elementMaxAbs, elementPowSum, elementProduct, epsilonEquals, equals, equalsArray, get, get, get, get, getComponent, getComponents, getElements, getElements, getElements, isDense, isSparse, join, multiplyCopy, negateCopy, reciprocalCopy, scale, scaleCopy, setElements, setInnerProduct, setSparse, 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.matrixx.IMatrix

add2, addCopy, addCopy, columnCount, diagonalProduct, getBand, getColumnClone, getColumns, getColumnView, getRow, getRowClone, getRows, getRowView, innerProduct, innerProduct, innerProduct, inverse, isDiagonal, isIdentity, isInvertible, isRectangularDiagonal, isSquare, isSymmetric, rowCount, subMatrix, toNestedDoubleArrays, trace, transform, transformInPlace, transposeInPlace

Methods inherited from interface mikera.arrayz.INDArray

absCopy, absDiff, absDiffCopy, add, addApplyOp, addAt, addCopy, addCopy, addInnerProduct, addInnerProduct, addMultiple, addMultipleSparse, addOuterProduct, addOuterProductSparse, addPower, addPower, addSparse, addSparse, addToArray, applyOp, applyOp, applyOp, applyOpCopy, asDoubleArray, asElementList, asVector, broadcast, broadcastCloneLike, broadcastCopyLike, broadcastLike, broadcastLike, broadcastLike, clone, componentCount, denseClone, dimensionality, divide, divide, divideCopy, divideCopy, elementAbsPowSum, elementCount, elementIterator, elementMaxAbs, elementPowSum, elementProduct, elementsEqual, ensureMutable, epsilonEquals, epsilonEquals, equals, equalsArray, equalsArray, get, get, get, get, get, get, get, get, getComponent, getComponents, getElement, getElements, getElements, getElements, getElements, getLongShape, getShape, getShape, getShapeClone, getSlices, getSlices, getSliceViews, getTransposeCopy, hasUncountable, immutable, innerProduct, innerProduct, innerProduct, isDense, isElementConstrained, isMutable, isSameShape, isSparse, isView, join, join, multiply, multiplyCopy, multiplyCopy, mutable, negate, negateCopy, outerProduct, pow, reciprocalCopy, reduce, reduce, reduceSlices, reduceSlices, reorder, reorder, reshape, rotateView, scale, scaleAdd, scaleAdd, scaleCopy, set, set, set, set, set, set, setApplyOp, setElements, setElements, setElements, setInnerProduct, setMultiple, setMultiple, setSparse, setSparse, signumCopy, slice, slice, sliceCount, sliceValue, sparse, sparseClone, sqrt, squareCopy, sub, sub, subArray, subCopy, toDoubleArray, toDoubleBuffer, toSliceArray, toVector, validate, withComponents

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface mikera.arrayz.impl.IStridedArray

getArray

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

wrap

public static DenseColumnMatrix wrap(int rows,
                                     int cols,
                                     double[] data)

create

public static DenseColumnMatrix create(AMatrix m)

getArrayOffset

public int getArrayOffset()

Description copied from interface: IStridedArray

Gets the data array offset for the first element of this strided array

Specified by:

getArrayOffset in interface IStridedArray

Specified by:

getArrayOffset in class AStridedMatrix

Returns:

rowStride

public int rowStride()

Description copied from class: AStridedMatrix

Gets the row stride for this strided matrix. Each row has this offset in the underlying data array vs. the previous row. May be positive, zero or negative.

Specified by:

rowStride in class AStridedMatrix

columnStride

public int columnStride()

Description copied from class: AStridedMatrix

Gets the column stride for this strided matrix. Each column has this offset in the underlying data array vs. the previous column. May be positive, zero or negative.

Specified by:

columnStride in class AStridedMatrix

getColumn

public ArraySubVector getColumn(int j)

Description copied from interface: IMatrix

Returns a column of the matrix. May or may not be a view, depending on matrix type. Intended for the fastest possible read access of the column. This often means a view, but might not be (e.g. getColumn on a Matrix33 returns a Vector3).

Specified by:

getColumn in interface IMatrix

Specified by:

getColumn in interface IFastColumns

Overrides:

getColumn in class AStridedMatrix

copyRowTo

public void copyRowTo(int i,
                      double[] dest,
                      int destOffset)

Description copied from class: AMatrix

Copies the elements in a selected row of this matrix to a double array

Specified by:

copyRowTo in class AStridedMatrix

Parameters:

i - The index of the selected row

dest - Destination double[] array

destOffset - Offset into destination array

copyColumnTo

public void copyColumnTo(int j,
                         double[] dest,
                         int destOffset)

Description copied from class: AMatrix

Copies the elements in a selected row of this matrix to a double array

Specified by:

copyColumnTo in class AStridedMatrix

dest - Destination double[] array

setRow

public void setRow(int i,
                   AVector row)

Description copied from class: AMatrix

Sets a row in a matrix to the value specified by the given vector

Overrides:

setRow in class AMatrix

setColumn

public void setColumn(int j,
                      AVector col)

Description copied from class: AMatrix

Sets a column in a matrix.

Overrides:

setColumn in class AMatrix

addMultiple

public void addMultiple(AMatrix m,
                        double factor)

Description copied from class: AMatrix

Adds a scalar multiple of another matrix to this matrix

Overrides:

addMultiple in class AMatrix

addOuterProduct

public void addOuterProduct(AVector a,
                            AVector b)

Description copied from class: AMatrix

Adds the outer product of two vectors to this matrix

Overrides:

addOuterProduct in class AMatrix

set

public void set(AMatrix m)

Description copied from class: AMatrix

Sets this matrix with the element values from another matrix. Source matrix must have the same shape.

Overrides:

set in class AMatrix

get

public double get(int i,
                  int j)

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

Overrides:

get in class AArrayMatrix

set

public void set(int i,
                int j,
                double value)

Description copied from interface: INDArray

Sets a value at a given position in a mutable 2D array

Specified by:

set in interface INDArray

Specified by:

set in interface IMatrix

Overrides:

set in class ARectangularMatrix

unsafeSet

public void unsafeSet(int i,
                      int j,
                      double value)

Description copied from class: AMatrix

Sets an element value 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:

unsafeSet in class AArrayMatrix

unsafeGet

public double unsafeGet(int i,
                        int j)

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 AArrayMatrix

Returns:

addAt

public void addAt(int i,
                  int j,
                  double d)

Description copied from interface: IMatrix

Adds a value at a specific position in the matrix, mutating the matrix Does not perform bounds checking - this in an unsafe operation

Specified by:

addAt in interface IMatrix

Overrides:

addAt in class AMatrix

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

Specified by:

isFullyMutable in class AMatrix

isPackedArray

public boolean isPackedArray()

Description copied from class: AArrayMatrix

Returns true if the data array is fully packed by this matrix in row-major order

Specified by:

isPackedArray in interface IStridedArray

Overrides:

isPackedArray in class AStridedMatrix

Returns:

isBoolean

public boolean isBoolean()

Description copied from interface: INDArray

Returns true if the array is boolean (contains only 0.0 or 1.0 values)

Specified by:

isBoolean in interface INDArray

Overrides:

isBoolean in class AMatrix

isZero

public boolean isZero()

Description copied from class: AMatrix

Returns true if the matrix is the zero matrix (all components zero)

Specified by:

isZero in interface INDArray

Overrides:

isZero in class AStridedMatrix

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 AMatrix

elementSquaredSum

public double elementSquaredSum()

Description copied from class: AMatrix

Returns the squared sum of all elements in this matrix

Specified by:

elementSquaredSum in interface INDArray

Overrides:

elementSquaredSum in class AMatrix

elementMax

public double elementMax()

Description copied from interface: INDArray

Returns the maximum element value in this array. Throws an error if there are no elements.

Specified by:

elementMax in interface INDArray

Overrides:

elementMax in class AbstractArray<AVector>

elementMin

public double elementMin()

Description copied from interface: INDArray

Returns the maximum element value in this array. Throws an error if there are no elements.

Specified by:

elementMin in interface INDArray

Overrides:

elementMin in class AbstractArray<AVector>

abs

public void abs()

Description copied from interface: INDArray

Replaces all elements of this array with their absolute values, according to Math.abs(double)

Specified by:

abs in interface INDArray

Overrides:

abs in class AMatrix

signum

public void signum()

Description copied from interface: INDArray

Calculates the signum of all elements of this mutable array Sets each component of the array to its sign value (-1, 0 or 1)

Specified by:

signum in interface INDArray

Overrides:

signum in class AMatrix

square

public void square()

Description copied from interface: INDArray

Squares all elements of the array in place

Specified by:

square in interface INDArray

Overrides:

square in class AMatrix

exp

public void exp()

Description copied from interface: INDArray

Computes the function e^x (in-place) for all array elements

Specified by:

exp in interface INDArray

Overrides:

exp in class AMatrix

log

public void log()

Description copied from interface: INDArray

Computes the natural logarithm (in-place) for all array elements

Specified by:

log in interface INDArray

Overrides:

log in class AMatrix

applyOp

public void applyOp(Op op)

Description copied from interface: INDArray

Applies a unary operator to all elements of the array (in-place)

Specified by:

applyOp in interface INDArray

Overrides:

applyOp in class AStridedMatrix

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 AMatrix

add

public void add(double d)

Description copied from interface: INDArray

Adds a double value to all elements in this array. Implementations may optimize the case of 0.0

Specified by:

add in interface INDArray

Overrides:

add in class AMatrix

multiply

public void multiply(double factor)

Description copied from interface: INDArray

Multiplies all elements of the array in place by a given double value

Specified by:

multiply in interface INDArray

Overrides:

multiply in class AMatrix

fill

public void fill(double value)

Description copied from interface: INDArray

Fills this array with a single double value. Requires the array to be mutable.

Specified by:

fill in interface INDArray

Overrides:

fill in class AMatrix

reciprocal

public void reciprocal()

Description copied from interface: INDArray

Replaces all elements in the array with their reciprocal

Specified by:

reciprocal in interface INDArray

Overrides:

reciprocal in class AMatrix

clamp

public void clamp(double min,
                  double max)

Description copied from interface: INDArray

Clamps all the elements of this array within the specified [min,max] range

Specified by:

clamp in interface INDArray

Overrides:

clamp in class AMatrix

getTranspose

public Matrix getTranspose()

Description copied from interface: INDArray

Returns the transpose of this array. A transpose of an array is equivalent to reversing the order of dimensions. May or may not return a view depending on the array type.

Specified by:

getTranspose in interface INDArray

Specified by:

getTranspose in interface IMatrix

Overrides:

getTranspose in class AStridedMatrix

Returns:

the transpose of this matrix

getTransposeView

public Matrix getTransposeView()

Description copied from interface: INDArray

Returns a transposed view of the array. May throw UnsupportedOperationException if the array type does not support this capability

Specified by:

getTransposeView in interface INDArray

Specified by:

getTransposeView in interface IMatrix

Overrides:

getTransposeView in class AStridedMatrix

Returns:

the transpose of this matrix, as a view

exactClone

public DenseColumnMatrix 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 AMatrix

Returns:

A clone of the original array

dense

public DenseColumnMatrix dense()

Description copied from interface: INDArray

Coerces this INDArray to a dense format, without changing its element values. May return the same INDArray if already dense. May also mutate the internal structure of the original NDArray, or create a view over parts of the original INDArray. You should take a defensive copy of the original NDArray if any of this concerns you. The returned dense array may not be fully mutable in all elements.

Specified by:

dense in interface INDArray

Overrides:

dense in class AMatrix

copy

public DenseColumnMatrix copy()

Description copied from interface: INDArray

Returns a defensive copy of the array data. Use this if the original array might change and you need a defensive copy. May return the same array if the original was immutable, otherwise will return a defensive copy.

Specified by:

copy in interface INDArray

Overrides:

copy in class AMatrix

toMatrixTranspose

public Matrix toMatrixTranspose()

Description copied from class: AMatrix

Coerces the transpose of a matrix to the standard mutable Matrix type in row major order. Performs a copy if necessary.

Overrides:

toMatrixTranspose in class AMatrix