Google Git
Sign in
apache / datasketches / d3adc1a60d93e5399c063ea3ed5ef18960ddb98d / . / api / core / snapshot / apidocs / com / yahoo / sketches / theta / UpdateSketchBuilder.html
blob: 87edc7dd6e6da5acc4411a5ceaf7b2f63d159917 [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 (1.8.0_162) on Thu Mar 14 13:13:09 PDT 2019 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>UpdateSketchBuilder (com.yahoo.datasketches:sketches-core 0.13.1-SNAPSHOT API)</title>
<meta name="date" content="2019-03-14">
<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="UpdateSketchBuilder (com.yahoo.datasketches:sketches-core 0.13.1-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,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":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/UpdateSketchBuilder.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="../../../../com/yahoo/sketches/theta/UpdateSketch.html" title="class in com.yahoo.sketches.theta"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/yahoo/sketches/theta/UpdateSketchBuilder.html" target="_top">Frames</a></li>
<li><a href="UpdateSketchBuilder.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">com.yahoo.sketches.theta</div>
<h2 title="Class UpdateSketchBuilder" class="title">Class UpdateSketchBuilder</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>com.yahoo.sketches.theta.UpdateSketchBuilder</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">UpdateSketchBuilder</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">For building a new UpdateSketch.</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 ======== -->
<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="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html#UpdateSketchBuilder--">UpdateSketchBuilder</a></span>()</code>
<div class="block">Constructor for building a new UpdateSketch.</div>
</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="../../../../com/yahoo/sketches/theta/UpdateSketch.html" title="class in com.yahoo.sketches.theta">UpdateSketch</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html#build--">build</a></span>()</code>
<div class="block">Returns an UpdateSketch with the current configuration of this Builder.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../com/yahoo/sketches/theta/UpdateSketch.html" title="class in com.yahoo.sketches.theta">UpdateSketch</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html#build-com.yahoo.memory.WritableMemory-">build</a></span>(com.yahoo.memory.WritableMemory&nbsp;dstMem)</code>
<div class="block">Returns an UpdateSketch with the current configuration of this Builder
with the specified backing destination Memory store.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../com/yahoo/sketches/theta/UpdateSketch.html" title="class in com.yahoo.sketches.theta">UpdateSketch</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html#buildLocal-com.yahoo.sketches.theta.UpdateSketch-">buildLocal</a></span>(<a href="../../../../com/yahoo/sketches/theta/UpdateSketch.html" title="class in com.yahoo.sketches.theta">UpdateSketch</a>&nbsp;shared)</code>
<div class="block">Returns a local concurrent UpdateSketch to be used as a per-thread local buffer along with the
given concurrent shared UpdateSketch and the current configuration of this Builder</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../com/yahoo/sketches/theta/UpdateSketch.html" title="class in com.yahoo.sketches.theta">UpdateSketch</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html#buildShared--">buildShared</a></span>()</code>
<div class="block">Returns an on-heap concurrent shared UpdateSketch with the current configuration of the
Builder.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../com/yahoo/sketches/theta/UpdateSketch.html" title="class in com.yahoo.sketches.theta">UpdateSketch</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html#buildShared-com.yahoo.memory.WritableMemory-">buildShared</a></span>(com.yahoo.memory.WritableMemory&nbsp;dstMem)</code>
<div class="block">Returns a direct (potentially off-heap) concurrent shared UpdateSketch with the current
configuration of the Builder and the given destination WritableMemory.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../com/yahoo/sketches/theta/UpdateSketch.html" title="class in com.yahoo.sketches.theta">UpdateSketch</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html#buildSharedFromSketch-com.yahoo.sketches.theta.UpdateSketch-com.yahoo.memory.WritableMemory-">buildSharedFromSketch</a></span>(<a href="../../../../com/yahoo/sketches/theta/UpdateSketch.html" title="class in com.yahoo.sketches.theta">UpdateSketch</a>&nbsp;sketch,
com.yahoo.memory.WritableMemory&nbsp;dstMem)</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html#getFamily--">getFamily</a></span>()</code>
<div class="block">Returns the Family</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html#getLgNominalEntries--">getLgNominalEntries</a></span>()</code>
<div class="block">Returns Log-base 2 Nominal Entries</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html#getLocalLgNominalEntries--">getLocalLgNominalEntries</a></span>()</code>
<div class="block">Returns Log-base 2 Nominal Entries for the concurrent local sketch</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html#getMaxConcurrencyError--">getMaxConcurrencyError</a></span>()</code>
<div class="block">Gets the Maximum Concurrency Error</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html#getMaxNumLocalThreads--">getMaxNumLocalThreads</a></span>()</code>
<div class="block">Gets the Maximum Number of Local Threads.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>com.yahoo.memory.MemoryRequestServer</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html#getMemoryRequestServer--">getMemoryRequestServer</a></span>()</code>
<div class="block">Returns the MemoryRequestServer</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html#getNumPoolThreads--">getNumPoolThreads</a></span>()</code>
<div class="block">Gets the number of background pool threads used for propagation in the concurrent sketches.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html#getP--">getP</a></span>()</code>
<div class="block">Returns the pre-sampling probability <i>p</i></div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html#getPropagateOrderedCompact--">getPropagateOrderedCompact</a></span>()</code>
<div class="block">Gets the Propagate Ordered Compact flag used with concurrent sketches.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="../../../../com/yahoo/sketches/ResizeFactor.html" title="enum in com.yahoo.sketches">ResizeFactor</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html#getResizeFactor--">getResizeFactor</a></span>()</code>
<div class="block">Returns the Resize Factor</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html#getSeed--">getSeed</a></span>()</code>
<div class="block">Returns the seed</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code><a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html" title="class in com.yahoo.sketches.theta">UpdateSketchBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html#setFamily-com.yahoo.sketches.Family-">setFamily</a></span>(<a href="../../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a>&nbsp;family)</code>
<div class="block">Set the Family.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code><a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html" title="class in com.yahoo.sketches.theta">UpdateSketchBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html#setLocalLogNominalEntries-int-">setLocalLogNominalEntries</a></span>(int&nbsp;lgNomEntries)</code>
<div class="block">Alternative method of setting the Nominal Entries for a local concurrent sketch from the
log_base2 value.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code><a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html" title="class in com.yahoo.sketches.theta">UpdateSketchBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html#setLocalNominalEntries-int-">setLocalNominalEntries</a></span>(int&nbsp;nomEntries)</code>
<div class="block">Sets the Nominal Entries for the concurrent local sketch.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code><a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html" title="class in com.yahoo.sketches.theta">UpdateSketchBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html#setLogNominalEntries-int-">setLogNominalEntries</a></span>(int&nbsp;lgNomEntries)</code>
<div class="block">Alternative method of setting the Nominal Entries for this sketch from the log_base2 value.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html#setMaxConcurrencyError-double-">setMaxConcurrencyError</a></span>(double&nbsp;maxConcurrencyError)</code>
<div class="block">Sets the Maximum Concurrency Error.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html#setMaxNumLocalThreads-int-">setMaxNumLocalThreads</a></span>(int&nbsp;maxNumLocalThreads)</code>
<div class="block">Sets the Maximum Number of Local Threads.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code><a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html" title="class in com.yahoo.sketches.theta">UpdateSketchBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html#setMemoryRequestServer-com.yahoo.memory.MemoryRequestServer-">setMemoryRequestServer</a></span>(com.yahoo.memory.MemoryRequestServer&nbsp;memReqSvr)</code>
<div class="block">Set the MemoryRequestServer</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code><a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html" title="class in com.yahoo.sketches.theta">UpdateSketchBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html#setNominalEntries-int-">setNominalEntries</a></span>(int&nbsp;nomEntries)</code>
<div class="block">Sets the Nominal Entries for this sketch.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html#setNumPoolThreads-int-">setNumPoolThreads</a></span>(int&nbsp;numPoolThreads)</code>
<div class="block">Sets the number of pool threads used for background propagation in the concurrent sketches.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code><a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html" title="class in com.yahoo.sketches.theta">UpdateSketchBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html#setP-float-">setP</a></span>(float&nbsp;p)</code>
<div class="block">Sets the upfront uniform sampling probability, <i>p</i></div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code><a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html" title="class in com.yahoo.sketches.theta">UpdateSketchBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html#setPropagateOrderedCompact-boolean-">setPropagateOrderedCompact</a></span>(boolean&nbsp;prop)</code>
<div class="block">Sets the Propagate Ordered Compact flag to the given value.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code><a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html" title="class in com.yahoo.sketches.theta">UpdateSketchBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html#setResizeFactor-com.yahoo.sketches.ResizeFactor-">setResizeFactor</a></span>(<a href="../../../../com/yahoo/sketches/ResizeFactor.html" title="enum in com.yahoo.sketches">ResizeFactor</a>&nbsp;rf)</code>
<div class="block">Sets the cache Resize Factor.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code><a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html" title="class in com.yahoo.sketches.theta">UpdateSketchBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html#setSeed-long-">setSeed</a></span>(long&nbsp;seed)</code>
<div class="block">Sets the long seed value that is required by the hashing function.</div>
</td>
</tr>
<tr id="i30" 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">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html#toString--">toString</a></span>()</code>&nbsp;</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#clone--" title="class or interface in java.lang">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">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">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">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#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="UpdateSketchBuilder--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>UpdateSketchBuilder</h4>
<pre>public&nbsp;UpdateSketchBuilder()</pre>
<div class="block">Constructor for building a new UpdateSketch. The default configuration is
<ul>
<li>Nominal Entries: <a href="../../../../com/yahoo/sketches/Util.html#DEFAULT_NOMINAL_ENTRIES">4096</a></li>
<li>Seed: <a href="../../../../com/yahoo/sketches/Util.html#DEFAULT_UPDATE_SEED">9001L</a></li>
<li>Input Sampling Probability: 1.0</li>
<li>Family: <a href="../../../../com/yahoo/sketches/Family.html#QUICKSELECT"><code>Family.QUICKSELECT</code></a></li>
<li>Resize Factor: The default for sketches on the Java heap is <a href="../../../../com/yahoo/sketches/ResizeFactor.html#X8"><code>ResizeFactor.X8</code></a>.
For direct sketches, which are targeted for native memory off the Java heap, this value will
be fixed at either <a href="../../../../com/yahoo/sketches/ResizeFactor.html#X1"><code>ResizeFactor.X1</code></a> or <a href="../../../../com/yahoo/sketches/ResizeFactor.html#X2"><code>ResizeFactor.X2</code></a>.</li>
<li>MemoryRequestServer (Direct only): <code>DefaultMemoryRequestServer</code>.</li>
</ul>
Parameters unique to the concurrent sketches only:
<ul>
<li>Number of local Nominal Entries: 4</li>
<li>Concurrent NumPoolThreads: 3</li>
<li>Concurrent PropagateOrderedCompact: true</li>
<li>Concurrent MaxConcurrencyError: 0</li>
</ul></div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setNominalEntries-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setNominalEntries</h4>
<pre>public&nbsp;<a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html" title="class in com.yahoo.sketches.theta">UpdateSketchBuilder</a>&nbsp;setNominalEntries(int&nbsp;nomEntries)</pre>
<div class="block">Sets the Nominal Entries for this sketch.
This value is also used for building a shared concurrent sketch.
The minimum value is 16 (2^4) and the maximum value is 67,108,864 (2^26).
Be aware that sketches as large as this maximum value may not have been
thoroughly tested or characterized for performance.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>nomEntries</code> - <a href="../../../../resources/dictionary.html#nomEntries">Nominal Entries</a>
This will become the ceiling power of 2 if the given value is not.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this UpdateSketchBuilder</dd>
</dl>
</li>
</ul>
<a name="setLogNominalEntries-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLogNominalEntries</h4>
<pre>public&nbsp;<a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html" title="class in com.yahoo.sketches.theta">UpdateSketchBuilder</a>&nbsp;setLogNominalEntries(int&nbsp;lgNomEntries)</pre>
<div class="block">Alternative method of setting the Nominal Entries for this sketch from the log_base2 value.
This value is also used for building a shared concurrent sketch.
The minimum value is 4 and the maximum value is 26.
Be aware that sketches as large as this maximum value may not have been
thoroughly tested or characterized for performance.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>lgNomEntries</code> - the Log Nominal Entries for the concurrent shared sketch</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this UpdateSketchBuilder</dd>
</dl>
</li>
</ul>
<a name="getLgNominalEntries--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLgNominalEntries</h4>
<pre>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 name="setLocalNominalEntries-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLocalNominalEntries</h4>
<pre>public&nbsp;<a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html" title="class in com.yahoo.sketches.theta">UpdateSketchBuilder</a>&nbsp;setLocalNominalEntries(int&nbsp;nomEntries)</pre>
<div class="block">Sets the Nominal Entries for the concurrent local sketch. The minimum value is 16 and the
maximum value is 67,108,864, which is 2^26.
Be aware that sketches as large as this maximum
value have not been thoroughly tested or characterized for performance.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>nomEntries</code> - <a href="../../../../resources/dictionary.html#nomEntries">Nominal Entries</a>
This will become the ceiling power of 2 if it is not.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this ConcurrentThetaBuilder</dd>
</dl>
</li>
</ul>
<a name="setLocalLogNominalEntries-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLocalLogNominalEntries</h4>
<pre>public&nbsp;<a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html" title="class in com.yahoo.sketches.theta">UpdateSketchBuilder</a>&nbsp;setLocalLogNominalEntries(int&nbsp;lgNomEntries)</pre>
<div class="block">Alternative method of setting the Nominal Entries for a local concurrent sketch from the
log_base2 value.
The minimum value is 4 and the maximum value is 26.
Be aware that sketches as large as this maximum
value have not been thoroughly tested or characterized for performance.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>lgNomEntries</code> - the Log Nominal Entries for a concurrent local sketch</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this ConcurrentThetaBuilder</dd>
</dl>
</li>
</ul>
<a name="getLocalLgNominalEntries--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocalLgNominalEntries</h4>
<pre>public&nbsp;int&nbsp;getLocalLgNominalEntries()</pre>
<div class="block">Returns Log-base 2 Nominal Entries for the concurrent local sketch</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Log-base 2 Nominal Entries for the concurrent local sketch</dd>
</dl>
</li>
</ul>
<a name="setSeed-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSeed</h4>
<pre>public&nbsp;<a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html" title="class in com.yahoo.sketches.theta">UpdateSketchBuilder</a>&nbsp;setSeed(long&nbsp;seed)</pre>
<div class="block">Sets the long seed value that is required 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 UpdateSketchBuilder</dd>
</dl>
</li>
</ul>
<a name="getSeed--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSeed</h4>
<pre>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 name="setP-float-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setP</h4>
<pre>public&nbsp;<a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html" title="class in com.yahoo.sketches.theta">UpdateSketchBuilder</a>&nbsp;setP(float&nbsp;p)</pre>
<div class="block">Sets the upfront uniform sampling probability, <i>p</i></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 UpdateSketchBuilder</dd>
</dl>
</li>
</ul>
<a name="getP--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getP</h4>
<pre>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 name="setResizeFactor-com.yahoo.sketches.ResizeFactor-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setResizeFactor</h4>
<pre>public&nbsp;<a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html" title="class in com.yahoo.sketches.theta">UpdateSketchBuilder</a>&nbsp;setResizeFactor(<a href="../../../../com/yahoo/sketches/ResizeFactor.html" title="enum in com.yahoo.sketches">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 UpdateSketchBuilder</dd>
</dl>
</li>
</ul>
<a name="getResizeFactor--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResizeFactor</h4>
<pre>public&nbsp;<a href="../../../../com/yahoo/sketches/ResizeFactor.html" title="enum in com.yahoo.sketches">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 name="setFamily-com.yahoo.sketches.Family-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFamily</h4>
<pre>public&nbsp;<a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html" title="class in com.yahoo.sketches.theta">UpdateSketchBuilder</a>&nbsp;setFamily(<a href="../../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a>&nbsp;family)</pre>
<div class="block">Set the Family.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>family</code> - the family for this builder</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this UpdateSketchBuilder</dd>
</dl>
</li>
</ul>
<a name="getFamily--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFamily</h4>
<pre>public&nbsp;<a href="../../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a>&nbsp;getFamily()</pre>
<div class="block">Returns the Family</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the Family</dd>
</dl>
</li>
</ul>
<a name="setMemoryRequestServer-com.yahoo.memory.MemoryRequestServer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMemoryRequestServer</h4>
<pre>public&nbsp;<a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html" title="class in com.yahoo.sketches.theta">UpdateSketchBuilder</a>&nbsp;setMemoryRequestServer(com.yahoo.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 UpdateSketchBuilder</dd>
</dl>
</li>
</ul>
<a name="getMemoryRequestServer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMemoryRequestServer</h4>
<pre>public&nbsp;com.yahoo.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 name="setNumPoolThreads-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setNumPoolThreads</h4>
<pre>public&nbsp;void&nbsp;setNumPoolThreads(int&nbsp;numPoolThreads)</pre>
<div class="block">Sets the number of pool threads used for background propagation in the concurrent sketches.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>numPoolThreads</code> - the given number of pool threads</dd>
</dl>
</li>
</ul>
<a name="getNumPoolThreads--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumPoolThreads</h4>
<pre>public&nbsp;int&nbsp;getNumPoolThreads()</pre>
<div class="block">Gets the number of background pool threads used for propagation in the concurrent sketches.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of background pool threads</dd>
</dl>
</li>
</ul>
<a name="setPropagateOrderedCompact-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPropagateOrderedCompact</h4>
<pre>public&nbsp;<a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html" title="class in com.yahoo.sketches.theta">UpdateSketchBuilder</a>&nbsp;setPropagateOrderedCompact(boolean&nbsp;prop)</pre>
<div class="block">Sets the Propagate Ordered Compact flag to the given value. Used with concurrent sketches.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>prop</code> - the given value</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this UpdateSketchBuilder</dd>
</dl>
</li>
</ul>
<a name="getPropagateOrderedCompact--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPropagateOrderedCompact</h4>
<pre>public&nbsp;boolean&nbsp;getPropagateOrderedCompact()</pre>
<div class="block">Gets the Propagate Ordered Compact flag used with concurrent sketches.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the Propagate Ordered Compact flag</dd>
</dl>
</li>
</ul>
<a name="setMaxConcurrencyError-double-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxConcurrencyError</h4>
<pre>public&nbsp;void&nbsp;setMaxConcurrencyError(double&nbsp;maxConcurrencyError)</pre>
<div class="block">Sets the Maximum Concurrency Error.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>maxConcurrencyError</code> - the given Maximum Concurrency Error.</dd>
</dl>
</li>
</ul>
<a name="getMaxConcurrencyError--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxConcurrencyError</h4>
<pre>public&nbsp;double&nbsp;getMaxConcurrencyError()</pre>
<div class="block">Gets the Maximum Concurrency Error</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the Maximum Concurrency Error</dd>
</dl>
</li>
</ul>
<a name="setMaxNumLocalThreads-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMaxNumLocalThreads</h4>
<pre>public&nbsp;void&nbsp;setMaxNumLocalThreads(int&nbsp;maxNumLocalThreads)</pre>
<div class="block">Sets the Maximum Number of Local Threads.
This is used to set the size of the local concurrent buffers.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>maxNumLocalThreads</code> - the given Maximum Number of Local Threads</dd>
</dl>
</li>
</ul>
<a name="getMaxNumLocalThreads--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxNumLocalThreads</h4>
<pre>public&nbsp;int&nbsp;getMaxNumLocalThreads()</pre>
<div class="block">Gets the Maximum Number of Local Threads.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the Maximum Number of Local Threads.</dd>
</dl>
</li>
</ul>
<a name="build--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>build</h4>
<pre>public&nbsp;<a href="../../../../com/yahoo/sketches/theta/UpdateSketch.html" title="class in com.yahoo.sketches.theta">UpdateSketch</a>&nbsp;build()</pre>
<div class="block">Returns an UpdateSketch with the current configuration of this Builder.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an UpdateSketch</dd>
</dl>
</li>
</ul>
<a name="build-com.yahoo.memory.WritableMemory-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>build</h4>
<pre>public&nbsp;<a href="../../../../com/yahoo/sketches/theta/UpdateSketch.html" title="class in com.yahoo.sketches.theta">UpdateSketch</a>&nbsp;build(com.yahoo.memory.WritableMemory&nbsp;dstMem)</pre>
<div class="block">Returns an UpdateSketch with the current configuration of this Builder
with the specified backing destination Memory store.
Note: this cannot be used with the Alpha Family of sketches.</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 UpdateSketch</dd>
</dl>
</li>
</ul>
<a name="buildShared--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildShared</h4>
<pre>public&nbsp;<a href="../../../../com/yahoo/sketches/theta/UpdateSketch.html" title="class in com.yahoo.sketches.theta">UpdateSketch</a>&nbsp;buildShared()</pre>
<div class="block">Returns an on-heap concurrent shared UpdateSketch with the current configuration of the
Builder.
<p>The parameters unique to the shared concurrent sketch are:
<ul>
<li>Number of Pool Threads (default is 3)</li>
<li>Maximum Concurrency Error</li>
</ul>
<p>Key parameters that are in common with other <i>Theta</i> sketches:
<ul>
<li>Nominal Entries or Log Nominal Entries (for the shared concurrent sketch)</li>
</ul></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an on-heap concurrent UpdateSketch with the current configuration of the Builder.</dd>
</dl>
</li>
</ul>
<a name="buildShared-com.yahoo.memory.WritableMemory-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildShared</h4>
<pre>public&nbsp;<a href="../../../../com/yahoo/sketches/theta/UpdateSketch.html" title="class in com.yahoo.sketches.theta">UpdateSketch</a>&nbsp;buildShared(com.yahoo.memory.WritableMemory&nbsp;dstMem)</pre>
<div class="block">Returns a direct (potentially off-heap) concurrent shared UpdateSketch with the current
configuration of the Builder and the given destination WritableMemory.
<p>The parameters unique to the shared concurrent sketch are:
<ul>
<li>Number of Pool Threads (default is 3)</li>
<li>Maximum Concurrency Error</li>
</ul>
<p>Key parameters that are in common with other <i>Theta</i> sketches:
<ul>
<li>Nominal Entries or Log Nominal Entries (for the shared concurrent sketch)</li>
<li>Destination Writable Memory (if not null, returned sketch is Direct. Default is null.)</li>
</ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>dstMem</code> - the given WritableMemory for Direct, otherwise <i>null</i>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a concurrent UpdateSketch with the current configuration of the Builder
and the given destination WritableMemory.</dd>
</dl>
</li>
</ul>
<a name="buildSharedFromSketch-com.yahoo.sketches.theta.UpdateSketch-com.yahoo.memory.WritableMemory-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildSharedFromSketch</h4>
<pre>public&nbsp;<a href="../../../../com/yahoo/sketches/theta/UpdateSketch.html" title="class in com.yahoo.sketches.theta">UpdateSketch</a>&nbsp;buildSharedFromSketch(<a href="../../../../com/yahoo/sketches/theta/UpdateSketch.html" title="class in com.yahoo.sketches.theta">UpdateSketch</a>&nbsp;sketch,
com.yahoo.memory.WritableMemory&nbsp;dstMem)</pre>
</li>
</ul>
<a name="buildLocal-com.yahoo.sketches.theta.UpdateSketch-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildLocal</h4>
<pre>public&nbsp;<a href="../../../../com/yahoo/sketches/theta/UpdateSketch.html" title="class in com.yahoo.sketches.theta">UpdateSketch</a>&nbsp;buildLocal(<a href="../../../../com/yahoo/sketches/theta/UpdateSketch.html" title="class in com.yahoo.sketches.theta">UpdateSketch</a>&nbsp;shared)</pre>
<div class="block">Returns a local concurrent UpdateSketch to be used as a per-thread local buffer along with the
given concurrent shared UpdateSketch and the current configuration of this Builder
<p>The parameters unique to the local concurrent sketch are:
<ul>
<li>Local Nominal Entries or Local Log Nominal Entries</li>
<li>Propagate Ordered Compact flag</li>
</ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>shared</code> - the concurrent shared sketch to be accessed via the concurrent local sketch.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an UpdateSketch to be used as a per-thread local buffer.</dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>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">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">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">Object</a></code></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/UpdateSketchBuilder.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="../../../../com/yahoo/sketches/theta/UpdateSketch.html" title="class in com.yahoo.sketches.theta"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/yahoo/sketches/theta/UpdateSketchBuilder.html" target="_top">Frames</a></li>
<li><a href="UpdateSketchBuilder.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; 2015&#x2013;2019. All rights reserved.</small></p>
</body>
</html>