mikera.arrayz

Class Array

java.lang.Object

mikera.arrayz.impl.AbstractArray<INDArray>

mikera.arrayz.Array

All Implemented Interfaces:

Cloneable, Iterable<INDArray>, IStridedArray, INDArray

public final class Array
extends AbstractArray<INDArray>
implements IStridedArray

General purpose mutable packed N-dimensional array This is the general multi-dimensional equivalent of Matrix and Vector, and as such is the most efficient storage type for 3D+ arrays

Author:

Mike

Method Summary

Methods

Modifier and Type	Method and Description
void	abs() Replaces all elements of this array with their absolute values, according to Math.abs(double)
void	applyOp(IOp op) Applies a unary operator to all elements of the array (in-place)
void	applyOp(Op op) Applies a unary operator to all elements of the array (in-place)
double[]	asDoubleArray() Returns the underlying double array representing the packed elements of this array Returns nil if there is no such underlying array
Vector	asVector() Constructs a view of the array as a single vector in row-major order.
INDArray	clone() Returns a clone of the array, as a new array which will be fully mutable and may be of a different class to the original.
static Array	create(INDArray a)
static Array	createFromVector(AVector a, int[] shape) Creates a new matrix using the elements in the specified vector.
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.
Iterator<Double>	elementIterator() Returns an iterator over all elements in this array.
double	elementSquaredSum() Returns the total sum of elements in this array.
double	elementSum() Returns the total sum of elements in this array.
boolean	equals(Array a)
boolean	equals(INDArray a) Returns true if the two arrays are exactly equal in value and shape
Array	exactClone() Returns an exact deep clone of an array (i.e.
void	exp() Computes the function e^x (in-place) for all array elements
double	get(int... indexes) Returns the double value at the specified index position in an array
double[]	getArray()
int	getArrayOffset()
void	getElements(double[] values, int offset) Gets all elements of the array, copying them into a double array
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
List<INDArray>	getSlices() Returns a list of all major slices of this array.
int	getStride(int dim)
int[]	getStrides()
INDArray	immutable() Returns an immutable version of this INDArray's data
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	isPackedArray()
boolean	isView() Return true if this array is a view type
boolean	isZero() Returns true if the array is zero (all elements equal to zero)
void	log() Computes the natural logarithm (in-place) for all array elements
void	multiply(double factor) Multiplies all elements of the array by a given double value
static Array	newArray(int... shape)
void	set(int[] indexes, double value)
void	setElements(double[] values, int offset, int length) Sets all elements in an array using the given double values
void	signum() Calculates the signum of all elements of the array
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.
void	square() Squares all elements of the array
INDArray	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
Vector	toVector() Converts the array into a flattened vector
void	validate() Validates the internal data structure of the INDArray.
static INDArray	wrap(double[] data, int[] shape)
static Array	wrap(Matrix m)
static Array	wrap(Vector v)

Methods inherited from class mikera.arrayz.impl.AbstractArray

add, add, asElementList, broadcast, broadcastCloneLike, broadcastLike, clamp, copyTo, divide, divide, ensureMutable, epsilonEquals, epsilonEquals, equals, fill, get, get, get, getShape, getSlices, getSliceViews, getTranspose, getTransposeCopy, getTransposeView, hashCode, innerProduct, isBoolean, isSameShape, iterator, join, multiply, mutable, negate, nonZeroCount, outerProduct, pow, reciprocal, reshape, rotateView, scale, scaleAdd, set, set, set, set, set, setElements, sqrt, sub, sub, toArray, toDoubleArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface mikera.arrayz.INDArray

add, add, asElementList, broadcast, broadcastCloneLike, broadcastLike, clamp, copyTo, divide, divide, ensureMutable, epsilonEquals, epsilonEquals, fill, get, get, get, getShape, getSlices, getSliceViews, getTranspose, getTransposeCopy, getTransposeView, innerProduct, isBoolean, isSameShape, join, multiply, mutable, negate, nonZeroCount, outerProduct, pow, reciprocal, reshape, rotateView, scale, scaleAdd, set, set, set, set, set, setElements, sqrt, sub, sub, toArray, toDoubleArray

Method Detail

wrap

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

wrap

public static Array wrap(Vector v)

wrap

public static Array wrap(Matrix m)

newArray

public static Array newArray(int... shape)

create

public static Array create(INDArray a)

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:

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:

getStride

public int getStride(int dim)

Specified by:

getStride in interface IStridedArray

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:

set

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

Specified by:

set in interface INDArray

asVector

public Vector 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:

toVector

public Vector toVector()

Description copied from interface: INDArray

Converts the array into a flattened vector

Specified by:

toVector in interface INDArray

Overrides:

toVector in class AbstractArray<INDArray>

Returns:

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)

