Deploying to gh-pages from @ f8772e4 🚀

docs/master/deprecated-list.html

@@ -97,10 +97,39 @@
 <h1 title="Deprecated API" class="title">Deprecated API</h1>
 <h2 title="Contents">Contents</h2>
 <ul>
+<li><a href="#method">Methods</a></li>
 <li><a href="#constructor">Constructors</a></li>
 </ul>
 </div>
-<div class="contentContainer"><a id="constructor">
+<div class="contentContainer"><a id="method">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<table class="deprecatedSummary">
+<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
+<tr>
+<th class="colFirst" scope="col">Method</th>
+<th class="colLast" scope="col">Description</th>
+</tr>
+<tbody>
+<tr class="altColor">
+<th class="colDeprecatedItemName" scope="row"><a href="org/apache/datasketches/theta/Sketch.html#getMaxCompactSketchBytes(int)">org.apache.datasketches.theta.Sketch.getMaxCompactSketchBytes&#8203;(int)</a></th>
+<td class="colLast">
+<div class="deprecationComment">as a public method. Use <a href="org/apache/datasketches/theta/Sketch.html#getCompactSketchMaxBytes(int)"><code>instead</code></a></div>
+</td>
+</tr>
+<tr class="rowColor">
+<th class="colDeprecatedItemName" scope="row"><a href="org/apache/datasketches/theta/Sketches.html#getMaxCompactSketchBytes(int)">org.apache.datasketches.theta.Sketches.getMaxCompactSketchBytes&#8203;(int)</a></th>
+<td class="colLast">
+<div class="deprecationComment">as a public method. Use <a href="org/apache/datasketches/theta/Sketches.html#getCompactSketchMaxBytes(int)"><code>instead</code></a></div>
+</td>
+</tr>
+</tbody>
+</table>
+</li>
+</ul>
+<a id="constructor">
 <!--   -->
 </a>
 <ul class="blockList">

docs/master/index-all.html

@@ -1796,6 +1796,16 @@ <h2 class="title">G</h2>
 <dd>&nbsp;</dd>
 <dt><span class="memberNameLink"><a href="org/apache/datasketches/hll/Union.html#getCompactSerializationBytes()">getCompactSerializationBytes()</a></span> - Method in class org.apache.datasketches.hll.<a href="org/apache/datasketches/hll/Union.html" title="class in org.apache.datasketches.hll">Union</a></dt>
 <dd>&nbsp;</dd>
+<dt><span class="memberNameLink"><a href="org/apache/datasketches/theta/Sketch.html#getCompactSketchMaxBytes(int)">getCompactSketchMaxBytes(int)</a></span> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></dt>
+<dd>
+<div class="block">Returns the maximum number of storage bytes required for a CompactSketch given the configured
+ log_base2 of the number of nominal entries, which is a power of 2.</div>
+</dd>
+<dt><span class="memberNameLink"><a href="org/apache/datasketches/theta/Sketches.html#getCompactSketchMaxBytes(int)">getCompactSketchMaxBytes(int)</a></span> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketches.html" title="class in org.apache.datasketches.theta">Sketches</a></dt>
+<dd>
+<div class="block">Returns the maximum number of storage bytes required for a CompactSketch given the configured
+ number of nominal entries (power of 2).</div>
+</dd>
 <dt><span class="memberNameLink"><a href="org/apache/datasketches/kll/KllItemsSketch.html#getComparator()">getComparator()</a></span> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllItemsSketch.html" title="class in org.apache.datasketches.kll">KllItemsSketch</a></dt>
 <dd>&nbsp;</dd>
 <dt><span class="memberNameLink"><a href="org/apache/datasketches/quantiles/ItemsSketch.html#getComparator()">getComparator()</a></span> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a></dt>
