public interface INDArray extends Serializable, AutoCloseable
Modifier and Type | Method and Description |
---|---|
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)
Addition of this ndarray.
|
INDArray |
addColumnVector(INDArray columnVector)
Addition of a column vector (copy)
|
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)
|
boolean |
all()
This method checks if all elements within this array are non-zero (or true, in case of boolean)
|
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
|
boolean |
any()
This method checks if any of the elements within this array are non-zero (or true, in case of boolean)
|
INDArray |
argMax(int... dimension)
This method returns index of highest value along specified dimension(s)
|
INDArray |
assign(boolean value)
Set all entries of the ndarray to the specified value
|
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(long... shape)
Broadcasts this ndarray to be the specified shape
|
INDArray |
castTo(DataType dataType)
This method cast elements of this INDArray to new data type
|
void |
close()
This method releases exclusive off-heap resources uses by this INDArray instance.
|
boolean |
closeable()
This method checks, if this INDArray instalce can use close() method
|
int |
columns()
Returns the number of columns in this matrix (throws exception if not 2d)
|
INDArray |
cond(Condition condition)
Returns a binary INDArray with value 'true' if the element matches the specified condition and 'false' otherwise
|
INDArray |
cumsum(int dimension)
Returns the cumulative sum along a dimension.
|
INDArray |
cumsumi(int dimension)
Returns the cumulative sum along a dimension.
|
DataBuffer |
data()
Returns a linear double array representation of this ndarray
|
DataType |
dataType()
This method returns dtype for this INDArray
|
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.
|
INDArray |
dimShuffle(Object[] rearrange,
long[] newOrder,
boolean[] broadCastable) |
double |
distance1(INDArray other)
Returns the (1-norm) distance.
|
double |
distance2(INDArray other)
Returns the (euclidean) distance.
|
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)
Division if ndarray by number
|
INDArray |
divColumnVector(INDArray columnVector)
Division of a column vector (copy)
|
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 |
elementWiseStride()
Element wise stride
|
INDArray |
entropy(int... dimension)
Returns entropy value for this INDArray along specified dimension(s)
|
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 |
eq(INDArray other)
Returns the binary ndarray for "Equals" comparison.
|
INDArray |
eq(Number other)
Returns the binary ndarray for "Equals" comparison.
|
boolean |
equalShapes(INDArray other)
This method checks 2 INDArrays for equal shapes.
Shapes are considered equal if: (a) Both arrays have equal rank, and (b) size(0)...size(rank()-1) are equal for both arrays |
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 |
getColumn(long i)
Returns the specified column.
|
INDArray |
getColumn(long i,
boolean keepDim)
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(long... indices) |
double |
getDouble(long i)
Get the double value at the specified linear index in the array
|
double |
getDouble(long i,
long j)
Get the double value at the specified indices.
|
double |
getDoubleUnsafe(long offset)
Get a double at the given linear offset unsafe, without checks.
|
float |
getFloat(int[] indices)
Returns the elements at the specified indices
|
float |
getFloat(long i)
Return the item at the linear index i
|
float |
getFloat(long[] indices) |
float |
getFloat(long i,
long j)
Return the item at row i column j
Note that this is the same as calling getScalar(new int[]{i,j}
|
SparseFormat |
getFormat()
Return the sparse format (i.e COO, CSR, ...)
|
int |
getInt(int... indices)
Get an integer value at the specified indices.
|
int |
getLeadingOnes()
Get the number of leading ones in the array shape.
|
long |
getLong(long... indices) |
long |
getLong(long index) |
Number |
getNumber(long... indices) |
Number |
getNumber(long index) |
INDArray |
getRow(long i)
Returns the specified row as a 1D vector.
|
INDArray |
getRow(long i,
boolean keepDim)
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 specified indices
|
INDArray |
getScalar(long... indices) |
INDArray |
getScalar(long i)
Returns the element at the specified index
|
INDArray |
getScalar(long row,
long column)
Returns the element at the specified row/column
|
String |
getString(long index)
Get string value at given index.
|
int |
getTrailingOnes()
Get the number of trailing ones in the array shape.
|
DataBuffer |
getVectorCoordinates()
Return a array of non-major pointers
i.e.
|
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 "Greater Than" comparison.
|
INDArray |
gt(Number other)
Returns the binary ndarray for "Greater" comparison.
|
INDArray |
gte(Number other)
Returns binary ndarray for "Greter or equals" comparison.
|
int[] |
hiddenDimensions() |
boolean |
isAttached()
This method returns True, if this INDArray instance is attached to some Workspace.
|
boolean |
isB()
This method checks if this INDArray instance has boolean type
|
boolean |
isColumnVector()
Returns true if the number of columns is 1
|
boolean |
isColumnVectorOrScalar()
Returns true if the number of columns is 1
|
boolean |
isCompressed()
Check if this array is compressed.
|
boolean |
isEmpty()
This method returns true if this INDArray is special case: no-value INDArray
|
INDArray |
isInfinite()
Returns the binary NDArray with value true where this array's entries are infinite, or false where they
are not infinite
|
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
|
INDArray |
isNaN()
Returns the binary NDArray with value true where this array's entries are NaN, or false where they
are not infinite
|
boolean |
isR()
This method checks if this INDArray instance is one of Real types
|
boolean |
isRowVector()
Returns true if the number of rows is 1
|
boolean |
isRowVectorOrScalar()
Returns true if the number of rows is 1
|
boolean |
isS()
This method checks if this INDArray instance has String type
|
boolean |
isScalar()
Returns true if this ndarray is a scalar
|
boolean |
isSparse()
Check if this array is sparse
|
boolean |
isSquare()
Returns whether the matrix
has the same rows and columns
|
boolean |
isVector()
Returns true if this ndarray is a vector
|
boolean |
isVectorOrScalar()
Returns true if this ndarray is a vector or scalar
|
boolean |
isView()
Check if this array is a view or not.
|
boolean |
isZ()
This method checks if this INDArray instance is one of integer types
|
long |
length()
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.
|
INDArray |
like()
This method returns empty array with the same dtype/order/shape as this one
|
long |
linearIndex(long i)
Get the linear index of the data in to the array
|
INDArray |
logEntropy(int... dimension)
Returns log entropy value for this INDArray along specified dimension(s)
|
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.
|
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(boolean keepDims,
int... dimension)
Returns the overall max of this ndarray along given dimensions
|
INDArray |
max(int... dimension)
Returns the overall max of this ndarray along given dimensions
|
Number |
maxNumber()
Returns maximum value in this INDArray
|
INDArray |
mean(boolean keepDims,
int... dimension)
Returns the overall mean of this ndarray
|
INDArray |
mean(INDArray result,
boolean keepDims,
int... dimension)
Returns the overall mean of this ndarray
|
INDArray |
mean(INDArray result,
int... dimension)
Returns the overall mean of this ndarray
|
INDArray |
mean(int... dimension)
Returns the overall mean of this ndarray
|
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 detachOnNoWs)
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(boolean keepDims,
int... dimension)
Returns the overall min of this ndarray
|
INDArray |
min(int... dimension)
Returns the overall min of this ndarray
|
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 |
mmul(INDArray other,
INDArray result,
MMulTranspose mMulTranspose)
Perform an copy matrix multiplication
|
INDArray |
mmul(INDArray other,
MMulTranspose mMulTranspose)
Perform a copy matrix multiplication
|
INDArray |
mmuli(INDArray other)
Perform an inplace matrix multiplication
|
INDArray |
mmuli(INDArray other,
INDArray result)
Perform an inplace matrix multiplication
|
INDArray |
mmuli(INDArray other,
INDArray result,
MMulTranspose transpose)
Perform an in place matrix multiplication
|
INDArray |
mmuli(INDArray other,
MMulTranspose transpose)
Perform an copy matrix multiplication
|
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)
Multiplication of ndarray.
|
INDArray |
mulColumnVector(INDArray columnVector)
Multiplication of a column vector (copy)
|
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.
|
int |
nnz()
Return the number of non-null element
|
boolean |
none()
This method checks if any of the elements within this array are non-zero (or true, in case of boolean)
|
INDArray |
norm1(boolean keepDims,
int... dimension)
Returns the norm1 (L1 norm, i.e., sum of absolute values; also known as Taxicab or Manhattan norm) along the
specified dimension
|
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
|
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(boolean keepDims,
int... dimension)
Returns the norm2 (L2 norm, sqrt(sum(x_i^2), also known as Euclidean norm) along the specified dimension(s)
|
INDArray |
norm2(int... dimension)
Returns the norm2 (L2 norm, sqrt(sum(x_i^2), also known as Euclidean norm) along the specified dimension(s)
|
Number |
norm2Number()
Return the norm2 (L2 norm, sqrt(sum(x_i^2), also known as Euclidean norm) for the entire array
|
INDArray |
normmax(boolean keepDims,
int... dimension)
Returns the max norm (aka infinity norm, equal to the maximum absolute value) along the specified dimension(s)
|
INDArray |
normmax(int... dimension)
Returns the max norm (aka infinity norm, equal to the maximum absolute value) along the specified dimension(s)
|
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 percentile,
int... dimension)
This method returns median along given dimension(s)
|
Number |
percentileNumber(Number percentile)
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(boolean keepDims,
int... dimension)
Returns the product along a given dimension
|
INDArray |
prod(int... dimension)
Returns the product along a given dimension
|
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 |
putColumn(int column,
INDArray toPut)
Insert a column in to this array
Will throw an exception if this ndarray is not a matrix
|
INDArray |
putiColumnVector(INDArray columnVector)
In place assignment of a column vector
|
INDArray |
putiRowVector(INDArray rowVector)
in place assignment of row vector, to each row of this array
|
INDArray |
putRow(long 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(long[] i,
double value)
|
INDArray |
putScalar(long[] i,
float value)
|
INDArray |
putScalar(long[] i,
int value)
|
INDArray |
putScalar(long i,
double value)
Insert the number linearly in to the ndarray
|
INDArray |
putScalar(long i,
float value)
Insert a scalar float at the specified index
|
INDArray |
putScalar(long i,
int value)
Insert a scalar int at the specified index
|
INDArray |
putScalar(long row,
long col,
double value)
Insert the value at the specified indices, in a 2d (rank 2) NDArray
Equivalent to putScalar(int[], double) but avoids int[] creation |
INDArray |
putScalar(long dim0,
long dim1,
long dim2,
double value)
Insert the value at the specified indices, in a 3d (rank 3) NDArray
Equivalent to putScalar(int[], double) but avoids int[] creation |
INDArray |
putScalar(long dim0,
long dim1,
long dim2,
long dim3,
double value)
Insert the value at the specified indices, in a 4d (rank 4) NDArray
Equivalent to 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
|
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)
|
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)
|
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,
long... 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
See:
https://github.com/numpy/numpy/blob/master/numpy/matlib.py#L310-L358
|
INDArray |
reshape(char order,
boolean enforceView,
long... newShape)
Reshapes the ndarray (note: it's not possible to change the length of the ndarray).
|
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(char order,
long... newShape)
Reshapes the ndarray (can't change the length of the ndarray).
|
INDArray |
reshape(int[] shape) |
INDArray |
reshape(long... newShape)
Reshapes the ndarray (can't change the length of the ndarray).
|
INDArray |
reshape(long rows,
long 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)
|
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)
|
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
|
void |
setData(DataBuffer data) |
void |
setOrder(char order)
Set the ordering
|
void |
setShapeAndStride(int[] shape,
int[] stride)
Shape and stride setter
|
INDArray |
shannonEntropy(int... dimension)
Returns Shannon entropy value for this INDArray along specified dimension(s)
|
Number |
shannonEntropyNumber()
Returns non-normalized Shannon entropy value for this INDArray
|
long[] |
shape()
Returns the shape of this ndarray
|
LongShapeDescriptor |
shapeDescriptor()
Returns shape descriptor of this ndarray
|
LongBuffer |
shapeInfo()
Shape info
|
DataBuffer |
shapeInfoDataBuffer()
Shape info
|
long[] |
shapeInfoJava()
This method returns shapeInformation as jvm long array
|
String |
shapeInfoToString()
Returns the shape information debugging information
|
long |
size(int dimension)
Returns the size along a specified dimension
|
INDArray |
slice(long i)
Returns the specified slice of this ndarray
|
INDArray |
slice(long i,
int dimension)
Returns the specified slice of this ndarray
|
long |
slices()
Returns the number of slices in this ndarray
|
void |
sliceVectors(List<INDArray> list)
Flattens the array for linear indexing in list.
|
DataBuffer |
sparseInfoDataBuffer()
Sparse info
|
int[] |
sparseOffsets() |
double |
squaredDistance(INDArray other)
Returns the square of the Euclidean distance.
|
INDArray |
std(boolean biasCorrected,
boolean keepDims,
int... dimension)
Standard deviation of an ndarray along a dimension
|
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
|
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
|
long[] |
stride()
Returns the stride of this ndarray
|
int |
stride(int dimension)
Calculate the stride along a particular dimension
|
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)
Subtraction of this ndarray
|
INDArray |
subColumnVector(INDArray columnVector)
Subtraction of a column vector (copy)
|
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(boolean keepDims,
int... dimension)
Returns the sum along the last dimension of this ndarray
|
INDArray |
sum(INDArray result,
boolean keepDims,
int... dimension)
Returns the sum along the last dimension of this ndarray
|
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
|
Number |
sumNumber()
Sum the entire array
|
INDArray |
swapAxes(int dimension,
int with)
Mainly here for people coming from numpy.
|
INDArray |
tensorAlongDimension(long index,
int... dimension)
Get the vector along a particular dimension
|
long |
tensorsAlongDimension(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.
|
int |
toFlatArray(com.google.flatbuffers.FlatBufferBuilder builder)
Add an
INDArray
to flatbuffers builder |
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.
|
long[][] |
toLongMatrix()
Convert this ndarray to a 2d int matrix.
|
long[] |
toLongVector()
Convert this ndarray to a 1d long matrix.
|
String |
toString(long maxElements,
boolean forceSummarize,
int precision)
Get a string representation of the array
|
String |
toString(NDArrayStrings options)
Get a string representation of the array with configurable formatting
|
String |
toStringFull()
ToString with unlimited elements and precision
|
INDArray |
transpose()
Flip the rows and columns of a matrix
|
INDArray |
transposei()
Flip the rows and columns of a matrix, in-place
|
INDArray |
ulike()
This method returns uninitialized array with the same dtype/order/shape as this one
|
int |
underlyingRank() |
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
|
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
|
long |
vectorsAlongDimension(int dimension)
Returns the number of possible vectors for a given dimension
|
boolean |
wasClosed()
This method checks if array or its buffer was closed before
|
String shapeInfoToString()
DataBuffer shapeInfoDataBuffer()
DataBuffer sparseInfoDataBuffer()
LongBuffer shapeInfo()
boolean isView()
boolean isSparse()
boolean isCompressed()
void markAsCompressed(boolean reallyCompressed)
reallyCompressed
- new value for compressed.int rank()
int stride(int dimension)
dimension
- the dimension to get the stride forint elementWiseStride()
double getDoubleUnsafe(long offset)
offset
- the offset to get atString getString(long index)
index
- index to retreiveINDArray putScalarUnsafe(long offset, double value)
offset
- the offset to insert atvalue
- the value to insertlong vectorsAlongDimension(int dimension)
dimension
- the dimension to calculate the number of vectors forINDArray vectorAlongDimension(int index, int dimension)
index
- the index of the vector to getScalardimension
- the dimension to getScalar the vector fromlong tensorsAlongDimension(int... dimension)
dimension
- the dimension to calculate the number of vectors forINDArray tensorAlongDimension(long index, int... dimension)
index
- the index of the vector to getScalardimension
- the dimension to getScalar the vector fromINDArray cumsumi(int dimension)
dimension
- the dimension to perform cumulative sum along.INDArray cumsum(int dimension)
dimension
- the dimension to perform cumulative sum along.INDArray assign(INDArray arr)
arr
- the elements to assignINDArray assignIf(INDArray arr, Condition condition)
arr
- the elements to assignINDArray replaceWhere(INDArray arr, Condition condition)
arr
- Source arraycondition
- Condition to applyINDArray putScalar(long i, double value)
i
- the index to insert intovalue
- the value to insertINDArray putScalar(long i, float value)
i
- The index to insert intovalue
- Value to insertINDArray putScalar(long i, int value)
i
- The index to insert intovalue
- Value to insertINDArray putScalar(int[] i, double value)
i
- the indices to insert atvalue
- the number to insertINDArray putScalar(long[] i, double value)
INDArray putScalar(long[] i, float value)
INDArray putScalar(long[] i, int value)
INDArray putScalar(long row, long col, double value)
putScalar(int[], double)
but avoids int[] creationrow
- Row (dimension 0) indexcol
- Column (dimension 1) indexvalue
- Value to putINDArray putScalar(long dim0, long dim1, long dim2, double value)
putScalar(int[], double)
but avoids int[] creationdim0
- Dimension 0 indexdim1
- Dimension 1 indexdim2
- Dimension 2 indexvalue
- Value to putINDArray putScalar(long dim0, long dim1, long dim2, long dim3, double value)
putScalar(int[], double)
but avoids int[] creationdim0
- Dimension 0 indexdim1
- Dimension 1 indexdim2
- Dimension 2 indexdim3
- Dimension 3 indexvalue
- Value to putINDArray lt(Number other)
other
- the number to compare.INDArray putScalar(int[] indexes, float value)
indexes
- Indices to place the valuevalue
- Value to insertINDArray putScalar(int[] indexes, int value)
indexes
- Indices to place the valuevalue
- Value to insertINDArray eps(Number other)
other
- the number to compare.INDArray eq(Number other)
other
- the number to compare.INDArray gt(Number other)
other
- the number to compare.INDArray gte(Number other)
other
- the number to compare.INDArray lte(Number other)
other
- the number to compare.INDArray lt(INDArray other)
other
- the ndarray to compare.INDArray eps(INDArray other)
other
- the ndarray to compare.INDArray neq(Number other)
other
- the number to compare.INDArray neq(INDArray other)
other
- the ndarray to compare.INDArray eq(INDArray other)
other
- the ndarray to compare.INDArray gt(INDArray other)
other
- the ndarray to compare.INDArray isInfinite()
INDArray isNaN()
INDArray neg()
INDArray negi()
INDArray rdiv(Number n)
n
- Value to use for reverse divisionINDArray rdivi(Number n)
n
- Value to use for reverse divisionINDArray rsub(Number n)
n
- Value to use for reverse subtractionINDArray rsubi(Number n)
n
- Value to use for reverse subtractionINDArray div(Number n)
n
- Number to divide values byINDArray divi(Number n)
n
- Number to divide values byINDArray mul(Number n)
n
- the number to multiply byINDArray muli(Number n)
n
- The number to multiply byINDArray sub(Number n)
n
- the number to subtract byINDArray subi(Number n)
n
- Number to subtractINDArray add(Number n)
n
- the number to addINDArray addi(Number n)
n
- Number to addINDArray rdiv(Number n, INDArray result)
n
- the number to divide byresult
- Array to place the result in. Must match shape of this arrayINDArray rdivi(Number n, INDArray result)
n
- the number to divide byresult
- the result ndarrayINDArray rsub(Number n, INDArray result)
n
- the number to subtract byresult
- the result ndarrayINDArray rsubi(Number n, INDArray result)
n
- the number to subtract byresult
- the result ndarrayINDArray div(Number n, INDArray result)
n
- the number to divide byresult
- the result ndarrayINDArray divi(Number n, INDArray result)
n
- the number to divide byresult
- the result ndarrayINDArray mul(Number n, INDArray result)
n
- the number to multiply byresult
- the result ndarrayINDArray muli(Number n, INDArray result)
n
- the number to divide byresult
- the result ndarrayINDArray sub(Number n, INDArray result)
n
- the number to subtract byresult
- the result ndarrayINDArray subi(Number n, INDArray result)
n
- the number to subtract byresult
- the result ndarrayINDArray add(Number n, INDArray result)
n
- the number to addresult
- the result ndarrayINDArray addi(Number n, INDArray result)
n
- the number to addresult
- the result ndarrayINDArray get(INDArrayIndex... indexes)
indexes
- the indexes in to the arrayINDArray match(INDArray comp, Condition condition)
comp
- condition
- INDArray match(Number comp, Condition condition)
comp
- condition
- INDArray getWhere(INDArray comp, Condition condition)
comp
- the comparison arraycondition
- the condition to applyINDArray getWhere(Number comp, Condition condition)
comp
- the comparison arraycondition
- the condition to applyINDArray putWhere(INDArray comp, INDArray put, Condition condition)
comp
- the comparison arrayput
- the elements to putcondition
- the condition for masking onINDArray putWhere(Number comp, INDArray put, Condition condition)
comp
- the comparison arrayput
- the elements to putcondition
- the condition for masking onINDArray putWhereWithMask(INDArray mask, INDArray put)
mask
- the mask to useput
- the array to putINDArray putWhereWithMask(INDArray mask, Number put)
mask
- the mask to useput
- the array to putINDArray putWhere(Number comp, Number put, Condition condition)
comp
- the comparison arrayput
- the elements to putcondition
- the condition for masking onINDArray get(INDArray indices)
indices
- an ndaray of the indices to get the elements forINDArray getColumns(int... columns)
columns
- Columns to extract out of the current arrayINDArray getRows(int... rows)
rows
- Rose to extract from this arrayINDArray rdiv(INDArray other)
other
- the matrix to divide fromINDArray rdivi(INDArray other)
other
- The matrix to divide fromINDArray rdiv(INDArray other, INDArray result)
other
- the matrix to divide fromresult
- the result ndarrayINDArray rdivi(INDArray other, INDArray result)
other
- the matrix to divide fromresult
- the result ndarrayINDArray rsub(INDArray other, INDArray result)
other
- the matrix to subtract fromresult
- the result ndarrayINDArray rsub(INDArray other)
other
- Other array to use in reverse subtractionINDArray rsubi(INDArray other)
other
- Other way to use in reverse subtraction operationINDArray rsubi(INDArray other, INDArray result)
other
- the other ndarray to subtractresult
- the result ndarrayINDArray assign(Number value)
value
- the value to assignINDArray assign(boolean value)
value
- the value to assignlong linearIndex(long i)
i
- the index to getScalarINDArray putSlice(int slice, INDArray put)
slice
- the slice to assignput
- the slice to applyTransformToDestinationINDArray cond(Condition condition)
condition
- Condition to applyINDArray repmat(int... shape)
shape
- the new shape of this ndarrayINDArray repeat(int dimension, long... repeats)
dimension
- the dimension to repeatrepeats
- the number of elements to repeat on each elementINDArray putRow(long row, INDArray toPut)
row
- the row insert intotoPut
- the row to insertINDArray putColumn(int column, INDArray toPut)
column
- the column to inserttoPut
- the array to putINDArray getScalar(long row, long column)
row
- the row of the element to returncolumn
- the row of the element to returnINDArray getScalar(long i)
i
- the index of the element to returndouble squaredDistance(INDArray other)
double distance2(INDArray other)
double distance1(INDArray other)
INDArray put(INDArray indices, INDArray element)
indices
- the indices to putelement
- the element array to putINDArray put(INDArrayIndex[] indices, INDArray element)
indices
- the indices to put the ndarray in toelement
- the ndarray to putINDArray put(INDArrayIndex[] indices, Number element)
indices
- the indices to put the ndarray in toelement
- the ndarray to putINDArray put(int[] indices, INDArray element)
indices
- the indices to insert intoelement
- a scalar ndarrayINDArray put(int i, int j, INDArray element)
i
- the row insert intoj
- the column to insert intoelement
- a scalar ndarrayINDArray put(int i, int j, Number element)
i
- the row insert intoj
- the column to insert intoelement
- a scalar ndarrayINDArray put(int i, INDArray element)
i
- the index insert intoelement
- a scalar ndarrayINDArray diviColumnVector(INDArray columnVector)
columnVector
- the column vector used for divisionINDArray divColumnVector(INDArray columnVector)
columnVector
- the column vector used for divisionINDArray diviRowVector(INDArray rowVector)
rowVector
- the row vector used for divisionINDArray divRowVector(INDArray rowVector)
rowVector
- the row vector used for divisionINDArray rdiviColumnVector(INDArray columnVector)
columnVector
- the column vector used for divisionINDArray rdivColumnVector(INDArray columnVector)
columnVector
- the column vector used for divisionINDArray rdiviRowVector(INDArray rowVector)
rowVector
- the row vector used for divisionINDArray rdivRowVector(INDArray rowVector)
rowVector
- the row vector used for divisionINDArray muliColumnVector(INDArray columnVector)
columnVector
- the column vector used for multiplicationINDArray mulColumnVector(INDArray columnVector)
columnVector
- the column vector used for multiplicationINDArray muliRowVector(INDArray rowVector)
rowVector
- the row vector used for multiplicationINDArray mulRowVector(INDArray rowVector)
rowVector
- the row vector used for multiplicationINDArray rsubiColumnVector(INDArray columnVector)
columnVector
- the column vector to subtractINDArray rsubColumnVector(INDArray columnVector)
columnVector
- the column vector to subtractINDArray rsubiRowVector(INDArray rowVector)
rowVector
- the row vector to subtractINDArray rsubRowVector(INDArray rowVector)
rowVector
- the row vector to subtractINDArray subiColumnVector(INDArray columnVector)
columnVector
- the column vector to subtractINDArray subColumnVector(INDArray columnVector)
columnVector
- the column vector to subtractINDArray subiRowVector(INDArray rowVector)
rowVector
- the row vector to subtractINDArray subRowVector(INDArray rowVector)
rowVector
- the row vector to subtractINDArray addiColumnVector(INDArray columnVector)
columnVector
- the column vector to addINDArray putiColumnVector(INDArray columnVector)
columnVector
- the column vector to addINDArray addColumnVector(INDArray columnVector)
columnVector
- the column vector to addINDArray addiRowVector(INDArray rowVector)
rowVector
- the row vector to addINDArray putiRowVector(INDArray rowVector)
rowVector
- Row vector to putINDArray addRowVector(INDArray rowVector)
rowVector
- the row vector to addINDArray mmul(INDArray other, MMulTranspose mMulTranspose)
other
- the other matrix to perform matrix multiply withINDArray mmul(INDArray other)
other
- the other matrix to perform matrix multiply withdouble[][] toDoubleMatrix()
double[] toDoubleVector()
float[] toFloatVector()
float[][] toFloatMatrix()
int[] toIntVector()
long[] toLongVector()
long[][] toLongMatrix()
int[][] toIntMatrix()
INDArray mmul(INDArray other, INDArray result)
other
- the other matrix to perform matrix multiply withresult
- the result ndarrayINDArray mmul(INDArray other, INDArray result, MMulTranspose mMulTranspose)
other
- the other matrix to perform matrix multiply withresult
- the result ndarraymMulTranspose
- the transpose status of each arrayINDArray div(INDArray other)
other
- the second ndarray to divideINDArray div(INDArray other, INDArray result)
other
- the second ndarray to divideresult
- the result ndarrayINDArray mul(INDArray other)
other
- the second ndarray to multiplyINDArray mul(INDArray other, INDArray result)
other
- the second ndarray to multiplyresult
- the result ndarrayINDArray sub(INDArray other)
other
- the second ndarray to subtractINDArray sub(INDArray other, INDArray result)
other
- the second ndarray to subtractresult
- the result ndarrayINDArray add(INDArray other)
other
- the second ndarray to addINDArray add(INDArray other, INDArray result)
other
- the second ndarray to addresult
- the result ndarrayINDArray mmuli(INDArray other, MMulTranspose transpose)
other
- the other matrix to perform matrix multiply withtranspose
- the transpose status of each ndarrayINDArray mmuli(INDArray other)
other
- the other matrix to perform matrix multiply withINDArray mmuli(INDArray other, INDArray result, MMulTranspose transpose)
other
- the other matrix to perform matrix multiply withresult
- the result ndarrayINDArray mmuli(INDArray other, INDArray result)
other
- the other matrix to perform matrix multiply withresult
- the result ndarrayINDArray divi(INDArray other)
other
- the second ndarray to divideINDArray divi(INDArray other, INDArray result)
other
- the second ndarray to divideresult
- the result ndarrayINDArray muli(INDArray other)
other
- the second ndarray to multiplyINDArray muli(INDArray other, INDArray result)
other
- the second ndarray to multiplyresult
- the result ndarrayINDArray subi(INDArray other)
other
- the second ndarray to subtractINDArray subi(INDArray other, INDArray result)
other
- the second ndarray to subtractresult
- the result ndarrayINDArray addi(INDArray other)
other
- the second ndarray to addINDArray addi(INDArray other, INDArray result)
other
- the second ndarray to addresult
- the result ndarrayINDArray normmax(int... dimension)
dimension
- the dimension to the max norm alongINDArray normmax(boolean keepDims, int... dimension)
dimension
- the dimension to the max norm alongkeepDims
- whether to keep reduced dimensions as dimensions of size 1Number normmaxNumber()
INDArray norm2(int... dimension)
dimension
- the dimension to getScalar the norm2 alongINDArray norm2(boolean keepDims, int... dimension)
dimension
- the dimension to getScalar the norm2 alongkeepDims
- whether to keep reduced dimensions as dimensions of size 1Number norm2Number()
INDArray norm1(int... dimension)
dimension
- the dimension to getScalar the norm1 alongINDArray norm1(boolean keepDims, int... dimension)
dimension
- the dimension to getScalar the norm1 alongkeepDims
- whether to keep reduced dimensions as dimensions of size 1Number norm1Number()
INDArray std(int... dimension)
dimension
- the dimension to getScalar the std alongNumber stdNumber()
INDArray std(boolean biasCorrected, int... dimension)
dimension
- the dimension to getScalar the std alongINDArray std(boolean biasCorrected, boolean keepDims, int... dimension)
dimension
- the dimension to getScalar the std alongkeepDims
- whether to keep reduced dimensions as dimensions of size 1Number stdNumber(boolean biasCorrected)
biasCorrected
- If true: bias corrected standard deviation. False: not bias correctedINDArray prod(int... dimension)
dimension
- the dimension to getScalar the product alongINDArray prod(boolean keepDims, int... dimension)
dimension
- the dimension to getScalar the product alongkeepDims
- whether to keep reduced dimensions as dimensions of size 1Number prodNumber()
INDArray mean(int... dimension)
dimension
- the dimension to getScalar the mean alongINDArray mean(INDArray result, int... dimension)
dimension
- the dimension to getScalar the mean alongINDArray mean(boolean keepDims, int... dimension)
dimension
- the dimension to getScalar the mean alongkeepDims
- whether to keep reduced dimensions as dimensions of size 1INDArray mean(INDArray result, boolean keepDims, int... dimension)
dimension
- the dimension to getScalar the mean alongkeepDims
- whether to keep reduced dimensions as dimensions of size 1INDArray amean(int... dimension)
dimension
- the dimension to getScalar the mean alongNumber meanNumber()
Number ameanNumber()
INDArray var(int... dimension)
dimension
- the dimension to getScalar the variance alongINDArray var(boolean biasCorrected, int... dimension)
biasCorrected
- boolean on whether to apply corrected biasdimension
- the dimension to getScalar the variance alongNumber varNumber()
INDArray max(int... dimension)
dimension
- the dimension to getScalar the max alongINDArray max(boolean keepDims, int... dimension)
dimension
- the dimension to getScalar the max alongkeepDims
- whether to keep reduced dimensions as dimensions of size 1INDArray amax(int... dimension)
dimension
- the dimension to getScalar the amax alongNumber maxNumber()
Number amaxNumber()
INDArray min(int... dimension)
dimension
- the dimension to getScalar the min alongINDArray min(boolean keepDims, int... dimension)
dimension
- the dimension to getScalar the min alongkeepDims
- whether to keep reduced dimensions as dimensions of size 1INDArray amin(int... dimension)
Number minNumber()
Number aminNumber()
INDArray sum(int... dimension)
dimension
- the dimension to getScalar the sum alongINDArray sum(boolean keepDims, int... dimension)
dimension
- the dimension to getScalar the sum alongkeepDims
- whether to keep reduced dimensions as dimensions of size 1Number scan(Condition condition)
condition
- Condition to calculate matches forINDArray sum(INDArray result, int... dimension)
result
- result of this operation will be stored heredimension
- the dimension to getScalar the sum alongINDArray sum(INDArray result, boolean keepDims, int... dimension)
result
- result of this operation will be stored herekeepDims
- whether to keep reduced dimensions as dimensions of size 1dimension
- the dimension to getScalar the sum alongNumber sumNumber()
Number entropyNumber()
Number shannonEntropyNumber()
Number logEntropyNumber()
INDArray entropy(int... dimension)
dimension
- specified dimension(s)INDArray shannonEntropy(int... dimension)
dimension
- specified dimension(s)INDArray logEntropy(int... dimension)
dimension
- specified dimension(s)void setShapeAndStride(int[] shape, int[] stride)
shape
- new value for shapestride
- new value for stridevoid setOrder(char order)
order
- the ordering to setINDArray getScalar(int... indices)
indices
- the indices to getScalarINDArray getScalar(long... indices)
int getInt(int... indices)
indices
- Indices to get the integer at. Number of indices must match the array rank.long getLong(long index)
long getLong(long... indices)
Number getNumber(long index)
Number getNumber(long... indices)
double getDouble(int... indices)
indices
- Indices to get the double at. Number of indices must match the array rank.double getDouble(long... indices)
float getFloat(int[] indices)
indices
- the indices to getScalarfloat getFloat(long[] indices)
double getDouble(long i)
i
- Indexdouble getDouble(long i, long j)
i
- Dimension 0 (row) indexj
- Dimension 1 (column) indexfloat getFloat(long i)
i
- the index of the item to getScalarfloat getFloat(long i, long j)
i
- the row to getScalarj
- the column to getScalarINDArray dup()
INDArray dup(char order)
order
- order of the NDArray. 'f' or 'c'INDArray ravel()
INDArray ravel(char order)
void setData(DataBuffer data)
data
- long slices()
int getTrailingOnes()
int getLeadingOnes()
INDArray slice(long i, int dimension)
i
- the index of the slice to returndimension
- the dimension to return the slice forINDArray slice(long i)
i
- the index of the slice to returnlong offset()
long originalOffset()
INDArray reshape(char order, long... newShape)
newShape
- the new shape of the ndarrayINDArray reshape(char order, int... newShape)
newShape
- the new shape of the ndarrayINDArray reshape(char order, boolean enforceView, long... newShape)
newShape
- the new shape of the ndarrayINDArray reshape(char order, int rows, int columns)
rows
- the rows of the matrixcolumns
- the columns of the matrixINDArray reshape(long... newShape)
newShape
- the new shape of the ndarrayINDArray reshape(int[] shape)
INDArray reshape(long rows, long columns)
rows
- the rows of the matrixcolumns
- the columns of the matrixINDArray transpose()
INDArray transposei()
INDArray swapAxes(int dimension, int with)
dimension
- the dimension to swapwith
- the one to swap it withINDArray permute(int... rearrange)
rearrange
- the dimensions to swap toINDArray permutei(int... rearrange)
rearrange
- the dimensions to swap toINDArray dimShuffle(Object[] rearrange, int[] newOrder, boolean[] broadCastable)
rearrange
- the dimensions to swap tonewOrder
- the new order (think permute)broadCastable
- (whether the dimension is broadcastable) (must be same length as new order)INDArray getColumn(long i)
i
- the column to getScalarINDArray getColumn(long i, boolean keepDim)
i
- the row to getkeepDim
- If true: return [length, 1] array. Otherwise: return [length] arrayINDArray getRow(long i)
i
- the row to getScalarINDArray getRow(long i, boolean keepDim)
i
- the row to getkeepDim
- If true: return [1,length] array. Otherwise: return [length] arrayint columns()
int rows()
boolean isColumnVector()
boolean isRowVector()
boolean isColumnVectorOrScalar()
boolean isRowVectorOrScalar()
boolean isVector()
boolean isVectorOrScalar()
boolean isSquare()
boolean isMatrix()
boolean isScalar()
long[] shape()
LongShapeDescriptor shapeDescriptor()
long[] stride()
char ordering()
long size(int dimension)
dimension
- the dimension to return the size forlong length()
INDArray broadcast(long... shape)
shape
- the new shape of this ndarrayINDArray broadcast(INDArray result)
Object element()
DataBuffer data()
boolean equalsWithEps(Object o, double eps)
o
- eps
- Epsilon value to use for the quality operationboolean equalShapes(INDArray other)
other
- OtherINDArray unsafeDuplication()
dup()
INDArray unsafeDuplication(boolean blocking)
dup()
INDArray remainder(INDArray denominator)
denominator
- the denominatorINDArray remainder(INDArray denominator, INDArray result)
denominator
- the denominatorresult
- the result array to put this inINDArray remainder(Number denominator)
denominator
- the denominator as a scalarINDArray remainder(Number denominator, INDArray result)
denominator
- result
- INDArray remainderi(INDArray denominator)
denominator
- INDArray remainderi(Number denominator)
denominator
- INDArray fmod(INDArray denominator)
denominator
- the array of denominators for each element
in this arrayINDArray fmod(INDArray denominator, INDArray result)
denominator
- theresult
- the result arrayINDArray argMax(int... dimension)
dimension
- Dimension along which to perform the argMax operationboolean isAttached()
boolean isInScope()
INDArray detach()
INDArray leverage()
INDArray leverageTo(String id)
id
- ID of the workspace to leverage toleverageTo(String, boolean)
INDArray leverageTo(String id, boolean enforceExistence) throws Nd4jNoSuchWorkspaceException
Nd4jNoSuchWorkspaceException
is thrown. Otherwise, if enforceExistance == false and no workspace with the specified ID exists, then the current
INDArray is returned unmodified (same as leverage()
id
- ID of the workspace to leverage toenforceExistence
- If true, and the specified workspace does not exist: an Nd4jNoSuchWorkspaceException
will be thrown.Nd4jNoSuchWorkspaceException
leverageTo(String)
INDArray leverageOrDetach(String id)
id
- ID of the workspace to leverage toleverageTo(String)
INDArray migrate()
migrate(boolean)
INDArray migrate(boolean detachOnNoWs)
migrate()
detachOnNoWs
- If true: detach on no WS. If false and no workspace: return this.Number percentileNumber(Number percentile)
percentile
- target percentile in range of 0..100Number medianNumber()
INDArray median(int... dimension)
dimension
- INDArray percentile(Number percentile, int... dimension)
percentile
- target percentile in range of 0..100dimension
- Dimension to calculate percentile forDataBuffer getVectorCoordinates()
INDArray toDense()
int nnz()
SparseFormat getFormat()
SparseFormat
int[] flags()
int[] hiddenDimensions()
int[] sparseOffsets()
int underlyingRank()
int toFlatArray(com.google.flatbuffers.FlatBufferBuilder builder)
INDArray
to flatbuffers builderbuilder
- the builder to useboolean isEmpty()
long[] shapeInfoJava()
DataType dataType()
boolean isR()
boolean isZ()
boolean isB()
boolean isS()
INDArray castTo(DataType dataType)
dataType
- boolean all()
boolean any()
boolean none()
boolean closeable()
void close()
close
in interface AutoCloseable
boolean wasClosed()
INDArray like()
INDArray ulike()
String toString(@NonNull NDArrayStrings options)
options
- format optionsString toString(long maxElements, boolean forceSummarize, int precision)
maxElements
- Summarize if more than maxElements in the arrayforceSummarize
- Force a summary instead of a full printprecision
- The number of decimals to print. Doesn't print trailing 0s if negativeString toStringFull()
BaseNDArray.toString(long, boolean, int)
Copyright © 2019. All rights reserved.