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

- Packages that use ColGroup
  Package | Description
  --- | ---
  org.apache.sysds.runtime.compress |
  org.apache.sysds.runtime.compress.colgroup |
  org.apache.sysds.runtime.compress.utils |

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

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

    Method parameters in org.apache.sysds.runtime.compress with type arguments of type ColGroup
    Modifier and Type | Method and Description
    --- | ---
    `void` | CompressedMatrixBlock.`allocateColGroupList(List<ColGroup> colGroups)`
    `void` | CompressionStatistics.`setColGroupsCounts(List<ColGroup> colGroups)` Set array of counts regarding col group types.

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

    Subclasses of ColGroup in org.apache.sysds.runtime.compress.colgroup
    Modifier and Type | Class and Description
    --- | ---
    `class` | `ColGroupDDC` Class to encapsulate information about a column group that is encoded with dense dictionary encoding (DDC).
    `class` | `ColGroupDDC1` Class to encapsulate information about a column group that is encoded with dense dictionary encoding (DDC) using 1 byte codes.
    `class` | `ColGroupDDC2` Class to encapsulate information about a column group that is encoded with dense dictionary encoding (DDC) using 2 byte codes.
    `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` | `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 ColGroup
    Modifier and Type | Method and Description
    --- | ---
    `static ColGroup` | ColGroupFactory.`compress(int[] colIndexes, int rlen, ABitmap ubm, ColGroup.CompressionType compType, CompressionSettings cs, MatrixBlock rawMatrixBlock)` Method for compressing an ColGroup.
    `static ColGroup[]` | ColGroupFactory.`compressColGroups(MatrixBlock in, HashMap<Integer,Double> compRatios, List<int[]> groups, CompressionSettings compSettings, int k)` The actual compression method, that handles the logic of compressing multiple columns together.
    `static ColGroup` | ColGroupConverter.`copyColGroup(ColGroup group)` Copy col group instance with deep copy of column indices but shallow copy of actual contents;
    `ColGroup` | ColGroupRLE.`scalarOperation(ScalarOperator op)`
    `ColGroup` | ColGroupDDC1.`scalarOperation(ScalarOperator op)`
    `abstract ColGroup` | ColGroup.`scalarOperation(ScalarOperator op)` Perform the specified scalar operation directly on the compressed column group, without decompressing individual cells if possible.
    `ColGroup` | ColGroupUncompressed.`scalarOperation(ScalarOperator op)`
    `ColGroup` | ColGroupDDC2.`scalarOperation(ScalarOperator op)`
    `ColGroup` | ColGroupOLE.`scalarOperation(ScalarOperator op)`

    Methods in org.apache.sysds.runtime.compress.colgroup that return types with arguments of type ColGroup
    Modifier and Type | Method and Description
    --- | ---
    `static List<ColGroup>` | ColGroupFactory.`assignColumns(int numCols, ColGroup[] colGroups, MatrixBlock rawBlock, CompressionSettings compSettings)` Method for producing the final ColGroupList stored inside the CompressedMatrixBlock.
    `static List<ColGroup>` | ColGroupIO.`readGroups(DataInput in)` Read groups from a file.

    Methods in org.apache.sysds.runtime.compress.colgroup with parameters of type ColGroup
    Modifier and Type | Method and Description
    --- | ---
    `static List<ColGroup>` | ColGroupFactory.`assignColumns(int numCols, ColGroup[] colGroups, MatrixBlock rawBlock, CompressionSettings compSettings)` Method for producing the final ColGroupList stored inside the CompressedMatrixBlock.
    `static ColGroup` | ColGroupConverter.`copyColGroup(ColGroup group)` Copy col group instance with deep copy of column indices but shallow copy of actual contents;
    `static MatrixBlock` | ColGroupConverter.`getUncompressedColBlock(ColGroup group)` Extracts the Uncompressed MatrixBlock representation of a Col Group

    Method parameters in org.apache.sysds.runtime.compress.colgroup with type arguments of type ColGroup
    Modifier and Type | Method and Description
    --- | ---
    `static void` | ColGroupIO.`writeGroups(DataOutput out, List<ColGroup> colGroups)` Writes the ColGroups out to the DataOutput.

    Constructor parameters in org.apache.sysds.runtime.compress.colgroup with type arguments of type ColGroup
    Constructor and Description
    `DenseRowIterator(int rl, int ru, List<ColGroup> colGroups, int clen)`
    `SparseRowIterator(int rl, int ru, List<ColGroup> colGroups, int clen)`

  - ### Uses of ColGroup in org.apache.sysds.runtime.compress.utils

    Constructor parameters in org.apache.sysds.runtime.compress.utils with type arguments of type ColGroup
    Constructor and Description
    `ColumnGroupIterator(int rl, int ru, int cgl, int cgu, boolean inclZeros, List<ColGroup> colGroups)`

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