Module org.apache.arrow.format
Package org.apache.arrow.flatbuf

Class SparseMatrixIndexCSX

java.lang.Object
com.google.flatbuffers.Table
org.apache.arrow.flatbuf.SparseMatrixIndexCSX
public final class SparseMatrixIndexCSX extends com.google.flatbuffers.Table
Compressed Sparse format, that is matrix-specific.

  • Constructor Details

    • SparseMatrixIndexCSX

      public SparseMatrixIndexCSX()

  • Method Details

    • ValidateVersion

      public static void ValidateVersion()

    • getRootAsSparseMatrixIndexCSX

      public static SparseMatrixIndexCSX getRootAsSparseMatrixIndexCSX(ByteBuffer _bb)

    • getRootAsSparseMatrixIndexCSX

      public static SparseMatrixIndexCSX getRootAsSparseMatrixIndexCSX(ByteBuffer _bb, SparseMatrixIndexCSX obj)

    • __init

      public void __init(int _i, ByteBuffer _bb)

    • __assign

      public SparseMatrixIndexCSX __assign(int _i, ByteBuffer _bb)

    • compressedAxis

      public short compressedAxis()
      Which axis, row or column, is compressed

    • indptrType

      public Int indptrType()
      The type of values in indptrBuffer

    • indptrType

      public Int indptrType(Int obj)

    • indptrBuffer

      public Buffer indptrBuffer()
      indptrBuffer stores the location and size of indptr array that represents the range of the rows. The i-th row spans from `indptr[i]` to `indptr[i+1]` in the data. The length of this array is 1 + (the number of rows), and the type of index value is long. For example, let X be the following 6x4 matrix: ```text X := [[0, 1, 2, 0], [0, 0, 3, 0], [0, 4, 0, 5], [0, 0, 0, 0], [6, 0, 7, 8], [0, 9, 0, 0]]. ``` The array of non-zero values in X is: ```text values(X) = [1, 2, 3, 4, 5, 6, 7, 8, 9]. ``` And the indptr of X is: ```text indptr(X) = [0, 2, 3, 5, 5, 8, 10]. ```

    • indptrBuffer

      public Buffer indptrBuffer(Buffer obj)

    • indicesType

      public Int indicesType()
      The type of values in indicesBuffer

    • indicesType

      public Int indicesType(Int obj)

    • indicesBuffer

      public Buffer indicesBuffer()
      indicesBuffer stores the location and size of the array that contains the column indices of the corresponding non-zero values. The type of index value is long. For example, the indices of the above X is: ```text indices(X) = [1, 2, 2, 1, 3, 0, 2, 3, 1]. ``` Note that the indices are sorted in lexicographical order for each row.

    • indicesBuffer

      public Buffer indicesBuffer(Buffer obj)

    • startSparseMatrixIndexCSX

      public static void startSparseMatrixIndexCSX(com.google.flatbuffers.FlatBufferBuilder builder)

    • addCompressedAxis

      public static void addCompressedAxis(com.google.flatbuffers.FlatBufferBuilder builder, short compressedAxis)

    • addIndptrType

      public static void addIndptrType(com.google.flatbuffers.FlatBufferBuilder builder, int indptrTypeOffset)

    • addIndptrBuffer

      public static void addIndptrBuffer(com.google.flatbuffers.FlatBufferBuilder builder, int indptrBufferOffset)

    • addIndicesType

      public static void addIndicesType(com.google.flatbuffers.FlatBufferBuilder builder, int indicesTypeOffset)

    • addIndicesBuffer

      public static void addIndicesBuffer(com.google.flatbuffers.FlatBufferBuilder builder, int indicesBufferOffset)

    • endSparseMatrixIndexCSX

      public static int endSparseMatrixIndexCSX(com.google.flatbuffers.FlatBufferBuilder builder)