INDArray (Vectorz 0.28.0 API)

All Superinterfaces:

Cloneable, Serializable

All Known Subinterfaces:

IFastColumns, IFastRows, IMatrix, IScalar, IStridedArray, IVector

All Known Implementing Classes:

AArrayMatrix, AArrayVector, ABandedMatrix, ABitVector, ABlockMatrix, ABooleanMatrix, AbstractArray, AComputedVector, AConstrainedVector, ADenseArrayMatrix, ADiagonalMatrix, AMatrix, AMatrixViewVector, APrimitiveMatrix, APrimitiveVector, ARectangularMatrix, Array, ArrayIndexScalar, ArraySubVector, AScalar, ASingleBandMatrix, ASizedVector, ASparseVector, AStridedMatrix, AStridedVector, AVector, AVectorMatrix, AWrappedVector, AxisVector, BandedMatrix, BaseDerivedVector, BaseNDArray, BitVector, BlockDiagonalMatrix, BroadcastVectorMatrix, ColumnMatrix, DiagonalMatrix, DoubleScalar, GrowableVector, IdentityMatrix, ImmutableArray, ImmutableMatrix, ImmutableScalar, ImmutableVector, IndexedArrayVector, IndexedSubVector, IndexVector, JoinedArray, JoinedArrayVector, JoinedVector, Matrix, Matrix11, Matrix22, Matrix33, MatrixAsVector, MatrixBandView, MatrixBuilder, MatrixColumnView, MatrixIndexScalar, MatrixRowView, NDArray, PermutationMatrix, PermutedMatrix, QuadtreeMatrix, RangeVector, RepeatedElementVector, RowMatrix, Scalar, ScalarMatrix, SingleElementVector, SliceArray, SparseColumnMatrix, SparseHashedVector, SparseIndexedVector, SparseRowMatrix, StridedMatrix, StridedVector, SubsetMatrix, TransposedMatrix, UnmodifiableVector, Vector, Vector0, Vector1, Vector2, Vector3, Vector4, VectorBuilder, VectorIndexScalar, VectorMatrixM3, VectorMatrixMN, WrappedScalarVector, WrappedSubVector, ZeroMatrix, ZeroVector
```
public interface INDArray
extends Cloneable, Serializable
```
Interface for general multi-dimensional arrays of doubles

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`	`add(double a)` Adds a double value to all elements in this array
`void`	`add(INDArray a)` Adds all the elements of another array to this array, in an elementwise order.
`void`	`applyOp(IOperator 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
`List<Double>`	`asElementList()` Returns a list containing all elements of this array
`AVector`	`asVector()` Constructs a view of the array as a single vector in row-major order.
`INDArray`	`broadcast(int... shape)` Returns a view of this array broadcasted up to a larger shape
`INDArray`	`broadcastCloneLike(INDArray target)` Creates a clone of the array, broadcasted if necessary to match the shape of the target
`INDArray`	`broadcastLike(INDArray target)` Broadcasts to match the shape of the target
`void`	`clamp(double min, double max)` Clamps all the elments of this array within the specified [min,max] range
`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.
`void`	`copyTo(double[] arr)` Copies all the elements of this INDArray to the specified double array
`int`	`dimensionality()` Returns the dimensionality of the array (number of dimensions in the array shape) e.g.
`void`	`divide(double factor)` Divides all elements by a given factor
`void`	`divide(INDArray a)` Divides all elements by the equivalent elements in a second array
`long`	`elementCount()` Returns the total number of elements in this array.
`Iterator<Double>`	`elementIterator()` Returns an iterator over all elements in this array.
`double`	`elementMax()` Returns the maximum element value in this array.
`double`	`elementMin()` Returns the maximum element value 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.
`INDArray`	`ensureMutable()` Ensures the array is a fully mutable, efficient representation that is not a view.
`boolean`	`epsilonEquals(INDArray a)` Tests is this array is approximately equal to another array.
`boolean`	`epsilonEquals(INDArray a, double epsilon)` Tests is this array is approximately equal to another array, up to a given tolerance (epsilon) The arrays must have the same shape
`boolean`	`equals(INDArray a)` Returns true if the two arrays are exactly equal in value and shape
`INDArray`	`exactClone()` Returns an exact deep clone of an array (i.e.
`void`	`exp()` Computes the function e^x (in-place) for all array elements
`void`	`fill(double value)` Fills the array with asingle double value
`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
`void`	`getElements(double[] dest, int offset)` Gets all elements of the array, copying them into a double array
`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
`List<?>`	`getSlices()` Returns a list of all major slices of this array.
`List<?>`	`getSlices(int dimension)` Returns a list of all slices of this array along a given dimension
`List<INDArray>`	`getSliceViews()` Returns a list of slices as mutable INDArray views.
`INDArray`	`getTranspose()` Returns the transpose of this array.
`INDArray`	`getTransposeCopy()` Returns a transposed copy of the array.
`INDArray`	`getTransposeView()` Returns a transposed view of the array.
`INDArray`	`immutable()` Returns an immutable version of this INDArray's data
`INDArray`	`innerProduct(INDArray a)` Calculates the inner product of this array with another array.
`boolean`	`isBoolean()` Returns true if the array is boolean (contains only 0.0 or 1.0 values)
`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`	`isSameShape(INDArray a)` Returns true if this array is the same shape as another array
`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)
`INDArray`	`join(INDArray a, int dimension)` Joins an array with another array along a specified dimension
`void`	`log()` Computes the natural logarithm (in-place) for all array elements
`void`	`multiply(double d)` Multiplies all elements of the array by a given double value
`void`	`multiply(INDArray a)` Multiplies all elements by the equivalent elements in a second array
`INDArray`	`mutable()` Coerces this INDArray to a fully mutable format.
`void`	`negate()` Negates all elements in the array
`long`	`nonZeroCount()` Returns the number of non-zero elements in the array.
`INDArray`	`outerProduct(INDArray a)` Calculates the outer product of this array with another array.
`void`	`pow(double exponent)` Raises all elements of the array to a specified power
`void`	`reciprocal()` Replaces all elements in the array with their reciprocal
`INDArray`	`reshape(int... shape)` Returns a new array by rearranging the elements of this array into the desired shape Truncates or zero-pads the elements as required to fill the new shape
`INDArray`	`rotateView(int dimension, int shift)` Returns rotated view of this array
`void`	`scale(double d)` Scales all elements of the array by a given double value
`void`	`scaleAdd(double factor, double constant)` Scales all elements of the array by a given double value and adds a constant vale
`void`	`set(double value)` Sets all elements of an array to a specific double value
`void`	`set(INDArray a)` Sets this array to the element values contained in another array
`void`	`set(int[] indexes, double value)`
`void`	`set(int i, double value)`
`void`	`set(int i, int j, double value)`
`void`	`set(Object o)` Sets this array to the element values contained in the given object.
`void`	`setElements(double[] values)` Sets all elements in an array using the given double values
`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.
`INDArray`	`sparse()` Coerces this INDArray to a sparse format, without changing its element values.
`void`	`sqrt()` Computes the square root of all elements in the array
`void`	`square()` Squares all elements of the array
`void`	`sub(double a)` Subtracts a double value from all elements in this array
`void`	`sub(INDArray a)` Subtracts all the elements of another array from this array, in an elementwise order.
`INDArray`	`subArray(int[] offsets, int[] shape)` Returns a subarray view of a larger array
`Array`	`toArray()` Converts the array into a packed mutable Array instance
`double[]`	`toDoubleArray()` Copies the elements of this INDArray to a new double 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.

- Method Detail
  - dimensionality
```
int dimensionality()
```
    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.
    
    Returns:
  - getShape
```
int[] getShape()
```
    Returns the shape of the array as an array of ints.
    
    Returns:
  - getShapeClone
```
int[] getShapeClone()
```
    Returns the shape of the array as an array of ints, guaranteed to be a new array
    
    Returns:
  - getShape
```
int getShape(int dim)
```
    Returns the dimension size for a specific dimension in the array's shape
    
    Parameters:
    dim -
    
    Returns:
  - getLongShape
```
long[] getLongShape()
```
    Returns the shape of the array as an array of longs.
    
    Returns:
  - get
```
double get()
```
    Returns the double value of a scalar array
    
    Returns:
  - get
```
double get(int x)
```
    Returns the double value at the specified position in a 1D vector
    
    Returns:
  - get
```
double get(int x,
         int y)
