ai.djl.ndarray

Interface Matrix

All Superinterfaces:

java.lang.AutoCloseable, NDArray

public interface Matrix
extends NDArray

An interface representing a 2-dimensional matrix.

Method Summary

Modifier and Type	Method and Description
NDArray	addColumnVector(NDArray columnVector) Adds a column vector (copy).
NDArray	addiColumnVector(NDArray columnVector) Adds a column vector in place.
NDArray	addiRowVector(NDArray rowVector) Adds a row vector in place.
NDArray	addRowVector(NDArray rowVector) Adds a row vector (copy).
NDArray	divColumnVector(NDArray columnVector) Divides a column vector (copy).
NDArray	diviColumnVector(NDArray columnVector) Divides a column vector in place.
NDArray	diviRowVector(NDArray rowVector) Divides a row vector in place.
NDArray	divRowVector(NDArray rowVector) Divides a row vector (copy).
NDArray	getColumn(long i) Returns the specified column.
NDArray	getColumns(int... columns) Returns a new NDArray comprised of the specified columns only.
NDArray	getRow(long i) Returns the specified row.
NDArray	getRows(int... rows) Returns a new NDArray comprised of the specified rows only.
NDArray	getScalar(long row, long column) Returns the element at the specified row/column.
NDArray	mulColumnVector(NDArray columnVector) Multiplies a column vector (copy).
NDArray	muliColumnVector(NDArray columnVector) Multiplies a column vector in place.
NDArray	muliRowVector(NDArray rowVector) Multiplies a row vector in place.
NDArray	mulRowVector(NDArray rowVector) Multiplies a row vector (copy).
NDArray	put(int i, int j, java.lang.Number element) Inserts the element at the specified index.
NDArray	putColumn(int column, NDArray toPut) Inserts a column into this array.
NDArray	putiColumnVector(NDArray columnVector) Assigns a column vector in place.
NDArray	putiRowVector(NDArray rowVector) Assigns a row vector to each row of this array in place.
NDArray	putRow(long row, NDArray toPut) Inserts a row into this matrix.
NDArray	rdivColumnVector(NDArray columnVector) Reverses the division of a column vector (copy).
NDArray	rdiviColumnVector(NDArray columnVector) Reverses the divison of a column vector in place.
NDArray	rdiviRowVector(NDArray rowVector) Reverses division of a column vector in place.
NDArray	rdivRowVector(NDArray rowVector) Reverses division of a column vector (copy).
NDArray	reshape(char order, int rows, int columns) Reshapes the NDArray (it can't change the length of the NDArray).
NDArray	rsubColumnVector(NDArray columnVector) Reverses subtraction of a column vector (copy).
NDArray	rsubiColumnVector(NDArray columnVector) Reverses subtraction of a column vector in place.
NDArray	rsubiRowVector(NDArray rowVector) Reverses subtraction of a row vector in place.
NDArray	rsubRowVector(NDArray rowVector) Reverses subtraction of a row vector (copy).
NDArray	subColumnVector(NDArray columnVector) Subtracts a column vector (copy).
NDArray	subiColumnVector(NDArray columnVector) Subtracts a column vector in place.
NDArray	subiRowVector(NDArray rowVector) Subtracts a row vector in place.
NDArray	subRowVector(NDArray rowVector) Subtracts a row vector (copy).
double[][]	toDoubleMatrix() Converts this NDArray to a 2d double matrix.
float[][]	toFloatMatrix() Converts this NDArray to a 2d float matrix.
int[][]	toIntMatrix() Converts this NDArray to a 2d int matrix.
long[][]	toLongMatrix() Converts this NDArray to a 2d long matrix.

Methods inherited from interface ai.djl.ndarray.NDArray

abs, acos, acosh, add, add, addi, addi, all, allClose, allClose, any, argMax, argMax, argMin, argMin, argSort, argSort, argSort, asin, asInDevice, asinh, asMatrix, asType, atan, atanh, attach, attachGradient, booleanMask, booleanMask, broadcast, broadcast, cbrt, ceil, clip, close, concat, concat, contentEquals, contentEquals, copyTo, cos, cosh, countNonzero, countNonzero, createMask, createMask, cumSum, cumSum, detach, div, div, divi, divi, dot, duplicate, eq, eq, exp, expandDims, flatten, floor, get, get, get, get, getBoolean, getByte, getDataType, getDevice, getDouble, getFloat, getGradient, getInt, getLong, getManager, getName, getNDArrayInternal, getScalar, getShape, getSparseFormat, getUid, getUint8, gt, gt, gte, gte, isEmpty, isInfinite, isNaN, isScalar, isSparse, like, log, log10, log2, logicalAnd, logicalNot, logicalOr, logicalXor, lt, lt, lte, lte, max, max, max, maximum, maximum, mean, mean, mean, median, median, min, min, min, minimum, minimum, mod, mod, modi, modi, mul, mul, muli, muli, neg, negi, neq, neq, none, nonzero, onesLike, percentile, percentile, pow, pow, powi, powi, prod, prod, prod, repeat, repeat, repeat, repeat, reshape, reshape, round, set, set, set, set, set, set, set, set, setName, setScalar, shapeEquals, sin, sinh, size, size, slice, softmax, softmax, softmax, softmax, sort, sort, split, split, split, split, square, squeeze, squeeze, squeeze, stack, stack, sub, sub, subi, subi, sum, sum, sum, swapAxes, tan, tanh, tile, tile, tile, tile, toArray, toBooleanArray, toByteArray, toByteBuffer, toDegrees, toDense, toDoubleArray, toFloatArray, toIntArray, toLongArray, toRadians, toSparse, toUint8Array, trace, trace, trace, transpose, transpose, trunc, zerosLike

Method Detail

putRow

NDArray putRow(long row,
               NDArray toPut)

Inserts a row into this matrix.

Parameters:

row - the row to insert

toPut - the array to insert into

Returns:

this matrix

putColumn

NDArray putColumn(int column,
                  NDArray toPut)

Inserts a column into this array.

Parameters:

column - the column to insert

toPut - the array to insert into

Returns:

this array

getScalar

NDArray getScalar(long row,
                  long column)

Returns the element at the specified row/column.

Parameters:

row - the row of the element to return

column - the column of the element to return

Returns:

a scalar NDArray of the element at this index

diviColumnVector

NDArray diviColumnVector(NDArray columnVector)

Divides a column vector in place.

Parameters:

columnVector - the column vector used for division

Returns:

the result of the division

divColumnVector

NDArray divColumnVector(NDArray columnVector)

Divides a column vector (copy).

Parameters:

columnVector - the column vector used for division

Returns:

the result of the division

diviRowVector

NDArray diviRowVector(NDArray rowVector)

Divides a row vector in place.

Parameters:

rowVector - the row vector used for division

Returns:

the result of the division

divRowVector

NDArray divRowVector(NDArray rowVector)

Divides a row vector (copy).

Parameters:

rowVector - the row vector used for division

Returns:

the result of the division

rdiviColumnVector

NDArray rdiviColumnVector(NDArray columnVector)

Reverses the divison of a column vector in place.

Parameters:

columnVector - the column vector used for division

Returns:

the result of the division

rdivColumnVector

NDArray rdivColumnVector(NDArray columnVector)

Reverses the division of a column vector (copy).

Parameters:

columnVector - the column vector used for division

Returns:

the result of the division

rdiviRowVector

NDArray rdiviRowVector(NDArray rowVector)

Reverses division of a column vector in place.

Parameters:

rowVector - the row vector used for division

Returns:

the result of the division

rdivRowVector

NDArray rdivRowVector(NDArray rowVector)

Reverses division of a column vector (copy).

Parameters:

rowVector - the row vector used for division

Returns:

the result of the division

muliColumnVector

NDArray muliColumnVector(NDArray columnVector)

Multiplies a column vector in place.

Parameters:

columnVector - the column vector used for multiplication

Returns:

the result of the multiplication

mulColumnVector

NDArray mulColumnVector(NDArray columnVector)

Multiplies a column vector (copy).

Parameters:

columnVector - the column vector used for multiplication

Returns:

the result of the multiplication

muliRowVector

NDArray muliRowVector(NDArray rowVector)

Multiplies a row vector in place.

Parameters:

rowVector - the row vector used for multiplication

Returns:

the result of the multiplication

mulRowVector

NDArray mulRowVector(NDArray rowVector)

Multiplies a row vector (copy).

Parameters:

rowVector - the row vector used for multiplication

Returns:

the result of the multiplication

rsubiColumnVector

NDArray rsubiColumnVector(NDArray columnVector)

Reverses subtraction of a column vector in place.

Parameters:

columnVector - the column vector to subtract

Returns:

the result of the subtraction

rsubColumnVector

NDArray rsubColumnVector(NDArray columnVector)

Reverses subtraction of a column vector (copy).

Parameters:

columnVector - the column vector to subtract

Returns:

the result of the subtraction

rsubiRowVector

NDArray rsubiRowVector(NDArray rowVector)

Reverses subtraction of a row vector in place.

Parameters:

rowVector - the row vector to subtract

Returns:

the result of the subtraction

rsubRowVector

NDArray rsubRowVector(NDArray rowVector)

Reverses subtraction of a row vector (copy).

Parameters:

rowVector - the row vector to subtract

Returns:

the result of the subtraction

subiColumnVector

NDArray subiColumnVector(NDArray columnVector)

Subtracts a column vector in place.

Parameters:

columnVector - the column vector to subtract

Returns:

the result of the subtraction

subColumnVector

NDArray subColumnVector(NDArray columnVector)

Subtracts a column vector (copy).

Parameters:

columnVector - the column vector to subtract

Returns:

the result of the subtraction

subiRowVector

NDArray subiRowVector(NDArray rowVector)

Subtracts a row vector in place.

Parameters:

rowVector - the row vector to subtract

Returns:

the result of the subtraction

subRowVector

NDArray subRowVector(NDArray rowVector)

Subtracts a row vector (copy).

Parameters:

rowVector - the row vector to subtract

Returns:

the result of the subtraction

addiColumnVector

NDArray addiColumnVector(NDArray columnVector)

Adds a column vector in place.

Parameters:

columnVector - the column vector to add

Returns:

the result of the addition

putiColumnVector

NDArray putiColumnVector(NDArray columnVector)

Assigns a column vector in place.

Parameters:

columnVector - the column vector to add

Returns:

the result of the assignment

addColumnVector

NDArray addColumnVector(NDArray columnVector)

Adds a column vector (copy).

Parameters:

columnVector - the column vector to add

Returns:

the result of the addition

addiRowVector

NDArray addiRowVector(NDArray rowVector)

Adds a row vector in place.

Parameters:

rowVector - the row vector to add

Returns:

the result of the addition

putiRowVector

NDArray putiRowVector(NDArray rowVector)

Assigns a row vector to each row of this array in place.

Parameters:

rowVector - the row vector to assign

Returns:

this array, after assigning every row to the specified value

addRowVector

NDArray addRowVector(NDArray rowVector)

Adds a row vector (copy).

Parameters:

rowVector - the row vector to add

Returns:

the result of the addition

getColumn

NDArray getColumn(long i)

Returns the specified column.

Parameters:

i - the column to getScalar

Returns:

the specified column

getRow

NDArray getRow(long i)

Returns the specified row.

Parameters:

i - the row to getScalar

Returns:

the specified row

getColumns

NDArray getColumns(int... columns)

Returns a new NDArray comprised of the specified columns only.

Parameters:

columns - the columns to extract out of the current array

Returns:

an array with only the specified columns

getRows

NDArray getRows(int... rows)

Returns a new NDArray comprised of the specified rows only.

Parameters:

rows - the rows to extract from this array

Returns:

an array with only the specified rows

put

NDArray put(int i,
            int j,
            java.lang.Number element)

Inserts the element at the specified index.

Parameters:

i - the row to insert into

j - the column to insert into

element - a scalar NDArray

Returns:

a scalar NDArray of the element at this index

reshape

NDArray reshape(char order,
                int rows,
                int columns)

Reshapes the NDArray (it can't change the length of the NDArray).

Parameters:

order - the order of the new array

rows - the rows of the matrix

columns - the columns of the matrix

Returns:

the reshaped NDArray

toDoubleMatrix

double[][] toDoubleMatrix()

Converts 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 the off heap nature, moving data on heap is very expensive and should not be used if possible.

Returns:

a copy of this array as a 2d double array

toFloatMatrix

float[][] toFloatMatrix()

Converts 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 the off heap nature, moving data on to the heap is very expensive and should not be used if possible.

Returns:

a copy of this array as a 2d float array

toLongMatrix

long[][] toLongMatrix()

Converts this NDArray to a 2d long matrix.

Note that THIS SHOULD NOT BE USED FOR SPEED. This is mainly used for integrations with other libraries. Due to the off heap nature, moving data on to the heap is very expensive and should not be used if possible.

Returns:

a copy of this array as a 2d long array

toIntMatrix

int[][] toIntMatrix()

Converts 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 the off heap nature, moving data on to the heap is very expensive and should not be used if possible.

Returns:

a copy of this array as a 2d int array