BaseSparseNDArrayCOO (nd4j-api 1.0.0-beta4 API)

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

All Implemented Interfaces:

Serializable, AutoCloseable, INDArray, ISparseNDArray
```
public class BaseSparseNDArrayCOO
extends BaseSparseNDArray
```
Author:

Audrey Loeffel

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected static SparseFormat format

protected DataBuffer indices

protected boolean isSorted

protected DataBuffer values
- Fields inherited from class org.nd4j.linalg.api.ndarray.BaseSparseNDArray
  columns, isMatrix, isScalar, isSparse, isVector, javaShapeInformation, length, rank, rows, shape, shapeInformation, sparseInformation, stride, THRESHOLD_MEMORY_ALLOCATION

Fields
Modifier and Type	Field and Description
`protected static SparseFormat`	`format`
`protected DataBuffer`	`indices`
`protected boolean`	`isSorted`
`protected DataBuffer`	`values`

Constructor Summary

Constructors
Constructor and Description
`BaseSparseNDArrayCOO(DataBuffer values, DataBuffer indices, DataBuffer sparseInformation, long[] shape)`
`BaseSparseNDArrayCOO(DataBuffer values, DataBuffer indices, long[] shape)`
`BaseSparseNDArrayCOO(DataBuffer values, DataBuffer indices, long[] sparseOffsets, int[] flags, int[] hiddenDimensions, int underlyingRank, long[] shape)`
`BaseSparseNDArrayCOO(double[] values, int[][] indices, long[] shape)`
`BaseSparseNDArrayCOO(double[] values, long[][] indices, long[] shape)`
`BaseSparseNDArrayCOO(float[] values, int[][] indices, long[] shape)`
`BaseSparseNDArrayCOO(float[] values, long[][] indices, long[] shape)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addOrUpdate(long[] indexes, double value)` Add a new element in the ndarray or update the value if there is already a non-null element at this position
`boolean`	`all()` This method checks if all elements within this array are non-zero (or true, in case of boolean)
`boolean`	`any()` This method checks if any of the elements within this array are non-zero (or true, in case of boolean)
`INDArray`	`assign(INDArray arr)` Assign all of the elements in the given ndarray to this ndarray
`boolean`	`canInsert(DataBuffer buffer, int length)` Return if there is enough allocated memory space to add data of a given length in the databuffer
`INDArray`	`castTo(DataType dataType)` This method cast elements of this INDArray to new data type
`protected void`	`checkBufferCoherence()` Check that the length of indices and values are coherent and matches the rank of the matrix.
`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
`long`	`countNNZ()` Count the number of value that are included in the ndarray (view) according to the sparse offsets and the shape
`protected static DataBuffer`	`createIndiceBuffer(int[][] indices, long[] shape)` Create a DataBuffer for indices of given arrays of indices.
`protected static DataBuffer`	`createIndiceBuffer(long[][] indices, long[] shape)` Create a DataBuffer for indices of given arrays of indices.
`protected static DataBuffer`	`createSparseInformationBuffer(int rank)` Create a SparseInfo databuffer given rank if of the sparse matrix.
`protected static DataBuffer`	`createValueBuffer(double[] values)` Create a DataBuffer for values of given array of values.
`protected static DataBuffer`	`createValueBuffer(float[] values)` Create a DataBuffer for values of given array of values.
`DataBuffer`	`data()` Returns a linear double array representation of this ndarray
`int[]`	`filterOutFixedDimensions(int[] flags, List<Integer> idx)`
`INDArray`	`get(INDArrayIndex... indexes)` Returns a subset of this array based on the specified indexes
`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.
`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, ...)
`DataBuffer`	`getIncludedIndices()` Return a copy of the indices included in the view.
`DataBuffer`	`getIncludedValues()` Return a copy of the values included in the array.
`DataBuffer`	`getIndices()`
`DataBuffer`	`getIndicesOf(int i)` Returns the indices of the element of the given index in the array context
`int`	`getInt(int... indices)` Get an integer value at the specified indices.
`long`	`getLong(long index)`
`int`	`getNumHiddenDimension()`
`INDArray`	`getScalar(int... indices)` Returns the elements at the specified indices
`INDArray`	`getScalar(long... indices)`
`String`	`getString(long index)`
`DataBuffer`	`getUnderlyingIndices()` Return the indices buffer
`DataBuffer`	`getUnderlyingIndicesOf(int i)` Returns the underlying indices of the element of the given index such as there really are in the original ndarray
`DataBuffer`	`getUnderlyingValues()` Return the values buffer
`DataBuffer`	`getValues()`
`DataBuffer`	`getVectorCoordinates()` Returns the indices of non-zero element of the vector
`int`	`indexesBinarySearch(int lowerBound, int upperBound, int[] idx)` Return the position of the idx array into the indexes buffer between the lower and upper bound.
`boolean`	`isB()` This method checks if this INDArray instance has boolean type
`boolean`	`isDimensionFixed(int i)` Return if the dimension in argument is a fixed dimension.
`boolean`	`isEmpty()` This method returns true if this INDArray is special case: no-value INDArray
`boolean`	`isR()` This method checks if this INDArray instance is one of Real types
`boolean`	`isS()` This method checks if this INDArray instance has String type
`boolean`	`isSorted()`
`boolean`	`isView()` Returns true if this array is a view or not
`boolean`	`isZ()` This method checks if this INDArray instance is one of integer types
`boolean`	`isZero(int... indexes)`
`INDArray`	`mmul(INDArray other, INDArray result, MMulTranspose mMulTranspose)` Perform an copy matrix multiplication
`INDArray`	`mmul(INDArray other, MMulTranspose mMulTranspose)`
`INDArray`	`mmuli(INDArray other, INDArray result, MMulTranspose transpose)`
`INDArray`	`mmuli(INDArray other, MMulTranspose transpose)`
`boolean`	`none()` This method checks if any of the elements within this array are non-zero (or true, in case of boolean)
`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[] indexes, 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[] indexes, double value)` Insert the item at the specified indices
`INDArray`	`putScalar(long[] indexes, 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 `INDArray.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 `INDArray.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 `INDArray.putScalar(int[], double)` but avoids int[] creation
`INDArray`	`removeEntry(int idx)` Remove an element of the ndarray
`INDArray`	`repeat(int dimension, long... repeats)` Repeat elements along a specified dimension.
`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(int[] shape)`
`int`	`reverseIndexes(int... indexes)` Return the index of the value corresponding to the indexes
`void`	`setShape(long... shape)` Shape setter
`void`	`setStride(long... stride)` stride setter
`LongShapeDescriptor`	`shapeDescriptor()` Returns shape descriptor of this ndarray
`DataBuffer`	`shapeInfoDataBuffer()` Shape info
`DataBuffer`	`shiftLeft(DataBuffer buffer, int from, int offset, long datalength)`
`void`	`sort()` Sort the indexes and the values buffers
`INDArray`	`subArray(long[] offsets, int[] shape, int[] stride)`
`INDArray`	`toDense()` Converts the sparse ndarray into a dense one
`int`	`toFlatArray(com.google.flatbuffers.FlatBufferBuilder builder)` Add an `INDArray` to flatbuffers builder
`int[]`	`translateToPhysical(int[] virtualIndexes)`
`long[]`	`translateToPhysical(long[] virtualIndexes)` Translate the view index to the corresponding index of the original ndarray
`int`	`underlyingRank()`

Methods inherited from class org.nd4j.linalg.api.ndarray.BaseSparseNDArray
add, add, add, add, addColumnVector, addi, addi, addi, addi, addiColumnVector, addiRowVector, addRowVector, amax, amaxNumber, amean, ameanNumber, amin, aminNumber, argMax, assign, assignIf, broadcast, broadcast, clone, columns, cond, cumsum, cumsumi, dataType, detach, dimShuffle, dimShuffle, distance1, distance2, div, div, div, div, divColumnVector, divi, divi, divi, divi, diviColumnVector, diviRowVector, divRowVector, dup, dup, element, elementWiseStride, entropy, entropyNumber, eps, eps, eq, eq, equals, equalShapes, equalsWithEps, flags, fmod, fmod, fmod, fmod, fmodi, fmodi, get, get, getColumn, getColumn, getColumns, getDoubleUnsafe, getLeadingOnes, getLong, getNumber, getNumber, getPercentile, getRow, getRow, getRows, getScalar, getScalar, getTrailingOnes, getWhere, getWhere, gt, gt, gte, hiddenDimensions, init, isAttached, isColumnVector, isColumnVectorOrScalar, isCompressed, isInfinite, isInScope, isMatrix, isNaN, isRowVector, isRowVectorOrScalar, isScalar, isSparse, isSquare, isVector, isVectorOrScalar, javaTensorAlongDimension, length, lengthLong, leverage, leverageOrDetach, leverageTo, leverageTo, like, linearIndex, logEntropy, logEntropyNumber, lt, lt, lte, markAsCompressed, match, match, max, maxNumber, mean, mean, meanNumber, median, medianNumber, migrate, migrate, min, minNumber, mmul, mmul, mmuli, mmuli, mul, mul, mul, mul, mulColumnVector, muli, muli, muli, muli, muliColumnVector, muliRowVector, mulRowVector, neg, negi, neq, neq, nnz, norm1, norm1Number, norm2, norm2Number, normmax, normmaxNumber, offset, ordering, originalOffset, percentile, percentileNumber, permute, permutei, prod, prodNumber, put, putScalar, putScalar, putScalarUnsafe, putSlice, putWhere, putWhere, putWhere, putWhereWithMask, putWhereWithMask, rank, ravel, ravel, rdiv, rdiv, rdiv, rdiv, rdivColumnVector, rdivi, rdivi, rdivi, rdivi, rdiviColumnVector, rdiviRowVector, rdivRowVector, reallocate, remainder, remainder, remainder, remainder, remainderi, remainderi, replaceWhere, repmat, reshape, reshape, reshape, reshape, rows, rsub, rsub, rsub, rsub, rsubColumnVector, rsubi, rsubi, rsubi, rsubi, rsubiColumnVector, rsubiRowVector, rsubRowVector, scan, setData, setOrder, setShapeAndStride, setShapeInformation, shannonEntropy, shannonEntropyNumber, shape, shapeInfo, shapeInfoJava, shapeInfoToString, shapeOf, size, slice, slice, slices, sliceVectors, sparseInfoDataBuffer, sparseOffsets, squaredDistance, std, std, stdNumber, stdNumber, stride, stride, strideOf, sub, sub, sub, sub, subColumnVector, subi, subi, subi, subi, subiColumnVector, subiRowVector, subRowVector, sum, sum, sum, sumNumber, swapAxes, tensorAlongDimension, tensorsAlongDimension, toDoubleMatrix, toDoubleVector, toFloatMatrix, toFloatVector, toIntMatrix, toIntVector, toLongMatrix, toLongVector, transpose, transposei, ulike, unsafeDuplication, unsafeDuplication, var, var, varNumber, vectorAlongDimension, vectorsAlongDimension

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

- Field Detail
  - format
```
protected static final SparseFormat format
```
  - values
```
protected transient volatile DataBuffer values
```
  - indices
```
protected transient volatile DataBuffer indices
```
  - isSorted
```
protected transient volatile boolean isSorted
```
- Constructor Detail
  - BaseSparseNDArrayCOO
```
public BaseSparseNDArrayCOO(DataBuffer values,
                            DataBuffer indices,
                            long[] shape)
```
  - BaseSparseNDArrayCOO
```
public BaseSparseNDArrayCOO(double[] values,
                            long[][] indices,
                            long[] shape)
```
  - BaseSparseNDArrayCOO
```
public BaseSparseNDArrayCOO(float[] values,
                            long[][] indices,
                            long[] shape)
```
  - BaseSparseNDArrayCOO
```
public BaseSparseNDArrayCOO(double[] values,
                            int[][] indices,
                            long[] shape)
```
  - BaseSparseNDArrayCOO
```
public BaseSparseNDArrayCOO(float[] values,
                            int[][] indices,
                            long[] shape)
```
  - BaseSparseNDArrayCOO
```
public BaseSparseNDArrayCOO(DataBuffer values,
                            DataBuffer indices,
                            DataBuffer sparseInformation,
                            long[] shape)
```
  - BaseSparseNDArrayCOO
```
public BaseSparseNDArrayCOO(DataBuffer values,
                            DataBuffer indices,
                            long[] sparseOffsets,
                            int[] flags,
                            int[] hiddenDimensions,
                            int underlyingRank,
                            long[] shape)
```
- Method Detail
  - checkBufferCoherence
```
protected void checkBufferCoherence()
```
    Check that the length of indices and values are coherent and matches the rank of the matrix.
  - createSparseInformationBuffer
```
protected static DataBuffer createSparseInformationBuffer(int rank)
```
    Create a SparseInfo databuffer given rank if of the sparse matrix.
    
    Parameters:
    
    rank -
    
    Returns:
  - createValueBuffer
```
protected static DataBuffer createValueBuffer(float[] values)
```
    Create a DataBuffer for values of given array of values.
    
    Parameters:
    
    values -
    
    Returns:
  - createValueBuffer
```
protected static DataBuffer createValueBuffer(double[] values)
```
    Create a DataBuffer for values of given array of values.
    
    Parameters:
    
    values -
    
    Returns:
  - createIndiceBuffer
```
protected static DataBuffer createIndiceBuffer(long[][] indices,
                                               long[] shape)
```
    Create a DataBuffer for indices of given arrays of indices.
    
    Parameters:
    
    indices -
    
    shape -
    
    Returns:
  - createIndiceBuffer
```
protected static DataBuffer createIndiceBuffer(int[][] indices,
                                               long[] shape)
```
    Create a DataBuffer for indices of given arrays of indices.
    
    Parameters:
    
    indices -
    
    shape -
    
    Returns:
  - toFlatArray
```
public int toFlatArray(com.google.flatbuffers.FlatBufferBuilder builder)
```
    Description copied from interface: INDArray
    
    Add an INDArray to flatbuffers builder
    
    Parameters:
    
    builder - the builder to use
    
    Returns:
    
    the offset to add
  - countNNZ
```
public long countNNZ()
```
    Count the number of value that are included in the ndarray (view) according to the sparse offsets and the shape
    
    Returns:
    
    nnz
  - 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
    
    Overrides:
    
    assign in class BaseSparseNDArray
    
    Parameters:
    
    arr - the elements to assign
    
    Returns:
    
    this
  - sort
```
public void sort()
```
    Sort the indexes and the values buffers
  - translateToPhysical
```
public long[] translateToPhysical(long[] virtualIndexes)
```
    Translate the view index to the corresponding index of the original ndarray
    
    Parameters:
    
    virtualIndexes - the view indexes
    
    Returns:
    
    the original indexes
  - translateToPhysical
```
public int[] translateToPhysical(int[] virtualIndexes)
```
  - isDimensionFixed
```
public boolean isDimensionFixed(int i)
```
    Return if the dimension in argument is a fixed dimension.
  - putScalar
```
public INDArray putScalar(long i,
                          double value)
```
    Description copied from interface: INDArray
    
    Insert the number linearly in to the ndarray
    
    Specified by:
    
    putScalar in interface INDArray
    
    Overrides:
    
    putScalar in class BaseSparseNDArray
    
    Parameters:
    
    i - the index to insert into
    
    value - the value to insert
    
    Returns:
    
    this
  - putScalar
```
public INDArray putScalar(long i,
                          float value)
```
    Description copied from interface: INDArray
    
    Insert a scalar float at the specified index
    
    Specified by:
    
    putScalar in interface INDArray
    
    Overrides:
    
    putScalar in class BaseSparseNDArray
    
    Parameters:
    
    i - The index to insert into
    
    value - Value to insert
    
    Returns:
    
    This array
  - putScalar
```
public INDArray putScalar(long i,
                          int value)
```
    Description copied from interface: INDArray
    
    Insert a scalar int at the specified index
    
    Specified by:
    
    putScalar in interface INDArray
    
    Overrides:
    
    putScalar in class BaseSparseNDArray
    
    Parameters:
    
    i - The index to insert into
    
    value - Value to insert
    
    Returns:
    
    This array
  - putScalar
```
public INDArray putScalar(int[] indexes,
                          double value)
```
    Description copied from interface: INDArray
    
    Insert the item at the specified indices
    
    Specified by:
    
    putScalar in interface INDArray
    
    Overrides:
    
    putScalar in class BaseSparseNDArray
    
    Parameters:
    
    indexes - the indices to insert at
    
    value - the number to insert
    
    Returns:
    
    this
  - putScalar
```
public INDArray putScalar(long[] indexes,
                          double value)
```
    Specified by:
    
    putScalar in interface INDArray
    
    Overrides:
    
    putScalar in class BaseSparseNDArray
  - putScalar
```
public INDArray putScalar(long[] i,
                          float value)
```
    Specified by:
    
    putScalar in interface INDArray
    
    Overrides:
    
    putScalar in class BaseSparseNDArray
  - putScalar
```
public INDArray putScalar(long[] i,
                          int value)
```
    Specified by:
    
    putScalar in interface INDArray
    
    Overrides:
    
    putScalar in class BaseSparseNDArray
  - putScalar
```
public INDArray putScalar(long row,
                          long 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
    
    Overrides:
    
    putScalar in class BaseSparseNDArray
    
    Parameters:
    
    row - Row (dimension 0) index
    
    col - Column (dimension 1) index
    
    value - Value to put
    
    Returns:
    
    This INDArray
  - putScalar
```
public INDArray putScalar(long dim0,
                          long dim1,
                          long 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
    
    Overrides:
    
    putScalar in class BaseSparseNDArray
    
    Parameters:
    
    dim0 - Dimension 0 index
    
    dim1 - Dimension 1 index
    
    dim2 - Dimension 2 index
    
    value - Value to put
    
    Returns:
    
    This INDArray
  - putScalar
```
public INDArray putScalar(long dim0,
                          long dim1,
                          long dim2,
                          long 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
    
    Overrides:
    
    putScalar in class BaseSparseNDArray
    
    Parameters:
    
    dim0 - Dimension 0 index
    
    dim1 - Dimension 1 index
    
    dim2 - Dimension 2 index
    
    dim3 - Dimension 3 index
    
    value - Value to put
    
    Returns:
    
    This INDArray
  - putRow
```
public INDArray putRow(long 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
    
    Overrides:
    
    putRow in class BaseSparseNDArray
    
    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
    
    Overrides:
    
    putColumn in class BaseSparseNDArray
    
    Parameters:
    
    column - the column to insert
    
    toPut - the array to put
    
    Returns:
    
    this
  - 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
    
    Overrides:
    
    put in class BaseSparseNDArray
    
    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
    
    Overrides:
    
    put in class BaseSparseNDArray
    
    Parameters:
    
    indices - the indices to put the ndarray in to
    
    element - the ndarray to put
    
    Returns:
    
    this ndarray
  - put
```
public INDArray put(int[] indexes,
                    INDArray element)
```
    Description copied from interface: INDArray
    
    Inserts the element at the specified index
    
    Specified by:
    
    put in interface INDArray
    
    Overrides:
    
    put in class BaseSparseNDArray
    
    Parameters:
    
    indexes - 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
    
    Overrides:
    
    put in class BaseSparseNDArray
    
    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
    
    Overrides:
    
    put in class BaseSparseNDArray
    
    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
    
    Overrides:
    
    put in class BaseSparseNDArray
    
    Parameters:
    
    i - the index insert into
    
    element - a scalar ndarray
    
    Returns:
    
    a scalar ndarray of the element at this index
  - addOrUpdate
```
public void addOrUpdate(long[] indexes,
                        double value)
```
    Add a new element in the ndarray or update the value if there is already a non-null element at this position
    
    Parameters:
    
    indexes - the indexes of the element to be added
    
    value - the value of the element to be added
  - canInsert
```
public boolean canInsert(DataBuffer buffer,
                         int length)
```
    Return if there is enough allocated memory space to add data of a given length in the databuffer
    
    Parameters:
    
    buffer - a databuffer in which we want to add data
    
    length - the length of the data
    
    Returns:
    
    a boolean if the insertion is possible
  - shiftLeft
```
public DataBuffer shiftLeft(DataBuffer buffer,
                            int from,
                            int offset,
                            long datalength)
```
  - removeEntry
```
public INDArray removeEntry(int idx)
```
    Remove an element of the ndarray
    
    Parameters:
    
    idx - the index of the element to be removed
    
    Returns:
    
    the ndarray
  - get
```
public INDArray get(INDArrayIndex... indexes)
```
    Returns a subset of this array based on the specified indexes
    
    Specified by:
    
    get in interface INDArray
    
    Overrides:
    
    get in class BaseSparseNDArray
    
    Parameters:
    
    indexes - the indexes in to the array
    
    Returns:
    
    a view of the array with the specified indices
  - repeat
```
public INDArray repeat(int dimension,
                       long... repeats)
```
    Description copied from interface: INDArray
    
    Repeat elements along a specified dimension.
    
    Parameters:
    
    dimension - the dimension to repeat
    
    repeats - the number of elements to repeat on each element
    
    Returns:
    
    Repeated array
  - filterOutFixedDimensions
```
public int[] filterOutFixedDimensions(int[] flags,
                                      List<Integer> idx)
```
  - reverseIndexes
```
public int reverseIndexes(int... indexes)
```
    Return the index of the value corresponding to the indexes
    
    Parameters:
    
    indexes -
    
    Returns:
    
    index of the value
  - indexesBinarySearch
```
public int indexesBinarySearch(int lowerBound,
                               int upperBound,
                               int[] idx)
```
    Return the position of the idx array into the indexes buffer between the lower and upper bound.
    
    Parameters:
    
    idx - a set of coordinates
    
    lowerBound - the lower bound of the position
    
    upperBound - the upper bound of the position
    
    Returns:
    
    the position of the idx array into the indexes buffers, which corresponds to the position of the corresponding value in the values data.
  - getScalar
```
public INDArray getScalar(int... indices)
```
    Description copied from interface: INDArray
    
    Returns the elements at the specified indices
    
    Specified by:
    
    getScalar in interface INDArray
    
    Overrides:
    
    getScalar in class BaseSparseNDArray
    
    Parameters:
    
    indices - the indices to getScalar
    
    Returns:
    
    the array with the specified elements
  - getScalar
```
public INDArray getScalar(long... indices)
```
    Specified by:
    
    getScalar in interface INDArray
    
    Overrides:
    
    getScalar in class BaseSparseNDArray
  - 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
    
    Overrides:
    
    getInt in class BaseSparseNDArray
    
    Parameters:
    
    indices - Indices to get the integer at. Number of indices must match the array rank.
    
    Returns:
    
    Integer value at the specified index
  - getLong
```
public long getLong(long 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
    
    Overrides:
    
    getDouble in class BaseSparseNDArray
    
    Parameters:
    
    indices - Indices to get the double at. Number of indices must match the array rank.
    
    Returns:
    
    Double value at the specified index
  - getDouble
```
public double getDouble(long... indices)
```
    Specified by:
    
    getDouble in interface INDArray
    
    Overrides:
    
    getDouble in class BaseSparseNDArray
  - getFloat
```
public float getFloat(int[] indices)
```
    Description copied from interface: INDArray
    
    Returns the elements at the specified indices
    
    Specified by:
    
    getFloat in interface INDArray
    
    Overrides:
    
    getFloat in class BaseSparseNDArray
    
    Parameters:
    
    indices - the indices to getScalar
    
    Returns:
    
    the array with the specified elements
  - getFloat
```
public float getFloat(long[] indices)
```
    Specified by:
    
    getFloat in interface INDArray
    
    Overrides:
    
    getFloat in class BaseSparseNDArray
  - getDouble
```
public double getDouble(long i)
```
    Description copied from interface: INDArray
    
    Get the double value at the specified linear index in the array
    
    Specified by:
    
    getDouble in interface INDArray
    
    Overrides:
    
    getDouble in class BaseSparseNDArray
    
    Parameters:
    
    i - Index
    
    Returns:
    
    Double value at the specified index
  - getDouble
```
public double getDouble(long i,
                        long 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
    
    Overrides:
    
    getDouble in class BaseSparseNDArray
    
    Parameters:
    
    i - Dimension 0 (row) index
    
    j - Dimension 1 (column) index
    
    Returns:
  - getFloat
```
public float getFloat(long i)
```
    Description copied from interface: INDArray
    
    Return the item at the linear index i
    
    Specified by:
    
    getFloat in interface INDArray
    
    Overrides:
    
    getFloat in class BaseSparseNDArray
    
    Parameters:
    
    i - the index of the item to getScalar
    
    Returns:
    
    the item at index j
  - getFloat
```
public float getFloat(long i,
                      long 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
    
    Overrides:
    
    getFloat in class BaseSparseNDArray
    
    Parameters:
    
    i - the row to getScalar
    
    j - the column to getScalar
    
    Returns:
    
    the item at row i column j
  - 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.
    
    newShape - the new shape of the ndarray
    
    Returns:
    
    the reshaped ndarray
  - reshape
```
public INDArray reshape(char order,
                        boolean enforceView,
                        long... newShape)
```
    Description copied from interface: INDArray
    
    Reshapes the ndarray (note: it's not possible to change the length of the ndarray). Typically this will be a view, unless reshaping without copying (i.e., returning a view) is impossible.
    In that case, the behaviour will depend on the enforceView argument: enforceView == true: throw an exception
    enforceView == false: return a copy
    
    newShape - the new shape of the ndarray
    
    Returns:
    
    the reshaped ndarray
  - reshape
```
public INDArray reshape(int[] shape)
```
  - shapeDescriptor
```
public LongShapeDescriptor shapeDescriptor()
```
    Description copied from interface: INDArray
    
    Returns shape descriptor of this ndarray
    
    Returns:
  - getFormat
```
public SparseFormat getFormat()
```
    Description copied from interface: ISparseNDArray
    
    Return the sparse format (i.e COO, CSR, ...)
    
    Returns:
    
    format
    
    See Also:
    
    SparseFormat
  - underlyingRank
```
public int underlyingRank()
```
  - data
```
public DataBuffer data()
```
    Description copied from interface: INDArray
    
    Returns a linear double array representation of this ndarray
    
    Returns:
    
    the linear double array representation of this ndarray
  - getUnderlyingIndices
```
public DataBuffer getUnderlyingIndices()
```
    Return the indices buffer
    
    Returns:
    
    indices
  - getIncludedIndices
```
public DataBuffer getIncludedIndices()
```
    Return a copy of the indices included in the view. /!\ Change this DataBuffer won't change the ndarray!
    
    Returns:
    
    an array containing the virtual indexes of the values (think about views).
  - getUnderlyingValues
```
public DataBuffer getUnderlyingValues()
```
    Return the values buffer
    
    Returns:
    
    values
  - getIncludedValues
```
public DataBuffer getIncludedValues()
```
    Return a copy of the values included in the array. /!\ Change this DataBuffer won't change the ndarray!
    
    Returns:
    
    an array containing the values
  - getVectorCoordinates
```
public DataBuffer getVectorCoordinates()
```
    Returns the indices of non-zero element of the vector
    
    Returns:
    
    indices in Databuffer
  - toDense
```
public INDArray toDense()
```
    Converts the sparse ndarray into a dense one
    
    Specified by:
    
    toDense in interface INDArray
    
    Specified by:
    
    toDense in interface ISparseNDArray
    
    Overrides:
    
    toDense in class BaseSparseNDArray
    
    Returns:
    
    a dense ndarray
  - shapeInfoDataBuffer
```
public DataBuffer shapeInfoDataBuffer()
```
    Description copied from interface: INDArray
    
    Shape info
    
    Specified by:
    
    shapeInfoDataBuffer in interface INDArray
    
    Overrides:
    
    shapeInfoDataBuffer in class BaseSparseNDArray
    
    Returns:
  - subArray
```
public INDArray subArray(long[] offsets,
                         int[] shape,
                         int[] stride)
```
    Specified by:
    
    subArray in interface INDArray
    
    Overrides:
    
    subArray in class BaseSparseNDArray
    
    Returns:
  - getUnderlyingIndicesOf
```
public DataBuffer getUnderlyingIndicesOf(int i)
```
    Returns the underlying indices of the element of the given index such as there really are in the original ndarray
    
    Parameters:
    
    i - the index of the element+
    
    Returns:
    
    a dataBuffer containing the indices of element
  - getIndicesOf
```
public DataBuffer getIndicesOf(int i)
```
    Returns the indices of the element of the given index in the array context
    
    Parameters:
    
    i - the index of the element
    
    Returns:
    
    a dataBuffer containing the indices of element
  - isZero
```
public boolean isZero(int... indexes)
```
  - isView
```
public boolean isView()
```
    Description copied from interface: INDArray
    
    Returns true if this array is a view or not
    
    Returns:
  - getString
```
public String getString(long index)
```
  - getNumHiddenDimension
```
public int getNumHiddenDimension()
```
  - isSorted
```
public boolean isSorted()
```
  - getValues
```
public DataBuffer getValues()
```
  - getIndices
```
public DataBuffer getIndices()
```
  - putiColumnVector
```
public INDArray putiColumnVector(INDArray columnVector)
```
    Description copied from interface: INDArray
    
    In place assignment of a column vector
    
    Parameters:
    
    columnVector - the column vector to add
    
    Returns:
    
    the result of the addition
  - putiRowVector
```
public INDArray putiRowVector(INDArray rowVector)
```
    Description copied from interface: INDArray
    
    in place assignment of row vector, to each row of this array
    
    Parameters:
    
    rowVector - Row vector to put
    
    Returns:
    
    This array, after assigning every road to the specified value
  - mmul
```
public INDArray mmul(INDArray other,
                     MMulTranspose mMulTranspose)
```
  - mmul
```
public INDArray mmul(INDArray other,
                     INDArray result,
                     MMulTranspose mMulTranspose)
```
    Perform an copy matrix multiplication
    
    Parameters:
    
    other - the other matrix to perform matrix multiply with
    
    result - the result ndarray
    
    mMulTranspose - the transpose status of each array
    
    Returns:
    
    the result of the matrix multiplication
  - mmuli
```
public INDArray mmuli(INDArray other,
                      MMulTranspose transpose)
```
  - mmuli
```
public INDArray mmuli(INDArray other,
                      INDArray result,
                      MMulTranspose transpose)
```
  - setStride
```
public void setStride(long... stride)
```
    Description copied from interface: INDArray
    
    stride setter
    
    Specified by:
    
    setStride in interface INDArray
    
    Overrides:
    
    setStride in class BaseSparseNDArray
  - setShape
```
public void setShape(long... shape)
```
    Description copied from interface: INDArray
    
    Shape setter
    
    Specified by:
    
    setShape in interface INDArray
    
    Overrides:
    
    setShape in class BaseSparseNDArray
  - isEmpty
```
public boolean isEmpty()
```
    This method returns true if this INDArray is special case: no-value INDArray
    
    Returns:
  - isR
```
public boolean isR()
```
    Description copied from interface: INDArray
    
    This method checks if this INDArray instance is one of Real types
    
    Returns:
    
    true if data type is floating point, false otherwise
  - isZ
```
public boolean isZ()
```
    Description copied from interface: INDArray
    
    This method checks if this INDArray instance is one of integer types
    
    Returns:
  - isB
```
public boolean isB()
```
    Description copied from interface: INDArray
    
    This method checks if this INDArray instance has boolean type
    
    Returns:
  - castTo
```
public INDArray castTo(DataType dataType)
```
    Description copied from interface: INDArray
    
    This method cast elements of this INDArray to new data type
    
    Returns:
  - all
```
public boolean all()
```
    Description copied from interface: INDArray
    
    This method checks if all elements within this array are non-zero (or true, in case of boolean)
    
    Specified by:
    
    all in interface INDArray
    
    Overrides:
    
    all in class BaseSparseNDArray
    
    Returns:
  - any
```
public boolean any()
```
    Description copied from interface: INDArray
    
    This method checks if any of the elements within this array are non-zero (or true, in case of boolean)
    
    Specified by:
    
    any in interface INDArray
    
    Overrides:
    
    any in class BaseSparseNDArray
    
    Returns:
  - none
```
public boolean none()
```
    Description copied from interface: INDArray
    
    This method checks if any of the elements within this array are non-zero (or true, in case of boolean)
    
    Specified by:
    
    none in interface INDArray
    
    Overrides:
    
    none in class BaseSparseNDArray
    
    Returns:
  - closeable
```
public boolean closeable()
```
    Description copied from interface: INDArray
    
    This method checks, if this INDArray instalce can use close() method
    
    Returns:
    
    true if array can be released, false otherwise
  - close
```
public void close()
```
    Description copied from interface: INDArray
    
    This method releases exclusive off-heap resources uses by this INDArray instance. If INDArray relies on shared resources, exception will be thrown instead PLEASE NOTE: This method is NOT safe by any means
  - isS
```
public boolean isS()
```
    Description copied from interface: INDArray
    
    This method checks if this INDArray instance has String type
    
    Returns:

Class BaseSparseNDArrayCOO

Field Summary

Fields inherited from class org.nd4j.linalg.api.ndarray.BaseSparseNDArray

Constructor Summary

Method Summary

Methods inherited from class org.nd4j.linalg.api.ndarray.BaseSparseNDArray

Methods inherited from class java.lang.Object

Field Detail

format

values

indices

isSorted

Constructor Detail

BaseSparseNDArrayCOO

BaseSparseNDArrayCOO

BaseSparseNDArrayCOO

BaseSparseNDArrayCOO

BaseSparseNDArrayCOO

BaseSparseNDArrayCOO

BaseSparseNDArrayCOO

Method Detail

checkBufferCoherence

createSparseInformationBuffer

createValueBuffer

createValueBuffer

createIndiceBuffer

createIndiceBuffer

toFlatArray

countNNZ

assign

sort

translateToPhysical

translateToPhysical

isDimensionFixed

putScalar

putScalar

putScalar

putScalar

putScalar

putScalar

putScalar

putScalar

putScalar

putScalar

putRow

putColumn

put

put

put

put

put

put

addOrUpdate

canInsert

shiftLeft

removeEntry

get

repeat

filterOutFixedDimensions

reverseIndexes

indexesBinarySearch

getScalar

getScalar

getInt

getLong

getDouble

getDouble

getFloat

getFloat

getDouble

getDouble

getFloat

getFloat

reshape

reshape

reshape

shapeDescriptor

getFormat

underlyingRank

data