(datasketches-java) branch gh-pages updated: Deploying to gh-pages from @ apache/datasketches-java@33d8ad51504a5b2c43cbe28de33e91b3ed655005 🚀

Fri, 01 Nov 2024 13:57:09 -0700 

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 199ca44a Deploying to gh-pages from @ 
apache/datasketches-java@33d8ad51504a5b2c43cbe28de33e91b3ed655005 🚀
199ca44a is described below

commit 199ca44aa943ce0d363ad6fdac7d50867f8758f0
Author: AlexanderSaydakov <[email protected]>
AuthorDate: Fri Nov 1 20:56:10 2024 +0000

    Deploying to gh-pages from @ 
apache/datasketches-java@33d8ad51504a5b2c43cbe28de33e91b3ed655005 🚀
---
 docs/master/index-all.html                         |  12 ++-
 docs/master/member-search-index.js                 |   2 +-
 docs/master/member-search-index.zip                | Bin 18537 -> 18541 bytes
 .../quantilescommon/QuantilesDoublesAPI.html       |  32 ++++----
 .../apache/datasketches/tdigest/TDigestDouble.html |  89 +++++++++++++++++----
 .../org/apache/datasketches/theta/Sketch.html      |   2 +-
 .../org/apache/datasketches/theta/Sketches.html    |  12 +--
 docs/master/package-search-index.zip               | Bin 374 -> 374 bytes
 docs/master/type-search-index.zip                  | Bin 1768 -> 1768 bytes
 9 files changed, 110 insertions(+), 39 deletions(-)

diff --git a/docs/master/index-all.html b/docs/master/index-all.html
index 0a3540b7..daabe7a1 100644
--- a/docs/master/index-all.html
+++ b/docs/master/index-all.html
@@ -1708,6 +1708,11 @@ $('.navPadding').css('padding-top', 
$('.fixedNav').css("height"));
 <dd>
 <div class="block">This is equivalent to <a 
href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getCDF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getCDF(splitPoints,
 INCLUSIVE)</code></a></div>
 </dd>
+<dt><span class="memberNameLink"><a 
href="org/apache/datasketches/tdigest/TDigestDouble.html#getCDF(double%5B%5D)">getCDF(double[])</a></span>
 - Method in class org.apache.datasketches.tdigest.<a 
href="org/apache/datasketches/tdigest/TDigestDouble.html" title="class in 
org.apache.datasketches.tdigest">TDigestDouble</a></dt>
+<dd>
+<div class="block">Returns an approximation to the Cumulative Distribution 
Function (CDF), which is the
+ cumulative analog of the PMF, of the input stream given a set of split 
points.</div>
+</dd>
 <dt><span class="memberNameLink"><a 
href="org/apache/datasketches/kll/KllDoublesSketch.html#getCDF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getCDF(double[],
 QuantileSearchCriteria)</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>&nbsp;</dd>
 <dt><span class="memberNameLink"><a 
href="org/apache/datasketches/quantiles/DoublesSketch.html#getCDF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getCDF(double[],
 QuantileSearchCriteria)</a></span> - Method in class 
org.apache.datasketches.quantiles.<a 
href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in 
org.apache.datasketches.quantiles">DoublesSketch</a></dt>
@@ -1830,7 +1835,7 @@ $('.navPadding').css('padding-top', 
$('.fixedNav').css("height"));
 <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>
+ 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/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>
@@ -2857,6 +2862,11 @@ $('.navPadding').css('padding-top', 
$('.fixedNav').css("height"));
 <dd>
 <div class="block">This is equivalent to <a 
href="org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getPMF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"><code>getPMF(splitPoints,
 INCLUSIVE)</code></a></div>
 </dd>
+<dt><span class="memberNameLink"><a 
href="org/apache/datasketches/tdigest/TDigestDouble.html#getPMF(double%5B%5D)">getPMF(double[])</a></span>
 - Method in class org.apache.datasketches.tdigest.<a 
href="org/apache/datasketches/tdigest/TDigestDouble.html" title="class in 
org.apache.datasketches.tdigest">TDigestDouble</a></dt>
+<dd>
+<div class="block">Returns an approximation to the Probability Mass Function 
(PMF) of the input stream
+ given a set of split points.</div>
+</dd>
 <dt><span class="memberNameLink"><a 
href="org/apache/datasketches/kll/KllDoublesSketch.html#getPMF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getPMF(double[],
 QuantileSearchCriteria)</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>&nbsp;</dd>
 <dt><span class="memberNameLink"><a 
