INDArray (vectorz 0.15.2 API)

All Superinterfaces:

Cloneable

All Known Subinterfaces:

IMatrix, IScalar, IVector

All Known Implementing Classes:

AbstractArray, ADerivedVector, ADiagonalMatrix, AMatrix, APrimitiveVector, ArrayIndexScalar, ArraySubVector, ArrayVector, AScalar, ASparseVector, AVector, AVectorMatrix, AxisVector, BitVector, ColumnMatrix, ComputedVector, DiagonalMatrix, DoubleScalar, GrowableVector, IdentityMatrix, IndexedArrayVector, IndexedSubVector, JoinedArrayVector, JoinedVector, Matrix, Matrix22, Matrix33, MatrixSubVector, NDArray, PermutedMatrix, RepeatedElementVector, RowMatrix, ScalarMatrix, SingleElementVector, SliceArray, SparseIndexedVector, StridedArrayVector, SubsetMatrix, TransposedMatrix, UnmodifiableVector, Vector, Vector0, Vector1, Vector2, Vector3, Vector4, VectorIndexScalar, VectorMatrixM3, VectorMatrixMN, WrappedScalarVector, WrappedSubVector, ZeroMatrix, ZeroVector
```
public interface INDArray
extends Cloneable
```
Interface for general multi-dimensional arrays of doubles

Author:

Mike

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`add(double a)`
`void`	`add(INDArray a)`
`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)
`AVector`	`asVector()` Creates a view of the array as a single vector in row-major order.
`INDArray`	`broadcast(int... dimensions)`
`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.
`long`	`elementCount()` Returns the total number of 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(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.
`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
`List<?>`	`getSlices()` Returns a list of all major slices of this array.
`List<INDArray>`	`getSliceViews()` Returns a list of slices as mutable INDArray views.
`INDArray`	`innerProduct(INDArray a)` Calculates the inner product of this array with another array.
`boolean`	`isElementConstrained()` Returns true if the IND has additional constraints on element values
`boolean`	`isFullyMutable()` Returns true if the INDArray is 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 is a view
`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
`void`	`negate()`
`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.
`INDArray`	`reshape(int... dimensions)`
`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)`
`void`	`set(int[] indexes, double value)`
`void`	`set(int i, double value)`
`void`	`set(int i, int j, double value)`
`void`	`set(Object o)`
`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
`INDArray`	`slice(int majorSlice)`
`INDArray`	`slice(int dimension, int index)`
`int`	`sliceCount()`
`void`	`sub(double a)`
`void`	`sub(INDArray a)`
`void`	`toDoubleBuffer(DoubleBuffer dest)` Copies the elements of this INDArray to the specified double buffer
`AVector`	`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:
  - 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)
```
  - set
```
void set(Object o)
```
  - add
```
void add(double a)
```
  - sub
```
void sub(double a)
```
  - add
```
void add(INDArray a)
```
  - sub
```
void sub(INDArray a)
```
  - negate
```
void negate()
```
  - 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()
```
    Creates a view of the array as a single vector in row-major order.
    
    Returns:
  - reshape
```
INDArray reshape(int... dimensions)
```
  - broadcast
```
INDArray broadcast(int... dimensions)
```
  - slice
```
INDArray slice(int majorSlice)
```
  - slice
```
INDArray slice(int dimension,
             int index)
```
  - sliceCount
```
int sliceCount()
```
  - 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:
  - elementSquaredSum
```
double elementSquaredSum()
```
    Returns the total sum of elements in this array.
    
    Returns:
  - multiply
```
void multiply(INDArray a)
```
    Multiplies all elements by the equivalent elements in a second array
  - 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:
  - isFullyMutable
```
boolean isFullyMutable()
```
    Returns true if the INDArray is fully mutable in all positions i.e. every position can store any valid double value
    
    Returns:
  - isElementConstrained
```
boolean isElementConstrained()
```
    Returns true if the IND has additional constraints on element values
  - isView
```
boolean isView()
```
    Return true if this is a view
    
    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.
    
    Returns:
  - applyOp
```
void applyOp(Op op)
```
    Applies a unary operator to all elements of the array (in-place)
    
    Parameters:
    op -
  - applyOp
```
void applyOp(IOp 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 -
  - getSlices
```
List<?> getSlices()
```
    Returns a list of all major slices of this array.
    
    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 -
  - 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
```
AVector toVector()
```
    Converts the array into a flattened vector
    
    Returns:

Interface INDArray

Method Summary

Method Detail

dimensionality

getShape

getShape

getLongShape

get

get

get

get

set

set

set

set

set

set

add

sub

add

sub

negate

innerProduct

outerProduct

asVector

reshape

broadcast

slice

slice

sliceCount

elementCount

elementSum

elementSquaredSum

multiply

nonZeroCount

isMutable

isFullyMutable

isElementConstrained

isView

clone

applyOp

applyOp

equals

exactClone

setElements

setElements

getElements

scale

scaleAdd

multiply

getSlices

validate

copyTo

toDoubleBuffer

getSliceViews

toVector