Deploying to gh-pages from @ e89a10e 🚀

apache · Feb 15, 2024 · 5b8294e · 5b8294e
1 parent a64be1b
commit 5b8294e
Show file tree

Hide file tree

Showing 11 changed files with 154 additions and 36 deletions.
diff --git a/docs/master/index-all.html b/docs/master/index-all.html
@@ -2462,6 +2462,10 @@ <h2 class="title">G</h2>
 </dd>
 <dt><span class="memberNameLink"><a href="org/apache/datasketches/kll/KllSketch.SketchType.html#getName()">getName()</a></span> - Method in enum org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllSketch.SketchType.html" title="enum in org.apache.datasketches.kll">KllSketch.SketchType</a></dt>
 <dd>&nbsp;</dd>
+<dt><span class="memberNameLink"><a href="org/apache/datasketches/quantilescommon/SortedViewIterator.html#getNaturalRank()">getNaturalRank()</a></span> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/SortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">SortedViewIterator</a></dt>
+<dd>
+<div class="block">Gets the natural rank at the current index.</div>
+</dd>
 <dt><span class="memberNameLink"><a href="org/apache/datasketches/quantilescommon/QuantilesUtil.html#getNaturalRank(double,long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getNaturalRank(double, long, QuantileSearchCriteria)</a></span> - Static method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesUtil.html" title="class in org.apache.datasketches.quantilescommon">QuantilesUtil</a></dt>
 <dd>&nbsp;</dd>
 <dt><span class="memberNameLink"><a href="org/apache/datasketches/quantilescommon/SortedViewIterator.html#getNaturalRank(org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getNaturalRank(QuantileSearchCriteria)</a></span> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/SortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">SortedViewIterator</a></dt>
@@ -2479,6 +2483,10 @@ <h2 class="title">G</h2>
 <dd>
 <div class="block">Gets the configured nominal number of entries</div>
 </dd>
+<dt><span class="memberNameLink"><a href="org/apache/datasketches/quantilescommon/SortedViewIterator.html#getNormalizedRank()">getNormalizedRank()</a></span> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/SortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">SortedViewIterator</a></dt>
+<dd>
+<div class="block">Gets the normalized rank at the current index.</div>
+</dd>
 <dt><span class="memberNameLink"><a href="org/apache/datasketches/quantilescommon/SortedViewIterator.html#getNormalizedRank(org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getNormalizedRank(QuantileSearchCriteria)</a></span> - Method in class org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/SortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">SortedViewIterator</a></dt>
 <dd>
 <div class="block">Gets the normalized rank at the current index (or previous index)
@@ -2707,7 +2715,8 @@ <h2 class="title">G</h2>
 </dd>
 <dt><span class="memberNameLink"><a href="org/apache/datasketches/quantilescommon/GenericSortedViewIterator.html#getQuantile()">getQuantile()</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.</div>
+<div class="block">Gets the quantile at the current index
+ This is equivalent to <i>getQuantile(INCLUSIVE)</i>.</div>
 </dd>
 <dt><span class="memberNameLink"><a href="org/apache/datasketches/quantilescommon/QuantilesDoublesSketchIterator.html#getQuantile()">getQuantile()</a></span> - Method in interface org.apache.datasketches.quantilescommon.<a href="org/apache/datasketches/quantilescommon/QuantilesDoublesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesSketchIterator</a></dt>
 <dd>
@@ -2783,6 +2792,11 @@ <h2 class="title">G</h2>
 <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)
+ based on the chosen search criterion.</div>
+</dd>
 <dt><span class="memberNameLink"><a href="org/apache/datasketches/kll/KllDoublesSketch.html#getQuantileLowerBound(double)">getQuantileLowerBound(double)</a></span> - Method in class org.apache.datasketches.kll.<a href="org/apache/datasketches/kll/KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></dt>
 <dd>
 <div class="block">Gets the lower bound of the quantile confidence interval in which the quantile of the
@@ -4064,6 +4078,10 @@ <h2 class="title">I</h2>
 <dd>
 <div class="block">Include only the lower bound but not the upper bound</div>
 </dd>
+<dt><span class="memberNameLink"><a href="org/apache/datasketches/partitions/BoundsRule.html#INCLUDE_NEITHER">INCLUDE_NEITHER</a></span> - org.apache.datasketches.partitions.<a href="org/apache/datasketches/partitions/BoundsRule.html" title="enum in org.apache.datasketches.partitions">BoundsRule</a></dt>
+<dd>
+<div class="block">Include none</div>
+</dd>
 <dt><span class="memberNameLink"><a href="org/apache/datasketches/partitions/BoundsRule.html#INCLUDE_UPPER">INCLUDE_UPPER</a></span> - org.apache.datasketches.partitions.<a href="org/apache/datasketches/partitions/BoundsRule.html" title="enum in org.apache.datasketches.partitions">BoundsRule</a></dt>
 <dd>
 <div class="block">Include only the upper bound but not the lower bound</div>

diff --git a/docs/master/member-search-index.js b/docs/master/member-search-index.js
diff --git a/docs/master/member-search-index.zip b/docs/master/member-search-index.zip
diff --git a/docs/master/org/apache/datasketches/partitions/BoundsRule.html b/docs/master/org/apache/datasketches/partitions/BoundsRule.html
@@ -175,6 +175,12 @@ <h3>Enum Constant Summary</h3>
 </td>
 </tr>
 <tr class="altColor">
+<th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#INCLUDE_NEITHER">INCLUDE_NEITHER</a></span></code></th>
+<td class="colLast">
+<div class="block">Include none</div>
+</td>
+</tr>
+<tr class="rowColor">
 <th class="colFirst" scope="row"><code><span class="memberNameLink"><a href="#INCLUDE_UPPER">INCLUDE_UPPER</a></span></code></th>
 <td class="colLast">
 <div class="block">Include only the upper bound but not the lower bound</div>
@@ -267,13 +273,23 @@ <h4>INCLUDE_UPPER</h4>
 <a id="INCLUDE_LOWER">
 <!--   -->
 </a>
-<ul class="blockListLast">
+<ul class="blockList">
 <li class="blockList">
 <h4>INCLUDE_LOWER</h4>
 <pre>public static final&nbsp;<a href="BoundsRule.html" title="enum in org.apache.datasketches.partitions">BoundsRule</a> INCLUDE_LOWER</pre>
 <div class="block">Include only the lower bound but not the upper bound</div>
 </li>
 </ul>
+<a id="INCLUDE_NEITHER">
+<!--   -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>INCLUDE_NEITHER</h4>
+<pre>public static final&nbsp;<a href="BoundsRule.html" title="enum in org.apache.datasketches.partitions">BoundsRule</a> INCLUDE_NEITHER</pre>
+<div class="block">Include none</div>
+</li>
+</ul>
 </li>
 </ul>
 </section>

diff --git a/docs/master/org/apache/datasketches/quantilescommon/DoublesSortedViewIterator.html b/docs/master/org/apache/datasketches/quantilescommon/DoublesSortedViewIterator.html
@@ -212,7 +212,7 @@ <h3>Method Summary</h3>
 <!--   -->
 </a>
 <h3>Methods inherited from class&nbsp;org.apache.datasketches.quantilescommon.<a href="SortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">SortedViewIterator</a></h3>
-<code><a href="SortedViewIterator.html#getN()">getN</a>, <a href="SortedViewIterator.html#getNaturalRank(org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getNaturalRank</a>, <a href="SortedViewIterator.html#getNormalizedRank(org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getNormalizedRank</a>, <a href="SortedViewIterator.html#getWeight()">getWeight</a>, <a href="SortedViewIterator.html#next()">next</a></code></li>
+<code><a href="SortedViewIterator.html#getN()">getN</a>, <a href="SortedViewIterator.html#getNaturalRank()">getNaturalRank</a>, <a href="SortedViewIterator.html#getNaturalRank(org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getNaturalRank</a>, <a href="SortedViewIterator.html#getNormalizedRank()">getNormalizedRank</a>, <a href="SortedViewIterator.html#getNormalizedRank(org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getNormalizedRank</a>, <a href="SortedViewIterator.html#getWeight()">getWeight</a>, <a href="SortedViewIterator.html#next()">next</a></code></li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">

diff --git a/docs/master/org/apache/datasketches/quantilescommon/FloatsSortedViewIterator.html b/docs/master/org/apache/datasketches/quantilescommon/FloatsSortedViewIterator.html
@@ -212,7 +212,7 @@ <h3>Method Summary</h3>
 <!--   -->
 </a>
 <h3>Methods inherited from class&nbsp;org.apache.datasketches.quantilescommon.<a href="SortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">SortedViewIterator</a></h3>
-<code><a href="SortedViewIterator.html#getN()">getN</a>, <a href="SortedViewIterator.html#getNaturalRank(org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getNaturalRank</a>, <a href="SortedViewIterator.html#getNormalizedRank(org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getNormalizedRank</a>, <a href="SortedViewIterator.html#getWeight()">getWeight</a>, <a href="SortedViewIterator.html#next()">next</a></code></li>
+<code><a href="SortedViewIterator.html#getN()">getN</a>, <a href="SortedViewIterator.html#getNaturalRank()">getNaturalRank</a>, <a href="SortedViewIterator.html#getNaturalRank(org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getNaturalRank</a>, <a href="SortedViewIterator.html#getNormalizedRank()">getNormalizedRank</a>, <a href="SortedViewIterator.html#getNormalizedRank(org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getNormalizedRank</a>, <a href="SortedViewIterator.html#getWeight()">getWeight</a>, <a href="SortedViewIterator.html#next()">next</a></code></li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">