```
    Returns the double value at the specified position in a 2D matrix
    
    Returns:
  - get
```
double get(int... indexes)
```
    Returns the double value at the specified index position in an array
    
    Returns:
  - set
```
void set(double value)
```
    Sets all elements of an array to a specific double value
    
    Parameters:
    value -
  - set
```
void set(int i,
       double value)
```
  - set
```
void set(int i,
       int j,
       double value)
```
  - set
```
void set(int[] indexes,
       double value)
```
  - set
```
void set(INDArray a)
```
    Sets this array to the element values contained in another array
    
    Parameters:
    a -
  - set
```
void set(Object o)
```
    Sets this array to the element values contained in the given object. Attempts to interpret the object as an array
    
    Parameters:
    a -
  - add
```
void add(double a)
```
    Adds a double value to all elements in this array
  - sub
```
void sub(double a)
```
    Subtracts a double value from all elements in this array
  - add
```
void add(INDArray a)
```
    Adds all the elements of another array to this array, in an elementwise order.
    
    Parameters:
    a -
  - sub
```
void sub(INDArray a)
```
    Subtracts all the elements of another array from this array, in an elementwise order.
    
    Parameters:
    a -
  - fill
```
void fill(double value)
```
    Fills the array with asingle double value
    
    Parameters:
    value -
  - negate
```
void negate()
```
    Negates all elements in the array
  - reciprocal
```
void reciprocal()
```
    Replaces all elements in the array with their reciprocal
  - clamp
```
void clamp(double min,
         double max)
