BaseSparseNDArray (nd4j-api 1.0.0-beta API)

java.lang.Object
- org.nd4j.linalg.api.ndarray.BaseSparseNDArray

All Implemented Interfaces:

Serializable, INDArray, ISparseNDArray

Direct Known Subclasses:

BaseSparseNDArrayCOO, BaseSparseNDArrayCSR
```
public abstract class BaseSparseNDArray
extends Object
implements ISparseNDArray
```
Author:

Audrey Loeffel

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`columns`
`protected Boolean`	`isMatrix`
`protected Boolean`	`isScalar`
`static boolean`	`isSparse`
`protected Boolean`	`isVector`
`protected int[]`	`javaShapeInformation`
`protected long`	`length`
`protected int`	`rank`
`protected int`	`rows`
`protected DataBuffer`	`shape`
`protected DataBuffer`	`shapeInformation`
`protected DataBuffer`	`sparseInformation`
`protected DataBuffer`	`stride`
`protected static double`	`THRESHOLD_MEMORY_ALLOCATION`

Constructor Summary

Constructors
Constructor and Description

BaseSparseNDArray()

Constructors
Constructor and Description
`BaseSparseNDArray()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IComplexNDArray`	`add(IComplexNumber n)`
`IComplexNDArray`	`add(IComplexNumber n, IComplexNDArray result)`
`INDArray`	`add(INDArray other)` Element-wise copy addition of two NDArrays
`INDArray`	`add(INDArray other, INDArray result)` Element-wise copy addition of two NDArrays
`INDArray`	`add(Number n)` Scalar addition (cloning)
`INDArray`	`add(Number n, INDArray result)`
`INDArray`	`addColumnVector(INDArray columnVector)` Addition of a column vector (copy)
`IComplexNDArray`	`addi(IComplexNumber n)`
`IComplexNDArray`	`addi(IComplexNumber n, IComplexNDArray result)`
`INDArray`	`addi(INDArray other)` in place (element wise) addition of two NDArrays
`INDArray`	`addi(INDArray other, INDArray result)` in place (element wise) addition of two NDArrays
`INDArray`	`addi(Number n)` In place scalar addition
`INDArray`	`addi(Number n, INDArray result)` In place addition
`INDArray`	`addiColumnVector(INDArray columnVector)` In place addition of a column vector
`INDArray`	`addiRowVector(INDArray rowVector)` In place addition of a row vector
`INDArray`	`addRowVector(INDArray rowVector)` Addition of a row vector (copy)
`INDArray`	`amax(int... dimension)` Returns the absolute overall max of this ndarray along given dimensions
`Number`	`amaxNumber()` Returns maximum (absolute) value in this INDArray
`INDArray`	`amean(int... dimension)` Returns the absolute overall mean of this ndarray
`Number`	`ameanNumber()` Returns the absolute overall mean of this ndarray
`INDArray`	`amin(int... dimension)` Returns minimum (absolute) value in this INDArray, along the specified dimensions
`Number`	`aminNumber()` Returns absolute min value in this INDArray
`INDArray`	`argMax(int... dimension)` This method returns index of highest value along specified dimension(s)
`INDArray`	`assign(INDArray arr)` Assign all of the elements in the given ndarray to this ndarray
`INDArray`	`assign(Number value)` Set all entries of the ndarray to the specified value
`INDArray`	`assignIf(INDArray arr, Condition condition)` Assign all elements from given ndarray that are matching given condition, ndarray to this ndarray
`INDArray`	`broadcast(INDArray result)` Broadcasts this ndarray to be the specified shape
`INDArray`	`broadcast(int... shape)` Broadcasts this ndarray to be the specified shape
`void`	`checkDimensions(INDArray other)` Validate dimensions are equal
`void`	`cleanup()` Cleanup resources
`protected Object`	`clone()`
`int`	`columns()` Returns the number of columns in this matrix (throws exception if not 2d)
`INDArray`	`cond(Condition condition)` 1 in the ndarray if the element matches the condition 0 otherwise
`INDArray`	`condi(Condition condition)` In-place: 1 in the ndarray if the element matches the condition 0 otherwise
`INDArray`	`cumsum(int dimension)` Returns the cumulative sum along a dimension.
`INDArray`	`cumsumi(int dimension)` Returns the cumulative sum along a dimension.
`INDArray`	`detach()` This method detaches INDArray from Workspace, returning copy.
`INDArray`	`dimShuffle(Object[] rearrange, int[] newOrder, boolean[] broadCastable)` Dimshuffle: an extension of permute that adds the ability to broadcast various dimensions.
`double`	`distance1(INDArray other)` Returns the (1-norm) distance.
`double`	`distance2(INDArray other)` Returns the (euclidean) distance.
`IComplexNDArray`	`div(IComplexNumber n)`
`IComplexNDArray`	`div(IComplexNumber n, IComplexNDArray result)`
`INDArray`	`div(INDArray other)` Copy (element wise) division of two NDArrays
`INDArray`	`div(INDArray other, INDArray result)` copy (element wise) division of two NDArrays
`INDArray`	`div(Number n)` Division by a number
`INDArray`	`div(Number n, INDArray result)`
`INDArray`	`divColumnVector(INDArray columnVector)` Division of a column vector (copy)
`IComplexNDArray`	`divi(IComplexNumber n)`
`IComplexNDArray`	`divi(IComplexNumber n, IComplexNDArray result)`
`INDArray`	`divi(INDArray other)` in place (element wise) division of two NDArrays
`INDArray`	`divi(INDArray other, INDArray result)` in place (element wise) division of two NDArrays
`INDArray`	`divi(Number n)` In place scalar division
`INDArray`	`divi(Number n, INDArray result)` In place division of this ndarray
`INDArray`	`diviColumnVector(INDArray columnVector)` In place division of a column vector
`INDArray`	`diviRowVector(INDArray rowVector)` In place division of a row vector
`INDArray`	`divRowVector(INDArray rowVector)` Division of a row vector (copy)
`INDArray`	`dup()` Returns a copy of this ndarray
`INDArray`	`dup(char order)` Returns a copy of this ndarray, where the returned ndarray has the specified order
`Object`	`element()` Returns a scalar (individual element) of a scalar ndarray
`int`	`elementStride()` Element stride (one element to the next, also called the defualt stride: 1 for normal 2 for complex)
`int`	`elementWiseStride()` Element wise stride
`INDArray`	`entropy(int... dimension)` Returns entropy along dimension
`Number`	`entropyNumber()` Returns entropy value for this INDArray
`INDArray`	`eps(INDArray other)` Returns the binary ndarray for "Epsilon equals" comparison.
`INDArray`	`eps(Number other)` Returns the binary ndarray for "Epsilon equals" comparison.
`INDArray`	`epsi(INDArray other)` Returns the binary ndarray for "Epsilon equals" comparison.
`INDArray`	`epsi(Number other)` Returns the binary ndarray for "Epsilon equals" comparison.
`INDArray`	`eq(INDArray other)` Returns the binary ndarray for "Equals" comparison.
`INDArray`	`eq(Number other)` Returns the binary ndarray for "Equals" comparison.
`INDArray`	`eqi(INDArray other)` Returns the binary ndarray for "Equals" comparison.
`INDArray`	`eqi(Number other)` Returns the binary ndarray for "Equals" comparison.
`boolean`	`equals(Object o)`
`boolean`	`equalsWithEps(Object o, double eps)` This method checks 2 INDArrays equality with given eps
`int[]`	`flags()`
`INDArray`	`fmod(INDArray denominator)` remainder of division
`INDArray`	`fmod(INDArray denominator, INDArray result)` remainder of division
`INDArray`	`fmod(Number denominator)`
`INDArray`	`fmod(Number denominator, INDArray result)`
`INDArray`	`fmodi(INDArray denominator)` In place fmod
`INDArray`	`fmodi(Number denominator)` In place fmod
`INDArray`	`get(INDArray indices)` Get the elements from this ndarray based on the specified indices
`INDArray`	`get(INDArrayIndex... indexes)` Returns a subset of this array based on the specified indexes
`INDArray`	`get(List<List<Integer>> indices)` Get the elements from this ndarray based on the specified indices
`INDArray`	`getColumn(int i)` Returns the specified column.
`INDArray`	`getColumns(int... columns)` Get an INDArray comprised of the specified columns only.
`double`	`getDouble(int... indices)` Get a double value at the specified indices.
`double`	`getDouble(int i)` Get the double value at the specified linear index in the array
`double`	`getDouble(int i, int j)` Get the double value at the specified indices.
`double`	`getDoubleUnsafe(long offset)` Get a scalar at the given linear offset
`float`	`getFloat(int i)` Return the item at the linear index i
`float`	`getFloat(int[] indices)` Returns the elements at the the specified indices
`float`	`getFloat(int i, int j)` Return the item at row i column j Note that this is the same as calling getScalar(new int[]{i,j}
`int`	`getInt(int... indices)` Get an integer value at the specified indices.
`int`	`getLeadingOnes()` Get the number of leading ones in the array shape.
`protected double`	`getPercentile(Number quantile, INDArray sorted)`
`INDArray`	`getRow(int i)` Returns the specified row.
`INDArray`	`getRows(int... rows)` Get an INDArray comprised of the specified rows only.
`INDArray`	`getScalar(int... indices)` Returns the elements at the the specified indices
`INDArray`	`getScalar(int i)` Returns the element at the specified index
`INDArray`	`getScalar(int row, int column)` Returns the element at the specified row/column This will throw an exception if the
`int`	`getTrailingOnes()` Get the number of trailing ones in the array shape.
`INDArray`	`getWhere(INDArray comp, Condition condition)` Boolean indexing: Return the element if it fulfills the condition in result array
`INDArray`	`getWhere(Number comp, Condition condition)` Boolean indexing: Return the element if it fulfills the condition in result array
`INDArray`	`gt(INDArray other)` Returns the binary ndarray for "Greter" comparison.
`INDArray`	`gt(Number other)` Returns the binary ndarray for "Greater" comparison.
`INDArray`	`gte(Number other)` Returns binary ndarray for "Greter or equals" comparison.
`INDArray`	`gtei(Number other)` Returns the binary ndarray for "Greter or equals" comparison.
`INDArray`	`gti(INDArray other)` Returns the binary ndarray for "Greter" comparison.
`INDArray`	`gti(Number other)` Returns the binary ndarray for "Greter" comparison.
`int[]`	`hiddenDimensions()`
`int`	`index(int row, int column)` Return the linear index of the specified row and column
`protected void`	`init(int[] shape)`
`int`	`innerMostStride()` Get the inner most stride wrt the ordering of the array
`boolean`	`isAttached()` This method returns True, if this INDArray instance is attached to some Workspace.
`boolean`	`isCleanedUp()` Returns true if the ndarray has already been freed
`boolean`	`isColumnVector()` Checks whether the matrix is a column vector.
`boolean`	`isColumnVectorOrScalar()` Returns true if the number of columns is 1
`boolean`	`isCompressed()` Returns true if this array is compressed, and false otherwise
`boolean`	`isInScope()` This method checks, if given attached INDArray is still in scope of its parent Workspace PLEASE NOTE: if this INDArray isn't attached to any Workspace, this method will return true
`boolean`	`isMatrix()` Returns true if this ndarray is a matrix
`boolean`	`isRowVector()` Checks whether the matrix is a row vector.
`boolean`	`isRowVectorOrScalar()` Returns true if the number of rows is 1
`boolean`	`isScalar()` Returns true if this ndarray is a scalar
`boolean`	`isSparse()` Returns true if this array is sparse
`boolean`	`isSquare()` Returns whether the matrix has the same rows and columns
`boolean`	`isVector()` Checks whether the matrix is a vector.
`boolean`	`isVectorOrScalar()` Returns true if this ndarray is a vector or scalar
`boolean`	`isWrapAround()` Returns true if the ndarray on linear indexing wraps around based on the stride(1) of the ndarray This is a useful optimization in linear view where strides that might otherwise go out of bounds but wrap around instead.
`INDArray`	`javaTensorAlongDimension(int index, int... dimension)` Get the vector along a particular dimension
`int`	`length()` Returns the total number of elements in the ndarray
`long`	`lengthLong()` Returns the total number of elements in the ndarray
`INDArray`	`leverage()` This method detaches INDArray from current Workspace, and attaches it to Workspace above, if any.
`INDArray`	`leverageOrDetach(String id)` This method detaches INDArray from current Workspace, and attaches it to Workspace with a given Id, if a workspace with the given ID is open and active.
`INDArray`	`leverageTo(String id)` This method detaches INDArray from current Workspace, and attaches it to Workspace with a given Id - if a workspace with that ID exists.
`INDArray`	`leverageTo(String id, boolean enforceExistence)` This method detaches INDArray from current Workspace, and attaches it to Workspace with a given Id.
`int`	`linearIndex(int i)` Get the linear index of the data in to the array
`INDArray`	`linearView()` Returns a linear view reference of shape 1,length(ndarray)
`INDArray`	`linearViewColumnOrder()` Returns a linear view reference of shape 1,length(ndarray)
`INDArray`	`logEntropy(int... dimension)` Returns log entropy along dimension
`Number`	`logEntropyNumber()` Returns log entropy value for this INDArray
`INDArray`	`lt(INDArray other)` Returns the binary ndarray for "Less" comparison.
`INDArray`	`lt(Number other)` Returns the binary ndarray for "Less" comparison.
`INDArray`	`lte(Number other)` Returns the binary ndarray for "Less or equals" comparison.
`INDArray`	`ltei(Number other)` Returns the binary ndarray for "Less or equals" comparison.
`INDArray`	`lti(INDArray other)` Returns the binary ndarray for "Less" comparison.
`INDArray`	`lti(Number other)` Returns the binary ndarray for "Less" comparison.
`int`	`majorStride()` Return the major stride for an ndarray
`void`	`markAsCompressed(boolean reallyCompressed)` This method marks INDArray instance as compressed PLEASE NOTE: Do not use this method unless you 100% have to
`INDArray`	`match(INDArray comp, Condition condition)` Return a mask on whether each element matches the given condition
`INDArray`	`match(Number comp, Condition condition)` Returns a mask
`INDArray`	`max(int... dimension)` Returns the overall max of this ndarray along given dimensions
`IComplexNumber`	`maxComplex()`
`Number`	`maxNumber()` Returns maximum value in this INDArray
`INDArray`	`mean(INDArray result, int... dimension)` Returns the overall mean of this ndarray
`INDArray`	`mean(int... dimension)` Returns the overall mean of this ndarray
`IComplexNumber`	`meanComplex()`
`Number`	`meanNumber()` Returns the overall mean of this ndarray
`INDArray`	`median(int... dimension)` This method returns median along given dimension(s)
`Number`	`medianNumber()` This method returns median value for this INDArray
`INDArray`	`migrate()` This method pulls this INDArray into current Workspace.
`INDArray`	`migrate(boolean detachIfNoWs)` This method pulls this INDArray into current Workspace, or optionally detaches if no workspace is present. That is: If current workspace is present/active, INDArray is migrated to it. If no current workspace is present/active, one of two things occur: 1.
`INDArray`	`min(int... dimension)` Returns the overall min of this ndarray
`IComplexNumber`	`minComplex()`
`Number`	`minNumber()` Returns min value in this INDArray
`INDArray`	`mmul(INDArray other)` Perform a copy matrix multiplication
`INDArray`	`mmul(INDArray other, INDArray result)` Perform an copy matrix multiplication
`INDArray`	`mmuli(INDArray other)` Perform an inplace matrix multiplication
`INDArray`	`mmuli(INDArray other, INDArray result)` Perform an inplace matrix multiplication
`IComplexNDArray`	`mul(IComplexNumber n)`
`IComplexNDArray`	`mul(IComplexNumber n, IComplexNDArray result)`
`INDArray`	`mul(INDArray other)` copy (element wise) multiplication of two NDArrays
`INDArray`	`mul(INDArray other, INDArray result)` copy (element wise) multiplication of two NDArrays
`INDArray`	`mul(Number n)` Scalar multiplication (copy)
`INDArray`	`mul(Number n, INDArray result)`
`INDArray`	`mulColumnVector(INDArray columnVector)` Multiplication of a column vector (copy)
`IComplexNDArray`	`muli(IComplexNumber n)`
`IComplexNDArray`	`muli(IComplexNumber n, IComplexNDArray result)`
`INDArray`	`muli(INDArray other)` in place (element wise) multiplication of two NDArrays
`INDArray`	`muli(INDArray other, INDArray result)` in place (element wise) multiplication of two NDArrays
`INDArray`	`muli(Number n)` In place scalar multiplication
`INDArray`	`muli(Number n, INDArray result)` In place multiplication of this ndarray
`INDArray`	`muliColumnVector(INDArray columnVector)` In place multiplication of a column vector
`INDArray`	`muliRowVector(INDArray rowVector)` In place multiplication of a row vector
`INDArray`	`mulRowVector(INDArray rowVector)` Multiplication of a row vector (copy)
`INDArray`	`neg()` Returns the ndarray negative (cloned)
`INDArray`	`negi()` In place setting of the negative version of this ndarray
`INDArray`	`neq(INDArray other)` Returns the binary ndarray for "Not equals" comparison.
`INDArray`	`neq(Number other)` Returns the binary ndarray for "Not equals" comparison.
`INDArray`	`neqi(INDArray other)` Returns the binary ndarray for "Not equals" comparison.
`INDArray`	`neqi(Number other)` Returns the binary ndarray for "Not equals" comparison.
`int`	`nnz()` Return the number of non-null element
`INDArray`	`norm1(int... dimension)` Returns the norm1 (L1 norm, i.e., sum of absolute values; also known as Taxicab or Manhattan norm) along the specified dimension
`IComplexNumber`	`norm1Complex()` Calculate and return norm1 (L1 norm, i.e., sum of absolute values; also known as Taxicab or Manhattan norm) for the entire array
`Number`	`norm1Number()` Calculate and return norm1 (L1 norm, i.e., sum of absolute values; also known as Taxicab or Manhattan norm) for the entire array
`INDArray`	`norm2(int... dimension)` Returns the norm2 (L2 norm, sqrt(sum(x_i^2), also known as Euclidean norm) along the specified dimension(s)
`IComplexNumber`	`norm2Complex()`
`Number`	`norm2Number()` Return the norm2 (L2 norm, sqrt(sum(x_i^2), also known as Euclidean norm) for the entire array
`INDArray`	`normmax(int... dimension)` Returns the max norm (aka infinity norm, equal to the maximum absolute value) along the specified dimension(s)
`IComplexNumber`	`normmaxComplex()`
`Number`	`normmaxNumber()` Return the max norm (aka infinity norm, equal to the maximum absolute value) for the entire array
`long`	`offset()` Returns the start of where the ndarray is for the underlying data
`char`	`ordering()` Return the ordering (fortran or c 'f' and 'c' respectively) of this ndarray
`long`	`originalOffset()` Returns the start of where the ndarray is for the original data buffer
`INDArray`	`percentile(Number quantile, int... dimension)` This method returns median along given dimension(s)
`Number`	`percentileNumber(Number quantile)` This method returns percentile value for this INDArray
`INDArray`	`permute(int... rearrange)` See: http://www.mathworks.com/help/matlab/ref/permute.html
`INDArray`	`permutei(int... rearrange)` An in-place version of permute.
`INDArray`	`prod(int... dimension)` Returns the product along a given dimension
`IComplexNumber`	`prodComplex()`
`Number`	`prodNumber()` Calculate the product of all values in the array
`INDArray`	`put(INDArray indices, INDArray element)` Put element in to the indices denoted by the indices ndarray.
`INDArray`	`put(INDArrayIndex[] indices, INDArray element)` Put the elements of the ndarray in to the specified indices
`INDArray`	`put(INDArrayIndex[] indices, Number element)` Put the elements of the ndarray in to the specified indices
`INDArray`	`put(int[] indices, INDArray element)` Inserts the element at the specified index
`INDArray`	`put(int i, INDArray element)` Inserts the element at the specified index
`INDArray`	`put(int i, int j, INDArray element)` Inserts the element at the specified index
`INDArray`	`put(int i, int j, Number element)` Inserts the element at the specified index
`INDArray`	`put(List<List<Integer>> indices, INDArray element)` Put element in to the indices denoted by the indices ndarray.
`INDArray`	`putColumn(int column, INDArray toPut)` Insert a column in to this array Will throw an exception if this ndarray is not a matrix
`INDArray`	`putRow(int row, INDArray toPut)` Insert a row in to this array Will throw an exception if this ndarray is not a matrix
`INDArray`	`putScalar(int[] i, double value)` Insert the item at the specified indices
`INDArray`	`putScalar(int[] indexes, float value)` Put the specified float value at the specified indices in this array
`INDArray`	`putScalar(int[] indexes, int value)` Put the specified integer value at the specified indices in this array
`INDArray`	`putScalar(int i, double value)` Insert the number linearly in to the ndarray
`INDArray`	`putScalar(int i, float value)` Insert a scalar float at the specified index
`INDArray`	`putScalar(int i, int value)` Insert a scalar int at the specified index
`INDArray`	`putScalar(int row, int col, double value)` Insert the value at the specified indices, in a 2d (rank 2) NDArray Equivalent to `INDArray.putScalar(int[], double)` but avoids int[] creation
`INDArray`	`putScalar(int dim0, int dim1, int dim2, double value)` Insert the value at the specified indices, in a 3d (rank 3) NDArray Equivalent to `INDArray.putScalar(int[], double)` but avoids int[] creation
`INDArray`	`putScalar(int dim0, int dim1, int dim2, int dim3, double value)` Insert the value at the specified indices, in a 4d (rank 4) NDArray Equivalent to `INDArray.putScalar(int[], double)` but avoids int[] creation
`INDArray`	`putScalarUnsafe(long offset, double value)` Insert a scalar at the given linear offset
`INDArray`	`putSlice(int slice, INDArray put)` Assigns the given matrix (put) to the specified slice
`INDArray`	`putWhere(INDArray comp, INDArray put, Condition condition)` Assign the element according to the comparison array
`INDArray`	`putWhere(Number comp, INDArray put, Condition condition)` Assign the element according to the comparison array
`INDArray`	`putWhere(Number comp, Number put, Condition condition)` Assign the element according to the comparison array
`INDArray`	`putWhereWithMask(INDArray mask, INDArray put)` Use a pre computed mask for assigning arrays
`INDArray`	`putWhereWithMask(INDArray mask, Number put)` Use a pre computed mask for assigning arrays
`int`	`rank()` Returns the rank of the ndarray (the number of dimensions).
`INDArray`	`ravel()` Returns a flattened version (row vector) of this ndarray
`INDArray`	`ravel(char order)` Returns a flattened version (row vector) of this ndarray
`IComplexNDArray`	`rdiv(IComplexNumber n)`
`IComplexNDArray`	`rdiv(IComplexNumber n, IComplexNDArray result)`
`INDArray`	`rdiv(INDArray other)` Reverse division, elements wise.
`INDArray`	`rdiv(INDArray other, INDArray result)` Reverse division
`INDArray`	`rdiv(Number n)` Reverse division with a scalar - i.e., (n / thisArrayValues)
`INDArray`	`rdiv(Number n, INDArray result)` Reverse division (number / ndarray)
`INDArray`	`rdivColumnVector(INDArray columnVector)` Reverse division of a column vector (copy)
`IComplexNDArray`	`rdivi(IComplexNumber n)`
`IComplexNDArray`	`rdivi(IComplexNumber n, IComplexNDArray result)`
`INDArray`	`rdivi(INDArray other)` Reverse divsion (in place).
`INDArray`	`rdivi(INDArray other, INDArray result)` Reverse division (in-place)
`INDArray`	`rdivi(Number n)` In place reverse division - i.e., (n / thisArrayValues)
`INDArray`	`rdivi(Number n, INDArray result)` Reverse in place division
`INDArray`	`rdiviColumnVector(INDArray columnVector)` In place reverse divison of a column vector
`INDArray`	`rdiviRowVector(INDArray rowVector)` In place reverse division of a column vector
`INDArray`	`rdivRowVector(INDArray rowVector)` Reverse division of a column vector (copy)
`protected DataBuffer`	`reallocate(DataBuffer buffer)`
`INDArray`	`remainder(INDArray denominator)` Remainder operator
`INDArray`	`remainder(INDArray denominator, INDArray result)` Remainder operator
`INDArray`	`remainder(Number denominator)` The scalar denominator
`INDArray`	`remainder(Number denominator, INDArray result)`
`INDArray`	`remainderi(INDArray denominator)` In place remainder
`INDArray`	`remainderi(Number denominator)` In place remainder
`INDArray`	`repeat(int dimension, int... repeats)` Repeat elements along a specified dimension.
`INDArray`	`replaceWhere(INDArray arr, Condition condition)` Replaces all elements in this ndarray that are matching give condition, with corresponding elements from given array
`INDArray`	`repmat(int... shape)` Replicate and tile array to fill out to the given shape
`void`	`resetLinearView()` Resets the linear view
`INDArray`	`reshape(char order, int... newShape)` Reshapes the ndarray (can't change the length of the ndarray).
`INDArray`	`reshape(char order, int rows, int columns)` Reshapes the ndarray (can't change the length of the ndarray).
`INDArray`	`reshape(int... newShape)` Reshapes the ndarray (can't change the length of the ndarray).
`INDArray`	`reshape(int rows, int columns)` Reshapes the ndarray (can't change the length of the ndarray).
`int`	`rows()` Returns the number of rows in this matrix (throws exception if not 2d)
`IComplexNDArray`	`rsub(IComplexNumber n)`
`IComplexNDArray`	`rsub(IComplexNumber n, IComplexNDArray result)`
`INDArray`	`rsub(INDArray other)` Element-wise reverse subtraction (copy op).
`INDArray`	`rsub(INDArray other, INDArray result)` Reverse subtraction
`INDArray`	`rsub(Number n)` Reverse subtraction with duplicates - i.e., (n - thisArrayValues)
`INDArray`	`rsub(Number n, INDArray result)` Reverse subtraction
`INDArray`	`rsubColumnVector(INDArray columnVector)` Reverse subtraction of a column vector (copy)
`IComplexNDArray`	`rsubi(IComplexNumber n)`
`IComplexNDArray`	`rsubi(IComplexNumber n, IComplexNDArray result)`
`INDArray`	`rsubi(INDArray other)` Element-wise reverse subtraction (in the place op) - i.e., other - this
`INDArray`	`rsubi(INDArray other, INDArray result)` Reverse subtraction (in-place)
`INDArray`	`rsubi(Number n)` Reverse subtraction in place - i.e., (n - thisArrayValues)
`INDArray`	`rsubi(Number n, INDArray result)` Reverse in place subtraction
`INDArray`	`rsubiColumnVector(INDArray columnVector)` In place reverse subtraction of a column vector
`INDArray`	`rsubiRowVector(INDArray rowVector)` In place reverse subtraction of a row vector
`INDArray`	`rsubRowVector(INDArray rowVector)` Reverse subtraction of a row vector (copy)
`Number`	`scan(Condition condition)` This method takes boolean condition, and returns number of elements matching this condition
`int`	`secondaryStride()` Return the second stride for an ndarray.
`void`	`setData(DataBuffer data)`
`void`	`setOrder(char order)` Set the ordering
`void`	`setShape(int... shape)` Shape setter
`void`	`setShapeAndStride(int[] shape, int[] stride)` Shape and stride setter
`protected void`	`setShapeInformation(org.nd4j.linalg.primitives.Pair<DataBuffer,int[]> shapeInfo)`
`void`	`setStride(int... stride)` stride setter
`void`	`setWrapAround(boolean wrapAround)` Set the ndarray to wrap around
`INDArray`	`shannonEntropy(int... dimension)` Returns non-normalized Shannon entropy along dimension
`Number`	`shannonEntropyNumber()` Returns non-normalized Shannon entropy value for this INDArray
`int[]`	`shape()` Returns the shape of this ndarray
`IntBuffer`	`shapeInfo()` Shape info
`DataBuffer`	`shapeInfoDataBuffer()` Shape info
`String`	`shapeInfoToString()` Returns the shape information debugging information
`protected DataBuffer`	`shapeOf()`
`int`	`size(int dimension)` Returns the size along a specified dimension
`INDArray`	`slice(int i)` Returns the specified slice of this ndarray
`INDArray`	`slice(int i, int dimension)` Returns the specified slice of this ndarray
`int`	`slices()` Returns the number of slices in this ndarray
`void`	`sliceVectors(List<INDArray> list)`
`DataBuffer`	`sparseInfoDataBuffer()` Sparse info
`int[]`	`sparseOffsets()`
`double`	`squaredDistance(INDArray other)` Returns the square of the Euclidean distance.
`INDArray`	`std(boolean biasCorrected, int... dimension)` Standard deviation of an ndarray along a dimension
`INDArray`	`std(int... dimension)` Standard deviation of an INDArray along one or more dimensions
`IComplexNumber`	`stdComplex()`
`Number`	`stdNumber()` Calculate the standard deviation for the entire array
`Number`	`stdNumber(boolean biasCorrected)` Calculate the standard deviation for the entire array, specifying whether it is bias corrected or not
`int[]`	`stride()` Returns the stride of this ndarray
`int`	`stride(int dimension)` Calculate the stride along a particular dimension
`protected DataBuffer`	`strideOf()`
`IComplexNDArray`	`sub(IComplexNumber n)`
`IComplexNDArray`	`sub(IComplexNumber n, IComplexNDArray result)`
`INDArray`	`sub(INDArray other)` copy subtraction of two NDArrays
`INDArray`	`sub(INDArray other, INDArray result)` copy subtraction of two NDArrays
`INDArray`	`sub(Number n)` Scalar subtraction (copied)
`INDArray`	`sub(Number n, INDArray result)`
`INDArray`	`subArray(long[] offsets, int[] shape, int[] stride)`
`INDArray`	`subArray(ShapeOffsetResolution resolution)` Sub array based on the pre calculated shape,strides, offsets
`INDArray`	`subColumnVector(INDArray columnVector)` Subtraction of a column vector (copy)
`IComplexNDArray`	`subi(IComplexNumber n)`
`IComplexNDArray`	`subi(IComplexNumber n, IComplexNDArray result)`
`INDArray`	`subi(INDArray other)` in place (element wise) subtraction of two NDArrays
`INDArray`	`subi(INDArray other, INDArray result)` in place (element wise) subtraction of two NDArrays
`INDArray`	`subi(Number n)` In place scalar subtraction
`INDArray`	`subi(Number n, INDArray result)` In place subtraction of this ndarray
`INDArray`	`subiColumnVector(INDArray columnVector)` In place subtraction of a column vector
`INDArray`	`subiRowVector(INDArray rowVector)` In place subtraction of a row vector
`INDArray`	`subRowVector(INDArray rowVector)` Subtraction of a row vector (copy)
`INDArray`	`sum(INDArray result, int... dimension)` Returns the sum along the last dimension of this ndarray
`INDArray`	`sum(int... dimension)` Returns the sum along the last dimension of this ndarray
`IComplexNumber`	`sumComplex()` Sum the entire array
`Number`	`sumNumber()` Sum the entire array
`INDArray`	`swapAxes(int dimension, int with)` Mainly here for people coming from numpy.
`INDArray`	`tensorAlongDimension(int index, int... dimension)` Get the vector along a particular dimension
`int`	`tensorssAlongDimension(int... dimension)` Returns the number of possible vectors for a given dimension
`INDArray`	`toDense()` Return a dense representation of the sparse ndarray
`double[][]`	`toDoubleMatrix()` Convert this ndarray to a 2d double matrix.
`double[]`	`toDoubleVector()` Convert this ndarray to a 1d double matrix.
`float[][]`	`toFloatMatrix()` Convert this ndarray to a 2d float matrix.
`float[]`	`toFloatVector()` Convert this ndarray to a 1d float vector.
`int[][]`	`toIntMatrix()` Convert this ndarray to a 2d int matrix.
`int[]`	`toIntVector()` Convert this ndarray to a 1d int matrix.
`INDArray`	`transpose()` Flip the rows and columns of a matrix
`INDArray`	`transposei()` Flip the rows and columns of a matrix, in-place
`INDArray`	`unsafeDuplication()` Perform efficient (but unsafe) duplication.
`INDArray`	`unsafeDuplication(boolean blocking)` Perform efficient (but unsafe) duplication.
`INDArray`	`var(boolean biasCorrected, int... dimension)` Returns the overall variance of this ndarray
`INDArray`	`var(int... dimension)` Returns the overall variance of this ndarray
`IComplexNumber`	`varComplex()`
`Number`	`varNumber()` Returns the overall variance of all values in this INDArray
`INDArray`	`vectorAlongDimension(int index, int dimension)` Get the vector along a particular dimension
`int`	`vectorsAlongDimension(int dimension)` Returns the number of possible vectors for a given dimension

Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.nd4j.linalg.api.ndarray.ISparseNDArray
getFormat, getVectorCoordinates

Methods inherited from interface org.nd4j.linalg.api.ndarray.INDArray
convertToDoubles, convertToFloats, data, isView, mmul, mmul, mmuli, mmuli, putiColumnVector, putiRowVector, toFlatArray, underlyingRank

- Field Detail
  - THRESHOLD_MEMORY_ALLOCATION
```
protected static final double THRESHOLD_MEMORY_ALLOCATION
```
    See Also:
    
    Constant Field Values
  - rows
```
protected int rows
```
  - columns
```
protected int columns
```
  - rank
```
protected int rank
```
  - isVector
```
protected Boolean isVector
```
  - isMatrix
```
protected Boolean isMatrix
```
  - isScalar
```
protected Boolean isScalar
```
  - length
```
protected long length
```
  - isSparse
```
public static final boolean isSparse
```
    See Also:
    
    Constant Field Values
  - shapeInformation
```
protected transient volatile DataBuffer shapeInformation
```
  - javaShapeInformation
```
protected transient volatile int[] javaShapeInformation
```
  - sparseInformation
```
protected transient volatile DataBuffer sparseInformation
```
  - shape
```
protected transient DataBuffer shape
```
  - stride
```
protected transient DataBuffer stride
```
- Constructor Detail
  - BaseSparseNDArray
```
public BaseSparseNDArray()
```
- Method Detail
  - reallocate
```
protected DataBuffer reallocate(DataBuffer buffer)
```
  - clone
```
protected Object clone()
                throws CloneNotSupportedException
```
    Overrides:
    
    clone in class Object
    
    Throws:
    
    CloneNotSupportedException
  - isColumnVectorOrScalar
```
public boolean isColumnVectorOrScalar()
```
    Description copied from interface: INDArray
    
    Returns true if the number of columns is 1
    
    Specified by:
    
    isColumnVectorOrScalar in interface INDArray
    
    Returns:
    
    true if the number of columns is 1
  - isRowVectorOrScalar
```
public boolean isRowVectorOrScalar()
```
    Description copied from interface: INDArray
    
    Returns true if the number of rows is 1
    
    Specified by:
    
    isRowVectorOrScalar in interface INDArray
    
    Returns:
    
    true if the number of rows is 1
  - get
```
public INDArray get(INDArray indices)
```
    Description copied from interface: INDArray
    
    Get the elements from this ndarray based on the specified indices
    
    Specified by:
    
    get in interface INDArray
    
    Parameters:
    
    indices - an ndaray of the indices to get the elements for
    
    Returns:
    
    the elements to get the array for
  - toDoubleMatrix
```
public double[][] toDoubleMatrix()
```
    Description copied from interface: INDArray
    
    Convert this ndarray to a 2d double matrix. Note that THIS SHOULD NOT BE USED FOR SPEED. This is mainly used for integrations with other libraries. Due to nd4j's off heap nature, moving data on heap is very expensive and should not be used if possible.
    
    Specified by:
    
    toDoubleMatrix in interface INDArray
    
    Returns:
    
    a copy of this array as a 2d double array
  - toDoubleVector
```
public double[] toDoubleVector()
```
    Description copied from interface: INDArray
    
    Convert this ndarray to a 1d double matrix. Note that THIS SHOULD NOT BE USED FOR SPEED. This is mainly used for integrations with other libraries. Due to nd4j's off heap nature, moving data on heap is very expensive and should not be used if possible.
    
    Specified by:
    
    toDoubleVector in interface INDArray
    
    Returns:
    
    a copy of this array as a 1d double array
  - toFloatVector
```
public float[] toFloatVector()
```
    Description copied from interface: INDArray
    
    Convert this ndarray to a 1d float vector. Note that THIS SHOULD NOT BE USED FOR SPEED. This is mainly used for integrations with other libraries. Due to nd4j's off heap nature, moving data on heap is very expensive and should not be used if possible.
    
    Specified by:
    
    toFloatVector in interface INDArray
    
    Returns:
    
    a copy of this array as a 1d float array
  - toFloatMatrix
```
public float[][] toFloatMatrix()
```
    Description copied from interface: INDArray
    
    Convert this ndarray to a 2d float matrix. Note that THIS SHOULD NOT BE USED FOR SPEED. This is mainly used for integrations with other libraries. Due to nd4j's off heap nature, moving data on heap is very expensive and should not be used if possible.
    
    Specified by:
    
    toFloatMatrix in interface INDArray
    
    Returns:
    
    a copy of this array as a 2d float array
  - toIntVector
```
public int[] toIntVector()
```
    Description copied from interface: INDArray
    
    Convert this ndarray to a 1d int matrix. Note that THIS SHOULD NOT BE USED FOR SPEED. This is mainly used for integrations with other libraries. Due to nd4j's off heap nature, moving data on heap is very expensive and should not be used if possible.
    
    Specified by:
    
    toIntVector in interface INDArray
    
    Returns:
    
    a copy of this array as a 1d int array
  - toIntMatrix
```
public int[][] toIntMatrix()
```
    Description copied from interface: INDArray
    
    Convert this ndarray to a 2d int matrix. Note that THIS SHOULD NOT BE USED FOR SPEED. This is mainly used for integrations with other libraries. Due to nd4j's off heap nature, moving data on heap is very expensive and should not be used if possible.
    
    Specified by:
    
    toIntMatrix in interface INDArray
    
    Returns:
    
    a copy of this array as a 2d int array
  - match
```
public INDArray match(INDArray comp,
                      Condition condition)
```
    Description copied from interface: INDArray
    
    Return a mask on whether each element matches the given condition
    
    Specified by:
    
    match in interface INDArray
    
    Returns:
  - match
```
public INDArray match(Number comp,
                      Condition condition)
```
    Description copied from interface: INDArray
    
    Returns a mask
    
    Specified by:
    
    match in interface INDArray
    
    Returns:
  - putWhereWithMask
```
public INDArray putWhereWithMask(INDArray mask,
                                 INDArray put)
```
    Description copied from interface: INDArray
    
    Use a pre computed mask for assigning arrays
    
    Specified by:
    
    putWhereWithMask in interface INDArray
    
    Parameters:
    
    mask - the mask to use
    
    put - the array to put
    
    Returns:
    
    the resulting array
  - putWhereWithMask
```
public INDArray putWhereWithMask(INDArray mask,
                                 Number put)
```
    Description copied from interface: INDArray
    
    Use a pre computed mask for assigning arrays
    
    Specified by:
    
    putWhereWithMask in interface INDArray
    
    Parameters:
    
    mask - the mask to use
    
    put - the array to put
    
    Returns:
    
    the resulting array
  - toDense
```
public INDArray toDense()
```
    Description copied from interface: ISparseNDArray
    
    Return a dense representation of the sparse ndarray
    
    Specified by:
    
    toDense in interface INDArray
    
    Specified by:
    
    toDense in interface ISparseNDArray
  - getWhere
```
public INDArray getWhere(INDArray comp,
                         Condition condition)
```
    Description copied from interface: INDArray
    
    Boolean indexing: Return the element if it fulfills the condition in result array
    
    Specified by:
    
    getWhere in interface INDArray
    
    Parameters:
    
    comp - the comparison array
    
    condition - the condition to apply
    
    Returns:
    
    the array fulfilling the criteria
  - getWhere
```
public INDArray getWhere(Number comp,
                         Condition condition)
```
    Description copied from interface: INDArray
    
    Boolean indexing: Return the element if it fulfills the condition in result array
    
    Specified by:
    
    getWhere in interface INDArray
    
    Parameters:
    
    comp - the comparison array
    
    condition - the condition to apply
    
    Returns:
    
    the array fulfilling the criteria
  - putWhere
```
public INDArray putWhere(INDArray comp,
                         INDArray put,
                         Condition condition)
```
    Description copied from interface: INDArray
    
    Assign the element according to the comparison array
    
    Specified by:
    
    putWhere in interface INDArray
    
    Parameters:
    
    comp - the comparison array
    
    put - the elements to put
    
    condition - the condition for masking on
    
    Returns:
  - putWhere
```
public INDArray putWhere(Number comp,
                         INDArray put,
                         Condition condition)
```
    Description copied from interface: INDArray
    
    Assign the element according to the comparison array
    
    Specified by:
    
    putWhere in interface INDArray
    
    Parameters:
    
    comp - the comparison array
    
    put - the elements to put
    
    condition - the condition for masking on
    
    Returns:
  - putWhere
```
public INDArray putWhere(Number comp,
                         Number put,
                         Condition condition)
```
    Description copied from interface: INDArray
    
    Assign the element according to the comparison array
    
    Specified by:
    
    putWhere in interface INDArray
    
    Parameters:
    
    comp - the comparison array
    
    put - the elements to put
    
    condition - the condition for masking on
    
    Returns:
  - get
```
public INDArray get(List<List<Integer>> indices)
```
    Description copied from interface: INDArray
    
    Get the elements from this ndarray based on the specified indices
    
    Specified by:
    
    get in interface INDArray
    
    Parameters:
    
    indices - an ndaray of the indices to get the elements for
    
    Returns:
    
    the elements to get the array for
  - put
```
public INDArray put(List<List<Integer>> indices,
                    INDArray element)
```
    Description copied from interface: INDArray
    
    Put element in to the indices denoted by the indices ndarray. This is equivalent to: a[indices] = element in numpy.
    
    Specified by:
    
    put in interface INDArray
    
    Parameters:
    
    indices - the indices to put
    
    element - the element array to put
    
    Returns:
    
    this array
  - put
```
public INDArray put(INDArray indices,
                    INDArray element)
```
    Description copied from interface: INDArray
    
    Put element in to the indices denoted by the indices ndarray. This is equivalent to: a[indices] = element in numpy.
    
    Specified by:
    
    put in interface INDArray
    
    Parameters:
    
    indices - the indices to put
    
    element - the element array to put
    
    Returns:
    
    this array
  - isSparse
```
public boolean isSparse()
```
    Description copied from interface: INDArray
    
    Returns true if this array is sparse
    
    Specified by:
    
    isSparse in interface INDArray
    
    Returns:
  - length
```
public int length()
```
    Description copied from interface: INDArray
    
    Returns the total number of elements in the ndarray
    
    Specified by:
    
    length in interface INDArray
    
    Returns:
    
    the number of elements in the ndarray
  - nnz
```
public int nnz()
```
    Description copied from interface: ISparseNDArray
    
    Return the number of non-null element
    
    Specified by:
    
    nnz in interface INDArray
    
    Specified by:
    
    nnz in interface ISparseNDArray
    
    Returns:
    
    nnz
  - lengthLong
```
public long lengthLong()
```
    Description copied from interface: INDArray
    
    Returns the total number of elements in the ndarray
    
    Specified by:
    
    lengthLong in interface INDArray
    
    Returns:
    
    the number of elements in the ndarray
  - init
```
protected void init(int[] shape)
```
  - shapeInfoToString
```
public String shapeInfoToString()
```
    Description copied from interface: INDArray
    
    Returns the shape information debugging information
    
    Specified by:
    
    shapeInfoToString in interface INDArray
    
    Returns:
    
    the shape information debugging information
  - shapeInfoDataBuffer
```
public DataBuffer shapeInfoDataBuffer()
```
    Description copied from interface: INDArray
    
    Shape info
    
    Specified by:
    
    shapeInfoDataBuffer in interface INDArray
    
    Returns:
  - sparseInfoDataBuffer
```
public DataBuffer sparseInfoDataBuffer()
```
    Description copied from interface: INDArray
    
    Sparse info
    
    Specified by:
    
    sparseInfoDataBuffer in interface INDArray
    
    Returns:
  - shapeInfo
```
public IntBuffer shapeInfo()
```
    Description copied from interface: INDArray
    
    Shape info
    
    Specified by:
    
    shapeInfo in interface INDArray
    
    Returns:
  - isCompressed
```
public boolean isCompressed()
```
    Description copied from interface: INDArray
    
    Returns true if this array is compressed, and false otherwise
    
    Specified by:
    
    isCompressed in interface INDArray
    
    Returns:
  - markAsCompressed
```
public void markAsCompressed(boolean reallyCompressed)
```
    Description copied from interface: INDArray
    
    This method marks INDArray instance as compressed PLEASE NOTE: Do not use this method unless you 100% have to
    
    Specified by:
    
    markAsCompressed in interface INDArray
  - setWrapAround
```
public void setWrapAround(boolean wrapAround)
```
    Description copied from interface: INDArray
    
    Set the ndarray to wrap around
    
    Specified by:
    
    setWrapAround in interface INDArray
    
    Parameters:
    
    wrapAround - thewrap around
  - isWrapAround
```
public boolean isWrapAround()
```
    Description copied from interface: INDArray
    
    Returns true if the ndarray on linear indexing wraps around based on the stride(1) of the ndarray This is a useful optimization in linear view where strides that might otherwise go out of bounds but wrap around instead.
    
    Specified by:
    
    isWrapAround in interface INDArray
    
    Returns:
    
    true if this ndarray wraps around on linear indexing, false otherwise
  - rank
```
public int rank()
```
    Description copied from interface: INDArray
    
    Returns the rank of the ndarray (the number of dimensions).
    
    Specified by:
    
    rank in interface INDArray
    
    Returns:
    
    the rank for the ndarray.
  - flags
```
public int[] flags()
```
    Specified by:
    
    flags in interface INDArray
  - hiddenDimensions
```
public int[] hiddenDimensions()
```
    Specified by:
    
    hiddenDimensions in interface INDArray
  - sparseOffsets
```
public int[] sparseOffsets()
```
    Specified by:
    
    sparseOffsets in interface INDArray
  - stride
```
public int stride(int dimension)
```
    Description copied from interface: INDArray
    
    Calculate the stride along a particular dimension
    
    Specified by:
    
    stride in interface INDArray
    
    Parameters:
    
    dimension - the dimension to get the stride for
    
    Returns:
    
    the stride for a particular dimension
  - strideOf
```
protected DataBuffer strideOf()
```
  - elementStride
```
public int elementStride()
```
    Description copied from interface: INDArray
    
    Element stride (one element to the next, also called the defualt stride: 1 for normal 2 for complex)
    
    Specified by:
    
    elementStride in interface INDArray
    
    Returns:
  - elementWiseStride
```
public int elementWiseStride()
```
    Description copied from interface: INDArray
    
    Element wise stride
    
    Specified by:
    
    elementWiseStride in interface INDArray
  - isCleanedUp
```
public boolean isCleanedUp()
```
    Description copied from interface: INDArray
    
    Returns true if the ndarray has already been freed
    
    Specified by:
    
    isCleanedUp in interface INDArray
    
    Returns:
  - cleanup
```
public void cleanup()
```
    Description copied from interface: INDArray
    
    Cleanup resources
    
    Specified by:
    
    cleanup in interface INDArray
  - resetLinearView
```
public void resetLinearView()
```
    Description copied from interface: INDArray
    
    Resets the linear view
    
    Specified by:
    
    resetLinearView in interface INDArray
  - secondaryStride
```
public int secondaryStride()
```
    Description copied from interface: INDArray
    
    Return the second stride for an ndarray. Think of this as the stride for the next element in a column.
    
    Specified by:
    
    secondaryStride in interface INDArray
    
    Returns:
    
    the secondary stride for an ndarray
  - getDoubleUnsafe
```
public double getDoubleUnsafe(long offset)
```
    Description copied from interface: INDArray
    
    Get a scalar at the given linear offset
    
    Specified by:
    
    getDoubleUnsafe in interface INDArray
    
    Parameters:
    
    offset - the offset to get at
    
    Returns:
    
    this
  - putScalarUnsafe
```
public INDArray putScalarUnsafe(long offset,
                                double value)
```
    Description copied from interface: INDArray
    
    Insert a scalar at the given linear offset
    
    Specified by:
    
    putScalarUnsafe in interface INDArray
    
    Parameters:
    
    offset - the offset to insert at
    
    value - the value to insert
    
    Returns:
    
    this
  - majorStride
```
public int majorStride()
```
    Description copied from interface: INDArray
    
    Return the major stride for an ndarray
    
    Specified by:
    
    majorStride in interface INDArray
    
    Returns:
    
    the major stride for an ndarray
  - innerMostStride
```
public int innerMostStride()
```
    Description copied from interface: INDArray
    
    Get the inner most stride wrt the ordering of the array
    
    Specified by:
    
    innerMostStride in interface INDArray
    
    Returns:
  - linearView
```
public INDArray linearView()
```
    Description copied from interface: INDArray
    
    Returns a linear view reference of shape 1,length(ndarray)
    
    Specified by:
    
    linearView in interface INDArray
    
    Returns:
    
    the linear view of this ndarray
  - linearViewColumnOrder
```
public INDArray linearViewColumnOrder()
```
    Description copied from interface: INDArray
    
    Returns a linear view reference of shape 1,length(ndarray)
    
    Specified by:
    
    linearViewColumnOrder in interface INDArray
    
    Returns:
    
    the linear view of this ndarray
  - vectorsAlongDimension
```
public int vectorsAlongDimension(int dimension)
```
    Description copied from interface: INDArray
    
    Returns the number of possible vectors for a given dimension
    
    Specified by:
    
    vectorsAlongDimension in interface INDArray
    
    Parameters:
    
    dimension - the dimension to calculate the number of vectors for
    
    Returns:
    
    the number of possible vectors along a dimension
  - vectorAlongDimension
```
public INDArray vectorAlongDimension(int index,
                                     int dimension)
```
    Description copied from interface: INDArray
    
    Get the vector along a particular dimension
    
    Specified by:
    
    vectorAlongDimension in interface INDArray
    
    Parameters:
    
    index - the index of the vector to getScalar
    
    dimension - the dimension to getScalar the vector from
    
    Returns:
    
    the vector along a particular dimension
  - tensorssAlongDimension
```
public int tensorssAlongDimension(int... dimension)
```
    Description copied from interface: INDArray
    
    Returns the number of possible vectors for a given dimension
    
    Specified by:
    
    tensorssAlongDimension in interface INDArray
    
    Parameters:
    
    dimension - the dimension to calculate the number of vectors for
    
    Returns:
    
    the number of possible vectors along a dimension
  - tensorAlongDimension
```
public INDArray tensorAlongDimension(int index,
                                     int... dimension)
```
    Description copied from interface: INDArray
    
    Get the vector along a particular dimension
    
    Specified by:
    
    tensorAlongDimension in interface INDArray
    
    Parameters:
    
    index - the index of the vector to getScalar
    
    dimension - the dimension to getScalar the vector from
    
    Returns:
    
    the vector along a particular dimension
  - javaTensorAlongDimension
```
public INDArray javaTensorAlongDimension(int index,
                                         int... dimension)
```
    Description copied from interface: INDArray
    
    Get the vector along a particular dimension
    
    Specified by:
    
    javaTensorAlongDimension in interface INDArray
    
    Parameters:
    
    index - the index of the vector to getScalar
    
    dimension - the dimension to getScalar the vector from
    
    Returns:
    
    the vector along a particular dimension
  - cumsumi
```
public INDArray cumsumi(int dimension)
```
    Description copied from interface: INDArray
    
    Returns the cumulative sum along a dimension. In-place method.
    
    Specified by:
    
    cumsumi in interface INDArray
    
    Parameters:
    
    dimension - the dimension to perform cumulative sum along.
    
    Returns:
    
    this object.
  - cumsum
```
public INDArray cumsum(int dimension)
```
    Description copied from interface: INDArray
    
    Returns the cumulative sum along a dimension.
    
    Specified by:
    
    cumsum in interface INDArray
    
    Parameters:
    
    dimension - the dimension to perform cumulative sum along.
    
    Returns:
    
    the cumulative sum along the specified dimension
  - assign
```
public INDArray assign(INDArray arr)
```
    Description copied from interface: INDArray
    
    Assign all of the elements in the given ndarray to this ndarray
    
    Specified by:
    
    assign in interface INDArray
    
    Parameters:
    
    arr - the elements to assign
    
    Returns:
    
    this
  - assignIf
```
public INDArray assignIf(INDArray arr,
                         Condition condition)
```
    Description copied from interface: INDArray
    
    Assign all elements from given ndarray that are matching given condition, ndarray to this ndarray
    
    Specified by:
    
    assignIf in interface INDArray
    
    Parameters:
    
    arr - the elements to assign
    
    Returns:
    
    this
  - replaceWhere
```
public INDArray replaceWhere(INDArray arr,
                             Condition condition)
```
    Description copied from interface: INDArray
    
    Replaces all elements in this ndarray that are matching give condition, with corresponding elements from given array
    
    Specified by:
    
    replaceWhere in interface INDArray
    
    Parameters:
    
    arr - Source array
    
    condition - Condition to apply
    
    Returns:
    
    New array with values conditionally replaced
  - putScalar
```
public INDArray putScalar(int i,
                          double value)
```
    Description copied from interface: INDArray
    
    Insert the number linearly in to the ndarray
    
    Specified by:
    
    putScalar in interface INDArray
    
    Parameters:
    
    i - the index to insert into
    
    value - the value to insert
    
    Returns:
    
    this
  - putScalar
```
public INDArray putScalar(int i,
                          float value)
```
    Description copied from interface: INDArray
    
    Insert a scalar float at the specified index
    
    Specified by:
    
    putScalar in interface INDArray
    
    Parameters:
    
    i - The index to insert into
    
    value - Value to insert
    
    Returns:
    
    This array
  - putScalar
```
public INDArray putScalar(int i,
                          int value)
```
    Description copied from interface: INDArray
    
    Insert a scalar int at the specified index
    
    Specified by:
    
    putScalar in interface INDArray
    
    Parameters:
    
    i - The index to insert into
    
    value - Value to insert
    
    Returns:
    
    This array
  - putScalar
```
public INDArray putScalar(int[] i,
                          double value)
```
    Description copied from interface: INDArray
    
    Insert the item at the specified indices
    
    Specified by:
    
    putScalar in interface INDArray
    
    Parameters:
    
    i - the indices to insert at
    
    value - the number to insert
    
    Returns:
    
    this
  - putScalar
```
public INDArray putScalar(int row,
                          int col,
                          double value)
```
    Description copied from interface: INDArray
    
    Insert the value at the specified indices, in a 2d (rank 2) NDArray
    Equivalent to INDArray.putScalar(int[], double) but avoids int[] creation
    
    Specified by:
    
    putScalar in interface INDArray
    
    Parameters:
    
    row - Row (dimension 0) index
    
    col - Column (dimension 1) index
    
    value - Value to put
    
    Returns:
    
    This INDArray
  - putScalar
```
public INDArray putScalar(int dim0,
                          int dim1,
                          int dim2,
                          double value)
```
    Description copied from interface: INDArray
    
    Insert the value at the specified indices, in a 3d (rank 3) NDArray
    Equivalent to INDArray.putScalar(int[], double) but avoids int[] creation
    
    Specified by:
    
    putScalar in interface INDArray
    
    Parameters:
    
    dim0 - Dimension 0 index
    
    dim1 - Dimension 1 index
    
    dim2 - Dimension 2 index
    
    value - Value to put
    
    Returns:
    
    This INDArray
  - putScalar
```
public INDArray putScalar(int dim0,
                          int dim1,
                          int dim2,
                          int dim3,
                          double value)
```
    Description copied from interface: INDArray
    
    Insert the value at the specified indices, in a 4d (rank 4) NDArray
    Equivalent to INDArray.putScalar(int[], double) but avoids int[] creation
    
    Specified by:
    
    putScalar in interface INDArray
    
    Parameters:
    
    dim0 - Dimension 0 index
    
    dim1 - Dimension 1 index
    
    dim2 - Dimension 2 index
    
    dim3 - Dimension 3 index
    
    value - Value to put
    
    Returns:
    
    This INDArray
  - lt
```
public INDArray lt(Number other)
```
    Description copied from interface: INDArray
    
    Returns the binary ndarray for "Less" comparison.
    
    Specified by:
    
    lt in interface INDArray
    
    Parameters:
    
    other - the number to compare.
    
    Returns:
    
    the binary ndarray for "Less" comparison.
  - lti
```
public INDArray lti(Number other)
```
    Description copied from interface: INDArray
    
    Returns the binary ndarray for "Less" comparison. In-place method.
    
    Specified by:
    
    lti in interface INDArray
    
    Parameters:
    
    other - the number to compare.
    
    Returns:
    
    this object.
  - putScalar
```
public INDArray putScalar(int[] indexes,
                          float value)
```
    Description copied from interface: INDArray
    
    Put the specified float value at the specified indices in this array
    
    Specified by:
    
    putScalar in interface INDArray
    
    Parameters:
    
    indexes - Indices to place the value
    
    value - Value to insert
    
    Returns:
    
    This array
  - putScalar
```
public INDArray putScalar(int[] indexes,
                          int value)
```
    Description copied from interface: INDArray
    
    Put the specified integer value at the specified indices in this array
    
    Specified by:
    
    putScalar in interface INDArray
    
    Parameters:
    
    indexes - Indices to place the value
    
    value - Value to insert
    
    Returns:
    
    This array
  - eps
```
public INDArray eps(Number other)
```
    Description copied from interface: INDArray
    
    Returns the binary ndarray for "Epsilon equals" comparison.
    
    Specified by:
    
    eps in interface INDArray
    
    Parameters:
    
    other - the number to compare.
    
    Returns:
    
    the binary ndarray for "Epsilon equals" comparison.
  - epsi
```
public INDArray epsi(Number other)
```
    Description copied from interface: INDArray
    
    Returns the binary ndarray for "Epsilon equals" comparison. In-place method.
    
    Specified by:
    
    epsi in interface INDArray
    
    Parameters:
    
    other - the number to compare.
    
    Returns:
    
    this object.
  - eq
```
public INDArray eq(Number other)
```
    Description copied from interface: INDArray
    
    Returns the binary ndarray for "Equals" comparison.
    
    Specified by:
    
    eq in interface INDArray
    
    Parameters:
    
    other - the number to compare.
    
    Returns:
    
    the binary ndarray for "Equals" comparison.
  - eqi
```
public INDArray eqi(Number other)
```
    Description copied from interface: INDArray
    
    Returns the binary ndarray for "Equals" comparison. In-place method.
    
    Specified by:
    
    eqi in interface INDArray
    
    Parameters:
    
    other - the number to compare.
    
    Returns:
    
    this object.
  - gt
```
public INDArray gt(Number other)
```
    Description copied from interface: INDArray
    
    Returns the binary ndarray for "Greater" comparison.
    
    Specified by:
    
    gt in interface INDArray
    
    Parameters:
    
    other - the number to compare.
    
    Returns:
    
    the binary ndarray for "Greater" comparison.
  - gte
```
public INDArray gte(Number other)
```
    Description copied from interface: INDArray
    
    Returns binary ndarray for "Greter or equals" comparison.
    
    Specified by:
    
    gte in interface INDArray
    
    Parameters:
    
    other - the number to compare.
    
    Returns:
    
    binary ndarray for "Greter or equals" comparison.
  - lte
```
public INDArray lte(Number other)
```
    Description copied from interface: INDArray
    
    Returns the binary ndarray for "Less or equals" comparison.
    
    Specified by:
    
    lte in interface INDArray
    
    Parameters:
    
    other - the number to compare.
    
    Returns:
    
    the binary ndarray for "Less or equals" comparison.
  - gtei
```
public INDArray gtei(Number other)
```
    Description copied from interface: INDArray
    
    Returns the binary ndarray for "Greter or equals" comparison. In-place method.
    
    Specified by:
    
    gtei in interface INDArray
    
    Parameters:
    
    other - the number to compare.
    
    Returns:
    
    this object.
  - ltei
```
public INDArray ltei(Number other)
```
    Description copied from interface: INDArray
    
    Returns the binary ndarray for "Less or equals" comparison. In-place method.
    
    Specified by:
    
    ltei in interface INDArray
    
    Parameters:
    
    other - the number to compare.
    
    Returns:
    
    this object.
  - gti
```
public INDArray gti(Number other)
```
    Description copied from interface: INDArray
    
    Returns the binary ndarray for "Greter" comparison. In-place method.
    
    Specified by:
    
    gti in interface INDArray
    
    Parameters:
    
    other - the number to compare.
    
    Returns:
    
    this object.
  - lt
```
public INDArray lt(INDArray other)
```
    Description copied from interface: INDArray
    
    Returns the binary ndarray for "Less" comparison.
    
    Specified by:
    
    lt in interface INDArray
    
    Parameters:
    
    other - the ndarray to compare.
    
    Returns:
    
    the binary ndarray for "Less" comparison.
  - lti
```
public INDArray lti(INDArray other)
```
    Description copied from interface: INDArray
    
    Returns the binary ndarray for "Less" comparison. In-place method.
    
    Specified by:
    
    lti in interface INDArray
    
    Parameters:
    
    other - the ndarray to compare.
    
    Returns:
    
    this object.
  - eps
```
public INDArray eps(INDArray other)
```
    Description copied from interface: INDArray
    
    Returns the binary ndarray for "Epsilon equals" comparison.
    
    Specified by:
    
    eps in interface INDArray
    
    Parameters:
    
    other - the ndarray to compare.
    
    Returns:
    
    the binary ndarray for "Epsilon equals" comparison.
  - epsi
```
public INDArray epsi(INDArray other)
```
    Description copied from interface: INDArray
    
    Returns the binary ndarray for "Epsilon equals" comparison. In-place method.
    
    Specified by:
    
    epsi in interface INDArray
    
    Parameters:
    
    other - the ndarray to compare.
    
    Returns:
    
    this object.
  - neq
```
public INDArray neq(Number other)
```
    Description copied from interface: INDArray
    
    Returns the binary ndarray for "Not equals" comparison.
    
    Specified by:
    
    neq in interface INDArray
    
    Parameters:
    
    other - the number to compare.
    
    Returns:
    
    the binary ndarray for "Not equals" comparison.
  - neqi
```
public INDArray neqi(Number other)
```
    Description copied from interface: INDArray
    
    Returns the binary ndarray for "Not equals" comparison. In-place method.
    
    Specified by:
    
    neqi in interface INDArray
    
    Parameters:
    
    other - the number to compare.
    
    Returns:
    
    this object.
  - neq
```
public INDArray neq(INDArray other)
```
    Description copied from interface: INDArray
    
    Returns the binary ndarray for "Not equals" comparison.
    
    Specified by:
    
    neq in interface INDArray
    
    Parameters:
    
    other - the ndarray to compare.
    
    Returns:
    
    the binary ndarray for "Not equals" comparison.
  - neqi
```
public INDArray neqi(INDArray other)
```
    Description copied from interface: INDArray
    
    Returns the binary ndarray for "Not equals" comparison. In-place method.
    
    Specified by:
    
    neqi in interface INDArray
    
    Parameters:
    
    other - the ndarray to compare.
    
    Returns:
    
    this object.
  - eq
```
public INDArray eq(INDArray other)
```
    Description copied from interface: INDArray
    
    Returns the binary ndarray for "Equals" comparison.
    
    Specified by:
    
    eq in interface INDArray
    
    Parameters:
    
    other - the ndarray to compare.
    
    Returns:
    
    the binary ndarray for "Equals" comparison.
  - eqi
```
public INDArray eqi(INDArray other)
```
    Description copied from interface: INDArray
    
    Returns the binary ndarray for "Equals" comparison. In-place method.
    
    Specified by:
    
    eqi in interface INDArray
    
    Parameters:
    
    other - the ndarray to compare.
    
    Returns:
    
    this object.
  - gt
```
public INDArray gt(INDArray other)
```
    Description copied from interface: INDArray
    
    Returns the binary ndarray for "Greter" comparison.
    
    Specified by:
    
    gt in interface INDArray
    
    Parameters:
    
    other - the ndarray to compare.
    
    Returns:
    
    the binary ndarray for "Greter" comparison.
  - gti
```
public INDArray gti(INDArray other)
```
    Description copied from interface: INDArray
    
    Returns the binary ndarray for "Greter" comparison. In-place method.
    
    Specified by:
    
    gti in interface INDArray
    
    Parameters:
    
    other - the ndarray to compare.
    
    Returns:
    
    this object.
  - neg
```
public INDArray neg()
```
    Description copied from interface: INDArray
    
    Returns the ndarray negative (cloned)
    
    Specified by:
    
    neg in interface INDArray
    
    Returns:
    
    Array copy with all values negated
  - negi
```
public INDArray negi()
```
    Description copied from interface: INDArray
    
    In place setting of the negative version of this ndarray
    
    Specified by:
    
    negi in interface INDArray
    
    Returns:
    
    This array with all values negated
  - rdiv
```
public INDArray rdiv(Number n)
```
    Description copied from interface: INDArray
    
    Reverse division with a scalar - i.e., (n / thisArrayValues)
    
    Specified by:
    
    rdiv in interface INDArray
    
    Parameters:
    
    n - Value to use for reverse division
    
    Returns:
    
    Copy of array after applying reverse division
  - rdivi
```
public INDArray rdivi(Number n)
```
    Description copied from interface: INDArray
    
    In place reverse division - i.e., (n / thisArrayValues)
    
    Specified by:
    
    rdivi in interface INDArray
    
    Parameters:
    
    n - Value to use for reverse division
    
    Returns:
    
    This array after applying reverse division
  - rsub
```
public INDArray rsub(Number n)
```
    Description copied from interface: INDArray
    
    Reverse subtraction with duplicates - i.e., (n - thisArrayValues)
    
    Specified by:
    
    rsub in interface INDArray
    
    Parameters:
    
    n - Value to use for reverse subtraction
    
    Returns:
    
    Copy of array after reverse subtraction
  - rsubi
```
public INDArray rsubi(Number n)
```
    Description copied from interface: INDArray
    
    Reverse subtraction in place - i.e., (n - thisArrayValues)
    
    Specified by:
    
    rsubi in interface INDArray
    
    Parameters:
    
    n - Value to use for reverse subtraction
    
    Returns:
    
    This array after reverse subtraction
  - div
```
public INDArray div(Number n)
```
    Description copied from interface: INDArray
    
    Division by a number
    
    Specified by:
    
    div in interface INDArray
    
    Parameters:
    
    n - Number to divide values by
    
    Returns:
    
    Copy of array after division
  - divi
```
public INDArray divi(Number n)
```
    Description copied from interface: INDArray
    
    In place scalar division
    
    Specified by:
    
    divi in interface INDArray
    
    Parameters:
    
    n - Number to divide values by
    
    Returns:
    
    This array, after applying division operation
  - mul
```
public INDArray mul(Number n)
```
    Description copied from interface: INDArray
    
    Scalar multiplication (copy)
    
    Specified by:
    
    mul in interface INDArray
    
    Parameters:
    
    n - the number to multiply by
    
    Returns:
    
    a copy of this ndarray multiplied by the given number
  - muli
```
public INDArray muli(Number n)
```
    Description copied from interface: INDArray
    
    In place scalar multiplication
    
    Specified by:
    
    muli in interface INDArray
    
    Parameters:
    
    n - The number to multiply by
    
    Returns:
    
    This array, after applying scaler multiplication
  - sub
```
public INDArray sub(Number n)
```
    Description copied from interface: INDArray
    
    Scalar subtraction (copied)
    
    Specified by:
    
    sub in interface INDArray
    
    Parameters:
    
    n - the number to subtract by
    
    Returns:
    
    Copy of this array after applying subtraction operation
  - subi
```
public INDArray subi(Number n)
```
    Description copied from interface: INDArray
    
    In place scalar subtraction
    
    Specified by:
    
    subi in interface INDArray
    
    Parameters:
    
    n - Number to subtract
    
    Returns:
    
    This array, after applying subtraction operation
  - add
```
public INDArray add(Number n)
```
    Description copied from interface: INDArray
    
    Scalar addition (cloning)
    
    Specified by:
    
    add in interface INDArray
    
    Parameters:
    
    n - the number to add
    
    Returns:
    
    a clone with this matrix + the given number
  - addi
```
public INDArray addi(Number n)
```
    Description copied from interface: INDArray
    
    In place scalar addition
    
    Specified by:
    
    addi in interface INDArray
    
    Parameters:
    
    n - Number to add
    
    Returns:
    
    This array, after adding value
  - rdiv
```
public INDArray rdiv(Number n,
                     INDArray result)
```
    Description copied from interface: INDArray
    
    Reverse division (number / ndarray)
    
    Specified by:
    
    rdiv in interface INDArray
    
    Parameters:
    
    n - the number to divide by
    
    result - Array to place the result in. Must match shape of this array
    
    Returns:
    
    Result array
  - rdivi
```
public INDArray rdivi(Number n,
                      INDArray result)
```
    Description copied from interface: INDArray
    
    Reverse in place division
    
    Specified by:
    
    rdivi in interface INDArray
    
    Parameters:
    
    n - the number to divide by by
    
    result - the result ndarray
    
    Returns:
    
    the result ndarray
  - rsub
```
public INDArray rsub(Number n,
                     INDArray result)
```
    Description copied from interface: INDArray
    
    Reverse subtraction
    
    Specified by:
    
    rsub in interface INDArray
    
    Parameters:
    
    n - the number to subtract by
    
    result - the result ndarray
    
    Returns:
  - rsubi
```
public INDArray rsubi(Number n,
                      INDArray result)
```
    Description copied from interface: INDArray
    
    Reverse in place subtraction
    
    Specified by:
    
    rsubi in interface INDArray
    
    Parameters:
    
    n - the number to subtract by
    
    result - the result ndarray
    
    Returns:
    
    the result ndarray
  - div
```
public INDArray div(Number n,
                    INDArray result)
```
    Specified by:
    
    div in interface INDArray
    
    Returns:
  - divi
```
public INDArray divi(Number n,
                     INDArray result)
```
    Description copied from interface: INDArray
    
    In place division of this ndarray
    
    Specified by:
    
    divi in interface INDArray
    
    Parameters:
    
    n - the number to divide by
    
    result - the result ndarray
    
    Returns:
  - mul
```
public INDArray mul(Number n,
                    INDArray result)
```
    Specified by:
    
    mul in interface INDArray
  - muli
```
public INDArray muli(Number n,
                     INDArray result)
```
    Description copied from interface: INDArray
    
    In place multiplication of this ndarray
    
    Specified by:
    
    muli in interface INDArray
    
    Parameters:
    
    n - the number to divide by
    
    result - the result ndarray
    
    Returns:
  - sub
```
public INDArray sub(Number n,
                    INDArray result)
```
    Specified by:
    
    sub in interface INDArray
  - subi
```
public INDArray subi(Number n,
                     INDArray result)
```
    Description copied from interface: INDArray
    
    In place subtraction of this ndarray
    
    Specified by:
    
    subi in interface INDArray
    
    Parameters:
    
    n - the number to subtract by
    
    result - the result ndarray
    
    Returns:
    
    the result ndarray
  - add
```
public INDArray add(Number n,
                    INDArray result)
```
    Specified by:
    
    add in interface INDArray
  - addi
```
public INDArray addi(Number n,
                     INDArray result)
```
    Description copied from interface: INDArray
    
    In place addition
    
    Specified by:
    
    addi in interface INDArray
    
    Parameters:
    
    n - the number to add
    
    result - the result ndarray
    
    Returns:
    
    the result ndarray
  - get
```
public INDArray get(INDArrayIndex... indexes)
```
    Description copied from interface: INDArray
    
    Returns a subset of this array based on the specified indexes
    
    Specified by:
    
    get in interface INDArray
    
    Parameters:
    
    indexes - the indexes in to the array
    
    Returns:
    
    a view of the array with the specified indices
  - getColumns
```
public INDArray getColumns(int... columns)
```
    Description copied from interface: INDArray
    
    Get an INDArray comprised of the specified columns only. Copy operation.
    
    Specified by:
    
    getColumns in interface INDArray
    
    Parameters:
    
    columns - Columns to extract out of the current array
    
    Returns:
    
    Array with only the specified columns
  - getRows
```
public INDArray getRows(int... rows)
```
    Description copied from interface: INDArray
    
    Get an INDArray comprised of the specified rows only. Copy operation
    
    Specified by:
    
    getRows in interface INDArray
    
    Parameters:
    
    rows - Rose to extract from this array
    
    Returns:
    
    Array with only the specified rows
  - rdiv
```
public INDArray rdiv(INDArray other)
```
    Description copied from interface: INDArray
    
    Reverse division, elements wise. i.e., other / this
    
    Specified by:
    
    rdiv in interface INDArray
    
    Parameters:
    
    other - the matrix to divide from
    
    Returns:
    
    Copy of this array after performing element wise reverse division
  - rdivi
```
public INDArray rdivi(INDArray other)
```
    Description copied from interface: INDArray
    
    Reverse divsion (in place). i.e., other / this
    
    Specified by:
    
    rdivi in interface INDArray
    
    Parameters:
    
    other - The matrix to divide from
    
    Returns:
    
    This array after performing element wise reverse division
  - rdiv
```
public INDArray rdiv(INDArray other,
                     INDArray result)
```
    Description copied from interface: INDArray
    
    Reverse division
    
    Specified by:
    
    rdiv in interface INDArray
    
    Parameters:
    
    other - the matrix to subtract from
    
    result - the result ndarray
    
    Returns:
  - rdivi
```
public INDArray rdivi(INDArray other,
                      INDArray result)
```
    Description copied from interface: INDArray
    
    Reverse division (in-place)
    
    Specified by:
    
    rdivi in interface INDArray
    
    Parameters:
    
    other - the other ndarray to subtract
    
    result - the result ndarray
    
    Returns:
    
    the ndarray with the operation applied
  - rsub
```
public INDArray rsub(INDArray other,
                     INDArray result)
```
    Description copied from interface: INDArray
    
    Reverse subtraction
    
    Specified by:
    
    rsub in interface INDArray
    
    Parameters:
    
    other - the matrix to subtract from
    
    result - the result ndarray
    
    Returns:
  - rsub
```
public INDArray rsub(INDArray other)
```
    Description copied from interface: INDArray
    
    Element-wise reverse subtraction (copy op). i.e., other - this
    
    Specified by:
    
    rsub in interface INDArray
    
    Parameters:
    
    other - Other array to use in reverse subtraction
    
    Returns:
    
    Copy of this array, after applying reverse subtraction
  - rsubi
```
public INDArray rsubi(INDArray other)
```
    Description copied from interface: INDArray
    
    Element-wise reverse subtraction (in the place op) - i.e., other - this
    
    Specified by:
    
    rsubi in interface INDArray
    
    Parameters:
    
    other - Other way to use in reverse subtraction operation
    
    Returns:
    
    This array, after applying reverse subtraction
  - rsubi
```
public INDArray rsubi(INDArray other,
                      INDArray result)
```
    Description copied from interface: INDArray
    
    Reverse subtraction (in-place)
    
    Specified by:
    
    rsubi in interface INDArray
    
    Parameters:
    
    other - the other ndarray to subtract
    
    result - the result ndarray
    
    Returns:
    
    the ndarray with the operation applied
  - assign
```
public INDArray assign(Number value)
```
    Description copied from interface: INDArray
    
    Set all entries of the ndarray to the specified value
    
    Specified by:
    
    assign in interface INDArray
    
    Parameters:
    
    value - the value to assign
    
    Returns:
    
    the ndarray with the values
  - linearIndex
```
public int linearIndex(int i)
```
    Description copied from interface: INDArray
    
    Get the linear index of the data in to the array
    
    Specified by:
    
    linearIndex in interface INDArray
    
    Parameters:
    
    i - the index to getScalar
    
    Returns:
    
    the linear index in to the data
  - checkDimensions
```
public void checkDimensions(INDArray other)
```
    Description copied from interface: INDArray
    
    Validate dimensions are equal
    
    Specified by:
    
    checkDimensions in interface INDArray
    
    Parameters:
    
    other - the other ndarray to compare
  - sliceVectors
```
public void sliceVectors(List<INDArray> list)
```
    Specified by:
    
    sliceVectors in interface INDArray
  - putSlice
```
public INDArray putSlice(int slice,
                         INDArray put)
```
    Description copied from interface: INDArray
    
    Assigns the given matrix (put) to the specified slice
    
    Specified by:
    
    putSlice in interface INDArray
    
    Parameters:
    
    slice - the slice to assign
    
    put - the slice to applyTransformToDestination
    
    Returns:
    
    this for chainability
  - cond
```
public INDArray cond(Condition condition)
```
    Description copied from interface: INDArray
    
    1 in the ndarray if the element matches the condition 0 otherwise
    
    Specified by:
    
    cond in interface INDArray
    
    Parameters:
    
    condition - Condition to apply
    
    Returns:
    
    Copy of this array with values 0 (condition does not apply), or one (condition applies)
  - condi
```
public INDArray condi(Condition condition)
```
    Description copied from interface: INDArray
    
    In-place: 1 in the ndarray if the element matches the condition 0 otherwise
    
    Specified by:
    
    condi in interface INDArray
    
    Parameters:
    
    condition - Condition to apply
    
    Returns:
    
    This array, modified with values 0 (condition does not apply), or one (condition applies)
  - repmat
```
public INDArray repmat(int... shape)
```
    Description copied from interface: INDArray
    
    Replicate and tile array to fill out to the given shape
    
    Specified by:
    
    repmat in interface INDArray
    
    Parameters:
    
    shape - the new shape of this ndarray
    
    Returns:
    
    the shape to fill out to
  - repeat
```
public INDArray repeat(int dimension,
                       int... repeats)
```
    Description copied from interface: INDArray
    
    Repeat elements along a specified dimension.
    
    Specified by:
    
    repeat in interface INDArray
    
    Parameters:
    
    dimension - the dimension to repeat
    
    repeats - the number of elements to repeat on each element
    
    Returns:
  - putRow
```
public INDArray putRow(int row,
                       INDArray toPut)
```
    Description copied from interface: INDArray
    
    Insert a row in to this array Will throw an exception if this ndarray is not a matrix
    
    Specified by:
    
    putRow in interface INDArray
    
    Parameters:
    
    row - the row insert into
    
    toPut - the row to insert
    
    Returns:
    
    this
  - putColumn
```
public INDArray putColumn(int column,
                          INDArray toPut)
```
    Description copied from interface: INDArray
    
    Insert a column in to this array Will throw an exception if this ndarray is not a matrix
    
    Specified by:
    
    putColumn in interface INDArray
    
    Parameters:
    
    column - the column to insert
    
    toPut - the array to put
    
    Returns:
    
    this
  - getScalar
```
public INDArray getScalar(int row,
                          int column)
```
    Description copied from interface: INDArray
    
    Returns the element at the specified row/column This will throw an exception if the
    
    Specified by:
    
    getScalar in interface INDArray
    
    Parameters:
    
    row - the row of the element to return
    
    column - the row of the element to return
    
    Returns:
    
    a scalar indarray of the element at this index
  - getScalar
```
public INDArray getScalar(int i)
```
    Description copied from interface: INDArray
    
    Returns the element at the specified index
    
    Specified by:
    
    getScalar in interface INDArray
    
    Parameters:
    
    i - the index of the element to return
    
    Returns:
    
    a scalar ndarray of the element at this index
  - index
```
public int index(int row,
                 int column)
```
    Description copied from interface: INDArray
    
    Return the linear index of the specified row and column
    
    Specified by:
    
    index in interface INDArray
    
    Parameters:
    
    row - the row to getScalar the linear index for
    
    column - the column to getScalar the linear index for
    
    Returns:
    
    the linear index of the given row and column
  - squaredDistance
```
public double squaredDistance(INDArray other)
```
    Description copied from interface: INDArray
    
    Returns the square of the Euclidean distance.
    
    Specified by:
    
    squaredDistance in interface INDArray
  - distance2
```
public double distance2(INDArray other)
```
    Description copied from interface: INDArray
    
    Returns the (euclidean) distance.
    
    Specified by:
    
    distance2 in interface INDArray
  - distance1
```
public double distance1(INDArray other)
```
    Description copied from interface: INDArray
    
    Returns the (1-norm) distance.
    
    Specified by:
    
    distance1 in interface INDArray
  - put
```
public INDArray put(INDArrayIndex[] indices,
                    INDArray element)
```
    Description copied from interface: INDArray
    
    Put the elements of the ndarray in to the specified indices
    
    Specified by:
    
    put in interface INDArray
    
    Parameters:
    
    indices - the indices to put the ndarray in to
    
    element - the ndarray to put
    
    Returns:
    
    this ndarray
  - put
```
public INDArray put(INDArrayIndex[] indices,
                    Number element)
```
    Description copied from interface: INDArray
    
    Put the elements of the ndarray in to the specified indices
    
    Specified by:
    
    put in interface INDArray
    
    Parameters:
    
    indices - the indices to put the ndarray in to
    
    element - the ndarray to put
    
    Returns:
    
    this ndarray
  - put
```
public INDArray put(int[] indices,
                    INDArray element)
```
    Description copied from interface: INDArray
    
    Inserts the element at the specified index
    
    Specified by:
    
    put in interface INDArray
    
    Parameters:
    
    indices - the indices to insert into
    
    element - a scalar ndarray
    
    Returns:
    
    a scalar ndarray of the element at this index
  - put
```
public INDArray put(int i,
                    int j,
                    INDArray element)
```
    Description copied from interface: INDArray
    
    Inserts the element at the specified index
    
    Specified by:
    
    put in interface INDArray
    
    Parameters:
    
    i - the row insert into
    
    j - the column to insert into
    
    element - a scalar ndarray
    
    Returns:
    
    a scalar ndarray of the element at this index
  - put
```
public INDArray put(int i,
                    int j,
                    Number element)
```
    Description copied from interface: INDArray
    
    Inserts the element at the specified index
    
    Specified by:
    
    put in interface INDArray
    
    Parameters:
    
    i - the row insert into
    
    j - the column to insert into
    
    element - a scalar ndarray
    
    Returns:
    
    a scalar ndarray of the element at this index
  - put
```
public INDArray put(int i,
                    INDArray element)
```
    Description copied from interface: INDArray
    
    Inserts the element at the specified index
    
    Specified by:
    
    put in interface INDArray
    
    Parameters:
    
    i - the index insert into
    
    element - a scalar ndarray
    
    Returns:
    
    a scalar ndarray of the element at this index
  - diviColumnVector
```
public INDArray diviColumnVector(INDArray columnVector)
```
    Description copied from interface: INDArray
    
    In place division of a column vector
    
    Specified by:
    
    diviColumnVector in interface INDArray
    
    Parameters:
    
    columnVector - the column vector used for division
    
    Returns:
    
    the result of the division
  - divColumnVector
```
public INDArray divColumnVector(INDArray columnVector)
```
    Description copied from interface: INDArray
    
    Division of a column vector (copy)
    
    Specified by:
    
    divColumnVector in interface INDArray
    
    Parameters:
    
    columnVector - the column vector used for division
    
    Returns:
    
    the result of the division
  - diviRowVector
```
public INDArray diviRowVector(INDArray rowVector)
```
    Description copied from interface: INDArray
    
    In place division of a row vector
    
    Specified by:
    
    diviRowVector in interface INDArray
    
    Parameters:
    
    rowVector - the row vector used for division
    
    Returns:
    
    the result of the division
  - divRowVector
```
public INDArray divRowVector(INDArray rowVector)
```
    Description copied from interface: INDArray
    
    Division of a row vector (copy)
    
    Specified by:
    
    divRowVector in interface INDArray
    
    Parameters:
    
    rowVector - the row vector used for division
    
    Returns:
    
    the result of the division
  - rdiviColumnVector
```
public INDArray rdiviColumnVector(INDArray columnVector)
```
    Description copied from interface: INDArray
    
    In place reverse divison of a column vector
    
    Specified by:
    
    rdiviColumnVector in interface INDArray
    
    Parameters:
    
    columnVector - the column vector used for division
    
    Returns:
    
    the result of the division
  - rdivColumnVector
```
public INDArray rdivColumnVector(INDArray columnVector)
```
    Description copied from interface: INDArray
    
    Reverse division of a column vector (copy)
    
    Specified by:
    
    rdivColumnVector in interface INDArray
    
    Parameters:
    
    columnVector - the column vector used for division
    
    Returns:
    
    the result of the division
  - rdiviRowVector
```
public INDArray rdiviRowVector(INDArray rowVector)
```
    Description copied from interface: INDArray
    
    In place reverse division of a column vector
    
    Specified by:
    
    rdiviRowVector in interface INDArray
    
    Parameters:
    
    rowVector - the row vector used for division
    
    Returns:
    
    the result of the division
  - rdivRowVector
```
public INDArray rdivRowVector(INDArray rowVector)
```
    Description copied from interface: INDArray
    
    Reverse division of a column vector (copy)
    
    Specified by:
    
    rdivRowVector in interface INDArray
    
    Parameters:
    
    rowVector - the row vector used for division
    
    Returns:
    
    the result of the division
  - muliColumnVector
```
public INDArray muliColumnVector(INDArray columnVector)
```
    Description copied from interface: INDArray
    
    In place multiplication of a column vector
    
    Specified by:
    
    muliColumnVector in interface INDArray
    
    Parameters:
    
    columnVector - the column vector used for multiplication
    
    Returns:
    
    the result of the multiplication
  - mulColumnVector
```
public INDArray mulColumnVector(INDArray columnVector)
```
    Description copied from interface: INDArray
    
    Multiplication of a column vector (copy)
    
    Specified by:
    
    mulColumnVector in interface INDArray
    
    Parameters:
    
    columnVector - the column vector used for multiplication
    
    Returns:
    
    the result of the multiplication
  - muliRowVector
```
public INDArray muliRowVector(INDArray rowVector)
```
    Description copied from interface: INDArray
    
    In place multiplication of a row vector
    
    Specified by:
    
    muliRowVector in interface INDArray
    
    Parameters:
    
    rowVector - the row vector used for multiplication
    
    Returns:
    
    the result of the multiplication
  - mulRowVector
```
public INDArray mulRowVector(INDArray rowVector)
```
    Description copied from interface: INDArray
    
    Multiplication of a row vector (copy)
    
    Specified by:
    
    mulRowVector in interface INDArray
    
    Parameters:
    
    rowVector - the row vector used for multiplication
    
    Returns:
    
    the result of the multiplication
  - rsubiColumnVector
```
public INDArray rsubiColumnVector(INDArray columnVector)
```
    Description copied from interface: INDArray
    
    In place reverse subtraction of a column vector
    
    Specified by:
    
    rsubiColumnVector in interface INDArray
    
    Parameters:
    
    columnVector - the column vector to subtract
    
    Returns:
    
    the result of the subtraction
  - rsubColumnVector
```
public INDArray rsubColumnVector(INDArray columnVector)
```
    Description copied from interface: INDArray
    
    Reverse subtraction of a column vector (copy)
    
    Specified by:
    
    rsubColumnVector in interface INDArray
    
    Parameters:
    
    columnVector - the column vector to subtract
    
    Returns:
    
    the result of the subtraction
  - rsubiRowVector
```
public INDArray rsubiRowVector(INDArray rowVector)
```
    Description copied from interface: INDArray
    
    In place reverse subtraction of a row vector
    
    Specified by:
    
    rsubiRowVector in interface INDArray
    
    Parameters:
    
    rowVector - the row vector to subtract
    
    Returns:
    
    the result of the subtraction
  - rsubRowVector
```
public INDArray rsubRowVector(INDArray rowVector)
```
    Description copied from interface: INDArray
    
    Reverse subtraction of a row vector (copy)
    
    Specified by:
    
    rsubRowVector in interface INDArray
    
    Parameters:
    
    rowVector - the row vector to subtract
    
    Returns:
    
    the result of the subtraction
  - subiColumnVector
```
public INDArray subiColumnVector(INDArray columnVector)
```
    Description copied from interface: INDArray
    
    In place subtraction of a column vector
    
    Specified by:
    
    subiColumnVector in interface INDArray
    
    Parameters:
    
    columnVector - the column vector to subtract
    
    Returns:
    
    the result of the subtraction
  - subColumnVector
```
public INDArray subColumnVector(INDArray columnVector)
```
    Description copied from interface: INDArray
    
    Subtraction of a column vector (copy)
    
    Specified by:
    
    subColumnVector in interface INDArray
    
    Parameters:
    
    columnVector - the column vector to subtract
    
    Returns:
    
    the result of the subtraction
  - subiRowVector
```
public INDArray subiRowVector(INDArray rowVector)
```
    Description copied from interface: INDArray
    
    In place subtraction of a row vector
    
    Specified by:
    
    subiRowVector in interface INDArray
    
    Parameters:
    
    rowVector - the row vector to subtract
    
    Returns:
    
    the result of the subtraction
  - subRowVector
```
public INDArray subRowVector(INDArray rowVector)
```
    Description copied from interface: INDArray
    
    Subtraction of a row vector (copy)
    
    Specified by:
    
    subRowVector in interface INDArray
    
    Parameters:
    
    rowVector - the row vector to subtract
    
    Returns:
    
    the result of the subtraction
  - addiColumnVector
```
public INDArray addiColumnVector(INDArray columnVector)
```
    Description copied from interface: INDArray
    
    In place addition of a column vector
    
    Specified by:
    
    addiColumnVector in interface INDArray
    
    Parameters:
    
    columnVector - the column vector to add
    
    Returns:
    
    the result of the addition
  - addColumnVector
```
public INDArray addColumnVector(INDArray columnVector)
```
    Description copied from interface: INDArray
    
    Addition of a column vector (copy)
    
    Specified by:
    
    addColumnVector in interface INDArray
    
    Parameters:
    
    columnVector - the column vector to add
    
    Returns:
    
    the result of the addition
  - addiRowVector
```
public INDArray addiRowVector(INDArray rowVector)
```
    Description copied from interface: INDArray
    
    In place addition of a row vector
    
    Specified by:
    
    addiRowVector in interface INDArray
    
    Parameters:
    
    rowVector - the row vector to add
    
    Returns:
    
    the result of the addition
  - addRowVector
```
public INDArray addRowVector(INDArray rowVector)
```
    Description copied from interface: INDArray
    
    Addition of a row vector (copy)
    
    Specified by:
    
    addRowVector in interface INDArray
    
    Parameters:
    
    rowVector - the row vector to add
    
    Returns:
    
    the result of the addition
  - mmul
```
public INDArray mmul(INDArray other)
```
    Description copied from interface: INDArray
    
    Perform a copy matrix multiplication
    
    Specified by:
    
    mmul in interface INDArray
    
    Parameters:
    
    other - the other matrix to perform matrix multiply with
    
    Returns:
    
    the result of the matrix multiplication
  - mmul
```
public INDArray mmul(INDArray other,
                     INDArray result)
```
    Description copied from interface: INDArray
    
    Perform an copy matrix multiplication
    
    Specified by:
    
    mmul in interface INDArray
    
    Parameters:
    
    other - the other matrix to perform matrix multiply with
    
    result - the result ndarray
    
    Returns:
    
    the result of the matrix multiplication
  - div
```
public INDArray div(INDArray other)
```
    Description copied from interface: INDArray
    
    Copy (element wise) division of two NDArrays
    
    Specified by:
    
    div in interface INDArray
    
    Parameters:
    
    other - the second ndarray to divide
    
    Returns:
    
    the result of the divide
  - div
```
public INDArray div(INDArray other,
                    INDArray result)
```
    Description copied from interface: INDArray
    
    copy (element wise) division of two NDArrays
    
    Specified by:
    
    div in interface INDArray
    
    Parameters:
    
    other - the second ndarray to divide
    
    result - the result ndarray
    
    Returns:
    
    the result of the divide
  - mul
```
public INDArray mul(INDArray other)
```
    Description copied from interface: INDArray
    
    copy (element wise) multiplication of two NDArrays
    
    Specified by:
    
    mul in interface INDArray
    
    Parameters:
    
    other - the second ndarray to multiply
    
    Returns:
    
    the result of the addition
  - mul
```
public INDArray mul(INDArray other,
                    INDArray result)
```
    Description copied from interface: INDArray
    
    copy (element wise) multiplication of two NDArrays
    
    Specified by:
    
    mul in interface INDArray
    
    Parameters:
    
    other - the second ndarray to multiply
    
    result - the result ndarray
    
    Returns:
    
    the result of the multiplication
  - sub
```
public INDArray sub(INDArray other)
```
    Description copied from interface: INDArray
    
    copy subtraction of two NDArrays
    
    Specified by:
    
    sub in interface INDArray
    
    Parameters:
    
    other - the second ndarray to subtract
    
    Returns:
    
    the result of the addition
  - sub
```
public INDArray sub(INDArray other,
                    INDArray result)
```
    Description copied from interface: INDArray
    
    copy subtraction of two NDArrays
    
    Specified by:
    
    sub in interface INDArray
    
    Parameters:
    
    other - the second ndarray to subtract
    
    result - the result ndarray
    
    Returns:
    
    the result of the subtraction
  - add
```
public INDArray add(INDArray other)
```
    Description copied from interface: INDArray
    
    Element-wise copy addition of two NDArrays
    
    Specified by:
    
    add in interface INDArray
    
    Parameters:
    
    other - the second ndarray to add
    
    Returns:
    
    the result of the addition
  - add
```
public INDArray add(INDArray other,
                    INDArray result)
```
    Description copied from interface: INDArray
    
    Element-wise copy addition of two NDArrays
    
    Specified by:
    
    add in interface INDArray
    
    Parameters:
    
    other - the second ndarray to add
    
    result - the result ndarray
    
    Returns:
    
    the result of the addition
  - mmuli
```
public INDArray mmuli(INDArray other)
```
    Description copied from interface: INDArray
    
    Perform an inplace matrix multiplication
    
    Specified by:
    
    mmuli in interface INDArray
    
    Parameters:
    
    other - the other matrix to perform matrix multiply with
    
    Returns:
    
    the result of the matrix multiplication
  - mmuli
```
public INDArray mmuli(INDArray other,
                      INDArray result)
```
    Description copied from interface: INDArray
    
    Perform an inplace matrix multiplication
    
    Specified by:
    
    mmuli in interface INDArray
    
    Parameters:
    
    other - the other matrix to perform matrix multiply with
    
    result - the result ndarray
    
    Returns:
    
    the result of the matrix multiplication
  - divi
```
public INDArray divi(INDArray other)
```
    Description copied from interface: INDArray
    
    in place (element wise) division of two NDArrays
    
    Specified by:
    
    divi in interface INDArray
    
    Parameters:
    
    other - the second ndarray to divide
    
    Returns:
    
    the result of the divide
  - divi
```
public INDArray divi(INDArray other,
                     INDArray result)
```
    Description copied from interface: INDArray
    
    in place (element wise) division of two NDArrays
    
    Specified by:
    
    divi in interface INDArray
    
    Parameters:
    
    other - the second ndarray to divide
    
    result - the result ndarray
    
    Returns:
    
    the result of the divide
  - muli
```
public INDArray muli(INDArray other)
```
    Description copied from interface: INDArray
    
    in place (element wise) multiplication of two NDArrays
    
    Specified by:
    
    muli in interface INDArray
    
    Parameters:
    
    other - the second ndarray to multiply
    
    Returns:
    
    the result of the multiplication
  - muli
```
public INDArray muli(INDArray other,
                     INDArray result)
```
    Description copied from interface: INDArray
    
    in place (element wise) multiplication of two NDArrays
    
    Specified by:
    
    muli in interface INDArray
    
    Parameters:
    
    other - the second ndarray to multiply
    
    result - the result ndarray
    
    Returns:
    
    the result of the multiplication
  - subi
```
public INDArray subi(INDArray other)
```
    Description copied from interface: INDArray
    
    in place (element wise) subtraction of two NDArrays
    
    Specified by:
    
    subi in interface INDArray
    
    Parameters:
    
    other - the second ndarray to subtract
    
    Returns:
    
    the result of the subtraction
  - subi
```
public INDArray subi(INDArray other,
                     INDArray result)
```
    Description copied from interface: INDArray
    
    in place (element wise) subtraction of two NDArrays
    
    Specified by:
    
    subi in interface INDArray
    
    Parameters:
    
    other - the second ndarray to subtract
    
    result - the result ndarray
    
    Returns:
    
    the result of the subtraction
  - addi
```
public INDArray addi(INDArray other)
```
    Description copied from interface: INDArray
    
    in place (element wise) addition of two NDArrays
    
    Specified by:
    
    addi in interface INDArray
    
    Parameters:
    
    other - the second ndarray to add
    
    Returns:
    
    the result of the addition
  - addi
```
public INDArray addi(INDArray other,
                     INDArray result)
```
    Description copied from interface: INDArray
    
    in place (element wise) addition of two NDArrays
    
    Specified by:
    
    addi in interface INDArray
    
    Parameters:
    
    other - the second ndarray to add
    
    result - the result ndarray
    
    Returns:
    
    the result of the addition
  - normmax
```
public INDArray normmax(int... dimension)
```
    Description copied from interface: INDArray
    
    Returns the max norm (aka infinity norm, equal to the maximum absolute value) along the specified dimension(s)
    
    Specified by:
    
    normmax in interface INDArray
    
    Parameters:
    
    dimension - the dimension to the max norm along
    
    Returns:
    
    Max norm along the specified dimension
  - normmaxNumber
```
public Number normmaxNumber()
```
    Description copied from interface: INDArray
    
    Return the max norm (aka infinity norm, equal to the maximum absolute value) for the entire array
    
    Specified by:
    
    normmaxNumber in interface INDArray
    
    Returns:
    
    Max norm for the entire array
  - normmaxComplex
```
public IComplexNumber normmaxComplex()
```
    Specified by:
    
    normmaxComplex in interface INDArray
    
    Returns:
  - norm2
```
public INDArray norm2(int... dimension)
```
    Description copied from interface: INDArray
    
    Returns the norm2 (L2 norm, sqrt(sum(x_i^2), also known as Euclidean norm) along the specified dimension(s)
    
    Specified by:
    
    norm2 in interface INDArray
    
    Parameters:
    
    dimension - the dimension to getScalar the norm2 along
    
    Returns:
    
    the norm2 along the specified dimension
  - norm2Number
```
public Number norm2Number()
```
    Description copied from interface: INDArray
    
    Return the norm2 (L2 norm, sqrt(sum(x_i^2), also known as Euclidean norm) for the entire array
    
    Specified by:
    
    norm2Number in interface INDArray
    
    Returns:
    
    L2 norm for the array
  - norm2Complex
```
public IComplexNumber norm2Complex()
```
    Specified by:
    
    norm2Complex in interface INDArray
    
    Returns:
  - norm1
```
public INDArray norm1(int... dimension)
```
    Description copied from interface: INDArray
    
    Returns the norm1 (L1 norm, i.e., sum of absolute values; also known as Taxicab or Manhattan norm) along the specified dimension
    
    Specified by:
    
    norm1 in interface INDArray
    
    Parameters:
    
    dimension - the dimension to getScalar the norm1 along
    
    Returns:
    
    the norm1 along the specified dimension
  - norm1Number
```
public Number norm1Number()
```
    Description copied from interface: INDArray
    
    Calculate and return norm1 (L1 norm, i.e., sum of absolute values; also known as Taxicab or Manhattan norm) for the entire array
    
    Specified by:
    
    norm1Number in interface INDArray
    
    Returns:
    
    Norm 1 for the array
  - norm1Complex
```
public IComplexNumber norm1Complex()
```
    Description copied from interface: INDArray
    
    Calculate and return norm1 (L1 norm, i.e., sum of absolute values; also known as Taxicab or Manhattan norm) for the entire array
    
    Specified by:
    
    norm1Complex in interface INDArray
    
    Returns:
  - std
```
public INDArray std(int... dimension)
```
    Description copied from interface: INDArray
    
    Standard deviation of an INDArray along one or more dimensions
    
    Specified by:
    
    std in interface INDArray
    
    Parameters:
    
    dimension - the dimension to getScalar the std along
    
    Returns:
    
    the standard deviation along a particular dimension
  - stdNumber
```
public Number stdNumber()
```
    Description copied from interface: INDArray
    
    Calculate the standard deviation for the entire array
    
    Specified by:
    
    stdNumber in interface INDArray
    
    Returns:
  - std
```
public INDArray std(boolean biasCorrected,
                    int... dimension)
```
    Description copied from interface: INDArray
    
    Standard deviation of an ndarray along a dimension
    
    Specified by:
    
    std in interface INDArray
    
    dimension - the dimension to getScalar the std along
    
    Returns:
    
    the standard deviation along a particular dimension
  - stdNumber
```
public Number stdNumber(boolean biasCorrected)
```
    Description copied from interface: INDArray
    
    Calculate the standard deviation for the entire array, specifying whether it is bias corrected or not
    
    Specified by:
    
    stdNumber in interface INDArray
    
    Parameters:
    
    biasCorrected - If true: bias corrected standard deviation. False: not bias corrected
    
    Returns:
    
    Standard dev
  - stdComplex
```
public IComplexNumber stdComplex()
```
    Specified by:
    
    stdComplex in interface INDArray
    
    Returns:
  - prod
```
public INDArray prod(int... dimension)
```
    Description copied from interface: INDArray
    
    Returns the product along a given dimension
    
    Specified by:
    
    prod in interface INDArray
    
    Parameters:
    
    dimension - the dimension to getScalar the product along
    
    Returns:
    
    the product along the specified dimension
  - prodNumber
```
public Number prodNumber()
```
    Description copied from interface: INDArray
    
    Calculate the product of all values in the array
    
    Specified by:
    
    prodNumber in interface INDArray
    
    Returns:
    
    Product of all values in the array
  - prodComplex
```
public IComplexNumber prodComplex()
```
    Specified by:
    
    prodComplex in interface INDArray
    
    Returns:
  - mean
```
public INDArray mean(int... dimension)
```
    Description copied from interface: INDArray
    
    Returns the overall mean of this ndarray
    
    Specified by:
    
    mean in interface INDArray
    
    Parameters:
    
    dimension - the dimension to getScalar the mean along
    
    Returns:
    
    the mean along the specified dimension of this ndarray
  - meanNumber
```
public Number meanNumber()
```
    Description copied from interface: INDArray
    
    Returns the overall mean of this ndarray
    
    Specified by:
    
    meanNumber in interface INDArray
    
    Returns:
    
    the mean along the specified dimension of this ndarray
  - meanComplex
```
public IComplexNumber meanComplex()
```
    Specified by:
    
    meanComplex in interface INDArray
  - var
```
public INDArray var(int... dimension)
```
    Description copied from interface: INDArray
    
    Returns the overall variance of this ndarray
    
    Specified by:
    
    var in interface INDArray
    
    Parameters:
    
    dimension - the dimension to getScalar the mean along
    
    Returns:
    
    the mean along the specified dimension of this ndarray
  - var
```
public INDArray var(boolean biasCorrected,
                    int... dimension)
```
    Description copied from interface: INDArray
    
    Returns the overall variance of this ndarray
    
    Specified by:
    
    var in interface INDArray
    
    Parameters:
    
    biasCorrected - boolean on whether to apply corrected bias
    
    dimension - the dimension to getScalar the mean along
    
    Returns:
    
    the mean along the specified dimension of this ndarray
  - varNumber
```
public Number varNumber()
```
    Description copied from interface: INDArray
    
    Returns the overall variance of all values in this INDArray
    
    Specified by:
    
    varNumber in interface INDArray
    
    Returns:
    
    variance
  - varComplex
```
public IComplexNumber varComplex()
```
    Specified by:
    
    varComplex in interface INDArray
    
    Returns:
  - max
```
public INDArray max(int... dimension)
```
    Description copied from interface: INDArray
    
    Returns the overall max of this ndarray along given dimensions
    
    Specified by:
    
    max in interface INDArray
    
    Parameters:
    
    dimension - the dimension to getScalar the mean along
    
    Returns:
    
    the mean along the specified dimension of this ndarray
  - maxNumber
```
public Number maxNumber()
```
    Description copied from interface: INDArray
    
    Returns maximum value in this INDArray
    
    Specified by:
    
    maxNumber in interface INDArray
    
    Returns:
    
    maximum value
  - maxComplex
```
public IComplexNumber maxComplex()
```
    Specified by:
    
    maxComplex in interface INDArray
    
    Returns:
  - min
```
public INDArray min(int... dimension)
```
    Description copied from interface: INDArray
    
    Returns the overall min of this ndarray
    
    Specified by:
    
    min in interface INDArray
    
    Parameters:
    
    dimension - the dimension to getScalar the mean along
    
    Returns:
    
    the mean along the specified dimension of this ndarray
  - minNumber
```
public Number minNumber()
```
    Description copied from interface: INDArray
    
    Returns min value in this INDArray
    
    Specified by:
    
    minNumber in interface INDArray
    
    Returns:
    
    Minimum value in the array
  - minComplex
```
public IComplexNumber minComplex()
```
    Specified by:
    
    minComplex in interface INDArray
  - sum
```
public INDArray sum(int... dimension)
```
    Description copied from interface: INDArray
    
    Returns the sum along the last dimension of this ndarray
    
    Specified by:
    
    sum in interface INDArray
    
    Parameters:
    
    dimension - the dimension to getScalar the sum along
    
    Returns:
    
    the sum along the specified dimension of this ndarray
  - sumNumber
```
public Number sumNumber()
```
    Description copied from interface: INDArray
    
    Sum the entire array
    
    Specified by:
    
    sumNumber in interface INDArray
    
    Returns:
    
    Sum of array
  - sumComplex
```
public IComplexNumber sumComplex()
```
    Description copied from interface: INDArray
    
    Sum the entire array
    
    Specified by:
    
    sumComplex in interface INDArray
    
    Returns:
  - setStride
```
public void setStride(int... stride)
```
    Description copied from interface: INDArray
    
    stride setter
    
    Specified by:
    
    setStride in interface INDArray
  - setShape
```
public void setShape(int... shape)
```
    Description copied from interface: INDArray
    
    Shape setter
    
    Specified by:
    
    setShape in interface INDArray
  - setShapeAndStride
```
public void setShapeAndStride(int[] shape,
                              int[] stride)
```
    Description copied from interface: INDArray
    
    Shape and stride setter
    
    Specified by:
    
    setShapeAndStride in interface INDArray
  - setOrder
```
public void setOrder(char order)
```
    Description copied from interface: INDArray
    
    Set the ordering
    
    Specified by:
    
    setOrder in interface INDArray
    
    Parameters:
    
    order - the ordering to set
  - subArray
```
public INDArray subArray(ShapeOffsetResolution resolution)
```
    Description copied from interface: INDArray
    
    Sub array based on the pre calculated shape,strides, offsets
    
    Specified by:
    
    subArray in interface INDArray
    
    Parameters:
    
    resolution - the resolution to use
    
    Returns:
    
    the sub array based on the calculations from the resolution
  - subArray
```
public INDArray subArray(long[] offsets,
                         int[] shape,
                         int[] stride)
```
    Specified by:
    
    subArray in interface INDArray
    
    Returns:
  - getScalar
```
public INDArray getScalar(int... indices)
```
    Description copied from interface: INDArray
    
    Returns the elements at the the specified indices
    
    Specified by:
    
    getScalar in interface INDArray
    
    Parameters:
    
    indices - the indices to getScalar
    
    Returns:
    
    the array with the specified elements
  - getInt
```
public int getInt(int... indices)
```
    Description copied from interface: INDArray
    
    Get an integer value at the specified indices. Result will be cast to an integer, precision loss is possible.
    
    Specified by:
    
    getInt in interface INDArray
    
    Parameters:
    
    indices - Indices to get the integer at. Number of indices must match the array rank.
    
    Returns:
    
    Integer value at the specified index
  - getDouble
```
public double getDouble(int... indices)
```
    Description copied from interface: INDArray
    
    Get a double value at the specified indices.
    
    Specified by:
    
    getDouble in interface INDArray
    
    Parameters:
    
    indices - Indices to get the double at. Number of indices must match the array rank.
    
    Returns:
    
    Double value at the specified index
  - getFloat
```
public float getFloat(int[] indices)
```
    Description copied from interface: INDArray
    
    Returns the elements at the the specified indices
    
    Specified by:
    
    getFloat in interface INDArray
    
    Parameters:
    
    indices - the indices to getScalar
    
    Returns:
    
    the array with the specified elements
  - getDouble
```
public double getDouble(int i)
```
    Description copied from interface: INDArray
    
    Get the double value at the specified linear index in the array
    
    Specified by:
    
    getDouble in interface INDArray
    
    Parameters:
    
    i - Index
    
    Returns:
    
    Double value at the specified index
  - getDouble
```
public double getDouble(int i,
                        int j)
```
    Description copied from interface: INDArray
    
    Get the double value at the specified indices. Can only be used for 2D (rank 2) arrays.
    
    Specified by:
    
    getDouble in interface INDArray
    
    Parameters:
    
    i - Dimension 0 (row) index
    
    j - Dimension 1 (column) index
    
    Returns:
  - getFloat
```
public float getFloat(int i)
```
    Description copied from interface: INDArray
    
    Return the item at the linear index i
    
    Specified by:
    
    getFloat in interface INDArray
    
    Parameters:
    
    i - the index of the item to getScalar
    
    Returns:
    
    the item at index j
  - getFloat
```
public float getFloat(int i,
                      int j)
```
    Description copied from interface: INDArray
    
    Return the item at row i column j Note that this is the same as calling getScalar(new int[]{i,j}
    
    Specified by:
    
    getFloat in interface INDArray
    
    Parameters:
    
    i - the row to getScalar
    
    j - the column to getScalar
    
    Returns:
    
    the item at row i column j
  - dup
```
public INDArray dup()
```
    Description copied from interface: INDArray
    
    Returns a copy of this ndarray
    
    Specified by:
    
    dup in interface INDArray
    
    Returns:
    
    a copy of this ndarray
  - dup
```
public INDArray dup(char order)
```
    Description copied from interface: INDArray
    
    Returns a copy of this ndarray, where the returned ndarray has the specified order
    
    Specified by:
    
    dup in interface INDArray
    
    Parameters:
    
    order - order of the NDArray. 'f' or 'c'
    
    Returns:
    
    copy of ndarray with specified order
  - ravel
```
public INDArray ravel()
```
    Description copied from interface: INDArray
    
    Returns a flattened version (row vector) of this ndarray
    
    Specified by:
    
    ravel in interface INDArray
    
    Returns:
    
    a flattened version (row vector) of this ndarray
  - ravel
```
public INDArray ravel(char order)
```
    Description copied from interface: INDArray
    
    Returns a flattened version (row vector) of this ndarray
    
    Specified by:
    
    ravel in interface INDArray
    
    Returns:
    
    a flattened version (row vector) of this ndarray
  - setData
```
public void setData(DataBuffer data)
```
    Specified by:
    
    setData in interface INDArray
  - slices
```
public int slices()
```
    Description copied from interface: INDArray
    
    Returns the number of slices in this ndarray
    
    Specified by:
    
    slices in interface INDArray
    
    Returns:
    
    the number of slices in this ndarray
  - getTrailingOnes
```
public int getTrailingOnes()
```
    Description copied from interface: INDArray
    
    Get the number of trailing ones in the array shape. For example, a rank 3 array with shape [10, 1, 1] would return 2 for this method
    
    Specified by:
    
    getTrailingOnes in interface INDArray
    
    Returns:
    
    Number of trailing ones in shape
  - getLeadingOnes
```
public int getLeadingOnes()
```
    Description copied from interface: INDArray
    
    Get the number of leading ones in the array shape. For example, a rank 3 array with shape [1, 10, 1] would return value 1 for this method
    
    Specified by:
    
    getLeadingOnes in interface INDArray
    
    Returns:
    
    Number of leading ones in shape
  - slice
```
public INDArray slice(int i,
                      int dimension)
```
    Description copied from interface: INDArray
    
    Returns the specified slice of this ndarray
    
    Specified by:
    
    slice in interface INDArray
    
    Parameters:
    
    i - the index of the slice to return
    
    dimension - the dimension to return the slice for
    
    Returns:
    
    the specified slice of this ndarray
  - slice
```
public INDArray slice(int i)
```
    Description copied from interface: INDArray
    
    Returns the specified slice of this ndarray
    
    Specified by:
    
    slice in interface INDArray
    
    Parameters:
    
    i - the index of the slice to return
    
    Returns:
    
    the specified slice of this ndarray
  - offset
```
public long offset()
```
    Description copied from interface: INDArray
    
    Returns the start of where the ndarray is for the underlying data
    
    Specified by:
    
    offset in interface INDArray
    
    Returns:
    
    the starting offset
  - originalOffset
```
public long originalOffset()
```
    Description copied from interface: INDArray
    
    Returns the start of where the ndarray is for the original data buffer
    
    Specified by:
    
    originalOffset in interface INDArray
    
    Returns:
  - reshape
```
public INDArray reshape(char order,
                        int... newShape)
```
    Description copied from interface: INDArray
    
    Reshapes the ndarray (can't change the length of the ndarray). Typically this will be a view, unless reshaping without copying is impossible.
    
    Specified by:
    
    reshape in interface INDArray
    
    newShape - the new shape of the ndarray
    
    Returns:
    
    the reshaped ndarray
  - reshape
```
public INDArray reshape(char order,
                        int rows,
                        int columns)
```
    Description copied from interface: INDArray
    
    Reshapes the ndarray (can't change the length of the ndarray). Typically this will be a view, unless reshaping without copying is impossible.
    
    Specified by:
    
    reshape in interface INDArray
    
    rows - the rows of the matrix
    
    columns - the columns of the matrix
    
    Returns:
    
    the reshaped ndarray
  - reshape
```
public INDArray reshape(int... newShape)
```
    Description copied from interface: INDArray
    
    Reshapes the ndarray (can't change the length of the ndarray). Typically this will be a view, unless reshaping without copying is impossible.
    
    Specified by:
    
    reshape in interface INDArray
    
    Parameters:
    
    newShape - the new shape of the ndarray
    
    Returns:
    
    the reshaped ndarray
  - reshape
```
public INDArray reshape(int rows,
                        int columns)
```
    Description copied from interface: INDArray
    
    Reshapes the ndarray (can't change the length of the ndarray). Typically this will be a view, unless reshaping without copying is impossible.
    
    Specified by:
    
    reshape in interface INDArray
    
    Parameters:
    
    rows - the rows of the matrix
    
    columns - the columns of the matrix
    
    Returns:
    
    the reshaped ndarray
  - transpose
```
public INDArray transpose()
```
    Description copied from interface: INDArray
    
    Flip the rows and columns of a matrix
    
    Specified by:
    
    transpose in interface INDArray
    
    Returns:
    
    the flipped rows and columns of a matrix
  - transposei
```
public INDArray transposei()
```
    Description copied from interface: INDArray
    
    Flip the rows and columns of a matrix, in-place
    
    Specified by:
    
    transposei in interface INDArray
    
    Returns:
    
    the flipped rows and columns of a matrix
  - swapAxes
```
public INDArray swapAxes(int dimension,
                         int with)
```
    Description copied from interface: INDArray
    
    Mainly here for people coming from numpy. This is equivalent to a call to permute
    
    Specified by:
    
    swapAxes in interface INDArray
    
    Parameters:
    
    dimension - the dimension to swap
    
    with - the one to swap it with
    
    Returns:
    
    the swapped axes view
  - permute
```
public INDArray permute(int... rearrange)
```
    Description copied from interface: INDArray
    
    See: http://www.mathworks.com/help/matlab/ref/permute.html
    
    Specified by:
    
    permute in interface INDArray
    
    Parameters:
    
    rearrange - the dimensions to swap to
    
    Returns:
    
    the newly permuted array
  - permutei
```
public INDArray permutei(int... rearrange)
```
    Description copied from interface: INDArray
    
    An in-place version of permute. The array shape information (shape, strides) is modified by this operation (but not the data itself) See: http://www.mathworks.com/help/matlab/ref/permute.html
    
    Specified by:
    
    permutei in interface INDArray
    
    Parameters:
    
    rearrange - the dimensions to swap to
    
    Returns:
    
    the current array
  - dimShuffle
```
public INDArray dimShuffle(Object[] rearrange,
                           int[] newOrder,
                           boolean[] broadCastable)
```
    Description copied from interface: INDArray
    
    Dimshuffle: an extension of permute that adds the ability to broadcast various dimensions. This will only accept integers and xs.
    An x indicates a dimension should be broadcasted rather than permuted. Examples originally from the theano docs: http://deeplearning.net/software/theano/library/tensor/basic.html Returns a view of this tensor with permuted dimensions. Typically the pattern will include the integers 0, 1, ... ndim-1, and any number of ‘x’ characters in dimensions where this tensor should be broadcasted. A few examples of patterns and their effect: (‘x’) -> make a 0d (scalar) into a 1d vector (0, 1) -> identity for 2d vectors (1, 0) -> inverts the first and second dimensions (‘x’, 0) -> make a row out of a 1d vector (N to 1xN) (0, ‘x’) -> make a column out of a 1d vector (N to Nx1) (2, 0, 1) -> AxBxC to CxAxB (0, ‘x’, 1) -> AxB to Ax1xB (1, ‘x’, 0) -> AxB to Bx1xA (1,) -> This remove dimensions 0. It must be a broadcastable dimension (1xA to A)
    
    Specified by:
    
    dimShuffle in interface INDArray
    
    Parameters:
    
    rearrange - the dimensions to swap to
    
    newOrder - the new order (think permute)
    
    broadCastable - (whether the dimension is broadcastable) (must be same length as new order)
    
    Returns:
    
    the newly permuted array
  - broadcast
```
public INDArray broadcast(INDArray result)
```
    Description copied from interface: INDArray
    
    Broadcasts this ndarray to be the specified shape
    
    Specified by:
    
    broadcast in interface INDArray
    
    Returns:
    
    the broadcasted ndarray
  - getColumn
```
public INDArray getColumn(int i)
```
    Description copied from interface: INDArray
    
    Returns the specified column. Throws an exception if its not a matrix
    
    Specified by:
    
    getColumn in interface INDArray
    
    Parameters:
    
    i - the column to getScalar
    
    Returns:
    
    the specified column
  - getRow
```
public INDArray getRow(int i)
```
    Description copied from interface: INDArray
    
    Returns the specified row. Throws an exception if its not a matrix
    
    Specified by:
    
    getRow in interface INDArray
    
    Parameters:
    
    i - the row to getScalar
    
    Returns:
    
    the specified row
  - columns
```
public int columns()
```
    Description copied from interface: INDArray
    
    Returns the number of columns in this matrix (throws exception if not 2d)
    
    Specified by:
    
    columns in interface INDArray
    
    Returns:
    
    the number of columns in this matrix
  - rows
```
public int rows()
```
    Description copied from interface: INDArray
    
    Returns the number of rows in this matrix (throws exception if not 2d)
    
    Specified by:
    
    rows in interface INDArray
    
    Returns:
    
    the number of rows in this matrix
  - isVector
```
public boolean isVector()
```
    Checks whether the matrix is a vector.
    
    Specified by:
    
    isVector in interface INDArray
    
    Returns:
    
    whether this ndarray is a vector
  - isVectorOrScalar
```
public boolean isVectorOrScalar()
```
    Description copied from interface: INDArray
    
    Returns true if this ndarray is a vector or scalar
    
    Specified by:
    
    isVectorOrScalar in interface INDArray
    
    Returns:
    
    whether this ndarray is a vector or scalar
  - isSquare
```
public boolean isSquare()
```
    Description copied from interface: INDArray
    
    Returns whether the matrix has the same rows and columns
    
    Specified by:
    
    isSquare in interface INDArray
    
    Returns:
    
    true if the matrix has the same rows and columns false otherwise
  - isRowVector
```
public boolean isRowVector()
```
    Checks whether the matrix is a row vector.
    
    Specified by:
    
    isRowVector in interface INDArray
    
    Returns:
    
    true if the number of rows is 1
  - isColumnVector
```
public boolean isColumnVector()
```
    Checks whether the matrix is a column vector.
    
    Specified by:
    
    isColumnVector in interface INDArray
    
    Returns:
    
    true if the number of columns is 1
  - isMatrix
```
public boolean isMatrix()
```
    Description copied from interface: INDArray
    
    Returns true if this ndarray is a matrix
    
    Specified by:
    
    isMatrix in interface INDArray
    
    Returns:
    
    whether this ndarray is a matrix
  - isScalar
```
public boolean isScalar()
```
    Description copied from interface: INDArray
    
    Returns true if this ndarray is a scalar
    
    Specified by:
    
    isScalar in interface INDArray
    
    Returns:
    
    whether this ndarray is a scalar
  - ordering
```
public char ordering()
```
    Description copied from interface: INDArray
    
    Return the ordering (fortran or c 'f' and 'c' respectively) of this ndarray
    
    Specified by:
    
    ordering in interface INDArray
    
    Returns:
    
    the ordering of this ndarray
  - shape
```
public int[] shape()
```
    Description copied from interface: INDArray
    
    Returns the shape of this ndarray
    
    Specified by:
    
    shape in interface INDArray
    
    Returns:
    
    the shape of this ndarray
  - shapeOf
```
protected DataBuffer shapeOf()
```
  - stride
```
public int[] stride()
```
    Description copied from interface: INDArray
    
    Returns the stride of this ndarray
    
    Specified by:
    
    stride in interface INDArray
    
    Returns:
    
    the stride of this ndarray
  - size
```
public int size(int dimension)
```
    Description copied from interface: INDArray
    
    Returns the size along a specified dimension
    
    Specified by:
    
    size in interface INDArray
    
    Parameters:
    
    dimension - the dimension to return the size for
    
    Returns:
    
    the size of the array along the specified dimension
  - setShapeInformation
```
protected void setShapeInformation(org.nd4j.linalg.primitives.Pair<DataBuffer,int[]> shapeInfo)
```
  - broadcast
```
public INDArray broadcast(int... shape)
```
    Description copied from interface: INDArray
    
    Broadcasts this ndarray to be the specified shape
    
    Specified by:
    
    broadcast in interface INDArray
    
    Parameters:
    
    shape - the new shape of this ndarray
    
    Returns:
    
    the broadcasted ndarray
  - element
```
public Object element()
```
    Description copied from interface: INDArray
    
    Returns a scalar (individual element) of a scalar ndarray
    
    Specified by:
    
    element in interface INDArray
    
    Returns:
    
    the individual item in this ndarray
  - rdiv
```
public IComplexNDArray rdiv(IComplexNumber n)
```
    Specified by:
    
    rdiv in interface INDArray
    
    Returns:
  - rdivi
```
public IComplexNDArray rdivi(IComplexNumber n)
```
    Specified by:
    
    rdivi in interface INDArray
    
    Returns:
  - rsub
```
public IComplexNDArray rsub(IComplexNumber n)
```
    Specified by:
    
    rsub in interface INDArray
    
    Returns:
  - rsubi
```
public IComplexNDArray rsubi(IComplexNumber n)
```
    Specified by:
    
    rsubi in interface INDArray
    
    Returns:
  - div
```
public IComplexNDArray div(IComplexNumber n)
```
    Specified by:
    
    div in interface INDArray
    
    Returns:
  - divi
```
public IComplexNDArray divi(IComplexNumber n)
```
    Specified by:
    
    divi in interface INDArray
    
    Returns:
  - mul
```
public IComplexNDArray mul(IComplexNumber n)
```
    Specified by:
    
    mul in interface INDArray
    
    Returns:
  - muli
```
public IComplexNDArray muli(IComplexNumber n)
```
    Specified by:
    
    muli in interface INDArray
    
    Returns:
  - sub
```
public IComplexNDArray sub(IComplexNumber n)
```
    Specified by:
    
    sub in interface INDArray
    
    Returns:
  - subi
```
public IComplexNDArray subi(IComplexNumber n)
```
    Specified by:
    
    subi in interface INDArray
    
    Returns:
  - add
```
public IComplexNDArray add(IComplexNumber n)
```
    Specified by:
    
    add in interface INDArray
    
    Returns:
  - addi
```
public IComplexNDArray addi(IComplexNumber n)
```
    Specified by:
    
    addi in interface INDArray
    
    Returns:
  - rdiv
```
public IComplexNDArray rdiv(IComplexNumber n,
                            IComplexNDArray result)
```
    Specified by:
    
    rdiv in interface INDArray
    
    Returns:
  - rdivi
```
public IComplexNDArray rdivi(IComplexNumber n,
                             IComplexNDArray result)
```
    Specified by:
    
    rdivi in interface INDArray
    
    Returns:
  - rsub
```
public IComplexNDArray rsub(IComplexNumber n,
                            IComplexNDArray result)
```
    Specified by:
    
    rsub in interface INDArray
    
    Returns:
  - rsubi
```
public IComplexNDArray rsubi(IComplexNumber n,
                             IComplexNDArray result)
```
    Specified by:
    
    rsubi in interface INDArray
    
    Returns:
  - div
```
public IComplexNDArray div(IComplexNumber n,
                           IComplexNDArray result)
```
    Specified by:
    
    div in interface INDArray
    
    Returns:
  - divi
```
public IComplexNDArray divi(IComplexNumber n,
                            IComplexNDArray result)
```
    Specified by:
    
    divi in interface INDArray
    
    Returns:
  - mul
```
public IComplexNDArray mul(IComplexNumber n,
                           IComplexNDArray result)
```
    Specified by:
    
    mul in interface INDArray
    
    Returns:
  - muli
```
public IComplexNDArray muli(IComplexNumber n,
                            IComplexNDArray result)
```
    Specified by:
    
    muli in interface INDArray
    
    Returns:
  - sub
```
public IComplexNDArray sub(IComplexNumber n,
                           IComplexNDArray result)
```
    Specified by:
    
    sub in interface INDArray
    
    Returns:
  - subi
```
public IComplexNDArray subi(IComplexNumber n,
                            IComplexNDArray result)
```
    Specified by:
    
    subi in interface INDArray
    
    Returns:
  - add
```
public IComplexNDArray add(IComplexNumber n,
                           IComplexNDArray result)
```
    Specified by:
    
    add in interface INDArray
    
    Returns:
  - addi
```
public IComplexNDArray addi(IComplexNumber n,
                            IComplexNDArray result)
```
    Specified by:
    
    addi in interface INDArray
    
    Returns:
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - equalsWithEps
```
public boolean equalsWithEps(Object o,
                             double eps)
```
    Description copied from interface: INDArray
    
    This method checks 2 INDArrays equality with given eps
    
    Specified by:
    
    equalsWithEps in interface INDArray
    
    eps - Epsilon value to use for the quality operation
    
    Returns:
  - unsafeDuplication
```
public INDArray unsafeDuplication()
```
    Description copied from interface: INDArray
    
    Perform efficient (but unsafe) duplication. Don't use this method unless you know exactly what you are doing. Instead, use INDArray.dup()
    
    Specified by:
    
    unsafeDuplication in interface INDArray
    
    Returns:
    
    Unsafe duplicate of array
  - remainder
```
public INDArray remainder(INDArray denominator)
```
    Description copied from interface: INDArray
    
    Remainder operator
    
    Specified by:
    
    remainder in interface INDArray
    
    Parameters:
    
    denominator - the denominator
    
    Returns:
  - remainder
```
public INDArray remainder(INDArray denominator,
                          INDArray result)
```
    Description copied from interface: INDArray
    
    Remainder operator
    
    Specified by:
    
    remainder in interface INDArray
    
    Parameters:
    
    denominator - the denominator
    
    result - the result array to put this in
    
    Returns:
  - remainder
```
public INDArray remainder(Number denominator)
```
    Description copied from interface: INDArray
    
    The scalar denominator
    
    Specified by:
    
    remainder in interface INDArray
    
    Parameters:
    
    denominator - the denominator as a scalar
    
    Returns:
  - remainder
```
public INDArray remainder(Number denominator,
                          INDArray result)
```
    Specified by:
    
    remainder in interface INDArray
    
    Returns:
  - remainderi
```
public INDArray remainderi(INDArray denominator)
```
    Description copied from interface: INDArray
    
    In place remainder
    
    Specified by:
    
    remainderi in interface INDArray
    
    Returns:
  - remainderi
```
public INDArray remainderi(Number denominator)
```
    Description copied from interface: INDArray
    
    In place remainder
    
    Specified by:
    
    remainderi in interface INDArray
    
    Returns:
  - fmod
```
public INDArray fmod(INDArray denominator)
```
    Description copied from interface: INDArray
    
    remainder of division
    
    Specified by:
    
    fmod in interface INDArray
    
    Parameters:
    
    denominator - the array of denominators for each element in this array
    
    Returns:
  - fmod
```
public INDArray fmod(INDArray denominator,
                     INDArray result)
```
    Description copied from interface: INDArray
    
    remainder of division
    
    Specified by:
    
    fmod in interface INDArray
    
    Parameters:
    
    denominator - the
    
    result - the result array
    
    Returns:
  - fmod
```
public INDArray fmod(Number denominator)
```
    Specified by:
    
    fmod in interface INDArray
    
    Returns:
  - fmod
```
public INDArray fmod(Number denominator,
                     INDArray result)
```
    Specified by:
    
    fmod in interface INDArray
  - fmodi
```
public INDArray fmodi(INDArray denominator)
```
    Description copied from interface: INDArray
    
    In place fmod
    
    Specified by:
    
    fmodi in interface INDArray
    
    Returns:
  - fmodi
```
public INDArray fmodi(Number denominator)
```
    Description copied from interface: INDArray
    
    In place fmod
    
    Specified by:
    
    fmodi in interface INDArray
    
    Returns:
  - argMax
```
public INDArray argMax(int... dimension)
```
    Description copied from interface: INDArray
    
    This method returns index of highest value along specified dimension(s)
    
    Specified by:
    
    argMax in interface INDArray
    
    Parameters:
    
    dimension - Dimension along which to perform the argMax operation
    
    Returns:
    
    Array containing indices
  - isAttached
```
public boolean isAttached()
```
    Description copied from interface: INDArray
    
    This method returns True, if this INDArray instance is attached to some Workspace. False otherwise.
    
    Specified by:
    
    isAttached in interface INDArray
    
    Returns:
    
    True if attached to workspace, false otherwise
  - isInScope
```
public boolean isInScope()
```
    Description copied from interface: INDArray
    
    This method checks, if given attached INDArray is still in scope of its parent Workspace PLEASE NOTE: if this INDArray isn't attached to any Workspace, this method will return true
    
    Specified by:
    
    isInScope in interface INDArray
    
    Returns:
  - detach
```
public INDArray detach()
```
    Description copied from interface: INDArray
    
    This method detaches INDArray from Workspace, returning copy. Basically it's dup() into new memory chunk. PLEASE NOTE: If this INDArray instance is NOT attached - it will be returned unmodified.
    
    Specified by:
    
    detach in interface INDArray
    
    Returns:
    
    The attached copy of array, or original if not in workspace
  - leverage
```
public INDArray leverage()
```
    Description copied from interface: INDArray
    
    This method detaches INDArray from current Workspace, and attaches it to Workspace above, if any. PLEASE NOTE: If this INDArray instance is NOT attached - it will be returned unmodified. PLEASE NOTE: If current Workspace is the top-tier one, effect will be equal to detach() call - detached copy will be returned
    
    Specified by:
    
    leverage in interface INDArray
    
    Returns:
  - leverageTo
```
public INDArray leverageTo(String id)
```
    Description copied from interface: INDArray
    
    This method detaches INDArray from current Workspace, and attaches it to Workspace with a given Id - if a workspace with that ID exists. If no workspace with the specified ID exists, the current INDArray is returned unmodified.
    
    Specified by:
    
    leverageTo in interface INDArray
    
    Parameters:
    
    id - ID of the workspace to leverage to
    
    Returns:
    
    See Also:
    
    INDArray.leverageTo(String, boolean)
  - leverageTo
```
public INDArray leverageTo(String id,
                           boolean enforceExistence)
                    throws Nd4jNoSuchWorkspaceException
```
    Description copied from interface: INDArray
    
    This method detaches INDArray from current Workspace, and attaches it to Workspace with a given Id. If enforceExistence == true, and no workspace with the specified ID exists, then an Nd4jNoSuchWorkspaceException is thrown. Otherwise, if enforceExistance == false and no workspace with the specified ID exists, then the current INDArray is returned unmodified (same as INDArray.leverage()
    
    Specified by:
    
    leverageTo in interface INDArray
    
    Parameters:
    
    id - ID of the workspace to leverage to
    
    enforceExistence - If true, and the specified workspace does not exist: an Nd4jNoSuchWorkspaceException will be thrown.
    
    Returns:
    
    The INDArray, leveraged to the specified workspace
    
    Throws:
    
    Nd4jNoSuchWorkspaceException
    
    See Also:
    
    INDArray.leverageTo(String)
  - leverageOrDetach
```
public INDArray leverageOrDetach(String id)
```
    Description copied from interface: INDArray
    
    This method detaches INDArray from current Workspace, and attaches it to Workspace with a given Id, if a workspace with the given ID is open and active. If the workspace does not exist, or is not active, the array is detached from any workspaces.
    
    Specified by:
    
    leverageOrDetach in interface INDArray
    
    Parameters:
    
    id - ID of the workspace to leverage to
    
    Returns:
    
    The INDArray, leveraged to the specified workspace (if it exists and is active) otherwise the detached array
    
    See Also:
    
    INDArray.leverageTo(String)
  - migrate
```
public INDArray migrate()
```
    Description copied from interface: INDArray
    
    This method pulls this INDArray into current Workspace. PLEASE NOTE: If there's no current Workspace - INDArray returned as is
    
    Specified by:
    
    migrate in interface INDArray
    
    Returns:
    
    Migrated INDArray or this if no current workspace
    
    See Also:
    
    INDArray.migrate(boolean)
  - migrate
```
public INDArray migrate(boolean detachIfNoWs)
```
    Description copied from interface: INDArray
    
    This method pulls this INDArray into current Workspace, or optionally detaches if no workspace is present.
    That is:
    If current workspace is present/active, INDArray is migrated to it.
    If no current workspace is present/active, one of two things occur: 1. If detachOnNoWs arg is true: if there is no current workspace, INDArray is detached 2. If detachOnNoWs arg is false: this INDArray is returned as-is (no-op) - equivalent to INDArray.migrate()
    
    Specified by:
    
    migrate in interface INDArray
    
    Parameters:
    
    detachIfNoWs - If true: detach on no WS. If false and no workspace: return this.
    
    Returns:
    
    Migrated INDArray
  - sum
```
public INDArray sum(INDArray result,
                    int... dimension)
```
    Description copied from interface: INDArray
    
    Returns the sum along the last dimension of this ndarray
    
    Specified by:
    
    sum in interface INDArray
    
    Parameters:
    
    result - result of this operation will be stored here
    
    dimension - the dimension to getScalar the sum along
    
    Returns:
    
    the sum along the specified dimension of this ndarray
  - mean
```
public INDArray mean(INDArray result,
                     int... dimension)
```
    Description copied from interface: INDArray
    
    Returns the overall mean of this ndarray
    
    Specified by:
    
    mean in interface INDArray
    
    dimension - the dimension to getScalar the mean along
    
    Returns:
    
    the mean along the specified dimension of this ndarray
  - amean
```
public INDArray amean(int... dimension)
```
    Description copied from interface: INDArray
    
    Returns the absolute overall mean of this ndarray
    
    Specified by:
    
    amean in interface INDArray
    
    Parameters:
    
    dimension - the dimension to getScalar the mean along
    
    Returns:
    
    the mean along the specified dimension of this ndarray
  - ameanNumber
```
public Number ameanNumber()
```
    Description copied from interface: INDArray
    
    Returns the absolute overall mean of this ndarray
    
    Specified by:
    
    ameanNumber in interface INDArray
    
    Returns:
    
    the mean along the specified dimension of this ndarray
  - amax
```
public INDArray amax(int... dimension)
```
    Description copied from interface: INDArray
    
    Returns the absolute overall max of this ndarray along given dimensions
    
    Specified by:
    
    amax in interface INDArray
    
    Parameters:
    
    dimension - the dimension to getScalar the mean along
    
    Returns:
    
    the mean along the specified dimension of this ndarray
  - amaxNumber
```
public Number amaxNumber()
```
    Description copied from interface: INDArray
    
    Returns maximum (absolute) value in this INDArray
    
    Specified by:
    
    amaxNumber in interface INDArray
    
    Returns:
    
    Max absolute value
  - amin
```
public INDArray amin(int... dimension)
```
    Description copied from interface: INDArray
    
    Returns minimum (absolute) value in this INDArray, along the specified dimensions
    
    Specified by:
    
    amin in interface INDArray
    
    Returns:
    
    Minimum absolute value
  - aminNumber
```
public Number aminNumber()
```
    Description copied from interface: INDArray
    
    Returns absolute min value in this INDArray
    
    Specified by:
    
    aminNumber in interface INDArray
    
    Returns:
    
    Absolute min value
  - scan
```
public Number scan(Condition condition)
```
    Description copied from interface: INDArray
    
    This method takes boolean condition, and returns number of elements matching this condition
    
    Specified by:
    
    scan in interface INDArray
    
    Parameters:
    
    condition - Condition to calculate matches for
    
    Returns:
    
    Number of elements matching condition
  - unsafeDuplication
```
public INDArray unsafeDuplication(boolean blocking)
```
    Description copied from interface: INDArray
    
    Perform efficient (but unsafe) duplication. Don't use this method unless you know exactly what you are doing. Instead, use INDArray.dup()
    
    Specified by:
    
    unsafeDuplication in interface INDArray
    
    Returns:
    
    Unsafe duplicate of array
  - entropyNumber
```
public Number entropyNumber()
```
    Returns entropy value for this INDArray
    
    Specified by:
    
    entropyNumber in interface INDArray
    
    Returns:
  - shannonEntropyNumber
```
public Number shannonEntropyNumber()
```
    Returns non-normalized Shannon entropy value for this INDArray
    
    Specified by:
    
    shannonEntropyNumber in interface INDArray
    
    Returns:
  - logEntropyNumber
```
public Number logEntropyNumber()
```
    Returns log entropy value for this INDArray
    
    Specified by:
    
    logEntropyNumber in interface INDArray
    
    Returns:
  - entropy
```
public INDArray entropy(int... dimension)
```
    Returns entropy along dimension
    
    Specified by:
    
    entropy in interface INDArray
    
    Parameters:
    
    dimension -
    
    Returns:
  - shannonEntropy
```
public INDArray shannonEntropy(int... dimension)
```
    Returns non-normalized Shannon entropy along dimension
    
    Specified by:
    
    shannonEntropy in interface INDArray
    
    Parameters:
    
    dimension -
    
    Returns:
  - logEntropy
```
public INDArray logEntropy(int... dimension)
```
    Returns log entropy along dimension
    
    Specified by:
    
    logEntropy in interface INDArray
    
    Parameters:
    
    dimension -
    
    Returns:
  - percentileNumber
```
public Number percentileNumber(Number quantile)
```
    Description copied from interface: INDArray
    
    This method returns percentile value for this INDArray
    
    Specified by:
    
    percentileNumber in interface INDArray
    
    Parameters:
    
    quantile - target percentile in range of 0..100
    
    Returns:
  - medianNumber
```
public Number medianNumber()
```
    Description copied from interface: INDArray
    
    This method returns median value for this INDArray
    
    Specified by:
    
    medianNumber in interface INDArray
    
    Returns:
    
    Median value for array
  - median
```
public INDArray median(int... dimension)
```
    Description copied from interface: INDArray
    
    This method returns median along given dimension(s)
    
    Specified by:
    
    median in interface INDArray
    
    Returns:
    
    Median along specified dimensions
  - getPercentile
```
protected double getPercentile(Number quantile,
                               INDArray sorted)
```
  - percentile
```
public INDArray percentile(Number quantile,
                           int... dimension)
```
    Description copied from interface: INDArray
    
    This method returns median along given dimension(s)
    
    Specified by:
    
    percentile in interface INDArray
    
    Parameters:
    
    quantile - target percentile in range of 0..100
    
    dimension - Dimension to calculate percentile for
    
    Returns:

Class BaseSparseNDArray

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.nd4j.linalg.api.ndarray.ISparseNDArray

Methods inherited from interface org.nd4j.linalg.api.ndarray.INDArray

Field Detail

THRESHOLD_MEMORY_ALLOCATION

rows

columns

rank

isVector

isMatrix

isScalar

length

isSparse

shapeInformation

javaShapeInformation

sparseInformation

shape

stride

Constructor Detail

BaseSparseNDArray

Method Detail

reallocate

clone

isColumnVectorOrScalar

isRowVectorOrScalar

get

toDoubleMatrix

toDoubleVector

toFloatVector

toFloatMatrix

toIntVector

toIntMatrix

match

match

putWhereWithMask

putWhereWithMask

toDense

getWhere

getWhere

putWhere

putWhere

putWhere

get

put

put

isSparse

length

nnz

lengthLong

init

shapeInfoToString

shapeInfoDataBuffer

sparseInfoDataBuffer

shapeInfo

isCompressed

markAsCompressed

setWrapAround

isWrapAround

rank

flags

hiddenDimensions

sparseOffsets

stride

strideOf

elementStride

elementWiseStride

isCleanedUp

cleanup

resetLinearView

secondaryStride

getDoubleUnsafe

putScalarUnsafe

majorStride

innerMostStride

linearView

linearViewColumnOrder