href="org/apache/datasketches/quantiles/DoublesSketch.html#getPMF(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getPMF(double[],
 QuantileSearchCriteria)</a></span> - Method in class 
org.apache.datasketches.quantiles.<a 
href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in 
org.apache.datasketches.quantiles">DoublesSketch</a></dt>
diff --git a/docs/master/member-search-index.js 
b/docs/master/member-search-index.js
index 82ea971e..0218b70f 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 755303ba..f3ab163f 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/quantilescommon/QuantilesDoublesAPI.html 
b/docs/master/org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html
index 3a4ee590..4ffbe7e2 100644
--- 
a/docs/master/org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html
+++ 
b/docs/master/org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html
@@ -376,7 +376,7 @@ extends <a href="QuantilesAPI.html" title="interface in 
org.apache.datasketches.
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>a discrete CDF array of m+1 double ranks (or cumulative probabilities) on 
the interval [0.0, 1.0].</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
-<dd><code><a 
href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true";
 title="class or interface in java.lang" 
class="externalLink">IllegalArgumentException</a></code> - if sketch is 
empty.</dd>
+<dd><code><a href="../common/SketchesArgumentException.html" title="class in 
org.apache.datasketches.common">SketchesArgumentException</a></code> - if 
sketch is empty.</dd>
 </dl>
 </li>
 </ul>
@@ -420,7 +420,7 @@ extends <a href="QuantilesAPI.html" title="interface in 
org.apache.datasketches.
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>a discrete CDF array of m+1 double ranks (or cumulative probabilities) on 
the interval [0.0, 1.0].</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
-<dd><code><a 
href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true";
 title="class or interface in java.lang" 
class="externalLink">IllegalArgumentException</a></code> - if sketch is 
empty.</dd>
+<dd><code><a href="../common/SketchesArgumentException.html" title="class in 
org.apache.datasketches.common">SketchesArgumentException</a></code> - if 
sketch is empty.</dd>
 </dl>
 </li>
 </ul>
@@ -437,7 +437,7 @@ extends <a href="QuantilesAPI.html" title="interface in 
org.apache.datasketches.
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the maximum item of the stream</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
-<dd><code><a 
href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true";
 title="class or interface in java.lang" 
class="externalLink">IllegalArgumentException</a></code> - if sketch is 
empty.</dd>
+<dd><code><a href="../common/SketchesArgumentException.html" title="class in 
org.apache.datasketches.common">SketchesArgumentException</a></code> - if 
sketch is empty.</dd>
 </dl>
 </li>
 </ul>
@@ -454,7 +454,7 @@ extends <a href="QuantilesAPI.html" title="interface in 
org.apache.datasketches.
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the minimum item of the stream</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
-<dd><code><a 
href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true";
 title="class or interface in java.lang" 
class="externalLink">IllegalArgumentException</a></code> - if sketch is 
empty.</dd>
+<dd><code><a href="../common/SketchesArgumentException.html" title="class in 
org.apache.datasketches.common">SketchesArgumentException</a></code> - if 
sketch is empty.</dd>
 </dl>
 </li>
 </ul>
@@ -472,7 +472,7 @@ extends <a href="QuantilesAPI.html" title="interface in 
org.apache.datasketches.
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>a PMF array of m+1 probability masses as doubles on the interval [0.0, 
1.0].</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
-<dd><code><a 
href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true";
 title="class or interface in java.lang" 
class="externalLink">IllegalArgumentException</a></code> - if sketch is 
empty.</dd>
+<dd><code><a href="../common/SketchesArgumentException.html" title="class in 
org.apache.datasketches.common">SketchesArgumentException</a></code> - if 
sketch is empty.</dd>
 </dl>
 </li>
 </ul>
@@ -523,7 +523,7 @@ extends <a href="QuantilesAPI.html" title="interface in 
org.apache.datasketches.
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>a PMF array of m+1 probability masses as doubles on the interval [0.0, 
1.0].</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
-<dd><code><a 
href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true";
 title="class or interface in java.lang" 
class="externalLink">IllegalArgumentException</a></code> - if sketch is 
empty.</dd>
+<dd><code><a href="../common/SketchesArgumentException.html" title="class in 
org.apache.datasketches.common">SketchesArgumentException</a></code> - if 
sketch is empty.</dd>
 </dl>
 </li>
 </ul>
