Google Git
Sign in
apache / systemds / d7838c8d55e38db7d9ead5104ba8696eec64ac9a / . / docs / api / java / org / apache / sysds / runtime / compress / CompressionSettingsBuilder.html
blob: 0ab707d4298f7e1ba33f5f79d755f1df06020a9e [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>CompressionSettingsBuilder (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="CompressionSettingsBuilder (Apache SystemDS 3.2.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":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/CompressionSettingsBuilder.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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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 CompressionSettingsBuilder" class="title">Class CompressionSettingsBuilder</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.CompressionSettingsBuilder</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public class <span class="typeNameLabel">CompressionSettingsBuilder</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">Builder pattern for Compression Settings. See CompressionSettings for details on values.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">CompressionSettingsBuilder</a></span>()</code></th>
<td class="colLast">&nbsp;</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><a href="CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addValidCompression(org.apache.sysds.runtime.compress.colgroup.AColGroup.CompressionType)">addValidCompression</a></span>&#8203;(<a href="colgroup/AColGroup.CompressionType.html" title="enum in org.apache.sysds.runtime.compress.colgroup">AColGroup.CompressionType</a>&nbsp;cp)</code></th>
<td class="colLast">
<div class="block">Add a single valid compression type to the EnumSet of valid compressions.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clearValidCompression()">clearValidCompression</a></span>()</code></th>
<td class="colLast">
<div class="block">Clear all the compression types allowed in the compression.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#copySettings(org.apache.sysds.runtime.compress.CompressionSettings)">copySettings</a></span>&#8203;(<a href="CompressionSettings.html" title="class in org.apache.sysds.runtime.compress">CompressionSettings</a>&nbsp;that)</code></th>
<td class="colLast">
<div class="block">Copy the settings from another CompressionSettings Builder, modifies this, not that.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="CompressionSettings.html" title="class in org.apache.sysds.runtime.compress">CompressionSettings</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#create()">create</a></span>()</code></th>
<td class="colLast">
<div class="block">Create the CompressionSettings object to use in the compression.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setAllowSharedDictionary(boolean)">setAllowSharedDictionary</a></span>&#8203;(boolean&nbsp;allowSharedDictionary)</code></th>
<td class="colLast">
<div class="block">Allow the Dictionaries to be shared between different column groups.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCoCodePercentage(double)">setCoCodePercentage</a></span>&#8203;(double&nbsp;coCodePercentage)</code></th>
<td class="colLast">
<div class="block">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.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setColumnPartitioner(org.apache.sysds.runtime.compress.cocode.CoCoderFactory.PartitionerType)">setColumnPartitioner</a></span>&#8203;(<a href="cocode/CoCoderFactory.PartitionerType.html" title="enum in org.apache.sysds.runtime.compress.cocode">CoCoderFactory.PartitionerType</a>&nbsp;columnPartitioner)</code></th>
<td class="colLast">
<div class="block">Set the type of CoCoding Partitioner type to use for combining columns together.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setCostType(org.apache.sysds.runtime.compress.cost.CostEstimatorFactory.CostType)">setCostType</a></span>&#8203;(<a href="cost/CostEstimatorFactory.CostType.html" title="enum in org.apache.sysds.runtime.compress.cost">CostEstimatorFactory.CostType</a>&nbsp;costType)</code></th>
<td class="colLast">
<div class="block">Set the cost type used for estimating the cost of column groups default is memory based.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setEstimationType(org.apache.sysds.runtime.compress.estim.sample.SampleEstimatorFactory.EstimationType)">setEstimationType</a></span>&#8203;(<a href="estim/sample/SampleEstimatorFactory.EstimationType.html" title="enum in org.apache.sysds.runtime.compress.estim.sample">SampleEstimatorFactory.EstimationType</a>&nbsp;estimationType)</code></th>
<td class="colLast">
<div class="block">Set the estimation type used for the sampled estimates.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setIsInSparkInstruction()">setIsInSparkInstruction</a></span>()</code></th>
<td class="colLast">
<div class="block">Inform the compression that it is executed in a spark instruction.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLossy(boolean)">setLossy</a></span>&#8203;(boolean&nbsp;lossy)</code></th>
<td class="colLast">
<div class="block">Set the Compression to use Lossy compression.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMaxColGroupCoCode(int)">setMaxColGroupCoCode</a></span>&#8203;(int&nbsp;maxColGroupCoCode)</code></th>
<td class="colLast">
<div class="block">Set the maximum number of columns to CoCode together in the CoCoding strategy.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMaxSampleSize(int)">setMaxSampleSize</a></span>&#8203;(int&nbsp;maxSampleSize)</code></th>
<td class="colLast">
<div class="block">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.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMinimumCompressionRatio(double)">setMinimumCompressionRatio</a></span>&#8203;(double&nbsp;ratio)</code></th>
<td class="colLast">
<div class="block">Set the minimum compression ratio to be achieved by the compression.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMinimumSampleSize(int)">setMinimumSampleSize</a></span>&#8203;(int&nbsp;minimumSampleSize)</code></th>
<td class="colLast">
<div class="block">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.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSamplingRatio(double)">setSamplingRatio</a></span>&#8203;(double&nbsp;samplingRatio)</code></th>
<td class="colLast">
<div class="block">Set the sampling ratio in percent to sample the input matrix.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSDCSortType(org.apache.sysds.runtime.compress.colgroup.insertionsort.InsertionSorterFactory.SORT_TYPE)">setSDCSortType</a></span>&#8203;(<a href="colgroup/insertionsort/InsertionSorterFactory.SORT_TYPE.html" title="enum in org.apache.sysds.runtime.compress.colgroup.insertionsort">InsertionSorterFactory.SORT_TYPE</a>&nbsp;sdcSortType)</code></th>
<td class="colLast">
<div class="block">Set the sort type to use.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSeed(int)">setSeed</a></span>&#8203;(int&nbsp;seed)</code></th>
<td class="colLast">
<div class="block">Set the seed for the compression operation.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code><a href="CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSortValuesByLength(boolean)">setSortValuesByLength</a></span>&#8203;(boolean&nbsp;sortValuesByLength)</code></th>
<td class="colLast">
<div class="block">Set the sortValuesByLength flag.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code><a href="CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTransposeInput(java.lang.String)">setTransposeInput</a></span>&#8203;(<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;transposeInput)</code></th>
<td class="colLast">
<div class="block">Specify if the input matrix should be transposed before compression.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code><a href="CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setValidCompressions(java.util.EnumSet)">setValidCompressions</a></span>&#8203;(<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;&nbsp;validCompressions)</code></th>
<td class="colLast">
<div class="block">Set the valid compression strategies used for the compression.</div>
</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#toString()" title="class or interface in java.lang" class="externalLink">toString</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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CompressionSettingsBuilder</h4>
<pre>public&nbsp;CompressionSettingsBuilder()</pre>
</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="copySettings(org.apache.sysds.runtime.compress.CompressionSettings)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>copySettings</h4>
<pre class="methodSignature">public&nbsp;<a href="CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a>&nbsp;copySettings&#8203;(<a href="CompressionSettings.html" title="class in org.apache.sysds.runtime.compress">CompressionSettings</a>&nbsp;that)</pre>
<div class="block">Copy the settings from another CompressionSettings Builder, modifies this, not that.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>that</code> - The other CompressionSettingsBuilder to copy settings from.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The modified CompressionSettings in the same object.</dd>
</dl>
</li>
</ul>
<a id="setLossy(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLossy</h4>
<pre class="methodSignature">public&nbsp;<a href="CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a>&nbsp;setLossy&#8203;(boolean&nbsp;lossy)</pre>
<div class="block">Set the Compression to use Lossy compression.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>lossy</code> - A boolean specifying if the compression should be lossy</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The CompressionSettingsBuilder</dd>
</dl>
</li>
</ul>
<a id="setSamplingRatio(double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSamplingRatio</h4>
<pre class="methodSignature">public&nbsp;<a href="CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a>&nbsp;setSamplingRatio&#8203;(double&nbsp;samplingRatio)</pre>
<div class="block">Set the sampling ratio in percent to sample the input matrix. Input value should be in range 0.0 - 1.0</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>samplingRatio</code> - The ratio to sample from the input</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The CompressionSettingsBuilder</dd>
</dl>
</li>
</ul>
<a id="setSortValuesByLength(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSortValuesByLength</h4>
<pre class="methodSignature">public&nbsp;<a href="CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a>&nbsp;setSortValuesByLength&#8203;(boolean&nbsp;sortValuesByLength)</pre>
<div class="block">Set the sortValuesByLength flag. This sorts the dictionaries containing the data based on their occurences in the
ColGroup. Improving cache efficiency especially for diverse column groups.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sortValuesByLength</code> - A boolean specifying if the values should be sorted</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The CompressionSettingsBuilder</dd>
</dl>
</li>
</ul>
<a id="setAllowSharedDictionary(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAllowSharedDictionary</h4>
<pre class="methodSignature">public&nbsp;<a href="CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a>&nbsp;setAllowSharedDictionary&#8203;(boolean&nbsp;allowSharedDictionary)</pre>
<div class="block">Allow the Dictionaries to be shared between different column groups.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>allowSharedDictionary</code> - A boolean specifying if the dictionary can be shared between column groups.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The CompressionSettingsBuilder</dd>
</dl>
</li>
</ul>
<a id="setTransposeInput(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTransposeInput</h4>
<pre class="methodSignature">public&nbsp;<a href="CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a>&nbsp;setTransposeInput&#8203;(<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;transposeInput)</pre>
<div class="block">Specify if the input matrix should be transposed before compression. This improves cache efficiency while
compression the input matrix</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>transposeInput</code> - string specifying if the input should be transposed before compression, should be one of
"auto", "true" or "false"</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The CompressionSettingsBuilder</dd>
</dl>
</li>
</ul>
<a id="setSeed(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSeed</h4>
<pre class="methodSignature">public&nbsp;<a href="CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a>&nbsp;setSeed&#8203;(int&nbsp;seed)</pre>
<div class="block">Set the seed for the compression operation.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>seed</code> - The seed used in sampling the matrix and general operations in the compression.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The CompressionSettingsBuilder</dd>
</dl>
</li>
</ul>
<a id="setValidCompressions(java.util.EnumSet)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setValidCompressions</h4>
<pre class="methodSignature">public&nbsp;<a href="CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a>&nbsp;setValidCompressions&#8203;(<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;&nbsp;validCompressions)</pre>
<div class="block">Set the valid compression strategies used for the compression.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>validCompressions</code> - An EnumSet of CompressionTypes to use in the compression</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The CompressionSettingsBuilder</dd>
</dl>
</li>
</ul>
<a id="addValidCompression(org.apache.sysds.runtime.compress.colgroup.AColGroup.CompressionType)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addValidCompression</h4>
<pre class="methodSignature">public&nbsp;<a href="CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a>&nbsp;addValidCompression&#8203;(<a href="colgroup/AColGroup.CompressionType.html" title="enum in org.apache.sysds.runtime.compress.colgroup">AColGroup.CompressionType</a>&nbsp;cp)</pre>
<div class="block">Add a single valid compression type to the EnumSet of valid compressions.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cp</code> - The compression type to add to the valid ones.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The CompressionSettingsBuilder</dd>
</dl>
</li>
</ul>
<a id="clearValidCompression()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearValidCompression</h4>
<pre class="methodSignature">public&nbsp;<a href="CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a>&nbsp;clearValidCompression()</pre>
<div class="block">Clear all the compression types allowed in the compression. This will only allow the Uncompressed ColGroup type.
Since this is required for operation of the compression</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The CompressionSettingsBuilder</dd>
</dl>
</li>
</ul>
<a id="setColumnPartitioner(org.apache.sysds.runtime.compress.cocode.CoCoderFactory.PartitionerType)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setColumnPartitioner</h4>
<pre class="methodSignature">public&nbsp;<a href="CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a>&nbsp;setColumnPartitioner&#8203;(<a href="cocode/CoCoderFactory.PartitionerType.html" title="enum in org.apache.sysds.runtime.compress.cocode">CoCoderFactory.PartitionerType</a>&nbsp;columnPartitioner)</pre>
<div class="block">Set the type of CoCoding Partitioner type to use for combining columns together.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>columnPartitioner</code> - The Strategy to select from PartitionerType</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The CompressionSettingsBuilder</dd>
</dl>
</li>
</ul>
<a id="setMaxColGroupCoCode(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxColGroupCoCode</h4>
<pre class="methodSignature">public&nbsp;<a href="CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a>&nbsp;setMaxColGroupCoCode&#8203;(int&nbsp;maxColGroupCoCode)</pre>
<div class="block">Set the maximum number of columns to CoCode together in the CoCoding strategy. Compression time increase with
higher numbers.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>maxColGroupCoCode</code> - The max selected.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The CompressionSettingsBuilder</dd>
</dl>
</li>
</ul>
<a id="setCoCodePercentage(double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCoCodePercentage</h4>
<pre class="methodSignature">public&nbsp;<a href="CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a>&nbsp;setCoCodePercentage&#8203;(double&nbsp;coCodePercentage)</pre>
<div class="block">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.
Note that with high coCoding the compression ratio would possibly be lower.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>coCodePercentage</code> - The percentage to set.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The CompressionSettingsBuilder</dd>
</dl>
</li>
</ul>
<a id="setMinimumSampleSize(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMinimumSampleSize</h4>
<pre class="methodSignature">public&nbsp;<a href="CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a>&nbsp;setMinimumSampleSize&#8203;(int&nbsp;minimumSampleSize)</pre>
<div class="block">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.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>minimumSampleSize</code> - The minimum sample size to extract</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The CompressionSettingsBuilder</dd>
</dl>
</li>
</ul>
<a id="setMaxSampleSize(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxSampleSize</h4>
<pre class="methodSignature">public&nbsp;<a href="CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a>&nbsp;setMaxSampleSize&#8203;(int&nbsp;maxSampleSize)</pre>
<div class="block">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.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>maxSampleSize</code> - The maximum sample size to extract</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The CompressionSettingsBuilder</dd>
</dl>
</li>
</ul>
<a id="setEstimationType(org.apache.sysds.runtime.compress.estim.sample.SampleEstimatorFactory.EstimationType)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setEstimationType</h4>
<pre class="methodSignature">public&nbsp;<a href="CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a>&nbsp;setEstimationType&#8203;(<a href="estim/sample/SampleEstimatorFactory.EstimationType.html" title="enum in org.apache.sysds.runtime.compress.estim.sample">SampleEstimatorFactory.EstimationType</a>&nbsp;estimationType)</pre>
<div class="block">Set the estimation type used for the sampled estimates.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>estimationType</code> - the estimation type in used.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The CompressionSettingsBuilder</dd>
</dl>
</li>
</ul>
<a id="setCostType(org.apache.sysds.runtime.compress.cost.CostEstimatorFactory.CostType)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCostType</h4>
<pre class="methodSignature">public&nbsp;<a href="CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a>&nbsp;setCostType&#8203;(<a href="cost/CostEstimatorFactory.CostType.html" title="enum in org.apache.sysds.runtime.compress.cost">CostEstimatorFactory.CostType</a>&nbsp;costType)</pre>
<div class="block">Set the cost type used for estimating the cost of column groups default is memory based.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>costType</code> - The Cost type wanted</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The CompressionSettingsBuilder</dd>
</dl>
</li>
</ul>
<a id="setMinimumCompressionRatio(double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMinimumCompressionRatio</h4>
<pre class="methodSignature">public&nbsp;<a href="CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a>&nbsp;setMinimumCompressionRatio&#8203;(double&nbsp;ratio)</pre>
<div class="block">Set the minimum compression ratio to be achieved by the compression.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>ratio</code> - The ratio to achieve while compressing</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The CompressionSettingsBuilder</dd>
</dl>
</li>
</ul>
<a id="setIsInSparkInstruction()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIsInSparkInstruction</h4>
<pre class="methodSignature">public&nbsp;<a href="CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a>&nbsp;setIsInSparkInstruction()</pre>
<div class="block">Inform the compression that it is executed in a spark instruction.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The CompressionSettingsBuilder</dd>
</dl>
</li>
</ul>
<a id="setSDCSortType(org.apache.sysds.runtime.compress.colgroup.insertionsort.InsertionSorterFactory.SORT_TYPE)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSDCSortType</h4>
<pre class="methodSignature">public&nbsp;<a href="CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a>&nbsp;setSDCSortType&#8203;(<a href="colgroup/insertionsort/InsertionSorterFactory.SORT_TYPE.html" title="enum in org.apache.sysds.runtime.compress.colgroup.insertionsort">InsertionSorterFactory.SORT_TYPE</a>&nbsp;sdcSortType)</pre>
<div class="block">Set the sort type to use.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sdcSortType</code> - The sort type for the construction of SDC groups</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The CompressionSettingsBuilder</dd>
</dl>
</li>
</ul>
<a id="create()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>create</h4>
<pre class="methodSignature">public&nbsp;<a href="CompressionSettings.html" title="class in org.apache.sysds.runtime.compress">CompressionSettings</a>&nbsp;create()</pre>
<div class="block">Create the CompressionSettings object to use in the compression.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The CompressionSettings</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/CompressionSettingsBuilder.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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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>