@@ -2342,12 +2352,15 @@ <h2 class="title">G</h2>
 <dd>&nbsp;</dd>
 <dt><span class="memberNameLink"><a href="org/apache/datasketches/theta/Sketch.html#getMaxCompactSketchBytes(int)">getMaxCompactSketchBytes(int)</a></span> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></dt>
 <dd>
-<div class="block">Returns the maximum number of storage bytes required for a CompactSketch with the given
- number of actual entries.</div>
+<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
+<div class="deprecationComment">as a public method. Use <a href="org/apache/datasketches/theta/Sketch.html#getCompactSketchMaxBytes(int)"><code>instead</code></a></div>
+</div>
 </dd>
 <dt><span class="memberNameLink"><a href="org/apache/datasketches/theta/Sketches.html#getMaxCompactSketchBytes(int)">getMaxCompactSketchBytes(int)</a></span> - Static method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/Sketches.html" title="class in org.apache.datasketches.theta">Sketches</a></dt>
 <dd>
-<div class="block">Ref: <a href="org/apache/datasketches/theta/Sketch.html#getMaxCompactSketchBytes(int)"><code>Sketch.getMaxCompactSketchBytes(int)</code></a></div>
+<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
+<div class="deprecationComment">as a public method. Use <a href="org/apache/datasketches/theta/Sketches.html#getCompactSketchMaxBytes(int)"><code>instead</code></a></div>
+</div>
 </dd>
 <dt><span class="memberNameLink"><a href="org/apache/datasketches/theta/UpdateSketchBuilder.html#getMaxConcurrencyError()">getMaxConcurrencyError()</a></span> - Method in class org.apache.datasketches.theta.<a href="org/apache/datasketches/theta/UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></dt>
 <dd>

docs/master/org/apache/datasketches/fdt/FdtSketch.html

@@ -246,7 +246,7 @@ <h3>Method Summary</h3>
 </tr>
 <tr id="i0" class="altColor">
 <td class="colFirst"><code><a href="../tuple/CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a>&lt;S&gt;</code></td>
-<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#compact()">compact</a></span>()</code></th>
+<th class="colSecond" scope="row"><code><span class="memberNameLink">compact</span>()</code></th>
 <td class="colLast">
 <div class="block">Converts the current state of the sketch into a compact sketch</div>
 </td>
@@ -258,28 +258,28 @@ <h3>Method Summary</h3>
 </tr>
 <tr id="i2" class="altColor">
 <td class="colFirst"><code>int</code></td>
-<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCountLessThanThetaLong(long)">getCountLessThanThetaLong</a></span>&#8203;(long&nbsp;thetaLong)</code></th>
+<th class="colSecond" scope="row"><code><span class="memberNameLink">getCountLessThanThetaLong</span>&#8203;(long&nbsp;thetaLong)</code></th>
 <td class="colLast">
 <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>
-<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCurrentCapacity()">getCurrentCapacity</a></span>()</code></th>
+<th class="colSecond" scope="row"><code><span class="memberNameLink">getCurrentCapacity</span>()</code></th>
 <td class="colLast">
 <div class="block">Get current capacity</div>
 </td>
 </tr>
 <tr id="i4" class="altColor">
 <td class="colFirst"><code>int</code></td>
-<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLgK()">getLgK</a></span>()</code></th>
+<th class="colSecond" scope="row"><code><span class="memberNameLink">getLgK</span>()</code></th>
 <td class="colLast">
 <div class="block">Get log_base2 of Nominal Entries</div>
 </td>
 </tr>
 <tr id="i5" class="rowColor">
 <td class="colFirst"><code>int</code></td>
-<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNominalEntries()">getNominalEntries</a></span>()</code></th>
+<th class="colSecond" scope="row"><code><span class="memberNameLink">getNominalEntries</span>()</code></th>
 <td class="colLast">
 <div class="block">Get configured nominal number of entries</div>
 </td>
@@ -301,7 +301,7 @@ <h3>Method Summary</h3>
 </tr>
 <tr id="i8" 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>
