mikera.arrayz.impl

Class ImmutableArray

java.lang.Object

mikera.arrayz.impl.AbstractArray<INDArray>

mikera.arrayz.impl.BaseNDArray

mikera.arrayz.impl.ImmutableArray

All Implemented Interfaces:

Cloneable, Iterable<INDArray>, IStridedArray, INDArray

public class ImmutableArray
extends BaseNDArray

Immutable N-dimensional array class Uses strided array storage

Author:

Mike

Field Summary

Fields inherited from class mikera.arrayz.impl.BaseNDArray

data, dimensions, offset, shape, stride

Method Summary

Methods

Modifier and Type	Method and Description
AVector	asVector() Constructs a view of the array as a single vector in row-major order.
static INDArray	create(INDArray a)
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.
INDArray	exactClone() Returns an exact deep clone of an array (i.e.
double	get(int... indexes) Returns the double value at the specified index position in an array
double[]	getArray()
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[]	getShapeClone() Returns the shape of the array as an array of ints, guaranteed to be a new array
int	getStride(int dim)
boolean	isElementConstrained() Returns true if this array has some constraints on element values
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)
boolean	isView() Return true if this array is a view type
void	set(int[] indexes, double value)
INDArray	slice(int majorSlice) Returns the specified major slice of this array as a view (slice along dimension 0)
INDArray	slice(int dimension, int index) Returns a slice view of this array along the specified dimension
int	sliceCount() returns the number of major slices in this array.
ImmutableArray	subArray(int[] offsets, int[] shape) Returns a subarray view of a larger array
void	toDoubleBuffer(DoubleBuffer dest) Copies the elements of this INDArray to the specified double buffer
static INDArray	wrap(double[] data, int[] shape)

Methods inherited from class mikera.arrayz.impl.BaseNDArray

get, get, get, getArrayOffset, getShape, getStrides, isPackedArray

Methods inherited from class mikera.arrayz.impl.AbstractArray

abs, add, add, applyOp, applyOp, asDoubleArray, asElementList, 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, 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, toArray, toDoubleArray, toString, toVector, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface mikera.arrayz.INDArray

abs, add, add, applyOp, applyOp, asDoubleArray, asElementList, broadcast, broadcastCloneLike, broadcastLike, clamp, clone, copyTo, divide, divide, elementIterator, elementSquaredSum, elementSum, ensureMutable, epsilonEquals, epsilonEquals, equals, exp, fill, getElements, getSlices, getSlices, getSliceViews, getTranspose, getTransposeCopy, getTransposeView, immutable, innerProduct, isBoolean, isSameShape, isZero, 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, toArray, toDoubleArray, toVector, validate

Method Detail

wrap

public static INDArray wrap(double[] data,
            int[] shape)

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

Overrides:

dimensionality in class BaseNDArray

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

Overrides:

isMutable in class AbstractArray<INDArray>

Returns:

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

Returns:

isElementConstrained

public boolean isElementConstrained()

Description copied from interface: INDArray

Returns true if this array has some constraints on element values

Specified by:

isElementConstrained in interface INDArray

Overrides:

isElementConstrained in class AbstractArray<INDArray>

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

Overrides:

getShape in class BaseNDArray

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 BaseNDArray

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 BaseNDArray

Returns:

getStride

public int getStride(int dim)

Specified by:

getStride in interface IStridedArray

Overrides:

getStride in class BaseNDArray

getIndex

public int getIndex(int... indexes)

Overrides:

getIndex in class BaseNDArray

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

Overrides:

get in class BaseNDArray

Returns:

set

public void set(int[] indexes,
       double value)

slice

public INDArray slice(int majorSlice)

Description copied from interface: INDArray

Returns the specified major slice of this array as a view (slice along dimension 0)

Returns:

slice

public INDArray slice(int dimension,
             int index)

Description copied from interface: INDArray

Returns a slice view of this array along the specified dimension

Returns:

subArray

public ImmutableArray subArray(int[] offsets,
                      int[] shape)

Description copied from interface: INDArray

Returns a subarray view of a larger array

Specified by:

subArray in interface INDArray

Overrides:

subArray in class AbstractArray<INDArray>

Returns:

sliceCount

public int sliceCount()

Description copied from interface: INDArray

returns the number of major slices in this array.

Specified by:

sliceCount in interface INDArray

Overrides:

sliceCount in class BaseNDArray

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 BaseNDArray

Returns:

isView

public boolean isView()

Description copied from interface: INDArray

Return true if this array is a view type

Returns:

asVector

public AVector asVector()

Description copied from interface: INDArray

Constructs a view of the array as a single vector in row-major order.

Specified by:

asVector in interface INDArray

Overrides:

asVector in class AbstractArray<INDArray>

Returns:

exactClone

public INDArray exactClone()

Description copied from interface: INDArray

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

Returns:

toDoubleBuffer

public void toDoubleBuffer(DoubleBuffer dest)

Description copied from interface: INDArray

Copies the elements of this INDArray to the specified double buffer

Specified by:

toDoubleBuffer in interface INDArray

Overrides:

toDoubleBuffer in class AbstractArray<INDArray>

create

public static INDArray create(INDArray a)

getArray

public double[] getArray()