mikera.arrayz.impl

Class BaseNDArray

java.lang.Object

mikera.arrayz.impl.AbstractArray<INDArray>

mikera.arrayz.impl.BaseShapedArray

mikera.arrayz.impl.BaseNDArray

All Implemented Interfaces:

Serializable, Cloneable, Iterable<INDArray>, IStridedArray, INDArray

Direct Known Subclasses:

ImmutableArray, NDArray

public abstract class BaseNDArray
extends BaseShapedArray
implements IStridedArray

Base class for NDArray implementations.

Author:

Mike

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected double[]	data
protected int	dimensions
protected int	offset
protected int[]	stride

Fields inherited from class mikera.arrayz.impl.BaseShapedArray

shape

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseNDArray(double[] data, int dimensions, int offset, int[] shape, int[] stride)

Method Summary

Modifier and Type	Method and Description
protected void	checkDimension(int dimension) Checks if an array has the specified dimension.
int	dimensionality() Returns the dimensionality of the array (i.e.
long	elementCount() Returns the total number of elements in this array.
double	get() Returns the double value of a scalar array
double	get(int... indexes) Returns the double value at the specified index position in an array
double	get(int x) Returns the double value at the specified position in a 1D vector
double	get(int x, int y) 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
int	getIndex(int... indexes)
long[]	getLongShape() Returns the shape of the array as an array of longs.
int	getShape(int dim) Returns the dimension size for a specific dimension in the array's shape
int	getStride(int dim) Gets the stide for a specific dimension in this strided array.
int[]	getStrides() Gets the strides for each dimension of this strided array.
boolean	isPackedArray() Checks if this array is fully packed in row major order.

Methods inherited from class mikera.arrayz.impl.BaseShapedArray

getShape, getShapeClone, isZero, reduce, reduce, sliceCount

Methods inherited from class mikera.arrayz.impl.AbstractArray

abs, absCopy, add, add, add, addAt, addCopy, addCopy, addInnerProduct, addInnerProduct, addInnerProduct, addMultiple, addOuterProduct, addPower, addPower, addToArray, applyOp, applyOp, applyOp, applyOp, applyOpCopy, asDoubleArray, asElementList, asVector, broadcast, broadcastCloneLike, broadcastCopyLike, broadcastLike, broadcastLike, broadcastLike, checkMutable, clamp, clone, componentCount, copy, dense, denseClone, density, divide, divide, divideCopy, elementAbsPowSum, elementIterator, elementMax, elementMin, elementPowSum, elementProduct, elementsEqual, elementSquaredSum, elementSum, ensureMutable, epsilonEquals, epsilonEquals, equals, equals, equals, equalsArray, equalsArray, exp, fill, get, get, get, get, get, getComponent, getComponents, getElements, getElements, getElements, getElements, getSlices, getSlices, getSliceViews, getTranspose, getTransposeCopy, getTransposeView, hashCode, hasUncountable, immutable, innerProduct, innerProduct, innerProduct, innerProduct, isBoolean, isDense, isElementConstrained, isFullyMutable, isMutable, isSameShape, isSparse, iterator, join, join, log, multiply, multiply, multiplyCopy, multiplyCopy, mutable, negate, negateCopy, nonZeroCount, outerProduct, pow, reciprocal, reciprocalCopy, reduceSlices, reduceSlices, reorder, reorder, reshape, rotateView, scale, scaleAdd, scaleAdd, scaleCopy, set, set, set, set, set, set, setElements, setElements, setElements, setInnerProduct, setMultiple, setMultiple, signum, signumCopy, sliceValue, sparse, sparseClone, sqrt, square, squareCopy, sub, sub, sub, subArray, subCopy, toArray, toDoubleArray, toDoubleBuffer, toSliceArray, toString, toStringFull, toVector, validate, withComponents

Methods inherited from class java.lang.Object

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

Methods inherited from interface mikera.arrayz.impl.IStridedArray

getArray

Methods inherited from interface mikera.arrayz.INDArray

abs, absCopy, add, add, addAt, addCopy, addCopy, addInnerProduct, addMultiple, addOuterProduct, addPower, addPower, addToArray, applyOp, applyOp, applyOp, applyOp, applyOpCopy, asDoubleArray, asElementList, asVector, broadcast, broadcastCloneLike, broadcastCopyLike, broadcastLike, broadcastLike, broadcastLike, checkMutable, clamp, clone, componentCount, copy, dense, denseClone, divide, divide, divideCopy, elementAbsPowSum, elementIterator, elementMax, elementMin, elementPowSum, elementProduct, elementsEqual, elementSquaredSum, elementSum, ensureMutable, epsilonEquals, epsilonEquals, equals, equalsArray, equalsArray, exactClone, exp, fill, get, get, get, get, get, getComponent, getComponents, getElements, getElements, getElements, getElements, getShape, getShapeClone, getSlices, getSlices, getSliceViews, getTranspose, getTransposeCopy, getTransposeView, hasUncountable, immutable, innerProduct, innerProduct, innerProduct, innerProduct, isBoolean, isDense, isElementConstrained, isFullyMutable, isMutable, isSameShape, isSparse, isView, isZero, join, join, log, multiply, multiply, multiplyCopy, multiplyCopy, mutable, negate, negateCopy, nonZeroCount, outerProduct, pow, reciprocal, reciprocalCopy, reduce, reduce, reduceSlices, reduceSlices, reorder, reorder, reshape, rotateView, scale, scaleAdd, scaleAdd, scaleCopy, set, set, set, set, set, set, set, setElements, setElements, setElements, setInnerProduct, setMultiple, setMultiple, signum, signumCopy, slice, slice, sliceCount, sliceValue, sparse, sparseClone, sqrt, square, squareCopy, sub, sub, subArray, subCopy, toArray, toDoubleArray, toDoubleBuffer, toSliceArray, toVector, validate, withComponents

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

dimensions

protected final int dimensions

offset

protected int offset

data

protected final double[] data

stride

protected final int[] stride

Constructor Detail

BaseNDArray

protected BaseNDArray(double[] data,
                      int dimensions,
                      int offset,
                      int[] shape,
                      int[] stride)

Method Detail

dimensionality

public int dimensionality()

Description copied from interface: INDArray

Returns the dimensionality of the array (i.e. the number of dimensions in the array shape) e.g. 0 for a scalar, 1 for a vector, 2 for a matrix etc.

Specified by:

dimensionality in interface INDArray

Overrides:

dimensionality in class BaseShapedArray

getStride

public final int getStride(int dim)

Description copied from interface: IStridedArray

Gets the stide for a specific dimension in this strided array.

Specified by:

getStride in interface IStridedArray

Returns:

getShape

public final int getShape(int dim)

Description copied from interface: INDArray

Returns the dimension size for a specific dimension in the array's shape

Specified by:

getShape in interface INDArray

Overrides:

getShape in class BaseShapedArray

getLongShape

public long[] getLongShape()

Description copied from interface: INDArray

Returns the shape of the array as an array of longs.

Specified by:

getLongShape in interface INDArray

Overrides:

getLongShape in class AbstractArray<INDArray>

getIndex

public int getIndex(int... indexes)

get

public double get(int... indexes)

Description copied from interface: INDArray

Returns the double value at the specified index position in an array

Specified by:

get in interface INDArray

get

public double get()

Description copied from interface: INDArray

Returns the double value of a scalar array

Specified by:

get in interface INDArray

Specified by:

get in class AbstractArray<INDArray>

get

public double get(int x)

Description copied from interface: INDArray

Returns the double value at the specified position in a 1D vector

Specified by:

get in interface INDArray

Specified by:

get in class AbstractArray<INDArray>

get

public double get(int x,
                  int y)

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 class AbstractArray<INDArray>

isPackedArray

public boolean isPackedArray()

Description copied from interface: IStridedArray

Checks if this array is fully packed in row major order.

Specified by:

isPackedArray in interface IStridedArray

Returns:

elementCount

public long elementCount()

Description copied from interface: INDArray

Returns the total number of elements in this array. Equivalent to the product all dimension sizes.

Specified by:

elementCount in interface INDArray

Overrides:

elementCount in class BaseShapedArray

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

Returns:

getStrides

public int[] getStrides()

Description copied from interface: IStridedArray

Gets the strides for each dimension of this strided array. The returned array should not be modified

Specified by:

getStrides in interface IStridedArray

Returns:

checkDimension

protected final void checkDimension(int dimension)

Description copied from class: AbstractArray

Checks if an array has the specified dimension. Throws an exception if not.

Overrides:

checkDimension in class AbstractArray<INDArray>