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

- Packages that use CompressionSettingsBuilder
  Package | Description
  --- | ---
  org.apache.sysds.runtime.compress |

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

    Methods in org.apache.sysds.runtime.compress that return CompressionSettingsBuilder
    Modifier and Type | Method | Description
    --- | --- | ---
    `CompressionSettingsBuilder` | CompressionSettingsBuilder.`addValidCompression​(AColGroup.CompressionType cp)` | Add a single valid compression type to the EnumSet of valid compressions.
    `CompressionSettingsBuilder` | CompressionSettingsBuilder.`clearValidCompression()` | Clear all the compression types allowed in the compression.
    `CompressionSettingsBuilder` | CompressionSettingsBuilder.`copySettings​(CompressionSettings that)` | Copy the settings from another CompressionSettings Builder, modifies this, not that.
    `CompressionSettingsBuilder` | CompressionSettingsBuilder.`setAllowSharedDictionary​(boolean allowSharedDictionary)` | Allow the Dictionaries to be shared between different column groups.
    `CompressionSettingsBuilder` | CompressionSettingsBuilder.`setCoCodePercentage​(double coCodePercentage)` | Set the coCode percentage, the effect is different based on the coCoding strategy, but the general effect is that higher values results in more coCoding while lower values result in less.
    `CompressionSettingsBuilder` | CompressionSettingsBuilder.`setColumnPartitioner​(CoCoderFactory.PartitionerType columnPartitioner)` | Set the type of CoCoding Partitioner type to use for combining columns together.
    `CompressionSettingsBuilder` | CompressionSettingsBuilder.`setCostType​(CostEstimatorFactory.CostType costType)` | Set the cost type used for estimating the cost of column groups default is memory based.
    `CompressionSettingsBuilder` | CompressionSettingsBuilder.`setEstimationType​(SampleEstimatorFactory.EstimationType estimationType)` | Set the estimation type used for the sampled estimates.
    `CompressionSettingsBuilder` | CompressionSettingsBuilder.`setIsInSparkInstruction()` | Inform the compression that it is executed in a spark instruction.
    `CompressionSettingsBuilder` | CompressionSettingsBuilder.`setLossy​(boolean lossy)` | Set the Compression to use Lossy compression.
    `CompressionSettingsBuilder` | CompressionSettingsBuilder.`setMaxColGroupCoCode​(int maxColGroupCoCode)` | Set the maximum number of columns to CoCode together in the CoCoding strategy.
    `CompressionSettingsBuilder` | CompressionSettingsBuilder.`setMaxSampleSize​(int maxSampleSize)` | Set the maximum sample size to extract from a given matrix, this overrules the sample percentage if the sample percentage extracted is higher than this maximum bound.
    `CompressionSettingsBuilder` | CompressionSettingsBuilder.`setMinimumCompressionRatio​(double ratio)` | Set the minimum compression ratio to be achieved by the compression.
    `CompressionSettingsBuilder` | CompressionSettingsBuilder.`setMinimumSampleSize​(int minimumSampleSize)` | Set the minimum sample size to extract from a given matrix, this overrules the sample percentage if the sample percentage extracted is lower than this minimum bound.
    `CompressionSettingsBuilder` | CompressionSettingsBuilder.`setSamplingRatio​(double samplingRatio)` | Set the sampling ratio in percent to sample the input matrix.
    `CompressionSettingsBuilder` | CompressionSettingsBuilder.`setSDCSortType​(InsertionSorterFactory.SORT_TYPE sdcSortType)` | Set the sort type to use.
    `CompressionSettingsBuilder` | CompressionSettingsBuilder.`setSeed​(int seed)` | Set the seed for the compression operation.
    `CompressionSettingsBuilder` | CompressionSettingsBuilder.`setSortValuesByLength​(boolean sortValuesByLength)` | Set the sortValuesByLength flag.
    `CompressionSettingsBuilder` | CompressionSettingsBuilder.`setTransposeInput​(String transposeInput)` | Specify if the input matrix should be transposed before compression.
    `CompressionSettingsBuilder` | CompressionSettingsBuilder.`setValidCompressions​(EnumSet<AColGroup.CompressionType> validCompressions)` | Set the valid compression strategies used for the compression.

    Methods in org.apache.sysds.runtime.compress with parameters of type CompressionSettingsBuilder
    Modifier and Type | Method | Description
    --- | --- | ---
    `static org.apache.commons.lang3.tuple.Pair<MatrixBlock,​CompressionStatistics>` | CompressedMatrixBlockFactory.`compress​(MatrixBlock mb, int k, CompressionSettingsBuilder compSettings)` |
    `static org.apache.commons.lang3.tuple.Pair<MatrixBlock,​CompressionStatistics>` | CompressedMatrixBlockFactory.`compress​(MatrixBlock mb, int k, CompressionSettingsBuilder compSettings, ACostEstimate costEstimator)` |
    `static org.apache.commons.lang3.tuple.Pair<MatrixBlock,​CompressionStatistics>` | CompressedMatrixBlockFactory.`compress​(MatrixBlock mb, int k, CompressionSettingsBuilder compSettings, CostEstimatorBuilder csb)` | The main method for compressing the input matrix.
    `static org.apache.commons.lang3.tuple.Pair<MatrixBlock,​CompressionStatistics>` | CompressedMatrixBlockFactory.`compress​(MatrixBlock mb, int k, CompressionSettingsBuilder compSettings, WTreeRoot root)` | The main method for compressing the input matrix.
    `static org.apache.commons.lang3.tuple.Pair<MatrixBlock,​CompressionStatistics>` | CompressedMatrixBlockFactory.`compress​(MatrixBlock mb, CompressionSettingsBuilder customSettings)` |