Deploying to gh-pages from @ 33d8ad5 🚀

docs/master/index-all.html

@@ -1708,6 +1708,11 @@ <h2 class="title">G</h2>
 <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 @@ <h2 class="title">G</h2>
 <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 @@ <h2 class="title">G</h2>
 <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>

docs/master/org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html

@@ -376,7 +376,7 @@ <h4>getCDF</h4>
 <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 @@ <h4>getCDF</h4>
 <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 @@ <h4>getMaxItem</h4>
 <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 @@ <h4>getMinItem</h4>
 <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 @@ <h4>getPMF</h4>
 <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 @@ <h4>getPMF</h4>
 <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 @@ <h4>getQuantile</h4>
 <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 @@ <h4>getQuantile</h4>
 <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 @@ <h4>getQuantileLowerBound</h4>
 <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 @@ <h4>getQuantileUpperBound</h4>
 <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 @@ <h4>getQuantiles</h4>
 <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 @@ <h4>getQuantiles</h4>
 <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 @@ <h4>getRank</h4>
 <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 @@ <h4>getRank</h4>
 <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 @@ <h4>getRanks</h4>
 <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 @@ <h4>getRanks</h4>
 <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>