Google Git
Sign in
apache / systemds / d7838c8d55e38db7d9ead5104ba8696eec64ac9a / . / docs / api / java / org / apache / sysds / runtime / compress / CompressionSettings.html
blob: 87a9a9c4da11884bd7ac17200b04b2ae8a24ec18 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>CompressionSettings (Apache SystemDS 3.2.0-SNAPSHOT API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.6.0.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CompressionSettings (Apache SystemDS 3.2.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/CompressionSettings.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.sysds.runtime.compress</a></div>
<h2 title="Class CompressionSettings" class="title">Class CompressionSettings</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.sysds.runtime.compress.CompressionSettings</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public class <span class="typeNameLabel">CompressionSettings</span>
extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></pre>
<div class="block">Compression Settings class, used as a bundle of parameters inside the Compression framework. See
CompressionSettingsBuilder for default non static parameters.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#allowSharedDictionary">allowSharedDictionary</a></span></code></th>
<td class="colLast">
<div class="block">Share DDC Dictionaries between ColGroups.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#BITMAP_BLOCK_SZ">BITMAP_BLOCK_SZ</a></span></code></th>
<td class="colLast">
<div class="block">Size of the blocks used in a blocked bitmap representation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#coCodePercentage">coCodePercentage</a></span></code></th>
<td class="colLast">
<div class="block">A Cocode parameter that differ in behavior based on compression method, in general it is a value that reflects
aggressively likely coCoding is used.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="cocode/CoCoderFactory.PartitionerType.html" title="enum in org.apache.sysds.runtime.compress.cocode">CoCoderFactory.PartitionerType</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#columnPartitioner">columnPartitioner</a></span></code></th>
<td class="colLast">
<div class="block">The selected method for column partitioning used in CoCoding compressed columns</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="cost/CostEstimatorFactory.CostType.html" title="enum in org.apache.sysds.runtime.compress.cost">CostEstimatorFactory.CostType</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#costComputationType">costComputationType</a></span></code></th>
<td class="colLast">
<div class="block">The cost computation type for the compression</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="estim/sample/SampleEstimatorFactory.EstimationType.html" title="enum in org.apache.sysds.runtime.compress.estim.sample">SampleEstimatorFactory.EstimationType</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#estimationType">estimationType</a></span></code></th>
<td class="colLast">
<div class="block">The sample type used for sampling</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isInSparkInstruction">isInSparkInstruction</a></span></code></th>
<td class="colLast">
<div class="block">Is a spark instruction</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#lossy">lossy</a></span></code></th>
<td class="colLast">
<div class="block">True if lossy compression is enabled</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#maxColGroupCoCode">maxColGroupCoCode</a></span></code></th>
<td class="colLast">
<div class="block">The maximum number of columns CoCoded allowed</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#maxSampleSize">maxSampleSize</a></span></code></th>
<td class="colLast">
<div class="block">The maximum size of the sample extracted.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#minimumCompressionRatio">minimumCompressionRatio</a></span></code></th>
<td class="colLast">
<div class="block">The minimum compression ratio to achieve.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#minimumSampleSize">minimumSampleSize</a></span></code></th>
<td class="colLast">
<div class="block">The minimum size of the sample extracted.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PAR_DDC_THRESHOLD">PAR_DDC_THRESHOLD</a></span></code></th>
<td class="colLast">
<div class="block">Parallelization threshold for DDC compression</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#samplePower">samplePower</a></span></code></th>
<td class="colLast">
<div class="block">The sampling ratio power to use when choosing sample size.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#samplingRatio">samplingRatio</a></span></code></th>
<td class="colLast">
<div class="block">The sampling ratio used when choosing ColGroups.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="colgroup/insertionsort/InsertionSorterFactory.SORT_TYPE.html" title="enum in org.apache.sysds.runtime.compress.colgroup.insertionsort">InsertionSorterFactory.SORT_TYPE</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sdcSortType">sdcSortType</a></span></code></th>
<td class="colLast">
<div class="block">The sorting type used in sorting/joining offsets to create SDC groups</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#seed">seed</a></span></code></th>
<td class="colLast">
<div class="block">If the seed is -1 then the system used system millisecond time and class hash for seeding.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#sortTuplesByFrequency">sortTuplesByFrequency</a></span></code></th>
<td class="colLast">
<div class="block">Sorting of values by physical length helps by 10-20%, especially for serial, while slight performance decrease for
parallel incl multi-threaded, hence not applied for distributed operations (also because compression time +
garbage collection increases)</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#transposed">transposed</a></span></code></th>
<td class="colLast">
<div class="block">Transpose input matrix, to optimize access when extracting bitmaps.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#transposeInput">transposeInput</a></span></code></th>
<td class="colLast">
<div class="block">Boolean specifying which transpose setting is used, can be auto, true or false</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/EnumSet.html?is-external=true" title="class or interface in java.util" class="externalLink">EnumSet</a>&lt;<a href="colgroup/AColGroup.CompressionType.html" title="enum in org.apache.sysds.runtime.compress.colgroup">AColGroup.CompressionType</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#validCompressions">validCompressions</a></span></code></th>
<td class="colLast">
<div class="block">Valid Compressions List, containing the ColGroup CompressionTypes that are allowed to be used for the compression
Default is to always allow for Uncompromisable ColGroup.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isRLEAllowed()">isRLEAllowed</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="PAR_DDC_THRESHOLD">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PAR_DDC_THRESHOLD</h4>
<pre>public static&nbsp;int PAR_DDC_THRESHOLD</pre>
<div class="block">Parallelization threshold for DDC compression</div>
</li>
</ul>
<a id="BITMAP_BLOCK_SZ">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>BITMAP_BLOCK_SZ</h4>
<pre>public static final&nbsp;int BITMAP_BLOCK_SZ</pre>
<div class="block">Size of the blocks used in a blocked bitmap representation. Note it is exactly Character.MAX_VALUE. This is not
Character max value + 1 because it breaks the offsets in cases with fully dense values.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.sysds.runtime.compress.CompressionSettings.BITMAP_BLOCK_SZ">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a id="sortTuplesByFrequency">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sortTuplesByFrequency</h4>
<pre>public final&nbsp;boolean sortTuplesByFrequency</pre>
<div class="block">Sorting of values by physical length helps by 10-20%, especially for serial, while slight performance decrease for
parallel incl multi-threaded, hence not applied for distributed operations (also because compression time +
garbage collection increases)</div>
</li>
</ul>
<a id="samplingRatio">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>samplingRatio</h4>
<pre>public final&nbsp;double samplingRatio</pre>
<div class="block">The sampling ratio used when choosing ColGroups. Note that, default behavior is to use exact estimator if the
number of elements is below 1000.
DEPRECATED</div>
</li>
</ul>
<a id="samplePower">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>samplePower</h4>
<pre>public final&nbsp;double samplePower</pre>
<div class="block">The sampling ratio power to use when choosing sample size. This is used in accordance to the function:
sampleSize += nRows^samplePower;
The value is bounded to be in the range of 0 to 1, 1 giving a sample size of everything, and 0 adding 1.</div>
</li>
</ul>
<a id="allowSharedDictionary">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>allowSharedDictionary</h4>
<pre>public final&nbsp;boolean allowSharedDictionary</pre>
<div class="block">Share DDC Dictionaries between ColGroups.</div>
</li>
</ul>
<a id="transposeInput">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>transposeInput</h4>
<pre>public final&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> transposeInput</pre>
<div class="block">Boolean specifying which transpose setting is used, can be auto, true or false</div>
</li>
</ul>
<a id="seed">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>seed</h4>
<pre>public final&nbsp;int seed</pre>
<div class="block">If the seed is -1 then the system used system millisecond time and class hash for seeding.</div>
</li>
</ul>
<a id="lossy">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>lossy</h4>
<pre>public final&nbsp;boolean lossy</pre>
<div class="block">True if lossy compression is enabled</div>
</li>
</ul>
<a id="columnPartitioner">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>columnPartitioner</h4>
<pre>public final&nbsp;<a href="cocode/CoCoderFactory.PartitionerType.html" title="enum in org.apache.sysds.runtime.compress.cocode">CoCoderFactory.PartitionerType</a> columnPartitioner</pre>
<div class="block">The selected method for column partitioning used in CoCoding compressed columns</div>
</li>
</ul>
<a id="costComputationType">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>costComputationType</h4>
<pre>public final&nbsp;<a href="cost/CostEstimatorFactory.CostType.html" title="enum in org.apache.sysds.runtime.compress.cost">CostEstimatorFactory.CostType</a> costComputationType</pre>
<div class="block">The cost computation type for the compression</div>
</li>
</ul>
<a id="maxColGroupCoCode">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>maxColGroupCoCode</h4>
<pre>public final&nbsp;int maxColGroupCoCode</pre>
<div class="block">The maximum number of columns CoCoded allowed</div>
</li>
</ul>
<a id="coCodePercentage">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>coCodePercentage</h4>
<pre>public final&nbsp;double coCodePercentage</pre>
<div class="block">A Cocode parameter that differ in behavior based on compression method, in general it is a value that reflects
aggressively likely coCoding is used.</div>
</li>
</ul>
<a id="validCompressions">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>validCompressions</h4>
<pre>public final&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/EnumSet.html?is-external=true" title="class or interface in java.util" class="externalLink">EnumSet</a>&lt;<a href="colgroup/AColGroup.CompressionType.html" title="enum in org.apache.sysds.runtime.compress.colgroup">AColGroup.CompressionType</a>&gt; validCompressions</pre>
<div class="block">Valid Compressions List, containing the ColGroup CompressionTypes that are allowed to be used for the compression
Default is to always allow for Uncompromisable ColGroup.</div>
</li>
</ul>
<a id="minimumSampleSize">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>minimumSampleSize</h4>
<pre>public final&nbsp;int minimumSampleSize</pre>
<div class="block">The minimum size of the sample extracted.</div>
</li>
</ul>
<a id="maxSampleSize">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>maxSampleSize</h4>
<pre>public final&nbsp;int maxSampleSize</pre>
<div class="block">The maximum size of the sample extracted.</div>
</li>
</ul>
<a id="estimationType">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>estimationType</h4>
<pre>public final&nbsp;<a href="estim/sample/SampleEstimatorFactory.EstimationType.html" title="enum in org.apache.sysds.runtime.compress.estim.sample">SampleEstimatorFactory.EstimationType</a> estimationType</pre>
<div class="block">The sample type used for sampling</div>
</li>
</ul>
<a id="transposed">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>transposed</h4>
<pre>public&nbsp;boolean transposed</pre>
<div class="block">Transpose input matrix, to optimize access when extracting bitmaps. This setting is changed inside the script
based on the transposeInput setting.
This is intentionally left as a mutable value, since the transposition of the input matrix is decided in phase 3.</div>
</li>
</ul>
<a id="minimumCompressionRatio">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>minimumCompressionRatio</h4>
<pre>public final&nbsp;double minimumCompressionRatio</pre>
<div class="block">The minimum compression ratio to achieve.</div>
</li>
</ul>
<a id="isInSparkInstruction">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isInSparkInstruction</h4>
<pre>public final&nbsp;boolean isInSparkInstruction</pre>
<div class="block">Is a spark instruction</div>
</li>
</ul>
<a id="sdcSortType">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>sdcSortType</h4>
<pre>public final&nbsp;<a href="colgroup/insertionsort/InsertionSorterFactory.SORT_TYPE.html" title="enum in org.apache.sysds.runtime.compress.colgroup.insertionsort">InsertionSorterFactory.SORT_TYPE</a> sdcSortType</pre>
<div class="block">The sorting type used in sorting/joining offsets to create SDC groups</div>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="isRLEAllowed()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRLEAllowed</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isRLEAllowed()</pre>
</li>
</ul>
<a id="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;toString()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/CompressionSettings.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>