Google Git
Sign in
apache / datasketches-website / d5f29b3e6de7df659f65c31ea2ce341dcaf8b675 / . / api / java / snapshot / apidocs / org / apache / datasketches / theta / SetOperationBuilder.html
blob: eaa930e5d8ef27c3c9eee210e5d59ee9f446820a [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>SetOperationBuilder (datasketches-java 4.0.0 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="SetOperationBuilder (datasketches-java 4.0.0 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};
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/SetOperationBuilder.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.datasketches.theta</a></div>
<h2 title="Class SetOperationBuilder" class="title">Class SetOperationBuilder</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" class="externalLink">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.datasketches.theta.SetOperationBuilder</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public class <span class="typeNameLabel">SetOperationBuilder</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" class="externalLink">Object</a></pre>
<div class="block">For building a new SetOperation.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Lee Rhodes</dd>
</dl>
</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()">SetOperationBuilder</a></span>()</code></th>
<td class="colLast">
<div class="block">Constructor for building a new SetOperation.</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><a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#build(org.apache.datasketches.common.Family)">build</a></span>&#8203;(<a href="../common/Family.html" title="enum in org.apache.datasketches.common">Family</a>&nbsp;family)</code></th>
<td class="colLast">
<div class="block">Returns a SetOperation with the current configuration of this Builder and the given Family.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#build(org.apache.datasketches.common.Family,org.apache.datasketches.memory.WritableMemory)">build</a></span>&#8203;(<a href="../common/Family.html" title="enum in org.apache.datasketches.common">Family</a>&nbsp;family,
org.apache.datasketches.memory.WritableMemory&nbsp;dstMem)</code></th>
<td class="colLast">
<div class="block">Returns a SetOperation with the current configuration of this Builder, the given Family
and the given destination memory.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="AnotB.html" title="class in org.apache.datasketches.theta">AnotB</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#buildANotB()">buildANotB</a></span>()</code></th>
<td class="colLast">
<div class="block">Convenience method, returns a configured SetOperation ANotB with
<a href="../../../../resources/dictionary.html#defaultUpdateSeed">Default Update Seed</a></div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="Intersection.html" title="class in org.apache.datasketches.theta">Intersection</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#buildIntersection()">buildIntersection</a></span>()</code></th>
<td class="colLast">
<div class="block">Convenience method, returns a configured SetOperation Intersection with
<a href="../../../../resources/dictionary.html#defaultNomEntries">Default Nominal Entries</a></div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="Intersection.html" title="class in org.apache.datasketches.theta">Intersection</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#buildIntersection(org.apache.datasketches.memory.WritableMemory)">buildIntersection</a></span>&#8203;(org.apache.datasketches.memory.WritableMemory&nbsp;dstMem)</code></th>
<td class="colLast">
<div class="block">Convenience method, returns a configured SetOperation Intersection with
<a href="../../../../resources/dictionary.html#defaultNomEntries">Default Nominal Entries</a>
and the given destination memory.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="Union.html" title="class in org.apache.datasketches.theta">Union</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#buildUnion()">buildUnion</a></span>()</code></th>
<td class="colLast">
<div class="block">Convenience method, returns a configured SetOperation Union with
<a href="../../../../resources/dictionary.html#defaultNomEntries">Default Nominal Entries</a></div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="Union.html" title="class in org.apache.datasketches.theta">Union</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#buildUnion(org.apache.datasketches.memory.WritableMemory)">buildUnion</a></span>&#8203;(org.apache.datasketches.memory.WritableMemory&nbsp;dstMem)</code></th>
<td class="colLast">
<div class="block">Convenience method, returns a configured SetOperation Union with
<a href="../../../../resources/dictionary.html#defaultNomEntries">Default Nominal Entries</a>
and the given destination memory.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLgNominalEntries()">getLgNominalEntries</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns Log-base 2 Nominal Entries</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>org.apache.datasketches.memory.MemoryRequestServer</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMemoryRequestServer()">getMemoryRequestServer</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the MemoryRequestServer</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>float</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getP()">getP</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the pre-sampling probability <i>p</i></div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../common/ResizeFactor.html" title="enum in org.apache.datasketches.common">ResizeFactor</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getResizeFactor()">getResizeFactor</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the Resize Factor</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSeed()">getSeed</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the seed</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setLogNominalEntries(int)">setLogNominalEntries</a></span>&#8203;(int&nbsp;lgNomEntries)</code></th>
<td class="colLast">
<div class="block">Alternative method of setting the Nominal Entries for this set operation from the log_base2 value.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMemoryRequestServer(org.apache.datasketches.memory.MemoryRequestServer)">setMemoryRequestServer</a></span>&#8203;(org.apache.datasketches.memory.MemoryRequestServer&nbsp;memReqSvr)</code></th>
<td class="colLast">
<div class="block">Set the MemoryRequestServer</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setNominalEntries(int)">setNominalEntries</a></span>&#8203;(int&nbsp;nomEntries)</code></th>
<td class="colLast">
<div class="block">Sets the Maximum Nominal Entries (max K) for this set operation.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setP(float)">setP</a></span>&#8203;(float&nbsp;p)</code></th>
<td class="colLast">
<div class="block">Sets the upfront uniform sampling probability, <i>p</i>.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setResizeFactor(org.apache.datasketches.common.ResizeFactor)">setResizeFactor</a></span>&#8203;(<a href="../common/ResizeFactor.html" title="enum in org.apache.datasketches.common">ResizeFactor</a>&nbsp;rf)</code></th>
<td class="colLast">
<div class="block">Sets the cache Resize Factor</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSeed(long)">setSeed</a></span>&#8203;(long&nbsp;seed)</code></th>
<td class="colLast">
<div class="block">Sets the long seed value that is require by the hashing function.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/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/javase/8/docs/api/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/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <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" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</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" class="externalLink">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" class="externalLink">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" class="externalLink">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" class="externalLink">notifyAll</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" class="externalLink">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" class="externalLink">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" 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>SetOperationBuilder</h4>
<pre>public&nbsp;SetOperationBuilder()</pre>
<div class="block">Constructor for building a new SetOperation. The default configuration is
<ul>
<li>Max Nominal Entries (max K):
<a href="../thetacommon/ThetaUtil.html#DEFAULT_NOMINAL_ENTRIES">4096</a></li>
<li>Seed: <a href="../thetacommon/ThetaUtil.html#DEFAULT_UPDATE_SEED">9001L</a></li>
<li><a href="../common/ResizeFactor.html#X8"><code>ResizeFactor.X8</code></a></li>
<li>Input Sampling Probability: 1.0</li>
<li>Memory: null</li>
</ul></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="setNominalEntries(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setNominalEntries</h4>
<pre class="methodSignature">public&nbsp;<a href="SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a>&nbsp;setNominalEntries&#8203;(int&nbsp;nomEntries)</pre>
<div class="block">Sets the Maximum Nominal Entries (max K) for this set operation. The effective value of K of the result of a
Set Operation can be less than max K, but never greater.
The minimum value is 16 and the maximum value is 67,108,864, which is 2^26.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>nomEntries</code> - <a href="../../../../resources/dictionary.html#nomEntries">Nominal Entres</a>
This will become the ceiling power of 2 if it is not a power of 2.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this SetOperationBuilder</dd>
</dl>
</li>
</ul>
<a id="setLogNominalEntries(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLogNominalEntries</h4>
<pre class="methodSignature">public&nbsp;<a href="SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a>&nbsp;setLogNominalEntries&#8203;(int&nbsp;lgNomEntries)</pre>
<div class="block">Alternative method of setting the Nominal Entries for this set operation from the log_base2 value.
The minimum value is 4 and the maximum value is 26.
Be aware that set operations as large as this maximum value may not have been
thoroughly characterized for performance.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>lgNomEntries</code> - the log_base2 Nominal Entries.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this SetOperationBuilder</dd>
</dl>
</li>
</ul>
<a id="getLgNominalEntries()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLgNominalEntries</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getLgNominalEntries()</pre>
<div class="block">Returns Log-base 2 Nominal Entries</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Log-base 2 Nominal Entries</dd>
</dl>
</li>
</ul>
<a id="setSeed(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSeed</h4>
<pre class="methodSignature">public&nbsp;<a href="SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a>&nbsp;setSeed&#8203;(long&nbsp;seed)</pre>
<div class="block">Sets the long seed value that is require by the hashing function.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>seed</code> - <a href="../../../../resources/dictionary.html#seed">See seed</a></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this SetOperationBuilder</dd>
</dl>
</li>
</ul>
<a id="getSeed()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSeed</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;getSeed()</pre>
<div class="block">Returns the seed</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the seed</dd>
</dl>
</li>
</ul>
<a id="setP(float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setP</h4>
<pre class="methodSignature">public&nbsp;<a href="SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a>&nbsp;setP&#8203;(float&nbsp;p)</pre>
<div class="block">Sets the upfront uniform sampling probability, <i>p</i>. Although this functionality is
implemented for Unions only, it rarely makes sense to use it. The proper use of upfront
sampling is when building the sketches.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>p</code> - <a href="../../../../resources/dictionary.html#p">See Sampling Probability, <i>p</i></a></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this SetOperationBuilder</dd>
</dl>
</li>
</ul>
<a id="getP()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getP</h4>
<pre class="methodSignature">public&nbsp;float&nbsp;getP()</pre>
<div class="block">Returns the pre-sampling probability <i>p</i></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the pre-sampling probability <i>p</i></dd>
</dl>
</li>
</ul>
<a id="setResizeFactor(org.apache.datasketches.common.ResizeFactor)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setResizeFactor</h4>
<pre class="methodSignature">public&nbsp;<a href="SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a>&nbsp;setResizeFactor&#8203;(<a href="../common/ResizeFactor.html" title="enum in org.apache.datasketches.common">ResizeFactor</a>&nbsp;rf)</pre>
<div class="block">Sets the cache Resize Factor</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>rf</code> - <a href="../../../../resources/dictionary.html#resizeFactor">See Resize Factor</a></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this SetOperationBuilder</dd>
</dl>
</li>
</ul>
<a id="getResizeFactor()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResizeFactor</h4>
<pre class="methodSignature">public&nbsp;<a href="../common/ResizeFactor.html" title="enum in org.apache.datasketches.common">ResizeFactor</a>&nbsp;getResizeFactor()</pre>
<div class="block">Returns the Resize Factor</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the Resize Factor</dd>
</dl>
</li>
</ul>
<a id="setMemoryRequestServer(org.apache.datasketches.memory.MemoryRequestServer)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMemoryRequestServer</h4>
<pre class="methodSignature">public&nbsp;<a href="SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a>&nbsp;setMemoryRequestServer&#8203;(org.apache.datasketches.memory.MemoryRequestServer&nbsp;memReqSvr)</pre>
<div class="block">Set the MemoryRequestServer</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>memReqSvr</code> - the given MemoryRequestServer</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this SetOperationBuilder</dd>
</dl>
</li>
</ul>
<a id="getMemoryRequestServer()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMemoryRequestServer</h4>
<pre class="methodSignature">public&nbsp;org.apache.datasketches.memory.MemoryRequestServer&nbsp;getMemoryRequestServer()</pre>
<div class="block">Returns the MemoryRequestServer</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the MemoryRequestServer</dd>
</dl>
</li>
</ul>
<a id="build(org.apache.datasketches.common.Family)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>build</h4>
<pre class="methodSignature">public&nbsp;<a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a>&nbsp;build&#8203;(<a href="../common/Family.html" title="enum in org.apache.datasketches.common">Family</a>&nbsp;family)</pre>
<div class="block">Returns a SetOperation with the current configuration of this Builder and the given Family.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>family</code> - the chosen SetOperation family</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a SetOperation</dd>
</dl>
</li>
</ul>
<a id="build(org.apache.datasketches.common.Family,org.apache.datasketches.memory.WritableMemory)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>build</h4>
<pre class="methodSignature">public&nbsp;<a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a>&nbsp;build&#8203;(<a href="../common/Family.html" title="enum in org.apache.datasketches.common">Family</a>&nbsp;family,
org.apache.datasketches.memory.WritableMemory&nbsp;dstMem)</pre>
<div class="block">Returns a SetOperation with the current configuration of this Builder, the given Family
and the given destination memory. Note that the destination memory cannot be used with AnotB.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>family</code> - the chosen SetOperation family</dd>
<dd><code>dstMem</code> - The destination Memory.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a SetOperation</dd>
</dl>
</li>
</ul>
<a id="buildUnion()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildUnion</h4>
<pre class="methodSignature">public&nbsp;<a href="Union.html" title="class in org.apache.datasketches.theta">Union</a>&nbsp;buildUnion()</pre>
<div class="block">Convenience method, returns a configured SetOperation Union with
<a href="../../../../resources/dictionary.html#defaultNomEntries">Default Nominal Entries</a></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a Union object</dd>
</dl>
</li>
</ul>
<a id="buildUnion(org.apache.datasketches.memory.WritableMemory)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildUnion</h4>
<pre class="methodSignature">public&nbsp;<a href="Union.html" title="class in org.apache.datasketches.theta">Union</a>&nbsp;buildUnion&#8203;(org.apache.datasketches.memory.WritableMemory&nbsp;dstMem)</pre>
<div class="block">Convenience method, returns a configured SetOperation Union with
<a href="../../../../resources/dictionary.html#defaultNomEntries">Default Nominal Entries</a>
and the given destination memory.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>dstMem</code> - The destination Memory.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a Union object</dd>
</dl>
</li>
</ul>
<a id="buildIntersection()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildIntersection</h4>
<pre class="methodSignature">public&nbsp;<a href="Intersection.html" title="class in org.apache.datasketches.theta">Intersection</a>&nbsp;buildIntersection()</pre>
<div class="block">Convenience method, returns a configured SetOperation Intersection with
<a href="../../../../resources/dictionary.html#defaultNomEntries">Default Nominal Entries</a></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an Intersection object</dd>
</dl>
</li>
</ul>
<a id="buildIntersection(org.apache.datasketches.memory.WritableMemory)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildIntersection</h4>
<pre class="methodSignature">public&nbsp;<a href="Intersection.html" title="class in org.apache.datasketches.theta">Intersection</a>&nbsp;buildIntersection&#8203;(org.apache.datasketches.memory.WritableMemory&nbsp;dstMem)</pre>
<div class="block">Convenience method, returns a configured SetOperation Intersection with
<a href="../../../../resources/dictionary.html#defaultNomEntries">Default Nominal Entries</a>
and the given destination memory.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>dstMem</code> - The destination Memory.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an Intersection object</dd>
</dl>
</li>
</ul>
<a id="buildANotB()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildANotB</h4>
<pre class="methodSignature">public&nbsp;<a href="AnotB.html" title="class in org.apache.datasketches.theta">AnotB</a>&nbsp;buildANotB()</pre>
<div class="block">Convenience method, returns a configured SetOperation ANotB with
<a href="../../../../resources/dictionary.html#defaultUpdateSeed">Default Update Seed</a></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an ANotB object</dd>
</dl>
</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/javase/8/docs/api/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/javase/8/docs/api/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/javase/8/docs/api/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/SetOperationBuilder.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; 2015&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>