mikera.arrayz.impl

Class ImmutableArray

java.lang.Object

mikera.arrayz.impl.AbstractArray<INDArray>

mikera.arrayz.impl.BaseShapedArray

mikera.arrayz.impl.BaseNDArray

mikera.arrayz.impl.ImmutableArray

All Implemented Interfaces:

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

public class ImmutableArray
extends BaseNDArray
implements IDense

General immutable N-dimensional array class Uses strided array storage

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
AVector	asVector() Constructs a view of all elements in the array as a single vector in row-major order.
static INDArray	create(INDArray a)
int	dimensionality() Returns the dimensionality of the array (i.e.
long	elementCount() Returns the total number of elements in this array.
boolean	equalsArray(double[] data, int offset) Returns true if the elements in this array exactly match the elements in the given array, in row-major order
INDArray	exactClone() Creates a deep clone of an array, using the same class implementation as the original array
double	get(int... indexes) Returns the double value at the specified index position in an array
double[]	getArray() Gets the underlying data array for this strided array Unsafe operation - may allow modification of otherwise immutable arrays
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 i.e.
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 considered as a view type.
void	set(int[] indexes, double value) Sets the element at the given indexed position in a mutable array
INDArray	slice(int majorSlice) Returns the specified major slice of this array as a view (slice along dimension 0) 0 dimensional slice results are permitted, but attempting to slice a 0 dimensional array will result in an error.
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 (i.e.
INDArray	sparseClone() Creates a fully mutable clone of this array.
ImmutableArray	subArray(int[] offsets, int[] shape) Returns a subarray view of a larger array
void	toDoubleBuffer(java.nio.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, getStride, getStrides, isPackedArray

Methods inherited from class mikera.arrayz.impl.BaseShapedArray

getElement, isZero, reduce, reduce

Methods inherited from class mikera.arrayz.impl.AbstractArray

abs, absCopy, absDiff, absDiffCopy, add, add, add, addApplyOp, addAt, addCopy, addCopy, addCopy, addInnerProduct, addInnerProduct, addInnerProduct, addInnerProduct, addMultiple, addMultipleSparse, addOuterProduct, addOuterProductSparse, addPower, addPower, addSparse, addSparse, addToArray, applyOp, applyOp, applyOp, applyOp, applyOpCopy, asDoubleArray, asElementList, broadcast, broadcastCloneLike, broadcastCopyLike, broadcastLike, broadcastLike, broadcastLike, clamp, clone, compareTo, componentCount, copy, dense, denseClone, density, divide, divide, divideCopy, divideCopy, elementAbsPowSum, elementIterator, elementMax, elementMaxAbs, elementMin, elementPowSum, elementProduct, elementsEqual, elementSquaredSum, elementSum, ensureMutable, epsilonEquals, epsilonEquals, equals, equals, equals, 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, 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, setApplyOp, setElements, setElements, setElements, setInnerProduct, setMultiple, setMultiple, setSparse, setSparse, signum, signumCopy, sliceValue, sparse, sqrt, square, squareCopy, sub, sub, sub, subCopy, toDoubleArray, toSliceArray, toString, toStringFull, toVector, validate, withComponents

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface mikera.arrayz.INDArray

abs, absCopy, absDiff, absDiffCopy, add, add, addApplyOp, addAt, addCopy, addCopy, addInnerProduct, addInnerProduct, addMultiple, addMultipleSparse, addOuterProduct, addOuterProductSparse, addPower, addPower, addSparse, addSparse, addToArray, applyOp, applyOp, applyOp, applyOp, applyOpCopy, asDoubleArray, asElementList, broadcast, broadcastCloneLike, broadcastCopyLike, broadcastLike, broadcastLike, broadcastLike, clamp, clone, componentCount, copy, dense, denseClone, divide, divide, divideCopy, divideCopy, elementAbsPowSum, elementIterator, elementMax, elementMaxAbs, elementMin, elementPowSum, elementProduct, elementsEqual, elementSquaredSum, elementSum, ensureMutable, epsilonEquals, epsilonEquals, equals, equalsArray, exp, fill, get, get, get, get, get, getComponent, getComponents, getElement, getElements, getElements, getElements, getElements, getSlices, getSlices, getSliceViews, getTranspose, getTransposeCopy, getTransposeView, hasUncountable, immutable, innerProduct, innerProduct, innerProduct, innerProduct, isBoolean, isDense, isSameShape, isSparse, 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, setApplyOp, setElements, setElements, setElements, setInnerProduct, setMultiple, setMultiple, setSparse, setSparse, signum, signumCopy, sliceValue, sparse, sqrt, square, squareCopy, sub, sub, subCopy, toDoubleArray, toSliceArray, toVector, validate, withComponents

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

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>

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>

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. WARNING: May return the internal int[] array describing the shape. Modifying this may cause undefined behaviour. If you want to guarantee a new int[] array that can be safely modified, use getShapeClone() instead

Specified by:

getShape in interface INDArray

Overrides:

getShape in class BaseShapedArray

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 i.e. will perform a defensive copy of any internal shape array if required.

Specified by:

getShapeClone in interface INDArray

Overrides:

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

set

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

Description copied from interface: INDArray

Sets the element at the given indexed position in a mutable array

Specified by:

set in interface INDArray

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) 0 dimensional slice results are permitted, but attempting to slice a 0 dimensional array will result in an error.

Specified by:

slice in interface INDArray

slice

public INDArray slice(int dimension,
                      int index)

Description copied from interface: INDArray

Returns a slice view of this array along the specified dimension

Specified by:

slice in interface INDArray

sliceCount

public int sliceCount()

Description copied from interface: INDArray

Returns the number of major slices in this array (i.e. the size of dimension 0)

Specified by:

sliceCount in interface INDArray

Overrides:

sliceCount in class BaseShapedArray

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>

elementCount

public long elementCount()

Description copied from interface: INDArray

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

Specified by:

elementCount in interface INDArray

Overrides:

elementCount in class BaseNDArray

isView

public boolean isView()

Description copied from interface: INDArray

Return true if this array is considered as a view type. This indicates (but does not guarantee): a) Data is *likely* to be shared with other arrays, so mutation of one may affect others b) It is *unlikely* to be in the most efficient general purpose format isView is intended to be used as for heuristics. It should *not* be used where the outcome might affect correctness.

Specified by:

isView in interface INDArray

asVector

public AVector asVector()

Description copied from interface: INDArray

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

Specified by:

asVector in interface INDArray

Overrides:

asVector in class AbstractArray<INDArray>

exactClone

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

Returns:

A clone of the original array

sparseClone

public INDArray sparseClone()

Description copied from interface: INDArray

Creates a fully mutable clone of this array. Will use a sparse format if possible.

Specified by:

sparseClone in interface INDArray

Overrides:

sparseClone in class AbstractArray<INDArray>

toDoubleBuffer

public void toDoubleBuffer(java.nio.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>

equalsArray

public boolean equalsArray(double[] data,
                           int offset)

Description copied from interface: INDArray

Returns true if the elements in this array exactly match the elements in the given array, in row-major order

Specified by:

equalsArray in interface INDArray

Overrides:

equalsArray in class AbstractArray<INDArray>

Parameters:

data - Array of double element values to check for equality

offset - Offset into the data array

Returns:

create

public static INDArray create(INDArray a)

getArray

public double[] getArray()

Description copied from interface: IStridedArray

Gets the underlying data array for this strided array Unsafe operation - may allow modification of otherwise immutable arrays

Specified by:

getArray in interface IStridedArray

Returns: