You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@datasketches.apache.org by gi...@apache.org on 2024/02/15 01:35:21 UTC
(datasketches-java) branch gh-pages updated: Deploying to gh-pages from @ apache/datasketches-java@e89a10e0a082658534d6a750281de66b7d83e670 🚀
This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch gh-pages
in repository https://gitbox.apache.org/repos/asf/datasketches-java.git
The following commit(s) were added to refs/heads/gh-pages by this push:
new 5b8294ef Deploying to gh-pages from @ apache/datasketches-java@e89a10e0a082658534d6a750281de66b7d83e670 🚀
5b8294ef is described below
commit 5b8294ef991065c9845102bf2926f4ca1837fe28
Author: leerho <le...@users.noreply.github.com>
AuthorDate: Thu Feb 15 01:35:16 2024 +0000
Deploying to gh-pages from @ apache/datasketches-java@e89a10e0a082658534d6a750281de66b7d83e670 🚀
---
docs/master/index-all.html | 20 ++++++-
docs/master/member-search-index.js | 2 +-
docs/master/member-search-index.zip | Bin 16496 -> 16518 bytes
.../apache/datasketches/partitions/BoundsRule.html | 18 +++++-
.../quantilescommon/DoublesSortedViewIterator.html | 2 +-
.../quantilescommon/FloatsSortedViewIterator.html | 2 +-
.../quantilescommon/GenericSortedViewIterator.html | 45 +++++++++++---
.../quantilescommon/SortedViewIterator.html | 65 +++++++++++++++++----
.../class-use/QuantileSearchCriteria.html | 36 +++++++-----
docs/master/package-search-index.zip | Bin 351 -> 351 bytes
docs/master/type-search-index.zip | Bin 1618 -> 1618 bytes
11 files changed, 154 insertions(+), 36 deletions(-)
diff --git a/docs/master/index-all.html b/docs/master/index-all.html
index 4ac2e7ba..3f9e815f 100644
--- a/docs/master/index-all.html
+++ b/docs/master/index-all.html
@@ -2462,6 +2462,10 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
</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> </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> </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 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
<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 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
</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 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
<dd> </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> </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 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
<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
index 68ba6dcf..58fa4a98 100644
--- a/docs/master/member-search-index.js
+++ b/docs/master/member-search-index.js
@@ -1 +1 @@
-memberSearchIndex = [{"p":"org.apache.datasketches.common","c":"Family","l":"A_NOT_B"},{"p":"org.apache.datasketches.common","c":"Family","l":"ALPHA"},{"p":"org.apache.datasketches.tuple.adouble","c":"DoubleSummary.Mode","l":"AlwaysOne"},{"p":"org.apache.datasketches.tuple.aninteger","c":"IntegerSummary.Mode","l":"AlwaysOne"},{"p":"org.apache.datasketches.theta","c":"AnotB","l":"AnotB()","url":"%3Cinit%3E()"},{"p":"org.apache.datasketches.tuple","c":"AnotB","l":"AnotB()","url":"%3Cinit%3 [...]
\ No newline at end of file
+memberSearchIndex = [{"p":"org.apache.datasketches.common","c":"Family","l":"A_NOT_B"},{"p":"org.apache.datasketches.common","c":"Family","l":"ALPHA"},{"p":"org.apache.datasketches.tuple.adouble","c":"DoubleSummary.Mode","l":"AlwaysOne"},{"p":"org.apache.datasketches.tuple.aninteger","c":"IntegerSummary.Mode","l":"AlwaysOne"},{"p":"org.apache.datasketches.theta","c":"AnotB","l":"AnotB()","url":"%3Cinit%3E()"},{"p":"org.apache.datasketches.tuple","c":"AnotB","l":"AnotB()","url":"%3Cinit%3 [...]
\ No newline at end of file
diff --git a/docs/master/member-search-index.zip b/docs/master/member-search-index.zip
index c7a12c47..0173f452 100644
Binary files a/docs/master/member-search-index.zip and b/docs/master/member-search-index.zip differ
diff --git a/docs/master/org/apache/datasketches/partitions/BoundsRule.html b/docs/master/org/apache/datasketches/partitions/BoundsRule.html
index 700ff4ef..f5fa5d45 100644
--- a/docs/master/org/apache/datasketches/partitions/BoundsRule.html
+++ b/docs/master/org/apache/datasketches/partitions/BoundsRule.html
@@ -175,6 +175,12 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?i
</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 @@ the order they are declared.</div>
<a id="INCLUDE_LOWER">
<!-- -->
</a>
-<ul class="blockListLast">
+<ul class="blockList">
<li class="blockList">
<h4>INCLUDE_LOWER</h4>
<pre>public static final <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 <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
index 7c20cb06..7d5f2b8a 100644
--- a/docs/master/org/apache/datasketches/quantilescommon/DoublesSortedViewIterator.html
+++ b/docs/master/org/apache/datasketches/quantilescommon/DoublesSortedViewIterator.html
@@ -212,7 +212,7 @@ extends <a href="SortedViewIterator.html" title="class in org.apache.datasketche
<!-- -->
</a>
<h3>Methods inherited from class 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="Sorted [...]
</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
index a07445bd..9ed2b658 100644
--- a/docs/master/org/apache/datasketches/quantilescommon/FloatsSortedViewIterator.html
+++ b/docs/master/org/apache/datasketches/quantilescommon/FloatsSortedViewIterator.html
@@ -212,7 +212,7 @@ extends <a href="SortedViewIterator.html" title="class in org.apache.datasketche
<!-- -->
</a>
<h3>Methods inherited from class 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="Sorted [...]
</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
index 1588bec9..9b6a9c5d 100644
--- 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 @@ extends <a href="SortedViewIterator.html" title="class in org.apache.datasketche
<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>​(<a href="QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> 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 @@ extends <a href="SortedViewIterator.html" title="class in org.apache.datasketche
<!-- -->
</a>
<h3>Methods inherited from class 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="Sorted [...]
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
@@ -266,20 +275,42 @@ extends <a href="SortedViewIterator.html" title="class in org.apache.datasketche
<a id="getQuantile()">
<!-- -->
</a>
-<ul class="blockListLast">
+<ul class="blockList">
<li class="blockList">
<h4>getQuantile</h4>
<pre class="methodSignature">public <a href="GenericSortedViewIterator.html" title="type parameter in GenericSortedViewIterator">T</a> 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 <a href="GenericSortedViewIterator.html" title="type parameter in GenericSortedViewIterator">T</a> getQuantile​(<a href="QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> 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>
diff --git a/docs/master/org/apache/datasketches/quantilescommon/SortedViewIterator.html b/docs/master/org/apache/datasketches/quantilescommon/SortedViewIterator.html
index dc34710e..9aa21a85 100644
--- a/docs/master/org/apache/datasketches/quantilescommon/SortedViewIterator.html
+++ b/docs/master/org/apache/datasketches/quantilescommon/SortedViewIterator.html
@@ -27,7 +27,7 @@
catch(err) {
}
//-->
-var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10};
+var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
@@ -216,12 +216,26 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>long</code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNaturalRank()">getNaturalRank</a></span>()</code></th>
+<td class="colLast">
+<div class="block">Gets the natural rank at the current index.</div>
+</td>
+</tr>
+<tr id="i2" class="altColor">
+<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNaturalRank(org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getNaturalRank</a></span>​(<a href="QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></th>
<td class="colLast">
<div class="block">Gets the natural rank at the current index (or previous index) based on the chosen search criterion.</div>
</td>
</tr>
-<tr id="i2" class="altColor">
+<tr id="i3" class="rowColor">
+<td class="colFirst"><code>double</code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNormalizedRank()">getNormalizedRank</a></span>()</code></th>
+<td class="colLast">
+<div class="block">Gets the normalized rank at the current index.</div>
+</td>
+</tr>
+<tr id="i4" class="altColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNormalizedRank(org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getNormalizedRank</a></span>​(<a href="QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></th>
<td class="colLast">
@@ -229,14 +243,14 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html
based on the chosen search criterion.</div>
</td>
</tr>
-<tr id="i3" class="rowColor">
+<tr id="i5" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getWeight()">getWeight</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the weight contribution of the item at the current index.</div>
</td>
</tr>
-<tr id="i4" class="altColor">
+<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#next()">next</a></span>()</code></th>
<td class="colLast">
@@ -304,6 +318,23 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html
<!-- -->
</a>
<h3>Method Detail</h3>
+<a id="getNaturalRank()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getNaturalRank</h4>
+<pre class="methodSignature">public long getNaturalRank()</pre>
+<div class="block">Gets the natural rank at the current index.
+ This is equivalent to <i>getNaturalRank(INCLUSIVE)</i>.
+
+ <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 natural rank at the current index.</dd>
+</dl>
+</li>
+</ul>
<a id="getNaturalRank(org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">
<!-- -->
</a>
@@ -315,8 +346,7 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html
This is also referred to as the "cumulative weight". The natural rank is a number in the range <i>[1, N]</i>,
where <i>N</i> (<a href="#getN()"><code>getN()</code></a>) is the total number of items fed to the sketch.
- <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="paramLabel">Parameters:</span></dt>
<dd><code>searchCrit</code> - if INCLUSIVE, includes the weight of the item at the current index in the computation of
@@ -341,6 +371,23 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html
</dl>
</li>
</ul>
+<a id="getNormalizedRank()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getNormalizedRank</h4>
+<pre class="methodSignature">public double getNormalizedRank()</pre>
+<div class="block">Gets the normalized rank at the current index.
+ This is equivalent to <i>getNormalizedRank(INCLUSIVE)</i>.
+
+ <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 normalized rank at the current index</dd>
+</dl>
+</li>
+</ul>
<a id="getNormalizedRank(org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">
<!-- -->
</a>
@@ -352,8 +399,7 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html
based on the chosen search criterion. Where <i>normalized rank = natural rank / N</i> (<a href="#getN()"><code>getN()</code></a>)
and is a fraction in the range (0,1.0].
- <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="paramLabel">Parameters:</span></dt>
<dd><code>searchCrit</code> - if INCLUSIVE, includes the normalized rank at the current index.
@@ -373,8 +419,7 @@ extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html
<pre class="methodSignature">public long getWeight()</pre>
<div class="block">Gets the weight contribution of the item at the current index.
- <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 weight contribution of the item at the current index.</dd>
diff --git a/docs/master/org/apache/datasketches/quantilescommon/class-use/QuantileSearchCriteria.html b/docs/master/org/apache/datasketches/quantilescommon/class-use/QuantileSearchCriteria.html
index 49aa4c27..77525a8c 100644
--- a/docs/master/org/apache/datasketches/quantilescommon/class-use/QuantileSearchCriteria.html
+++ b/docs/master/org/apache/datasketches/quantilescommon/class-use/QuantileSearchCriteria.html
@@ -729,6 +729,14 @@ the order they are declared.</div>
</td>
</tr>
<tr class="rowColor">
+<td class="colFirst"><code><a href="../GenericSortedViewIterator.html" title="type parameter in GenericSortedViewIterator">T</a></code></td>
+<th class="colSecond" scope="row"><span class="typeNameLabel">GenericSortedViewIterator.</span><code><span class="memberNameLink"><a href="../GenericSortedViewIterator.html#getQuantile(org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getQuantile</a></span>​(<a href="../QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> 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>
+<tr class="altColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">QuantilesDoublesAPI.</span><code><span class="memberNameLink"><a href="../QuantilesDoublesAPI.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getQuantile</a></span>​(double rank,
<a href="../QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></th>
@@ -736,7 +744,7 @@ the order they are declared.</div>
<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>float</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">QuantilesFloatsAPI.</span><code><span class="memberNameLink"><a href="../QuantilesFloatsAPI.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getQuantile</a></span>​(double rank,
<a href="../QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></th>
@@ -744,7 +752,7 @@ the order they are declared.</div>
<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code><a href="../QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a></code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">QuantilesGenericAPI.</span><code><span class="memberNameLink"><a href="../QuantilesGenericAPI.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getQuantile</a></span>​(double rank,
<a href="../QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></th>
@@ -752,7 +760,7 @@ the order they are declared.</div>
<div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>double[]</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">QuantilesDoublesAPI.</span><code><span class="memberNameLink"><a href="../QuantilesDoublesAPI.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getQuantiles</a></span>​(double[] ranks,
<a href="../QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></th>
@@ -760,7 +768,7 @@ the order they are declared.</div>
<div class="block">Gets an array of quantiles from the given array of normalized ranks.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>float[]</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">QuantilesFloatsAPI.</span><code><span class="memberNameLink"><a href="../QuantilesFloatsAPI.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getQuantiles</a></span>​(double[] ranks,
<a href="../QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></th>
@@ -768,7 +776,7 @@ the order they are declared.</div>
<div class="block">Gets an array of quantiles from the given array of normalized ranks.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code><a href="../QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a>[]</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">QuantilesGenericAPI.</span><code><span class="memberNameLink"><a href="../QuantilesGenericAPI.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getQuantiles</a></span>​(double[] ranks,
<a href="../QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></th>
@@ -776,7 +784,7 @@ the order they are declared.</div>
<div class="block">Gets an array of quantiles from the given array of normalized ranks.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">DoublesSortedView.</span><code><span class="memberNameLink"><a href="../DoublesSortedView.html#getRank(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getRank</a></span>​(double quantile,
<a href="../QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></th>
@@ -784,7 +792,7 @@ the order they are declared.</div>
<div class="block">Gets the normalized rank corresponding to the given a quantile.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">FloatsSortedView.</span><code><span class="memberNameLink"><a href="../FloatsSortedView.html#getRank(float,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getRank</a></span>​(float quantile,
<a href="../QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></th>
@@ -792,7 +800,7 @@ the order they are declared.</div>
<div class="block">Gets the normalized rank corresponding to the given a quantile.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">GenericSortedView.</span><code><span class="memberNameLink"><a href="../GenericSortedView.html#getRank(T,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getRank</a></span>​(<a href="../GenericSortedView.html" title="type parameter in GenericSortedView">T</a> quantile,
<a href="../QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></th>
@@ -800,7 +808,7 @@ the order they are declared.</div>
<div class="block">Gets the normalized rank corresponding to the given a quantile.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">QuantilesDoublesAPI.</span><code><span class="memberNameLink"><a href="../QuantilesDoublesAPI.html#getRank(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getRank</a></span>​(double quantile,
<a href="../QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></th>
@@ -808,7 +816,7 @@ the order they are declared.</div>
<div class="block">Gets the normalized rank corresponding to the given a quantile.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">QuantilesFloatsAPI.</span><code><span class="memberNameLink"><a href="../QuantilesFloatsAPI.html#getRank(float,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getRank</a></span>​(float quantile,
<a href="../QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></th>
@@ -816,7 +824,7 @@ the order they are declared.</div>
<div class="block">Gets the normalized rank corresponding to the given a quantile.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">QuantilesGenericAPI.</span><code><span class="memberNameLink"><a href="../QuantilesGenericAPI.html#getRank(T,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getRank</a></span>​(<a href="../QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a> quantile,
<a href="../QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></th>
@@ -824,7 +832,7 @@ the order they are declared.</div>
<div class="block">Gets the normalized rank corresponding to the given a quantile.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>double[]</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">QuantilesDoublesAPI.</span><code><span class="memberNameLink"><a href="../QuantilesDoublesAPI.html#getRanks(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getRanks</a></span>​(double[] quantiles,
<a href="../QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></th>
@@ -833,7 +841,7 @@ the order they are declared.</div>
search criterion.</div>
</td>
</tr>
-<tr class="altColor">
+<tr class="rowColor">
<td class="colFirst"><code>double[]</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">QuantilesFloatsAPI.</span><code><span class="memberNameLink"><a href="../QuantilesFloatsAPI.html#getRanks(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getRanks</a></span>​(float[] quantiles,
<a href="../QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></th>
@@ -842,7 +850,7 @@ the order they are declared.</div>
search criterion.</div>
</td>
</tr>
-<tr class="rowColor">
+<tr class="altColor">
<td class="colFirst"><code>double[]</code></td>
<th class="colSecond" scope="row"><span class="typeNameLabel">QuantilesGenericAPI.</span><code><span class="memberNameLink"><a href="../QuantilesGenericAPI.html#getRanks(T%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getRanks</a></span>​(<a href="../QuantilesGenericAPI.html" title="type parameter in QuantilesGenericAPI">T</a>[] quantiles,
<a href="../QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></th>
diff --git a/docs/master/package-search-index.zip b/docs/master/package-search-index.zip
index 047cc39f..d426db10 100644
Binary files a/docs/master/package-search-index.zip and b/docs/master/package-search-index.zip differ
diff --git a/docs/master/type-search-index.zip b/docs/master/type-search-index.zip
index f65a45c4..ff3cd158 100644
Binary files a/docs/master/type-search-index.zip and b/docs/master/type-search-index.zip differ
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datasketches.apache.org
For additional commands, e-mail: commits-help@datasketches.apache.org