Skip to content

Commit

Permalink
Deploying to gh-pages from @ 4f74acc 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
leerho committed Apr 8, 2024
1 parent 5c09d15 commit 141d6c2
Show file tree
Hide file tree
Showing 25 changed files with 119 additions and 1,004 deletions.
118 changes: 56 additions & 62 deletions docs/master/allclasses-index.html

Large diffs are not rendered by default.

1 change: 0 additions & 1 deletion docs/master/allclasses.html
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,6 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></li>
<li><a href="org/apache/datasketches/req/ReqSketchBuilder.html" title="class in org.apache.datasketches.req">ReqSketchBuilder</a></li>
<li><a href="org/apache/datasketches/req/ReqSketchIterator.html" title="class in org.apache.datasketches.req">ReqSketchIterator</a></li>
<li><a href="org/apache/datasketches/req/ReqSketchSortedView.html" title="class in org.apache.datasketches.req">ReqSketchSortedView</a></li>
<li><a href="org/apache/datasketches/sampling/ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a></li>
<li><a href="org/apache/datasketches/sampling/ReservoirItemsUnion.html" title="class in org.apache.datasketches.sampling">ReservoirItemsUnion</a></li>
<li><a href="org/apache/datasketches/sampling/ReservoirLongsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirLongsSketch</a></li>
Expand Down
30 changes: 1 addition & 29 deletions docs/master/index-all.html
Original file line number Diff line number Diff line change
Expand Up @@ -1499,7 +1499,7 @@ <h2 class="title">F</h2>
<dd>&nbsp;</dd>
<dt><a href="org/apache/datasketches/quantilescommon/FloatsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon"><span class="typeNameLink">FloatsSketchSortedView</span></a> - Class in <a href="org/apache/datasketches/quantilescommon/package-summary.html">org.apache.datasketches.quantilescommon</a></dt>
<dd>
<div class="block">The SortedView of the Quantiles Classic DoublesSketch and the KllDoublesSketch.</div>
<div class="block">The SortedView for the KllFloatsSketch and the ReqSketch.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/datasketches/quantilescommon/FloatsSketchSortedView.html#%3Cinit%3E(float%5B%5D,long%5B%5D,long,float,float)">FloatsSketchSortedView(float[], long[], long, float, float)</a></span> - Constructor for class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/FloatsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">FloatsSketchSortedView</a></dt>
<dd>
Expand Down Expand Up @@ -1785,8 +1785,6 @@ <h2 class="title">G</h2>
<dd>
<div class="block">Returns the array of cumulative weights from the sketch.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/datasketches/req/ReqSketchSortedView.html#getCumulativeWeights()">getCumulativeWeights()</a></span> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketchSortedView.html" title="class in org.apache.datasketches.req">ReqSketchSortedView</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="org/apache/datasketches/theta/Sketch.html#getCurrentBytes()">getCurrentBytes()</a></span> - 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 number of storage bytes required for this sketch in its current state.</div>
Expand Down Expand Up @@ -2361,8 +2359,6 @@ <h2 class="title">G</h2>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/datasketches/req/ReqSketch.html#getMaxItem()">getMaxItem()</a></span> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="org/apache/datasketches/req/ReqSketchSortedView.html#getMaxItem()">getMaxItem()</a></span> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketchSortedView.html" title="class in org.apache.datasketches.req">ReqSketchSortedView</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="org/apache/datasketches/quantiles/DoublesUnion.html#getMaxK()">getMaxK()</a></span> - Method in class org.apache.datasketches.quantiles.<a href="org/apache/datasketches/quantiles/DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></dt>
<dd>
<div class="block">Returns the configured <i>maxK</i> of this Union.</div>
Expand Down Expand Up @@ -2487,8 +2483,6 @@ <h2 class="title">G</h2>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/datasketches/req/ReqSketch.html#getMinItem()">getMinItem()</a></span> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="org/apache/datasketches/req/ReqSketchSortedView.html#getMinItem()">getMinItem()</a></span> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketchSortedView.html" title="class in org.apache.datasketches.req">ReqSketchSortedView</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="org/apache/datasketches/common/Family.html#getMinPreLongs()">getMinPreLongs()</a></span> - Method in enum org.apache.datasketches.common.<a href="org/apache/datasketches/common/Family.html" title="enum in org.apache.datasketches.common">Family</a></dt>
<dd>
<div class="block">Returns the minimum preamble size for this family in longs</div>
Expand Down Expand Up @@ -2525,8 +2519,6 @@ <h2 class="title">G</h2>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/datasketches/req/ReqSketch.html#getN()">getN()</a></span> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="org/apache/datasketches/req/ReqSketchSortedView.html#getN()">getN()</a></span> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketchSortedView.html" title="class in org.apache.datasketches.req">ReqSketchSortedView</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="org/apache/datasketches/sampling/EbppsItemsSketch.html#getN()">getN()</a></span> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/EbppsItemsSketch.html" title="class in org.apache.datasketches.sampling">EbppsItemsSketch</a></dt>
<dd>
<div class="block">Returns the number of items processed by the sketch, regardless
Expand Down Expand Up @@ -2657,8 +2649,6 @@ <h2 class="title">G</h2>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/datasketches/req/ReqSketch.html#getNumRetained()">getNumRetained()</a></span> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="org/apache/datasketches/req/ReqSketchSortedView.html#getNumRetained()">getNumRetained()</a></span> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketchSortedView.html" title="class in org.apache.datasketches.req">ReqSketchSortedView</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="org/apache/datasketches/sampling/ReservoirItemsSketch.html#getNumSamples()">getNumSamples()</a></span> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a></dt>
<dd>
<div class="block">Returns the current number of items in the reservoir, which may be smaller than the
Expand Down Expand Up @@ -2886,8 +2876,6 @@ <h2 class="title">G</h2>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/datasketches/req/ReqSketch.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getQuantile(double, QuantileSearchCriteria)</a></span> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="org/apache/datasketches/req/ReqSketchSortedView.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getQuantile(double, QuantileSearchCriteria)</a></span> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketchSortedView.html" title="class in org.apache.datasketches.req">ReqSketchSortedView</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="org/apache/datasketches/quantilescommon/GenericSortedViewIterator.html#getQuantile(org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getQuantile(QuantileSearchCriteria)</a></span> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/GenericSortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">GenericSortedViewIterator</a></dt>
<dd>
<div class="block">Gets the quantile at the current index (or previous index)
Expand Down Expand Up @@ -2952,8 +2940,6 @@ <h2 class="title">G</h2>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/datasketches/quantilescommon/ItemsSketchSortedView.html#getQuantiles()">getQuantiles()</a></span> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/ItemsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">ItemsSketchSortedView</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="org/apache/datasketches/req/ReqSketchSortedView.html#getQuantiles()">getQuantiles()</a></span> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketchSortedView.html" title="class in org.apache.datasketches.req">ReqSketchSortedView</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getQuantiles(double%5B%5D)">getQuantiles(double[])</a></span> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI</a></dt>
<dd>
<div class="block">This is equivalent to <a href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getQuantiles(ranks, INCLUSIVE)</code></a></div>
Expand Down Expand Up @@ -3078,8 +3064,6 @@ <h2 class="title">G</h2>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/datasketches/req/ReqSketch.html#getRank(float,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getRank(float, QuantileSearchCriteria)</a></span> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="org/apache/datasketches/req/ReqSketchSortedView.html#getRank(float,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getRank(float, QuantileSearchCriteria)</a></span> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketchSortedView.html" title="class in org.apache.datasketches.req">ReqSketchSortedView</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html#getRank(T)">getRank(T)</a></span> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesGenericAPI</a></dt>
<dd>
<div class="block">This is equivalent to <a href="org/apache/datasketches/quantilescommon/QuantilesGenericAPI.html#getRank(T,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getRank(T quantile, INCLUSIVE)</code></a></div>
Expand Down Expand Up @@ -4512,8 +4496,6 @@ <h2 class="title">I</h2>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/datasketches/req/ReqSketch.html#isEmpty()">isEmpty()</a></span> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="org/apache/datasketches/req/ReqSketchSortedView.html#isEmpty()">isEmpty()</a></span> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketchSortedView.html" title="class in org.apache.datasketches.req">ReqSketchSortedView</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="org/apache/datasketches/sampling/EbppsItemsSketch.html#isEmpty()">isEmpty()</a></span> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/EbppsItemsSketch.html" title="class in org.apache.datasketches.sampling">EbppsItemsSketch</a></dt>
<dd>
<div class="block">Returns true if the sketch is empty.</div>
Expand Down Expand Up @@ -4729,8 +4711,6 @@ <h2 class="title">I</h2>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/datasketches/req/ReqSketch.html#iterator()">iterator()</a></span> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="org/apache/datasketches/req/ReqSketchSortedView.html#iterator()">iterator()</a></span> - Method in class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketchSortedView.html" title="class in org.apache.datasketches.req">ReqSketchSortedView</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="org/apache/datasketches/sampling/VarOptItemsSamples.html#iterator()">iterator()</a></span> - Method in class org.apache.datasketches.sampling.<a href="org/apache/datasketches/sampling/VarOptItemsSamples.html" title="class in org.apache.datasketches.sampling">VarOptItemsSamples</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="org/apache/datasketches/theta/Sketch.html#iterator()">iterator()</a></span> - 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>
Expand Down Expand Up @@ -5720,14 +5700,6 @@ <h2 class="title">R</h2>
<dd>
<div class="block">Iterator over all retained items of the ReqSketch.</div>
</dd>
<dt><a href="org/apache/datasketches/req/ReqSketchSortedView.html" title="class in org.apache.datasketches.req"><span class="typeNameLink">ReqSketchSortedView</span></a> - Class in <a href="org/apache/datasketches/req/package-summary.html">org.apache.datasketches.req</a></dt>
<dd>
<div class="block">The SortedView of the ReqSketch.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/datasketches/req/ReqSketchSortedView.html#%3Cinit%3E(org.apache.datasketches.req.ReqSketch)">ReqSketchSortedView(ReqSketch)</a></span> - Constructor for class org.apache.datasketches.req.<a href="org/apache/datasketches/req/ReqSketchSortedView.html" title="class in org.apache.datasketches.req">ReqSketchSortedView</a></dt>
<dd>
<div class="block">Constructs this Sorted View given the sketch</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/datasketches/common/Family.html#RESERVOIR">RESERVOIR</a></span> - org.apache.datasketches.common.<a href="org/apache/datasketches/common/Family.html" title="enum in org.apache.datasketches.common">Family</a></dt>
<dd>
<div class="block">The Reservoir family of sketches.</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/master/member-search-index.js

