## 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.cost |
  org.apache.sysds.runtime.compress.estim |
  org.apache.sysds.runtime.compress.lib |

- - ### 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)`
    `static org.apache.commons.lang3.tuple.Pair<MatrixBlock,CompressionStatistics>` | CompressedMatrixBlockFactory.`compress(MatrixBlock mb, int k, CompressionSettings compSettings, ICostEstimate costEstimator)`
    `static org.apache.commons.lang3.tuple.Pair<MatrixBlock,CompressionStatistics>` | CompressedMatrixBlockFactory.`compress(MatrixBlock mb, int k, CompressionSettings compSettings, WTreeRoot root)` The main method for compressing the input matrix.
    `CompressionSettingsBuilder` | CompressionSettingsBuilder.`copySettings(CompressionSettings that)` Copy the settings from another CompressionSettings Builder, modifies this, not that.

  - ### 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 CompressedSizeInfo` | CoCoderFactory.`findCoCodesByPartitioning(CompressedSizeEstimator est, CompressedSizeInfo colInfos, int k, ICostEstimate costEstimator, CompressionSettings cs)` Main entry point of CoCode.

  - ### 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 AColGroup` | ColGroupFactory.`compress(int[] colIndexes, int rlen, ABitmap ubm, AColGroup.CompressionType compType, CompressionSettings cs, MatrixBlock rawMatrixBlock, double tupleSparsity)` Method for compressing an ColGroup.
    `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.

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

    Methods in org.apache.sysds.runtime.compress.cost with parameters of type CompressionSettings
    Modifier and Type | Method and Description
    --- | ---
    `static ICostEstimate` | CostEstimatorFactory.`create(CompressionSettings cs, WTreeRoot root, int nRows, int nCols)`

    Constructors in org.apache.sysds.runtime.compress.cost with parameters of type CompressionSettings
    Constructor and Description
    `DistinctCostEstimator(int nRows, CompressionSettings cs)`

  - ### 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 EstimationFactors` | CompressedSizeEstimator.`estimateCompressedColGroupSize(ABitmap ubm, int[] colIndexes, int nrRows, CompressionSettings cs)`
    `AColGroup.CompressionType` | CompressedSizeInfoColGroup.`getBestCompressionType(CompressionSettings cs)`
    `static CompressedSizeEstimator` | CompressedSizeEstimatorFactory.`getSizeEstimator(MatrixBlock data, CompressionSettings cs)`

    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 cs, int sampleSize)` CompressedSizeEstimatorSample, samples from the input data and estimates the size of the compressed matrix.

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

    Methods in org.apache.sysds.runtime.compress.lib with parameters of type CompressionSettings
    Modifier and Type | Method and Description
    --- | ---
    `static ABitmap` | BitmapEncoder.`extractBitmap(int[] colIndices, int rows, BitSet rawBlock, CompressionSettings compSettings)`

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