@@ -541,7 +541,7 @@ extends <a href="QuantilesAPI.html" title="interface in 
org.apache.datasketches.
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the approximate quantile given the normalized rank.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
-<dd><code><a 
href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true";
 title="class or interface in java.lang" 
class="externalLink">IllegalArgumentException</a></code> - if sketch is 
empty.</dd>
+<dd><code><a href="../common/SketchesArgumentException.html" title="class in 
org.apache.datasketches.common">SketchesArgumentException</a></code> - if 
sketch is empty.</dd>
 </dl>
 </li>
 </ul>
@@ -564,7 +564,7 @@ extends <a href="QuantilesAPI.html" title="interface in 
org.apache.datasketches.
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the approximate quantile given the normalized rank.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
-<dd><code><a 
href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true";
 title="class or interface in java.lang" 
class="externalLink">IllegalArgumentException</a></code> - if sketch is 
empty.</dd>
+<dd><code><a href="../common/SketchesArgumentException.html" title="class in 
org.apache.datasketches.common">SketchesArgumentException</a></code> - if 
sketch is empty.</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="QuantileSearchCriteria.html" title="enum in 
org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></dd>
 </dl>
@@ -591,7 +591,7 @@ extends <a href="QuantilesAPI.html" title="interface in 
org.apache.datasketches.
 <dd>the lower bound of the quantile confidence interval in which the quantile 
of the
  given rank exists.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
-<dd><code><a 
href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true";
 title="class or interface in java.lang" 
class="externalLink">IllegalArgumentException</a></code> - if sketch is 
empty.</dd>
+<dd><code><a href="../common/SketchesArgumentException.html" title="class in 
org.apache.datasketches.common">SketchesArgumentException</a></code> - if 
sketch is empty.</dd>
 </dl>
 </li>
 </ul>
@@ -616,7 +616,7 @@ extends <a href="QuantilesAPI.html" title="interface in 
org.apache.datasketches.
 <dd>the upper bound of the quantile confidence interval in which the true 
quantile of the
  given rank exists.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
-<dd><code><a 
href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true";
 title="class or interface in java.lang" 
class="externalLink">IllegalArgumentException</a></code> - if sketch is 
empty.</dd>
+<dd><code><a href="../common/SketchesArgumentException.html" title="class in 
org.apache.datasketches.common">SketchesArgumentException</a></code> - if 
sketch is empty.</dd>
 </dl>
 </li>
 </ul>
@@ -635,7 +635,7 @@ extends <a href="QuantilesAPI.html" title="interface in 
org.apache.datasketches.
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>an array of quantiles corresponding to the given array of normalized 
ranks.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
-<dd><code><a 
href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true";
 title="class or interface in java.lang" 
class="externalLink">IllegalArgumentException</a></code> - if sketch is 
empty.</dd>
+<dd><code><a href="../common/SketchesArgumentException.html" title="class in 
org.apache.datasketches.common">SketchesArgumentException</a></code> - if 
sketch is empty.</dd>
 </dl>
 </li>
 </ul>
@@ -657,7 +657,7 @@ extends <a href="QuantilesAPI.html" title="interface in 
org.apache.datasketches.
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>an array of quantiles corresponding to the given array of normalized 
ranks.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
-<dd><code><a 
href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true";
 title="class or interface in java.lang" 
class="externalLink">IllegalArgumentException</a></code> - if sketch is 
empty.</dd>
+<dd><code><a href="../common/SketchesArgumentException.html" title="class in 
org.apache.datasketches.common">SketchesArgumentException</a></code> - if 
sketch is empty.</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="QuantileSearchCriteria.html" title="enum in 
org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></dd>
 </dl>
@@ -677,7 +677,7 @@ extends <a href="QuantilesAPI.html" title="interface in 
org.apache.datasketches.
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the normalized rank corresponding to the given quantile</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
-<dd><code><a 
href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true";
 title="class or interface in java.lang" 
class="externalLink">IllegalArgumentException</a></code> - if sketch is 
empty.</dd>
+<dd><code><a href="../common/SketchesArgumentException.html" title="class in 
org.apache.datasketches.common">SketchesArgumentException</a></code> - if 
sketch is empty.</dd>
 </dl>
 </li>
 </ul>
@@ -697,7 +697,7 @@ extends <a href="QuantilesAPI.html" title="interface in 
org.apache.datasketches.
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the normalized rank corresponding to the given quantile</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
-<dd><code><a 
href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true";
 title="class or interface in java.lang" 