Specified by:

slice in interface INDArray

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

Specified by:

slice in interface INDArray

Returns:

subArray

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

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:

elementSum

public double elementSum()

Description copied from interface: INDArray

Returns the total sum of elements in this array.

Specified by:

elementSum in interface INDArray

Overrides:

elementSum in class AbstractArray<INDArray>

Returns:

elementSquaredSum

public double elementSquaredSum()

Description copied from interface: INDArray

Returns the total sum of elements in this array.

Specified by:

elementSquaredSum in interface INDArray

Overrides:

elementSquaredSum in class AbstractArray<INDArray>

Returns:

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

signum

public void signum()

Description copied from interface: INDArray

Calculates the signum of all elements of the array

Specified by:

signum in interface INDArray

Overrides:

signum in class AbstractArray<INDArray>

square

public void square()

Description copied from interface: INDArray

Squares all elements of the array

Specified by:

square in interface INDArray

Overrides:

square in class AbstractArray<INDArray>

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

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

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>

isView

public boolean isView()

Description copied from interface: INDArray

Return true if this array is a view type

Specified by:

isView in interface INDArray

Returns:

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

applyOp

public void applyOp(IOp 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 AbstractArray<INDArray>

equals

public boolean equals(INDArray a)

Description copied from interface: INDArray

Returns true if the two arrays are exactly equal in value and shape

Specified by:

equals in interface INDArray

Overrides:

equals in class AbstractArray<INDArray>

Returns:

equals

public boolean equals(Array a)

exactClone

public Array exactClone()

Description copied from interface: INDArray

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

Specified by:

exactClone in interface INDArray

Returns:

setElements

public void setElements(double[] values,
               int offset,
               int length)

Description copied from interface: INDArray

Sets all elements in an array using the given double values

Specified by:

setElements in interface INDArray

Overrides:

setElements in class AbstractArray<INDArray>

getElements

public void getElements(double[] values,
               int offset)

Description copied from interface: INDArray

Gets all elements of the array, copying them into a double array

Specified by:

getElements in interface INDArray

Overrides:

getElements in class AbstractArray<INDArray>

elementIterator

public Iterator<Double> elementIterator()

Description copied from interface: INDArray

Returns an iterator over all elements in this array.

Specified by:

elementIterator in interface INDArray

Overrides:

elementIterator in class AbstractArray<INDArray>

Returns:

multiply

public void multiply(double factor)

Description copied from interface: INDArray

Multiplies all elements of the array by a given double value

Specified by:

multiply in interface INDArray

Overrides:

multiply in class AbstractArray<INDArray>

getSlices

public List<INDArray> getSlices()

Description copied from interface: INDArray

Returns a list of all major slices of this array.

Specified by:

getSlices in interface INDArray

Overrides:

getSlices in class AbstractArray<INDArray>

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>

asDoubleArray

public double[] asDoubleArray()

Description copied from interface: INDArray

Returns the underlying double array representing the packed elements of this array Returns nil if there is no such underlying array

Specified by:

asDoubleArray in interface INDArray

Overrides:

asDoubleArray in class AbstractArray<INDArray>

clone

public INDArray clone()

Description copied from interface: INDArray

Returns a clone of the array, as a new array which will be fully mutable and may be of a different class to the original. Clone should attempt to return the most efficient possible array type.

Specified by:

clone in interface INDArray

Overrides:

clone in class AbstractArray<INDArray>

Returns:

validate

public void validate()

Description copied from interface: INDArray

Validates the internal data structure of the INDArray. Throws an exception on failure. Failure indicates a serious bug and/or data corruption.

Specified by:

validate in interface INDArray

Overrides:

validate in class AbstractArray<INDArray>

createFromVector

public static Array createFromVector(AVector a,
                     int[] shape)

Creates a new matrix using the elements in the specified vector. Truncates or zero-pads the data as required to fill the new matrix

Parameters:

data -

rows -

columns -

Returns:

getArray

public double[] getArray()

Specified by:

getArray in interface IStridedArray

getArrayOffset

public int getArrayOffset()

Specified by:

getArrayOffset in interface IStridedArray

getStrides

public int[] getStrides()

Specified by:

getStrides in interface IStridedArray

isPackedArray

public boolean isPackedArray()

Specified by:

isPackedArray in interface IStridedArray

isZero

public boolean isZero()

Description copied from interface: INDArray

Returns true if the array is zero (all elements equal to zero)

Specified by:

isZero in interface INDArray

Overrides:

isZero in class AbstractArray<INDArray>

Returns:

immutable

public INDArray immutable()

Description copied from interface: INDArray

Returns an immutable version of this INDArray's data

Specified by:

immutable in interface INDArray

Overrides:

immutable in class AbstractArray<INDArray>