Google Git
Sign in
apache / systemds / 94bbeae9f0567cf857b78caf2055d4d3e757ec84 / . / docs / api / java / org / apache / sysds / runtime / compress / CompressionSettingsBuilder.html
blob: 294ff738f4098ba24e1b68b5a1c59b797d3b2350 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CompressionSettingsBuilder (SystemDS 2.1.0-SNAPSHOT API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CompressionSettingsBuilder (SystemDS 2.1.0-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"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};
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";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.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">
<li><a href="../../../../../org/apache/sysds/runtime/compress/CompressionSettings.html" title="class in org.apache.sysds.runtime.compress"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/sysds/runtime/compress/CompressionStatistics.html" title="class in org.apache.sysds.runtime.compress"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/sysds/runtime/compress/CompressionSettingsBuilder.html" target="_top">Frames</a></li>
<li><a href="CompressionSettingsBuilder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></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>
</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 name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.sysds.runtime.compress</div>
<h2 title="Class CompressionSettingsBuilder" class="title">Class CompressionSettingsBuilder</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">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>
<br>
<pre>public class <span class="typeNameLabel">CompressionSettingsBuilder</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">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 ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/runtime/compress/CompressionSettingsBuilder.html#CompressionSettingsBuilder--">CompressionSettingsBuilder</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<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="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/sysds/runtime/compress/CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/runtime/compress/CompressionSettingsBuilder.html#addValidCompression-org.apache.sysds.runtime.compress.colgroup.AColGroup.CompressionType-">addValidCompression</a></span>(<a href="../../../../../org/apache/sysds/runtime/compress/colgroup/AColGroup.CompressionType.html" title="enum in org.apache.sysds.runtime.compress.colgroup">AColGroup.CompressionType</a>&nbsp;cp)</code>
<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="../../../../../org/apache/sysds/runtime/compress/CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/runtime/compress/CompressionSettingsBuilder.html#clearValidCompression--">clearValidCompression</a></span>()</code>
<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="../../../../../org/apache/sysds/runtime/compress/CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/runtime/compress/CompressionSettingsBuilder.html#copySettings-org.apache.sysds.runtime.compress.CompressionSettings-">copySettings</a></span>(<a href="../../../../../org/apache/sysds/runtime/compress/CompressionSettings.html" title="class in org.apache.sysds.runtime.compress">CompressionSettings</a>&nbsp;that)</code>
<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="../../../../../org/apache/sysds/runtime/compress/CompressionSettings.html" title="class in org.apache.sysds.runtime.compress">CompressionSettings</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/runtime/compress/CompressionSettingsBuilder.html#create--">create</a></span>()</code>
<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="../../../../../org/apache/sysds/runtime/compress/CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/runtime/compress/CompressionSettingsBuilder.html#setAllowSharedDictionary-boolean-">setAllowSharedDictionary</a></span>(boolean&nbsp;allowSharedDictionary)</code>
<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="../../../../../org/apache/sysds/runtime/compress/CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/runtime/compress/CompressionSettingsBuilder.html#setColumnPartitioner-org.apache.sysds.runtime.compress.cocode.PlanningCoCoder.PartitionerType-">setColumnPartitioner</a></span>(<a href="../../../../../org/apache/sysds/runtime/compress/cocode/PlanningCoCoder.PartitionerType.html" title="enum in org.apache.sysds.runtime.compress.cocode">PlanningCoCoder.PartitionerType</a>&nbsp;columnPartitioner)</code>
<div class="block">Set the type of CoCoding Partitioner type to use for combining columns together.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/sysds/runtime/compress/CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/runtime/compress/CompressionSettingsBuilder.html#setInvestigateEstimate-boolean-">setInvestigateEstimate</a></span>(boolean&nbsp;investigateEstimate)</code>
<div class="block">Set if the compression should be investigated while compressing.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/sysds/runtime/compress/CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/runtime/compress/CompressionSettingsBuilder.html#setLossy-boolean-">setLossy</a></span>(boolean&nbsp;lossy)</code>
<div class="block">Set the Compression to use Lossy compression.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/sysds/runtime/compress/CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/runtime/compress/CompressionSettingsBuilder.html#setmaxStaticColGroupCoCode-int-">setmaxStaticColGroupCoCode</a></span>(int&nbsp;maxStaticColGroupCoCode)</code>
<div class="block">Set the maximum number of columns to CoCode together in the static CoCoding strategy.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/sysds/runtime/compress/CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/runtime/compress/CompressionSettingsBuilder.html#setSamplingRatio-double-">setSamplingRatio</a></span>(double&nbsp;samplingRatio)</code>
<div class="block">Set the sampling ratio in percent to sample the input matrix.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/sysds/runtime/compress/CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/runtime/compress/CompressionSettingsBuilder.html#setSeed-int-">setSeed</a></span>(int&nbsp;seed)</code>
<div class="block">Set the seed for the compression operation.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/sysds/runtime/compress/CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/runtime/compress/CompressionSettingsBuilder.html#setSkipList-boolean-">setSkipList</a></span>(boolean&nbsp;skipList)</code>
<div class="block">Specify if the Offset list encoding should utilize skip lists.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/sysds/runtime/compress/CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/runtime/compress/CompressionSettingsBuilder.html#setSortValuesByLength-boolean-">setSortValuesByLength</a></span>(boolean&nbsp;sortValuesByLength)</code>
<div class="block">Set the sortValuesByLength flag.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/sysds/runtime/compress/CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/runtime/compress/CompressionSettingsBuilder.html#setTransposeInput-java.lang.String-">setTransposeInput</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;transposeInput)</code>
<div class="block">Specify if the input matrix should be transposed before compression.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/sysds/runtime/compress/CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/sysds/runtime/compress/CompressionSettingsBuilder.html#setValidCompressions-java.util.EnumSet-">setValidCompressions</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/EnumSet.html?is-external=true" title="class or interface in java.util">EnumSet</a>&lt;<a href="../../../../../org/apache/sysds/runtime/compress/colgroup/AColGroup.CompressionType.html" title="enum in org.apache.sysds.runtime.compress.colgroup">AColGroup.CompressionType</a>&gt;&nbsp;validCompressions)</code>
<div class="block">Set the valid compression strategies used for the compression.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="CompressionSettingsBuilder--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CompressionSettingsBuilder</h4>
<pre>public&nbsp;CompressionSettingsBuilder()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="copySettings-org.apache.sysds.runtime.compress.CompressionSettings-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>copySettings</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/sysds/runtime/compress/CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a>&nbsp;copySettings(<a href="../../../../../org/apache/sysds/runtime/compress/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 name="setLossy-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLossy</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/sysds/runtime/compress/CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a>&nbsp;setLossy(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 name="setSamplingRatio-double-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSamplingRatio</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/sysds/runtime/compress/CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a>&nbsp;setSamplingRatio(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 name="setSortValuesByLength-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSortValuesByLength</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/sysds/runtime/compress/CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a>&nbsp;setSortValuesByLength(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 name="setAllowSharedDictionary-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAllowSharedDictionary</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/sysds/runtime/compress/CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a>&nbsp;setAllowSharedDictionary(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 name="setTransposeInput-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTransposeInput</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/sysds/runtime/compress/CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a>&nbsp;setTransposeInput(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">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 name="setSkipList-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSkipList</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/sysds/runtime/compress/CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a>&nbsp;setSkipList(boolean&nbsp;skipList)</pre>
<div class="block">Specify if the Offset list encoding should utilize skip lists. This increase size of compression but improves
performance in Offset encodings. OLE and RLE.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>skipList</code> - a boolean specifying if the skiplist function is enabled</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The CompressionSettingsBuilder</dd>
</dl>
</li>
</ul>
<a name="setSeed-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSeed</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/sysds/runtime/compress/CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a>&nbsp;setSeed(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 name="setInvestigateEstimate-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setInvestigateEstimate</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/sysds/runtime/compress/CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a>&nbsp;setInvestigateEstimate(boolean&nbsp;investigateEstimate)</pre>
<div class="block">Set if the compression should be investigated while compressing.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>investigateEstimate</code> - A boolean specifying it the input should be estimated.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The CompressionSettingsBuilder</dd>
</dl>
</li>
</ul>
<a name="setValidCompressions-java.util.EnumSet-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setValidCompressions</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/sysds/runtime/compress/CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a>&nbsp;setValidCompressions(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/EnumSet.html?is-external=true" title="class or interface in java.util">EnumSet</a>&lt;<a href="../../../../../org/apache/sysds/runtime/compress/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 name="addValidCompression-org.apache.sysds.runtime.compress.colgroup.AColGroup.CompressionType-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addValidCompression</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/sysds/runtime/compress/CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a>&nbsp;addValidCompression(<a href="../../../../../org/apache/sysds/runtime/compress/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 name="clearValidCompression--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearValidCompression</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/sysds/runtime/compress/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 name="setColumnPartitioner-org.apache.sysds.runtime.compress.cocode.PlanningCoCoder.PartitionerType-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setColumnPartitioner</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/sysds/runtime/compress/CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a>&nbsp;setColumnPartitioner(<a href="../../../../../org/apache/sysds/runtime/compress/cocode/PlanningCoCoder.PartitionerType.html" title="enum in org.apache.sysds.runtime.compress.cocode">PlanningCoCoder.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 name="setmaxStaticColGroupCoCode-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setmaxStaticColGroupCoCode</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/sysds/runtime/compress/CompressionSettingsBuilder.html" title="class in org.apache.sysds.runtime.compress">CompressionSettingsBuilder</a>&nbsp;setmaxStaticColGroupCoCode(int&nbsp;maxStaticColGroupCoCode)</pre>
<div class="block">Set the maximum number of columns to CoCode together in the static CoCoding strategy. Compression time increase
with higher numbers.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>maxStaticColGroupCoCode</code> - The max selected.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The CompressionSettingsBuilder</dd>
</dl>
</li>
</ul>
<a name="create--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>create</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/sysds/runtime/compress/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>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.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">
<li><a href="../../../../../org/apache/sysds/runtime/compress/CompressionSettings.html" title="class in org.apache.sysds.runtime.compress"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/sysds/runtime/compress/CompressionStatistics.html" title="class in org.apache.sysds.runtime.compress"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/sysds/runtime/compress/CompressionSettingsBuilder.html" target="_top">Frames</a></li>
<li><a href="CompressionSettingsBuilder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.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>
</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 name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>