mikera.arrayz.impl

Class BaseNDArray

java.lang.Object

mikera.arrayz.impl.AbstractArray<INDArray>

mikera.arrayz.impl.BaseNDArray

All Implemented Interfaces:

Cloneable, Iterable<INDArray>, IStridedArray, INDArray

Direct Known Subclasses:

ImmutableArray, NDArray

public abstract class BaseNDArray
extends AbstractArray<INDArray>
implements IStridedArray

Base class for NDArray implementations.

Author:

Mike

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
int	dimensionality() Returns the dimensionality of the array (number of dimensions in the array shape) e.g.
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()
int	getIndex(int... indexes)
long[]	getLongShape() Returns the shape of the array as an array of longs.
int[]	getShape() Returns the shape of the array as an array of ints.
int	getShape(int dim) Returns the dimension size for a specific dimension in the array's shape
int[]	getShapeClone() Returns the shape of the array as an array of ints, guaranteed to be a new array
int	getStride(int dim)
int[]	getStrides()
boolean	isPackedArray()
int	sliceCount() returns the number of major slices in this array.

Methods inherited from class mikera.arrayz.impl.AbstractArray

abs, add, add, applyOp, applyOp, asDoubleArray, asElementList, asVector, broadcast, broadcastCloneLike, broadcastLike, clamp, clone, copyTo, divide, divide, elementIterator, elementSquaredSum, elementSum, ensureMutable, epsilonEquals, epsilonEquals, equals, equals, exp, fill, getElements, getSlices, getSlices, getSliceViews, getTranspose, getTransposeCopy, getTransposeView, hashCode, immutable, innerProduct, isBoolean, isElementConstrained, isFullyMutable, isMutable, isSameShape, isZero, iterator, join, log, multiply, multiply, mutable, negate, nonZeroCount, outerProduct, pow, reciprocal, reshape, rotateView, scale, scaleAdd, set, set, set, set, set, setElements, setElements, signum, sqrt, square, sub, sub, subArray, toArray, toDoubleArray, toDoubleBuffer, toString, toVector, validate

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, add, add, applyOp, applyOp, asDoubleArray, asElementList, asVector, broadcast, broadcastCloneLike, broadcastLike, clamp, clone, copyTo, divide, divide, elementIterator, elementSquaredSum, elementSum, ensureMutable, epsilonEquals, epsilonEquals, equals, exactClone, exp, fill, getElements, getSlices, getSlices, getSliceViews, getTranspose, getTransposeCopy, getTransposeView, immutable, innerProduct, isBoolean, isElementConstrained, isFullyMutable, isMutable, isSameShape, isView, isZero, join, log, multiply, multiply, mutable, negate, nonZeroCount, outerProduct, pow, reciprocal, reshape, rotateView, scale, scaleAdd, set, set, set, set, set, set, setElements, setElements, signum, slice, slice, sqrt, square, sub, sub, subArray, toArray, toDoubleArray, toDoubleBuffer, toVector, validate

Field Detail

dimensions

protected final int dimensions

shape

protected final int[] shape

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 (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

Returns:

getShape

public int[] getShape()

Description copied from interface: INDArray

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

Specified by:

getShape in interface IStridedArray

Specified by:

getShape in interface INDArray

Returns:

getShapeClone

public int[] getShapeClone()

Description copied from interface: INDArray

Returns the shape of the array as an array of ints, guaranteed to be a new array

Specified by:

getShapeClone in interface INDArray

Overrides:

getShapeClone in class AbstractArray<INDArray>

Returns:

getStride

public int getStride(int dim)

Specified by:

getStride in interface IStridedArray

getShape

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

Returns:

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>

Returns:

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

Returns:

get

public double get()

Description copied from interface: INDArray

Returns the double value of a scalar array

Specified by:

get in interface INDArray

Overrides:

get in class AbstractArray<INDArray>

Returns:

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

Overrides:

get in class AbstractArray<INDArray>

Returns:

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

Overrides:

get in class AbstractArray<INDArray>

Returns:

isPackedArray

public boolean isPackedArray()

Specified by:

isPackedArray in interface IStridedArray

sliceCount

public int sliceCount()

Description copied from interface: INDArray

returns the number of major slices in this array.

Specified by:

sliceCount in interface INDArray

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

Returns:

getArrayOffset

public int getArrayOffset()

Specified by:

getArrayOffset in interface IStridedArray

getStrides

public int[] getStrides()

Specified by:

getStrides in interface IStridedArray