Google Git
Sign in
apache / datasketches-website / 4e83e51533ab0e89e82946dca92a6cde8a66ded4 / . / api / java / snapshot / apidocs / org / apache / datasketches / tuple / UpdatableSketch.html
blob: 7587f1b0a1fdc42b8fedc06a39dfc54b2e5805ba [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_302) on Wed Jan 26 15:15:51 PST 2022 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>UpdatableSketch (datasketches-java 3.1.0 API)</title>
<meta name="date" content="2022-01-26">
<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="UpdatableSketch (datasketches-java 3.1.0 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":42,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/UpdatableSketch.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/datasketches/tuple/Union.html" title="class in org.apache.datasketches.tuple"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/datasketches/tuple/UpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/datasketches/tuple/UpdatableSketch.html" target="_top">Frames</a></li>
<li><a href="UpdatableSketch.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><a href="#fields.inherited.from.class.org.apache.datasketches.tuple.Sketch">Field</a>&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.datasketches.tuple</div>
<h2 title="Class UpdatableSketch" class="title">Class UpdatableSketch&lt;U,S extends <a href="../../../../org/apache/datasketches/tuple/UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a>&lt;U&gt;&gt;</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><a href="../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">org.apache.datasketches.tuple.Sketch</a>&lt;S&gt;</li>
<li>
<ul class="inheritance">
<li>org.apache.datasketches.tuple.UpdatableSketch&lt;U,S&gt;</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>U</code> - Type of the value, which is passed to update method of a Summary</dd>
<dd><code>S</code> - Type of the UpdatableSummary&lt;U&gt;</dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../org/apache/datasketches/tuple/strings/ArrayOfStringsSketch.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSketch</a>, <a href="../../../../org/apache/datasketches/tuple/adouble/DoubleSketch.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSketch</a>, <a href="../../../../org/apache/datasketches/tuple/aninteger/IntegerSketch.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSketch</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">UpdatableSketch&lt;U,S extends <a href="../../../../org/apache/datasketches/tuple/UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a>&lt;U&gt;&gt;</span>
extends <a href="../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a>&lt;S&gt;</pre>
<div class="block">An extension of QuickSelectSketch&lt;S&gt;, which can be updated with many types of keys.
Summary objects are created using a user-defined SummaryFactory class,
which should allow very flexible parameterization if needed.
Keys are presented to a sketch along with values of a user-defined
update type U. When an entry is inserted into a sketch or a duplicate key is
presented to a sketch then summary.update(U value) method will be called. So
any kind of user-defined accumulation is possible. Summaries also must know
how to copy themselves. Also union and intersection of summaries can be
implemented in a sub-class of SummarySetOperations, which will be used in
case Union or Intersection of two instances of Tuple Sketch is needed</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.datasketches.tuple.Sketch">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.datasketches.tuple.<a href="../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a></h3>
<code><a href="../../../../org/apache/datasketches/tuple/Sketch.html#PREAMBLE_LONGS">PREAMBLE_LONGS</a>, <a href="../../../../org/apache/datasketches/tuple/Sketch.html#summaryFactory_">summaryFactory_</a></code></li>
</ul>
</li>
</ul>
<!-- ======== 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/datasketches/tuple/UpdatableSketch.html#UpdatableSketch-int-int-float-org.apache.datasketches.tuple.SummaryFactory-">UpdatableSketch</a></span>(int&nbsp;nomEntries,
int&nbsp;lgResizeFactor,
float&nbsp;samplingProbability,
<a href="../../../../org/apache/datasketches/tuple/SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a>&lt;<a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html" title="type parameter in UpdatableSketch">S</a>&gt;&nbsp;summaryFactory)</code>
<div class="block">This is to create a new instance of an UpdatableQuickSelectSketch.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html#UpdatableSketch-org.apache.datasketches.memory.Memory-org.apache.datasketches.tuple.SummaryDeserializer-org.apache.datasketches.tuple.SummaryFactory-">UpdatableSketch</a></span>(org.apache.datasketches.memory.Memory&nbsp;srcMem,
<a href="../../../../org/apache/datasketches/tuple/SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a>&lt;<a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html" title="type parameter in UpdatableSketch">S</a>&gt;&nbsp;deserializer,
<a href="../../../../org/apache/datasketches/tuple/SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a>&lt;<a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html" title="type parameter in UpdatableSketch">S</a>&gt;&nbsp;summaryFactory)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">As of 3.0.0, heapifying an UpdatableSketch is deprecated.
This capability will be removed in a future release.
Heapifying a CompactSketch is not deprecated.</span></div>
</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html#UpdatableSketch-org.apache.datasketches.tuple.UpdatableSketch-">UpdatableSketch</a></span>(<a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a>&lt;<a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html" title="type parameter in UpdatableSketch">U</a>,<a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html" title="type parameter in UpdatableSketch">S</a>&gt;&nbsp;sketch)</code>
<div class="block">Copy Constructor</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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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/datasketches/tuple/CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a>&lt;S&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html#compact--">compact</a></span>()</code>
<div class="block">Converts the current state of the sketch into a compact sketch</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a>&lt;<a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html" title="type parameter in UpdatableSketch">U</a>,<a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html" title="type parameter in UpdatableSketch">S</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html#copy--">copy</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html#getCountLessThanThetaLong-long-">getCountLessThanThetaLong</a></span>(long&nbsp;thetaLong)</code>
<div class="block">Gets the number of hash values less than the given theta expressed as a long.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html#getCurrentCapacity--">getCurrentCapacity</a></span>()</code>
<div class="block">Get current capacity</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html#getLgK--">getLgK</a></span>()</code>
<div class="block">Get log_base2 of Nominal Entries</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html#getNominalEntries--">getNominalEntries</a></span>()</code>
<div class="block">Get configured nominal number of entries</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/datasketches/ResizeFactor.html" title="enum in org.apache.datasketches">ResizeFactor</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html#getResizeFactor--">getResizeFactor</a></span>()</code>
<div class="block">Get configured resize factor</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html#getRetainedEntries--">getRetainedEntries</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html#getSamplingProbability--">getSamplingProbability</a></span>()</code>
<div class="block">Get configured sampling probability</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html#insertSummary-int-S-">insertSummary</a></span>(int&nbsp;index,
S&nbsp;summary)</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/datasketches/tuple/SketchIterator.html" title="class in org.apache.datasketches.tuple">SketchIterator</a>&lt;S&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html#iterator--">iterator</a></span>()</code>
<div class="block">Returns a SketchIterator</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html#reset--">reset</a></span>()</code>
<div class="block">Resets this sketch an empty state.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html#toByteArray--">toByteArray</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">As of 3.0.0, serializing an UpdatableSketch is deprecated.
This capability will be removed in a future release.
Serializing a CompactSketch is not deprecated.</span></div>
</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html#trim--">trim</a></span>()</code>
<div class="block">Rebuilds reducing the actual number of entries to the nominal number of entries if needed</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html#update-byte:A-U-">update</a></span>(byte[]&nbsp;key,
<a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html" title="type parameter in UpdatableSketch">U</a>&nbsp;value)</code>
<div class="block">Updates this sketch with a byte[] key and U value.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html#update-double-U-">update</a></span>(double&nbsp;key,
<a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html" title="type parameter in UpdatableSketch">U</a>&nbsp;value)</code>
<div class="block">Updates this sketch with a double key and U value.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html#update-int:A-U-">update</a></span>(int[]&nbsp;key,
<a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html" title="type parameter in UpdatableSketch">U</a>&nbsp;value)</code>
<div class="block">Updates this sketch with a int[] key and U value.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html#update-long:A-U-">update</a></span>(long[]&nbsp;key,
<a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html" title="type parameter in UpdatableSketch">U</a>&nbsp;value)</code>
<div class="block">Updates this sketch with a long[] key and U value.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html#update-long-U-">update</a></span>(long&nbsp;key,
<a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html" title="type parameter in UpdatableSketch">U</a>&nbsp;value)</code>
<div class="block">Updates this sketch with a long key and U value.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html#update-java.lang.String-U-">update</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;key,
<a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html" title="type parameter in UpdatableSketch">U</a>&nbsp;value)</code>
<div class="block">Updates this sketch with a String key and U value.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.datasketches.tuple.Sketch">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.datasketches.tuple.<a href="../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a></h3>
<code><a href="../../../../org/apache/datasketches/tuple/Sketch.html#getEstimate--">getEstimate</a>, <a href="../../../../org/apache/datasketches/tuple/Sketch.html#getEstimate-int-">getEstimate</a>, <a href="../../../../org/apache/datasketches/tuple/Sketch.html#getLowerBound-int-">getLowerBound</a>, <a href="../../../../org/apache/datasketches/tuple/Sketch.html#getLowerBound-int-int-">getLowerBound</a>, <a href="../../../../org/apache/datasketches/tuple/Sketch.html#getSummaryFactory--">getSummaryFactory</a>, <a href="../../../../org/apache/datasketches/tuple/Sketch.html#getTheta--">getTheta</a>, <a href="../../../../org/apache/datasketches/tuple/Sketch.html#getThetaLong--">getThetaLong</a>, <a href="../../../../org/apache/datasketches/tuple/Sketch.html#getUpperBound-int-">getUpperBound</a>, <a href="../../../../org/apache/datasketches/tuple/Sketch.html#getUpperBound-int-int-">getUpperBound</a>, <a href="../../../../org/apache/datasketches/tuple/Sketch.html#isEmpty--">isEmpty</a>, <a href="../../../../org/apache/datasketches/tuple/Sketch.html#isEstimationMode--">isEstimationMode</a>, <a href="../../../../org/apache/datasketches/tuple/Sketch.html#toString--">toString</a></code></li>
</ul>
<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="UpdatableSketch-int-int-float-org.apache.datasketches.tuple.SummaryFactory-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>UpdatableSketch</h4>
<pre>public&nbsp;UpdatableSketch(int&nbsp;nomEntries,
int&nbsp;lgResizeFactor,
float&nbsp;samplingProbability,
<a href="../../../../org/apache/datasketches/tuple/SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a>&lt;<a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html" title="type parameter in UpdatableSketch">S</a>&gt;&nbsp;summaryFactory)</pre>
<div class="block">This is to create a new instance of an UpdatableQuickSelectSketch.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>nomEntries</code> - Nominal number of entries. Forced to the nearest power of 2 greater than
or equal to the given value.</dd>
<dd><code>lgResizeFactor</code> - log2(resizeFactor) - value from 0 to 3:
<pre>
0 - no resizing (max size allocated),
1 - double internal hash table each time it reaches a threshold
2 - grow four times
3 - grow eight times (default)
</pre></dd>
<dd><code>samplingProbability</code> - <a href="../../../../resources/dictionary.html#p">See Sampling Probability</a></dd>
<dd><code>summaryFactory</code> - An instance of a SummaryFactory.</dd>
</dl>
</li>
</ul>
<a name="UpdatableSketch-org.apache.datasketches.memory.Memory-org.apache.datasketches.tuple.SummaryDeserializer-org.apache.datasketches.tuple.SummaryFactory-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>UpdatableSketch</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;UpdatableSketch(org.apache.datasketches.memory.Memory&nbsp;srcMem,
<a href="../../../../org/apache/datasketches/tuple/SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a>&lt;<a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html" title="type parameter in UpdatableSketch">S</a>&gt;&nbsp;deserializer,
<a href="../../../../org/apache/datasketches/tuple/SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a>&lt;<a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html" title="type parameter in UpdatableSketch">S</a>&gt;&nbsp;summaryFactory)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">As of 3.0.0, heapifying an UpdatableSketch is deprecated.
This capability will be removed in a future release.
Heapifying a CompactSketch is not deprecated.</span></div>
<div class="block">This is to create an instance of a sketch given a serialized form</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>srcMem</code> - Memory object with data of a serialized UpdatableSketch</dd>
<dd><code>deserializer</code> - instance of SummaryDeserializer</dd>
<dd><code>summaryFactory</code> - instance of SummaryFactory</dd>
</dl>
</li>
</ul>
<a name="UpdatableSketch-org.apache.datasketches.tuple.UpdatableSketch-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>UpdatableSketch</h4>
<pre>public&nbsp;UpdatableSketch(<a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a>&lt;<a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html" title="type parameter in UpdatableSketch">U</a>,<a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html" title="type parameter in UpdatableSketch">S</a>&gt;&nbsp;sketch)</pre>
<div class="block">Copy Constructor</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>sketch</code> - the sketch to copy</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="copy--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>copy</h4>
<pre>public&nbsp;<a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a>&lt;<a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html" title="type parameter in UpdatableSketch">U</a>,<a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html" title="type parameter in UpdatableSketch">S</a>&gt;&nbsp;copy()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a deep copy of this sketch</dd>
</dl>
</li>
</ul>
<a name="update-long-java.lang.Object-">
<!-- -->
</a><a name="update-long-U-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>update</h4>
<pre>public&nbsp;void&nbsp;update(long&nbsp;key,
<a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html" title="type parameter in UpdatableSketch">U</a>&nbsp;value)</pre>
<div class="block">Updates this sketch with a long key and U value.
The value is passed to update() method of the Summary object associated with the key</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - The given long key</dd>
<dd><code>value</code> - The given U value</dd>
</dl>
</li>
</ul>
<a name="update-double-java.lang.Object-">
<!-- -->
</a><a name="update-double-U-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>update</h4>
<pre>public&nbsp;void&nbsp;update(double&nbsp;key,
<a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html" title="type parameter in UpdatableSketch">U</a>&nbsp;value)</pre>
<div class="block">Updates this sketch with a double key and U value.
The value is passed to update() method of the Summary object associated with the key</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - The given double key</dd>
<dd><code>value</code> - The given U value</dd>
</dl>
</li>
</ul>
<a name="update-java.lang.String-java.lang.Object-">
<!-- -->
</a><a name="update-java.lang.String-U-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>update</h4>
<pre>public&nbsp;void&nbsp;update(<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;key,
<a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html" title="type parameter in UpdatableSketch">U</a>&nbsp;value)</pre>
<div class="block">Updates this sketch with a String key and U value.
The value is passed to update() method of the Summary object associated with the key</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - The given String key</dd>
<dd><code>value</code> - The given U value</dd>
</dl>
</li>
</ul>
<a name="update-byte:A-java.lang.Object-">
<!-- -->
</a><a name="update-byte:A-U-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>update</h4>
<pre>public&nbsp;void&nbsp;update(byte[]&nbsp;key,
<a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html" title="type parameter in UpdatableSketch">U</a>&nbsp;value)</pre>
<div class="block">Updates this sketch with a byte[] key and U value.
The value is passed to update() method of the Summary object associated with the key</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - The given byte[] key</dd>
<dd><code>value</code> - The given U value</dd>
</dl>
</li>
</ul>
<a name="update-int:A-java.lang.Object-">
<!-- -->
</a><a name="update-int:A-U-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>update</h4>
<pre>public&nbsp;void&nbsp;update(int[]&nbsp;key,
<a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html" title="type parameter in UpdatableSketch">U</a>&nbsp;value)</pre>
<div class="block">Updates this sketch with a int[] key and U value.
The value is passed to update() method of the Summary object associated with the key</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - The given int[] key</dd>
<dd><code>value</code> - The given U value</dd>
</dl>
</li>
</ul>
<a name="update-long:A-java.lang.Object-">
<!-- -->
</a><a name="update-long:A-U-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>update</h4>
<pre>public&nbsp;void&nbsp;update(long[]&nbsp;key,
<a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html" title="type parameter in UpdatableSketch">U</a>&nbsp;value)</pre>
<div class="block">Updates this sketch with a long[] key and U value.
The value is passed to update() method of the Summary object associated with the key</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - The given long[] key</dd>
<dd><code>value</code> - The given U value</dd>
</dl>
</li>
</ul>
<a name="getRetainedEntries--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRetainedEntries</h4>
<pre>public&nbsp;int&nbsp;getRetainedEntries()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/datasketches/tuple/Sketch.html#getRetainedEntries--">getRetainedEntries</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a>&lt;S extends <a href="../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>number of retained entries</dd>
</dl>
</li>
</ul>
<a name="getCountLessThanThetaLong-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCountLessThanThetaLong</h4>
<pre>public&nbsp;int&nbsp;getCountLessThanThetaLong(long&nbsp;thetaLong)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../org/apache/datasketches/tuple/Sketch.html#getCountLessThanThetaLong-long-">Sketch</a></code></span></div>
<div class="block">Gets the number of hash values less than the given theta expressed as a long.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/datasketches/tuple/Sketch.html#getCountLessThanThetaLong-long-">getCountLessThanThetaLong</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a>&lt;S extends <a href="../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>&gt;</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>thetaLong</code> - the given theta as a long between zero and <i>Long.MAX_VALUE</i>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of hash values less than the given thetaLong.</dd>
</dl>
</li>
</ul>
<a name="getNominalEntries--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNominalEntries</h4>
<pre>public&nbsp;int&nbsp;getNominalEntries()</pre>
<div class="block">Get configured nominal number of entries</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>nominal number of entries</dd>
</dl>
</li>
</ul>
<a name="getLgK--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLgK</h4>
<pre>public&nbsp;int&nbsp;getLgK()</pre>
<div class="block">Get log_base2 of Nominal Entries</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>log_base2 of Nominal Entries</dd>
</dl>
</li>
</ul>
<a name="getSamplingProbability--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSamplingProbability</h4>
<pre>public&nbsp;float&nbsp;getSamplingProbability()</pre>
<div class="block">Get configured sampling probability</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>sampling probability</dd>
</dl>
</li>
</ul>
<a name="getCurrentCapacity--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCurrentCapacity</h4>
<pre>public&nbsp;int&nbsp;getCurrentCapacity()</pre>
<div class="block">Get current capacity</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>current capacity</dd>
</dl>
</li>
</ul>
<a name="getResizeFactor--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResizeFactor</h4>
<pre>public&nbsp;<a href="../../../../org/apache/datasketches/ResizeFactor.html" title="enum in org.apache.datasketches">ResizeFactor</a>&nbsp;getResizeFactor()</pre>
<div class="block">Get configured resize factor</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>resize factor</dd>
</dl>
</li>
</ul>
<a name="trim--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>trim</h4>
<pre>public&nbsp;void&nbsp;trim()</pre>
<div class="block">Rebuilds reducing the actual number of entries to the nominal number of entries if needed</div>
</li>
</ul>
<a name="reset--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reset</h4>
<pre>public&nbsp;void&nbsp;reset()</pre>
<div class="block">Resets this sketch an empty state.</div>
</li>
</ul>
<a name="compact--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compact</h4>
<pre>public&nbsp;<a href="../../../../org/apache/datasketches/tuple/CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a>&lt;S&gt;&nbsp;compact()</pre>
<div class="block">Converts the current state of the sketch into a compact sketch</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/datasketches/tuple/Sketch.html#compact--">compact</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a>&lt;S extends <a href="../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>compact sketch</dd>
</dl>
</li>
</ul>
<a name="toByteArray--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toByteArray</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
public&nbsp;byte[]&nbsp;toByteArray()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">As of 3.0.0, serializing an UpdatableSketch is deprecated.
This capability will be removed in a future release.
Serializing a CompactSketch is not deprecated.</span></div>
<div class="block">This serializes an UpdatableSketch (QuickSelectSketch).</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/datasketches/tuple/Sketch.html#toByteArray--">toByteArray</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a>&lt;S extends <a href="../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>serialized representation of an UpdatableSketch (QuickSelectSketch).</dd>
</dl>
</li>
</ul>
<a name="insertSummary-int-org.apache.datasketches.tuple.Summary-">
<!-- -->
</a><a name="insertSummary-int-S-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>insertSummary</h4>
<pre>protected&nbsp;void&nbsp;insertSummary(int&nbsp;index,
S&nbsp;summary)</pre>
</li>
</ul>
<a name="iterator--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>iterator</h4>
<pre>public&nbsp;<a href="../../../../org/apache/datasketches/tuple/SketchIterator.html" title="class in org.apache.datasketches.tuple">SketchIterator</a>&lt;S&gt;&nbsp;iterator()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../org/apache/datasketches/tuple/Sketch.html#iterator--">Sketch</a></code></span></div>
<div class="block">Returns a SketchIterator</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/datasketches/tuple/Sketch.html#iterator--">iterator</a></code>&nbsp;in class&nbsp;<code><a href="../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a>&lt;S extends <a href="../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a SketchIterator</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/UpdatableSketch.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/datasketches/tuple/Union.html" title="class in org.apache.datasketches.tuple"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/datasketches/tuple/UpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/datasketches/tuple/UpdatableSketch.html" target="_top">Frames</a></li>
<li><a href="UpdatableSketch.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><a href="#fields.inherited.from.class.org.apache.datasketches.tuple.Sketch">Field</a>&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;2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>