## Uses of Class
org.apache.sysds.runtime.compress.CompressionSettings

- Packages that use CompressionSettings
  Package | Description
  --- | ---
  org.apache.sysds.runtime.compress |
  org.apache.sysds.runtime.compress.cocode |
  org.apache.sysds.runtime.compress.colgroup |
  org.apache.sysds.runtime.compress.estim |

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

    Methods in org.apache.sysds.runtime.compress that return CompressionSettings
    Modifier and Type | Method and Description
    --- | ---
    `CompressionSettings` | CompressionSettingsBuilder.`create()` Create the CompressionSettings object to use in the compression.

    Methods in org.apache.sysds.runtime.compress with parameters of type CompressionSettings
    Modifier and Type | Method and Description
    --- | ---
    `static org.apache.commons.lang3.tuple.Pair<MatrixBlock,CompressionStatistics>` | CompressedMatrixBlockFactory.`compress(MatrixBlock mb, CompressionSettings customSettings)`
    `static org.apache.commons.lang3.tuple.Pair<MatrixBlock,CompressionStatistics>` | CompressedMatrixBlockFactory.`compress(MatrixBlock mb, int k, CompressionSettings compSettings)` The main method for compressing the input matrix.
    `CompressionSettingsBuilder` | CompressionSettingsBuilder.`copySettings(CompressionSettings that)` Copy the settings from another CompressionSettings Builder, modifies this, not that.
    `static ABitmap` | BitmapEncoder.`extractBitmap(int[] colIndices, MatrixBlock rawBlock, CompressionSettings compSettings)` Generate uncompressed bitmaps for a set of columns in an uncompressed matrix block.

    Constructors in org.apache.sysds.runtime.compress with parameters of type CompressionSettings
    Constructor and Description
    `ReaderColumnSelectionDense(MatrixBlock data, int[] colIndices, CompressionSettings compSettings)`
    `ReaderColumnSelectionDenseSample(MatrixBlock data, int[] colIndexes, int[] sampleIndexes, CompressionSettings compSettings)`
    `ReaderColumnSelectionSparse(MatrixBlock data, int[] colIndexes, CompressionSettings compSettings)`

  - ### Uses of CompressionSettings in org.apache.sysds.runtime.compress.cocode

    Methods in org.apache.sysds.runtime.compress.cocode with parameters of type CompressionSettings
    Modifier and Type | Method and Description
    --- | ---
    `static List<int[]>` | PlanningCoCoder.`findCoCodesByPartitioning(CompressedSizeEstimator sizeEstimator, CompressedSizeInfo colInfos, int numRows, int k, CompressionSettings cs)` Main entry point of CoCode.
    `List<int[]>` | ColumnGroupPartitionerStatic.`partitionColumns(List<Integer> groupCols, HashMap<Integer,PlanningCoCoder.GroupableColInfo> groupColsInfo, CompressionSettings cs)`
    `List<int[]>` | ColumnGroupPartitionerBinPacking.`partitionColumns(List<Integer> groupCols, HashMap<Integer,PlanningCoCoder.GroupableColInfo> groupColsInfo, CompressionSettings cs)`
    `abstract List<int[]>` | ColumnGroupPartitioner.`partitionColumns(List<Integer> groupCols, HashMap<Integer,PlanningCoCoder.GroupableColInfo> groupColsInfo, CompressionSettings cs)` Partitions a list of columns into a list of partitions that contains subsets of columns.

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

    Methods in org.apache.sysds.runtime.compress.colgroup with parameters of type CompressionSettings
    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` | 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.

  - ### Uses of CompressionSettings in org.apache.sysds.runtime.compress.estim

    Methods in org.apache.sysds.runtime.compress.estim with parameters of type CompressionSettings
    Modifier and Type | Method and Description
    --- | ---
    `static CompressedSizeEstimator` | CompressedSizeEstimatorFactory.`getSizeEstimator(MatrixBlock data, CompressionSettings compSettings)`

    Constructors in org.apache.sysds.runtime.compress.estim with parameters of type CompressionSettings
    Constructor and Description
    `CompressedSizeEstimatorExact(MatrixBlock data, CompressionSettings compSettings)`
    `CompressedSizeEstimatorSample(MatrixBlock data, CompressionSettings compSettings, int sampleSize)` CompressedSizeEstimatorSample, samples from the input data and estimates the size of the compressed matrix.

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