```
    Clamps all the elments of this array within the specified [min,max] range
    
    Parameters:
    min -
    max -
  - innerProduct
```
INDArray innerProduct(INDArray a)
```
    Calculates the inner product of this array with another array.
    
    Parameters:
    a -
    
    Returns:
  - outerProduct
```
INDArray outerProduct(INDArray a)
```
    Calculates the outer product of this array with another array.
    
    Parameters:
    a -
    
    Returns:
  - asVector
```
AVector asVector()
```
    Constructs a view of the array as a single vector in row-major order.
    
    Returns:
  - asElementList
```
List<Double> asElementList()
```
    Returns a list containing all elements of this array
    
    Returns:
  - reshape
```
INDArray reshape(int... shape)
```
    Returns a new array by rearranging the elements of this array into the desired shape Truncates or zero-pads the elements as required to fill the new shape
    
    Parameters:
    shape -
    
    Returns:
  - rotateView
```
INDArray rotateView(int dimension,
                  int shift)
```
    Returns rotated view of this array
    
    Returns:
  - broadcast
```
INDArray broadcast(int... shape)
```
    Returns a view of this array broadcasted up to a larger shape
    
    Parameters:
    shape -
    
    Returns:
  - broadcastLike
```
INDArray broadcastLike(INDArray target)
```
    Broadcasts to match the shape of the target
    
    Parameters:
    target -
    
    Returns:
  - broadcastCloneLike
```
INDArray broadcastCloneLike(INDArray target)
```
    Creates a clone of the array, broadcasted if necessary to match the shape of the target
    
    Parameters:
    target -
    
    Returns:
  - slice
```
INDArray slice(int majorSlice)
```
    Returns the specified major slice of this array as a view (slice along dimension 0)
    
    Parameters:
    majorSlice -
    
    Returns:
  - join
```
INDArray join(INDArray a,
            int dimension)
```
    Joins an array with another array along a specified dimension
    
    Parameters:
    majorSlice -
    
    Returns:
  - slice
```
INDArray slice(int dimension,
             int index)
```
    Returns a slice view of this array along the specified dimension
    
    Parameters:
    majorSlice -
    
    Returns:
  - subArray
```
INDArray subArray(int[] offsets,
                int[] shape)