+<th class="colSecond" scope="row"><code><span class="memberNameLink">getResizeFactor</span>()</code></th>
 <td class="colLast">
 <div class="block">Get configured resize factor</div>
 </td>
@@ -319,39 +319,39 @@ <h3>Method Summary</h3>
 </tr>
 <tr id="i10" class="altColor">
 <td class="colFirst"><code>int</code></td>
-<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRetainedEntries()">getRetainedEntries</a></span>()</code></th>
+<th class="colSecond" scope="row"><code><span class="memberNameLink">getRetainedEntries</span>()</code></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr id="i11" class="rowColor">
 <td class="colFirst"><code>float</code></td>
-<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSamplingProbability()">getSamplingProbability</a></span>()</code></th>
+<th class="colSecond" scope="row"><code><span class="memberNameLink">getSamplingProbability</span>()</code></th>
 <td class="colLast">
 <div class="block">Get configured sampling probability</div>
 </td>
 </tr>
 <tr id="i12" class="altColor">
 <td class="colFirst"><code>protected void</code></td>
-<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#insertSummary(int,S)">insertSummary</a></span>&#8203;(int&nbsp;index,
+<th class="colSecond" scope="row"><code><span class="memberNameLink">insertSummary</span>&#8203;(int&nbsp;index,
              S&nbsp;summary)</code></th>
 <td class="colLast">&nbsp;</td>
 </tr>
 <tr id="i13" class="rowColor">
 <td class="colFirst"><code><a href="../tuple/TupleSketchIterator.html" title="class in org.apache.datasketches.tuple">TupleSketchIterator</a>&lt;S&gt;</code></td>
-<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#iterator()">iterator</a></span>()</code></th>
+<th class="colSecond" scope="row"><code><span class="memberNameLink">iterator</span>()</code></th>
 <td class="colLast">
 <div class="block">Returns a SketchIterator</div>
 </td>
 </tr>
 <tr id="i14" class="altColor">
 <td class="colFirst"><code>void</code></td>
-<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#reset()">reset</a></span>()</code></th>
+<th class="colSecond" scope="row"><code><span class="memberNameLink">reset</span>()</code></th>
 <td class="colLast">
 <div class="block">Resets this sketch an empty state.</div>
 </td>
 </tr>
 <tr id="i15" class="rowColor">
 <td class="colFirst"><code>byte[]</code></td>
-<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toByteArray()">toByteArray</a></span>()</code></th>
+<th class="colSecond" scope="row"><code><span class="memberNameLink">toByteArray</span>()</code></th>
 <td class="colLast">
 <div class="block"><span class="deprecatedLabel">Deprecated.</span>
 <div class="deprecationComment">As of 3.0.0, serializing an UpdatableSketch is deprecated.</div>
@@ -360,7 +360,7 @@ <h3>Method Summary</h3>
 </tr>
 <tr id="i16" class="altColor">
 <td class="colFirst"><code>void</code></td>
-<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#trim()">trim</a></span>()</code></th>
+<th class="colSecond" scope="row"><code><span class="memberNameLink">trim</span>()</code></th>
 <td class="colLast">
 <div class="block">Rebuilds reducing the actual number of entries to the nominal number of entries if needed</div>
 </td>

docs/master/org/apache/datasketches/theta/CompactSketch.html

@@ -266,7 +266,7 @@ <h3>Method Summary</h3>
 <!--   -->
 </a>
 <h3>Methods inherited from class&nbsp;org.apache.datasketches.theta.<a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></h3>