diff --git a/docs/master/org/apache/datasketches/quantilescommon/GenericSortedViewIterator.html b/docs/master/org/apache/datasketches/quantilescommon/GenericSortedViewIterator.html
@@ -27,7 +27,7 @@
     catch(err) {
     }
 //-->
-var data = {"i0":10};
+var data = {"i0":10,"i1":10};
 var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
 var altColor = "altColor";
 var rowColor = "rowColor";
@@ -207,7 +207,16 @@ <h3>Method Summary</h3>
 <td class="colFirst"><code><a href="GenericSortedViewIterator.html" title="type parameter in GenericSortedViewIterator">T</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getQuantile()">getQuantile</a></span>()</code></th>
 <td class="colLast">
-<div class="block">Gets the quantile at the current index.</div>
+<div class="block">Gets the quantile at the current index
+ This is equivalent to <i>getQuantile(INCLUSIVE)</i>.</div>
+</td>
+</tr>
+<tr id="i1" class="rowColor">
+<td class="colFirst"><code><a href="GenericSortedViewIterator.html" title="type parameter in GenericSortedViewIterator">T</a></code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getQuantile(org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getQuantile</a></span>&#8203;(<a href="QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a>&nbsp;searchCrit)</code></th>
+<td class="colLast">
+<div class="block">Gets the quantile at the current index (or previous index)
+ based on the chosen search criterion.</div>
 </td>
 </tr>
 </table>
@@ -216,7 +225,7 @@ <h3>Method Summary</h3>
 <!--   -->
 </a>
 <h3>Methods inherited from class&nbsp;org.apache.datasketches.quantilescommon.<a href="SortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">SortedViewIterator</a></h3>
-<code><a href="SortedViewIterator.html#getN()">getN</a>, <a href="SortedViewIterator.html#getNaturalRank(org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getNaturalRank</a>, <a href="SortedViewIterator.html#getNormalizedRank(org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getNormalizedRank</a>, <a href="SortedViewIterator.html#getWeight()">getWeight</a>, <a href="SortedViewIterator.html#next()">next</a></code></li>
+<code><a href="SortedViewIterator.html#getN()">getN</a>, <a href="SortedViewIterator.html#getNaturalRank()">getNaturalRank</a>, <a href="SortedViewIterator.html#getNaturalRank(org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getNaturalRank</a>, <a href="SortedViewIterator.html#getNormalizedRank()">getNormalizedRank</a>, <a href="SortedViewIterator.html#getNormalizedRank(org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getNormalizedRank</a>, <a href="SortedViewIterator.html#getWeight()">getWeight</a>, <a href="SortedViewIterator.html#next()">next</a></code></li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
@@ -266,20 +275,42 @@ <h3>Method Detail</h3>
 <a id="getQuantile()">
 <!--   -->
 </a>
-<ul class="blockListLast">
+<ul class="blockList">
 <li class="blockList">
 <h4>getQuantile</h4>
 <pre class="methodSignature">public&nbsp;<a href="GenericSortedViewIterator.html" title="type parameter in GenericSortedViewIterator">T</a>&nbsp;getQuantile()</pre>
-<div class="block">Gets the quantile at the current index.
+<div class="block">Gets the quantile at the current index
+ This is equivalent to <i>getQuantile(INCLUSIVE)</i>.
 
- <p>Don't call this before calling next() for the first time
- or after getting false from next().</p></div>
+ <p>Don't call this before calling next() for the first time or after getting false from next().</p></div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the quantile at the current index.</dd>
 </dl>
 </li>
 </ul>
+<a id="getQuantile(org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">
+<!--   -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>getQuantile</h4>
+<pre class="methodSignature">public&nbsp;<a href="GenericSortedViewIterator.html" title="type parameter in GenericSortedViewIterator">T</a>&nbsp;getQuantile&#8203;(<a href="QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a>&nbsp;searchCrit)</pre>
+<div class="block">Gets the quantile at the current index (or previous index)
+ based on the chosen search criterion.
+
+ <p>Don't call this before calling next() for the first time or after getting false from next().</p></div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>searchCrit</code> - if INCLUSIVE, includes the quantile at the current index.
+ Otherwise, returns the quantile of the previous index.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>the quantile at the current index (or previous index)
+ based on the chosen search criterion. If the chosen search criterion is <i>EXCLUSIVE</i> and
+ the current index is at zero, this will return <i>null</i>.</dd>
+</dl>
+</li>
+</ul>
 </li>
 </ul>
 </section>