## Uses of Class
org.apache.sysds.runtime.compress.colgroup.AColGroup

- Packages that use AColGroup
  Package | Description
  --- | ---
  org.apache.sysds.runtime.compress |
  org.apache.sysds.runtime.compress.colgroup |
  org.apache.sysds.runtime.compress.lib |

- - ### Uses of AColGroup in org.apache.sysds.runtime.compress

    Methods in org.apache.sysds.runtime.compress that return types with arguments of type AColGroup
    Modifier and Type | Method and Description
    --- | ---
    `List<AColGroup>` | CompressedMatrixBlock.`getColGroups()`

    Methods in org.apache.sysds.runtime.compress with parameters of type AColGroup
    Modifier and Type | Method and Description
    --- | ---
    `void` | CompressedMatrixBlock.`allocateColGroup(AColGroup cg)` Allocate the given column group and remove all references to old column groups.

    Method parameters in org.apache.sysds.runtime.compress with type arguments of type AColGroup
    Modifier and Type | Method and Description
    --- | ---
    `void` | CompressedMatrixBlock.`allocateColGroupList(List<AColGroup> colGroups)`

  - ### Uses of AColGroup in org.apache.sysds.runtime.compress.colgroup

    Subclasses of AColGroup in org.apache.sysds.runtime.compress.colgroup
    Modifier and Type | Class and Description
    --- | ---
    `class` | `ColGroupCompressed` Base class for column groups encoded Encoded in a compressed manner.
    `class` | `ColGroupConst`
    `class` | `ColGroupDDC` Class to encapsulate information about a column group that is encoded with dense dictionary encoding (DDC).
    `class` | `ColGroupEmpty`
    `class` | `ColGroupOffset` Base class for column groups encoded with various types of bitmap encoding.
    `class` | `ColGroupOLE` Class to encapsulate information about a column group that is encoded with simple lists of offsets for each set of distinct values.
    `class` | `ColGroupRLE` A group of columns compressed with a single run-length encoded bitmap.
    `class` | `ColGroupSDC` Column group that sparsely encodes the dictionary values.
    `class` | `ColGroupSDCSingle` Column group that sparsely encodes the dictionary values.
    `class` | `ColGroupSDCSingleZeros` Column group that sparsely encodes the dictionary values.
    `class` | `ColGroupSDCZeros` Column group that sparsely encodes the dictionary values.
    `class` | `ColGroupUncompressed` Column group type for columns that are stored as dense arrays of doubles.
    `class` | `ColGroupValue` Base class for column groups encoded with value dictionary.

    Methods in org.apache.sysds.runtime.compress.colgroup that return AColGroup
    Modifier and Type | Method and Description
    --- | ---
    `AColGroup` | ColGroupRLE.`binaryRowOp(BinaryOperator op, double[] v, boolean sparseSafe, boolean left)`
    `AColGroup` | ColGroupEmpty.`binaryRowOp(BinaryOperator op, double[] v, boolean sparseSafe, boolean left)`
    `AColGroup` | ColGroupConst.`binaryRowOp(BinaryOperator op, double[] v, boolean sparseSafe, boolean left)`
    `AColGroup` | ColGroupSDCZeros.`binaryRowOp(BinaryOperator op, double[] v, boolean sparseSafe, boolean left)`
    `AColGroup` | ColGroupDDC.`binaryRowOp(BinaryOperator op, double[] v, boolean sparseSafe, boolean left)`
    `AColGroup` | ColGroupSDCSingle.`binaryRowOp(BinaryOperator op, double[] v, boolean sparseSafe, boolean left)`
    `AColGroup` | ColGroupSDC.`binaryRowOp(BinaryOperator op, double[] v, boolean sparseSafe, boolean left)`
    `AColGroup` | ColGroupUncompressed.`binaryRowOp(BinaryOperator op, double[] v, boolean sparseSafe, boolean left)`
    `abstract AColGroup` | AColGroup.`binaryRowOp(BinaryOperator op, double[] v, boolean sparseSafe, boolean left)` Perform a binary row operation.
    `AColGroup` | ColGroupSDCSingleZeros.`binaryRowOp(BinaryOperator op, double[] v, boolean sparseSafe, boolean left)`
    `AColGroup` | ColGroupOLE.`binaryRowOp(BinaryOperator op, double[] v, boolean sparseSafe, boolean left)`
    `static AColGroup` | ColGroupFactory.`compress(int[] colIndexes, int rlen, ABitmap ubm, AColGroup.CompressionType compType, CompressionSettings cs, MatrixBlock rawMatrixBlock, double tupleSparsity)` Method for compressing an ColGroup.
    `AColGroup` | ColGroupEmpty.`copy()`
    `AColGroup` | ColGroupUncompressed.`copy()`
    `abstract AColGroup` | AColGroup.`copy()` Get a copy of this column group.
    `AColGroup` | ColGroupValue.`copyAndSet(ADictionary newDictionary)`
    `AColGroup` | ColGroupValue.`copyAndSet(double[] newDictionary)`
    `AColGroup` | ColGroupValue.`copyAndSet(int[] colIndexes, ADictionary newDictionary)`
    `AColGroup` | ColGroupValue.`copyAndSet(int[] colIndexes, double[] newDictionary)`
    `static AColGroup` | ColGroupFactory.`genColGroupConst(int numRows, int numCols, double value)`
    `static AColGroup` | ColGroupFactory.`getColGroupConst(int numRows, int[] cols, double value)`
    `AColGroup` | ColGroupEmpty.`replace(double pattern, double replace)`
    `AColGroup` | ColGroupUncompressed.`replace(double pattern, double replace)`
    `abstract AColGroup` | AColGroup.`replace(double pattern, double replace)` Make a copy of the column group values, and replace all values that match pattern with replacement value.
    `AColGroup` | ColGroupValue.`replace(double pattern, double replace)`
    `AColGroup` | ColGroupEmpty.`rightMultByMatrix(MatrixBlock right)`
    `AColGroup` | ColGroupUncompressed.`rightMultByMatrix(MatrixBlock right)`
    `abstract AColGroup` | AColGroup.`rightMultByMatrix(MatrixBlock right)` Right matrix multiplication with this column group.
    `AColGroup` | ColGroupValue.`rightMultByMatrix(MatrixBlock right)`
    `AColGroup` | ColGroupRLE.`scalarOperation(ScalarOperator op)`
    `AColGroup` | ColGroupEmpty.`scalarOperation(ScalarOperator op)`
    `AColGroup` | ColGroupConst.`scalarOperation(ScalarOperator op)`
    `AColGroup` | ColGroupSDCZeros.`scalarOperation(ScalarOperator op)`
    `AColGroup` | ColGroupDDC.`scalarOperation(ScalarOperator op)`
    `AColGroup` | ColGroupSDCSingle.`scalarOperation(ScalarOperator op)`
    `AColGroup` | ColGroupSDC.`scalarOperation(ScalarOperator op)`
    `AColGroup` | ColGroupUncompressed.`scalarOperation(ScalarOperator op)`
    `abstract AColGroup` | AColGroup.`scalarOperation(ScalarOperator op)` Perform the specified scalar operation directly on the compressed column group, without decompressing individual cells if possible.
    `AColGroup` | ColGroupSDCSingleZeros.`scalarOperation(ScalarOperator op)`
    `AColGroup` | ColGroupOLE.`scalarOperation(ScalarOperator op)`
    `AColGroup` | AColGroup.`sliceColumn(int col)` Slice out a single column from the column group.
    `AColGroup` | AColGroup.`sliceColumns(int cl, int cu)` Slice out the columns within the range of cl and cu to remove the dictionary values related to these columns.

    Methods in org.apache.sysds.runtime.compress.colgroup that return types with arguments of type AColGroup
    Modifier and Type | Method and Description
    --- | ---
    `static List<AColGroup>` | ColGroupFactory.`compressColGroups(MatrixBlock in, CompressedSizeInfo csi, CompressionSettings compSettings, int k)` The actual compression method, that handles the logic of compressing multiple columns together.
    `static List<AColGroup>` | ColGroupIO.`readGroups(DataInput in, int nRows)` Read groups from a file.

    Methods in org.apache.sysds.runtime.compress.colgroup with parameters of type AColGroup
    Modifier and Type | Method and Description
    --- | ---
    `void` | ColGroupEmpty.`leftMultByAColGroup(AColGroup lhs, MatrixBlock c)`
    `void` | ColGroupUncompressed.`leftMultByAColGroup(AColGroup lhs, MatrixBlock result)`
    `abstract void` | AColGroup.`leftMultByAColGroup(AColGroup lhs, MatrixBlock result)` Left side matrix multiplication with a column group that is transposed.
    `void` | ColGroupValue.`leftMultByAColGroup(AColGroup lhs, MatrixBlock result)`

    Method parameters in org.apache.sysds.runtime.compress.colgroup with type arguments of type AColGroup
    Modifier and Type | Method and Description
    --- | ---
    `static void` | AColGroup.`decompressColumnToBlockUnSafe(MatrixBlock target, int rl, int ru, List<AColGroup> colGroups)` Decompress part of the col groups into the target matrix block, this decompression maintain the number of non zeros.
    `static long` | ColGroupIO.`getExactSizeOnDisk(List<AColGroup> colGroups)` Get the size on disk for the given list of column groups
    `static void` | ColGroupIO.`writeGroups(DataOutput out, List<AColGroup> colGroups)` Writes the ColGroups out to the DataOutput.

  - ### Uses of AColGroup in org.apache.sysds.runtime.compress.lib

    Method parameters in org.apache.sysds.runtime.compress.lib with type arguments of type AColGroup
    Modifier and Type | Method and Description
    --- | ---
    `static void` | CLALibLeftMultBy.`leftMultByTransposeSelf(List<AColGroup> groups, MatrixBlock result, int k, int numColumns, org.apache.commons.lang3.tuple.Pair<Integer,int[]> v, boolean overlapping)`

Copyright © 2021 The Apache Software Foundation. All rights reserved.