-<code><a href="Sketch.html#compact()">compact</a>, <a href="Sketch.html#getCountLessThanThetaLong(long)">getCountLessThanThetaLong</a>, <a href="Sketch.html#getCurrentBytes()">getCurrentBytes</a>, <a href="Sketch.html#getEstimate()">getEstimate</a>, <a href="Sketch.html#getLowerBound(int)">getLowerBound</a>, <a href="Sketch.html#getMaxCompactSketchBytes(int)">getMaxCompactSketchBytes</a>, <a href="Sketch.html#getMaxUpdateSketchBytes(int)">getMaxUpdateSketchBytes</a>, <a href="Sketch.html#getRetainedEntries()">getRetainedEntries</a>, <a href="Sketch.html#getRetainedEntries(boolean)">getRetainedEntries</a>, <a href="Sketch.html#getSerializationVersion(org.apache.datasketches.memory.Memory)">getSerializationVersion</a>, <a href="Sketch.html#getTheta()">getTheta</a>, <a href="Sketch.html#getThetaLong()">getThetaLong</a>, <a href="Sketch.html#getUpperBound(int)">getUpperBound</a>, <a href="Sketch.html#hasMemory()">hasMemory</a>, <a href="Sketch.html#isDirect()">isDirect</a>, <a href="Sketch.html#isEmpty()">isEmpty</a>, <a href="Sketch.html#isEstimationMode()">isEstimationMode</a>, <a href="Sketch.html#isOrdered()">isOrdered</a>, <a href="Sketch.html#isSameResource(org.apache.datasketches.memory.Memory)">isSameResource</a>, <a href="Sketch.html#iterator()">iterator</a>, <a href="Sketch.html#toByteArray()">toByteArray</a>, <a href="Sketch.html#toString()">toString</a>, <a href="Sketch.html#toString(boolean,boolean,int,boolean)">toString</a>, <a href="Sketch.html#toString(byte%5B%5D)">toString</a>, <a href="Sketch.html#toString(org.apache.datasketches.memory.Memory)">toString</a></code></li>
+<code><a href="Sketch.html#compact()">compact</a>, <a href="Sketch.html#getCompactSketchMaxBytes(int)">getCompactSketchMaxBytes</a>, <a href="Sketch.html#getCountLessThanThetaLong(long)">getCountLessThanThetaLong</a>, <a href="Sketch.html#getCurrentBytes()">getCurrentBytes</a>, <a href="Sketch.html#getEstimate()">getEstimate</a>, <a href="Sketch.html#getLowerBound(int)">getLowerBound</a>, <a href="Sketch.html#getMaxCompactSketchBytes(int)">getMaxCompactSketchBytes</a>, <a href="Sketch.html#getMaxUpdateSketchBytes(int)">getMaxUpdateSketchBytes</a>, <a href="Sketch.html#getRetainedEntries()">getRetainedEntries</a>, <a href="Sketch.html#getRetainedEntries(boolean)">getRetainedEntries</a>, <a href="Sketch.html#getSerializationVersion(org.apache.datasketches.memory.Memory)">getSerializationVersion</a>, <a href="Sketch.html#getTheta()">getTheta</a>, <a href="Sketch.html#getThetaLong()">getThetaLong</a>, <a href="Sketch.html#getUpperBound(int)">getUpperBound</a>, <a href="Sketch.html#hasMemory()">hasMemory</a>, <a href="Sketch.html#isDirect()">isDirect</a>, <a href="Sketch.html#isEmpty()">isEmpty</a>, <a href="Sketch.html#isEstimationMode()">isEstimationMode</a>, <a href="Sketch.html#isOrdered()">isOrdered</a>, <a href="Sketch.html#isSameResource(org.apache.datasketches.memory.Memory)">isSameResource</a>, <a href="Sketch.html#iterator()">iterator</a>, <a href="Sketch.html#toByteArray()">toByteArray</a>, <a href="Sketch.html#toString()">toString</a>, <a href="Sketch.html#toString(boolean,boolean,int,boolean)">toString</a>, <a href="Sketch.html#toString(byte%5B%5D)">toString</a>, <a href="Sketch.html#toString(org.apache.datasketches.memory.Memory)">toString</a></code></li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">