```
    Returns a subarray view of a larger array
    
    Parameters:
    majorSlice -
    
    Returns:
  - getTranspose
```
INDArray getTranspose()
```
    Returns the transpose of this array. A transpose of an array is equivalent to reversing the order of dimensions
    
    Returns:
  - getTransposeView
```
INDArray getTransposeView()
```
    Returns a transposed view of the array. May throw UnsupportedOperationException if the array does not support this capability
    
    Returns:
  - getTransposeCopy
```
INDArray getTransposeCopy()
```
    Returns a transposed copy of the array.
    
    Returns:
  - sliceCount
```
int sliceCount()
```
    returns the number of major slices in this array.
    
    Returns:
  - elementCount
```
long elementCount()
```
    Returns the total number of elements in this array. Equivalent to the product all dimension sizes.
    
    Returns:
  - elementSum
```
double elementSum()
```
    Returns the total sum of elements in this array.
    
    Returns:
  - elementMax
```
double elementMax()
```
    Returns the maximum element value in this array.
    
    Returns:
  - elementMin
```
double elementMin()
```
    Returns the maximum element value in this array.
    
    Returns:
  - elementSquaredSum
```
double elementSquaredSum()
```
    Returns the total sum of elements in this array.
    
    Returns:
  - elementIterator
```
Iterator<Double> elementIterator()
```
    Returns an iterator over all elements in this array.
    
    Returns:
  - multiply
```
void multiply(INDArray a)
```
    Multiplies all elements by the equivalent elements in a second array
  - divide
```
void divide(INDArray a)
```
    Divides all elements by the equivalent elements in a second array
  - divide
```
void divide(double factor)
```
    Divides all elements by a given factor
  - nonZeroCount
```
long nonZeroCount()
```
    Returns the number of non-zero elements in the array.
    
    Returns:
  - isMutable
```
boolean isMutable()
```
    Returns true if the INDArray is mutable (at least partially)
    
    Returns:
  - isBoolean
```
boolean isBoolean()
```
    Returns true if the array is boolean (contains only 0.0 or 1.0 values)
  - isFullyMutable
```
boolean isFullyMutable()
```
    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
    
    Returns:
  - isElementConstrained
```
boolean isElementConstrained()
```
    Returns true if this array has some constraints on element values
  - isSameShape
```
boolean isSameShape(INDArray a)
```
    Returns true if this array is the same shape as another array
  - isView
```
boolean isView()
```
    Return true if this array is a view type
    
    Returns:
  - isZero
```
boolean isZero()
```
    Returns true if the array is zero (all elements equal to zero)
    
    Returns:
  - clone
```
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. Clone should attempt to return the most efficient possible array type.
    
    Returns:
  - ensureMutable
```
INDArray ensureMutable()
```
    Ensures the array is a fully mutable, efficient representation that is not a view. Returns either the same array or a new clone.
  - applyOp
```
void applyOp(Op op)
```
    Applies a unary operator to all elements of the array (in-place)
    
    Parameters:
    op -
  - applyOp
```
void applyOp(IOperator op)
```
    Applies a unary operator to all elements of the array (in-place)
    
    Parameters:
    op -
  - equals
```
boolean equals(INDArray a)
```
    Returns true if the two arrays are exactly equal in value and shape
    
    Parameters:
    a -
    
    Returns:
  - exactClone
```
INDArray exactClone()
```
    Returns an exact deep clone of an array (i.e. of the same class as the original).
    
    Returns:
  - setElements
```
void setElements(double[] values)
```
    Sets all elements in an array using the given double values
  - setElements
```
void setElements(double[] values,
               int offset,
               int length)
```
    Sets all elements in an array using the given double values
  - getElements
```
void getElements(double[] dest,
               int offset)
```
    Gets all elements of the array, copying them into a double array
    
    Parameters:
    d -
  - scale
```
void scale(double d)
```
    Scales all elements of the array by a given double value
    
    Parameters:
    d -
  - scaleAdd
```
void scaleAdd(double factor,
            double constant)
```
    Scales all elements of the array by a given double value and adds a constant vale
    
    Parameters:
    d -
  - multiply