Large diffs are not rendered by default.

Binary file modified docs/master/member-search-index.zip
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ <h2 title="Class FloatsSketchSortedView" class="title">Class FloatsSketchSortedV
<pre>public class <span class="typeNameLabel">FloatsSketchSortedView</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>
implements <a href="FloatsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">FloatsSortedView</a></pre>
<div class="block">The SortedView of the Quantiles Classic DoublesSketch and the KllDoublesSketch.</div>
<div class="block">The SortedView for the KllFloatsSketch and the ReqSketch.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Alexander Saydakov, Lee Rhodes</dd>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ <h2 title="Interface FloatsSortedView" class="title">Interface FloatsSortedView<
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="FloatsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">FloatsSketchSortedView</a></code>, <code><a href="../req/ReqSketchSortedView.html" title="class in org.apache.datasketches.req">ReqSketchSortedView</a></code></dd>
<dd><code><a href="FloatsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">FloatsSketchSortedView</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">FloatsSortedView</span>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ <h2 title="Interface SortedView" class="title">Interface SortedView</h2>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="DoublesSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">DoublesSketchSortedView</a></code>, <code><a href="FloatsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">FloatsSketchSortedView</a></code>, <code><a href="ItemsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">ItemsSketchSortedView</a></code>, <code><a href="../req/ReqSketchSortedView.html" title="class in org.apache.datasketches.req">ReqSketchSortedView</a></code></dd>
<dd><code><a href="DoublesSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">DoublesSketchSortedView</a></code>, <code><a href="FloatsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">FloatsSketchSortedView</a></code>, <code><a href="ItemsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">ItemsSketchSortedView</a></code></dd>
</dl>
<hr>
<pre>public interface <span class="typeNameLabel">SortedView</span></pre>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,12 @@ <h2 title="Uses of Class org.apache.datasketches.quantilescommon.FloatsSketchSor
and Edo Liberty that is commonly referred to as the "KLL" sketch after the authors' last names.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="#org.apache.datasketches.req">org.apache.datasketches.req</a></th>
<td class="colLast">
<div class="block">This package is for the implementation of the Relative Error Quantiles sketch algorithm.</div>
</td>
</tr>
</tbody>
</table>
</li>
Expand Down Expand Up @@ -140,6 +146,28 @@ <h3>Uses of <a href="../FloatsSketchSortedView.html" title="class in org.apache.
</table>
</section>
</li>
<li class="blockList">
<section><a id="org.apache.datasketches.req">
<!-- -->
</a>
<h3>Uses of <a href="../FloatsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">FloatsSketchSortedView</a> in <a href="../../req/package-summary.html">org.apache.datasketches.req</a></h3>
<table class="useSummary">
<caption><span>Methods in <a href="../../req/package-summary.html">org.apache.datasketches.req</a> that return <a href="../FloatsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">FloatsSketchSortedView</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code><a href="../FloatsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">FloatsSketchSortedView</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">ReqSketch.</span><code><span class="memberNameLink"><a href="../../req/ReqSketch.html#getSortedView()">getSortedView</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</section>
</li>
</ul>
</li>
</ul>
Expand Down
Loading

0 comments on commit 141d6c2

Please sign in to comment.