class="externalLink">IllegalArgumentException</a></code> - if sketch is 
empty.</dd>
+<dd><code><a href="../common/SketchesArgumentException.html" title="class in 
org.apache.datasketches.common">SketchesArgumentException</a></code> - if 
sketch is empty.</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="QuantileSearchCriteria.html" title="enum in 
org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></dd>
 </dl>
@@ -717,7 +717,7 @@ extends <a href="QuantilesAPI.html" title="interface in 
org.apache.datasketches.
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>an array of normalized ranks corresponding to the given array of 
quantiles.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
-<dd><code><a 
href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true";
 title="class or interface in java.lang" 
class="externalLink">IllegalArgumentException</a></code> - if sketch is 
empty.</dd>
+<dd><code><a href="../common/SketchesArgumentException.html" title="class in 
org.apache.datasketches.common">SketchesArgumentException</a></code> - if 
sketch is empty.</dd>
 </dl>
 </li>
 </ul>
@@ -738,7 +738,7 @@ extends <a href="QuantilesAPI.html" title="interface in 
org.apache.datasketches.
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>an array of normalized ranks corresponding to the given array of 
quantiles.</dd>
 <dt><span class="throwsLabel">Throws:</span></dt>
-<dd><code><a 
href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true";
 title="class or interface in java.lang" 
class="externalLink">IllegalArgumentException</a></code> - if sketch is 
empty.</dd>
+<dd><code><a href="../common/SketchesArgumentException.html" title="class in 
org.apache.datasketches.common">SketchesArgumentException</a></code> - if 
sketch is empty.</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="QuantileSearchCriteria.html" title="enum in 
org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></dd>
 </dl>
diff --git a/docs/master/org/apache/datasketches/tdigest/TDigestDouble.html 
b/docs/master/org/apache/datasketches/tdigest/TDigestDouble.html
index f77309db..ff03136a 100644
--- a/docs/master/org/apache/datasketches/tdigest/TDigestDouble.html
+++ b/docs/master/org/apache/datasketches/tdigest/TDigestDouble.html
@@ -27,7 +27,7 @@
     catch(err) {
     }
 //-->