```
void multiply(double d)
```
    Multiplies all elements of the array by a given double value
    
    Parameters:
    d -
  - pow
```
void pow(double exponent)
```
    Raises all elements of the array to a specified power
    
    Parameters:
    exponent -
  - square
```
void square()
```
    Squares all elements of the array
  - sqrt
```
void sqrt()
```
    Computes the square root of all elements in the array
  - signum
```
void signum()
```
    Calculates the signum of all elements of the array
  - getSlices
```
List<?> getSlices()
```
    Returns a list of all major slices of this array.
    
    Returns:
  - getSlices
```
List<?> getSlices(int dimension)
```
    Returns a list of all slices of this array along a given dimension
    
    Returns:
  - validate
```
void validate()
```
    Validates the internal data structure of the INDArray. Throws an exception on failure. Failure indicates a serious bug and/or data corruption.
  - copyTo
```
void copyTo(double[] arr)
```
    Copies all the elements of this INDArray to the specified double array
    
    Parameters:
    arr -
  - toDoubleBuffer
```
void toDoubleBuffer(DoubleBuffer dest)
```
    Copies the elements of this INDArray to the specified double buffer
    
    Parameters:
    arr -
  - toDoubleArray
```
double[] toDoubleArray()
```
    Copies the elements of this INDArray to a new double array
    
    Parameters:
    arr -
  - asDoubleArray
```
double[] asDoubleArray()
```
    Returns the underlying double array representing the packed elements of this array Returns nil if there is no such underlying array
    
    Parameters:
    arr -
  - getSliceViews
```
List<INDArray> getSliceViews()
```
    Returns a list of slices as mutable INDArray views. Note: will return a list of AScalar values when this array is a 1D vector
    
    Returns:
  - toVector
```
Vector toVector()
```
    Converts the array into a flattened vector
    
    Returns:
  - toArray
```
Array toArray()
```
    Converts the array into a packed mutable Array instance
    
    Returns:
  - epsilonEquals
```
boolean epsilonEquals(INDArray a)
```
    Tests is this array is approximately equal to another array. The arrays must have the same shape
    
    Parameters:
    a -
    
    Returns:
  - epsilonEquals
```
boolean epsilonEquals(INDArray a,
                    double epsilon)
```
    Tests is this array is approximately equal to another array, up to a given tolerance (epsilon) The arrays must have the same shape
    
    Parameters:
    a -
    
    Returns:
  - abs
```
void abs()
```
    Replaces all elements of this array with their absolute values, according to Math.abs(double)
  - log
```
void log()
```
    Computes the natural logarithm (in-place) for all array elements
  - exp
```
void exp()
```
    Computes the function e^x (in-place) for all array elements
  - immutable
```
INDArray immutable()
```
    Returns an immutable version of this INDArray's data
  - mutable
```
INDArray mutable()
```
    Coerces this INDArray to a fully mutable format. May return the same INDArray if already mutable
  - sparse
```
INDArray sparse()
```
    Coerces this INDArray to a sparse format, without changing its element values. May return the same INDArray if already sparse. May also mutate the internal structure of the original NDArray, or create a view over parts of the original INDArray. You should take a defensive copy of the original NDArray if any of this concerns you. The returned sparse array may not be fully mutable in all elements.

Interface INDArray

Method Summary

Method Detail

dimensionality

getShape

getShapeClone

getShape

getLongShape

get

get

get

get

set

set

set

set

set

set

add

sub

add

sub

fill

negate

reciprocal

clamp

innerProduct

outerProduct

asVector

asElementList

reshape

rotateView

broadcast

broadcastLike

broadcastCloneLike

slice

join

slice

subArray

getTranspose

getTransposeView

getTransposeCopy

sliceCount

elementCount

elementSum

elementMax

elementMin

elementSquaredSum

elementIterator

multiply

divide

divide

nonZeroCount

isMutable

isBoolean

isFullyMutable

isElementConstrained

isSameShape

isView

isZero

clone

ensureMutable

applyOp

applyOp

equals

exactClone

setElements

setElements

getElements

scale

scaleAdd

multiply

pow

square

sqrt

signum

getSlices

getSlices

validate

copyTo