## 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 |

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

    Methods in org.apache.sysds.runtime.compress that return CompressionSettings
    Modifier and Type | Method | 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 | Description
    --- | --- | ---
    `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 | Description
    --- | --- | ---
    `static CompressedSizeInfo` | CoCoderFactory.`findCoCodesByPartitioning​(CompressedSizeEstimator est, CompressedSizeInfo colInfos, int k, ACostEstimate 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 | Description
    --- | --- | ---
    `static List<AColGroup>` | ColGroupFactory.`compressColGroups​(MatrixBlock in, CompressedSizeInfo csi, CompressionSettings cs, int k)` | The actual compression method, that handles the logic of compressing multiple columns together.
    `static List<AColGroup>` | ColGroupFactory.`compressColGroups​(MatrixBlock in, CompressedSizeInfo csi, CompressionSettings cs, ACostEstimate ce, int k)` |

  - ### 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 | Description
    --- | --- | ---
    `static ACostEstimate` | CostEstimatorFactory.`create​(CompressionSettings cs, CostEstimatorBuilder costBuilder, int nRows, int nCols, double sparsity)` |

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

  - ### 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 | Description
    --- | --- | ---
    `static CompressedSizeEstimator` | CompressedSizeEstimatorFactory.`createEstimator​(MatrixBlock data, CompressionSettings cs, int k)` | Create an estimator for the input data with the given settings and parallelization degree.
    `static CompressedSizeEstimator` | CompressedSizeEstimatorFactory.`createEstimator​(MatrixBlock data, CompressionSettings cs, int sampleSize, int k)` | Create an estimator for the input data with the given settings and parallelization degree.
    `AColGroup.CompressionType` | CompressedSizeInfoColGroup.`getBestCompressionType​(CompressionSettings cs)` |

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