-var data = 
{"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":9,"i8":9,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10};
+var data = 
{"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":9,"i10":9,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10};
 var tabs = {65535:["t0","All Methods"],1:["t1","Static 
Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
 var altColor = "altColor";
 var rowColor = "rowColor";
@@ -222,47 +222,63 @@ extends <a 
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html
 </td>
 </tr>
 <tr id="i1" class="rowColor">
+<td class="colFirst"><code>double[]</code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a 
href="#getCDF(double%5B%5D)">getCDF</a></span>&#8203;(double[]&nbsp;splitPoints)</code></th>
+<td class="colLast">
+<div class="block">Returns an approximation to the Cumulative Distribution 
Function (CDF), which is the
+ cumulative analog of the PMF, of the input stream given a set of split 
points.</div>
+</td>
+</tr>
+<tr id="i2" class="altColor">
 <td class="colFirst"><code>short</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a 
href="#getK()">getK</a></span>()</code></th>
 <td class="colLast">&nbsp;</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="#getMaxValue()">getMaxValue</a></span>()</code></th>
 <td class="colLast">&nbsp;</td>
 </tr>
-<tr id="i3" class="rowColor">
+<tr id="i4" class="altColor">
 <td class="colFirst"><code>double</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a 
href="#getMinValue()">getMinValue</a></span>()</code></th>
 <td class="colLast">&nbsp;</td>
 </tr>
-<tr id="i4" class="altColor">
+<tr id="i5" class="rowColor">
+<td class="colFirst"><code>double[]</code></td>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a 
href="#getPMF(double%5B%5D)">getPMF</a></span>&#8203;(double[]&nbsp;splitPoints)</code></th>
+<td class="colLast">
+<div class="block">Returns an approximation to the Probability Mass Function 
(PMF) of the input stream
+ given a set of split points.</div>
+</td>
+</tr>
+<tr id="i6" class="altColor">
 <td class="colFirst"><code>double</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a 
href="#getQuantile(double)">getQuantile</a></span>&#8203;(double&nbsp;rank)</code></th>
 <td class="colLast">
 <div class="block">Compute approximate quantile value corresponding to the 
given normalized rank</div>
 </td>
 </tr>
-<tr id="i5" class="rowColor">
+<tr id="i7" class="rowColor">
 <td class="colFirst"><code>double</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a 
href="#getRank(double)">getRank</a></span>&#8203;(double&nbsp;value)</code></th>
 <td class="colLast">
 <div class="block">Compute approximate normalized rank of the given 
value.</div>
 </td>
 </tr>
-<tr id="i6" class="altColor">
+<tr id="i8" class="altColor">
 <td class="colFirst"><code>long</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a 
href="#getTotalWeight()">getTotalWeight</a></span>()</code></th>
 <td class="colLast">&nbsp;</td>
 </tr>
-<tr id="i7" class="rowColor">
+<tr id="i9" class="rowColor">
 <td class="colFirst"><code>static <a href="TDigestDouble.html" title="class in 
org.apache.datasketches.tdigest">TDigestDouble</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a 
href="#heapify(org.apache.datasketches.memory.Memory)">heapify</a></span>&#8203;(org.apache.datasketches.memory.Memory&nbsp;mem)</code></th>
 <td class="colLast">
 <div class="block">Deserialize TDigest from a given memory.</div>
 </td>
 </tr>
-<tr id="i8" class="altColor">
+<tr id="i10" class="altColor">
 <td class="colFirst"><code>static <a href="TDigestDouble.html" title="class in 
org.apache.datasketches.tdigest">TDigestDouble</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a 
href="#heapify(org.apache.datasketches.memory.Memory,boolean)">heapify</a></span>&#8203;(org.apache.datasketches.memory.Memory&nbsp;mem,
        boolean&nbsp;isFloat)</code></th>
@@ -270,40 +286,40 @@ extends <a 
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html
 <div class="block">Deserialize TDigest from a given memory.</div>
 </td>
 </tr>
-<tr id="i9" class="rowColor">
+<tr id="i11" class="rowColor">
 <td class="colFirst"><code>boolean</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a 
href="#isEmpty()">isEmpty</a></span>()</code></th>
 <td class="colLast">&nbsp;</td>
 </tr>
-<tr id="i10" class="altColor">
+<tr id="i12" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a 
href="#merge(org.apache.datasketches.tdigest.TDigestDouble)">merge</a></span>&#8203;(<a
 href="TDigestDouble.html" title="class in 
org.apache.datasketches.tdigest">TDigestDouble</a>&nbsp;other)</code></th>
 <td class="colLast">
 <div class="block">Merge the given TDigest into this one</div>
 </td>
 </tr>
-<tr id="i11" class="rowColor">
+<tr id="i13" 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>
 <td class="colLast">
 <div class="block">Serialize this TDigest to a byte array form.</div>
 </td>
 </tr>
-<tr id="i12" class="altColor">
+<tr id="i14" class="altColor">
 <td class="colFirst"><code><a 
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
 title="class or interface in java.lang" 
class="externalLink">String</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a 
href="#toString()">toString</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Human-readable summary of this TDigest as a string</div>
 </td>
 </tr>
-<tr id="i13" class="rowColor">
+<tr id="i15" class="rowColor">
 <td class="colFirst"><code><a 
href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true";
 title="class or interface in java.lang" 
class="externalLink">String</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a 
href="#toString(boolean)">toString</a></span>&#8203;(boolean&nbsp;printCentroids)</code></th>
 <td class="colLast">
 <div class="block">Human-readable summary of this TDigest as a string</div>
 </td>
 </tr>
-<tr id="i14" class="altColor">
+<tr id="i16" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a 
href="#update(double)">update</a></span>&#8203;(double&nbsp;value)</code></th>
 <td class="colLast">
@@ -527,6 +543,51 @@ extends <a 
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html
 </dl>
 </li>
 </ul>
+<a id="getPMF(double[])">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getPMF</h4>
+<pre 
class="methodSignature">public&nbsp;double[]&nbsp;getPMF&#8203;(double[]&nbsp;splitPoints)</pre>
+<div class="block">Returns an approximation to the Probability Mass Function 
(PMF) of the input stream
+ given a set of split points.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>splitPoints</code> - an array of <i>m</i> unique, monotonically 
increasing values
+ that divide the input domain into <i>m+1</i> consecutive disjoint intervals 
(bins).</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>an array of m+1 doubles each of which is an approximation
+ to the fraction of the input stream values (the mass) that fall into one of 
those intervals.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="../common/SketchesStateException.html" title="class in 
org.apache.datasketches.common">SketchesStateException</a></code> - if sketch 
is empty.</dd>
+</dl>
+</li>
+</ul>
+<a id="getCDF(double[])">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getCDF</h4>
+<pre 
class="methodSignature">public&nbsp;double[]&nbsp;getCDF&#8203;(double[]&nbsp;splitPoints)</pre>
+<div class="block">Returns an approximation to the Cumulative Distribution 
Function (CDF), which is the
+ cumulative analog of the PMF, of the input stream given a set of split 
points.</div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>splitPoints</code> - an array of <i>m</i> unique, monotonically 
increasing values
+ that divide the input domain into <i>m+1</i> consecutive disjoint 
intervals.</dd>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>an array of m+1 doubles, which are a consecutive approximation to the CDF
+ of the input stream given the splitPoints. The value at array position j of 
the returned
+ CDF array is the sum of the returned values in positions 0 through j of the 
returned PMF
+ array. This can be viewed as array of ranks of the given split points plus 
one more value
+ that is always 1.</dd>
+<dt><span class="throwsLabel">Throws:</span></dt>
+<dd><code><a href="../common/SketchesStateException.html" title="class in 
org.apache.datasketches.common">SketchesStateException</a></code> - if sketch 
is empty.</dd>
+</dl>
+</li>
+</ul>
 <a id="toByteArray()">
 <!--   -->
 </a>
diff --git a/docs/master/org/apache/datasketches/theta/Sketch.html 
b/docs/master/org/apache/datasketches/theta/Sketch.html
index d19e0ade..bfef902b 100644
--- a/docs/master/org/apache/datasketches/theta/Sketch.html
+++ b/docs/master/org/apache/datasketches/theta/Sketch.html
@@ -733,7 +733,7 @@ implements <a href="../common/MemoryStatus.html" 
title="interface in org.apache.
 <dd><code>lgNomEntries</code> - <a 
href="../../../../resources/dictionary.html#nomEntries">Nominal Entries</a></dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the maximum number of storage bytes required for a CompactSketch with the 
given
- nomEntries.</dd>
+ lgNomEntries.</dd>
 </dl>
 </li>
 </ul>
diff --git a/docs/master/org/apache/datasketches/theta/Sketches.html 
b/docs/master/org/apache/datasketches/theta/Sketches.html
index c44d0c6d..d1c708fc 100644
--- a/docs/master/org/apache/datasketches/theta/Sketches.html
+++ b/docs/master/org/apache/datasketches/theta/Sketches.html
@@ -162,10 +162,10 @@ extends <a 
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html
 </tr>
 <tr id="i0" class="altColor">
 <td class="colFirst"><code>static int</code></td>
-<th class="colSecond" scope="row"><code><span class="memberNameLink"><a 
href="#getCompactSketchMaxBytes(int)">getCompactSketchMaxBytes</a></span>&#8203;(int&nbsp;nomEntries)</code></th>
+<th class="colSecond" scope="row"><code><span class="memberNameLink"><a 
href="#getCompactSketchMaxBytes(int)">getCompactSketchMaxBytes</a></span>&#8203;(int&nbsp;lgNomEntries)</code></th>
 <td class="colLast">
 <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>
+ log_base2 of the number of nominal entries, which is a power of 2.</div>
 </td>
 </tr>
 <tr id="i1" class="rowColor">
@@ -515,15 +515,15 @@ extends <a 
href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html
 <ul class="blockList">
 <li class="blockList">
 <h4>getCompactSketchMaxBytes</h4>
-<pre class="methodSignature">public 
static&nbsp;int&nbsp;getCompactSketchMaxBytes&#8203;(int&nbsp;nomEntries)</pre>
+<pre class="methodSignature">public 
static&nbsp;int&nbsp;getCompactSketchMaxBytes&#8203;(int&nbsp;lgNomEntries)</pre>
 <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>
+ log_base2 of the number of nominal entries, which is a power of 2.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
-<dd><code>nomEntries</code> - <a 
href="../../../../resources/dictionary.html#nomEntries">Nominal Entries</a></dd>
+<dd><code>lgNomEntries</code> - <a 
href="../../../../resources/dictionary.html#nomEntries">Nominal Entries</a></dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the maximum number of storage bytes required for a CompactSketch with the 
given
- nomEntries.</dd>
+ lgNomEntries.</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a 
href="Sketch.html#getCompactSketchMaxBytes(int)"><code>Sketch.getCompactSketchMaxBytes(int)</code></a></dd>
 </dl>
diff --git a/docs/master/package-search-index.zip 
b/docs/master/package-search-index.zip
index 8a36bd13..d5c808a3 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 5ec2ba4a..d93f601f 100644
Binary files a/docs/master/type-search-index.zip and 
b/docs/master/type-search-index.zip differ


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to