Deploying to gh-pages from @ 30fa37e 🚀

docs/master/allclasses.html

@@ -134,7 +134,6 @@ <h1 class="bar">All&nbsp;Classes</h1>
 <li><a href="org/apache/datasketches/cpc/MergingValidation.html" title="class in org.apache.datasketches.cpc">MergingValidation</a></li>
 <li><a href="org/apache/datasketches/hash/MurmurHash3.html" title="class in org.apache.datasketches.hash">MurmurHash3</a></li>
 <li><a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html" title="class in org.apache.datasketches.hash">MurmurHash3Adaptor</a></li>
-<li><a href="org/apache/datasketches/quantilescommon/PartitionBoundaries.html" title="interface in org.apache.datasketches.quantilescommon"><span class="interfaceName">PartitionBoundaries</span></a></li>
 <li><a href="org/apache/datasketches/partitions/Partitioner.html" title="class in org.apache.datasketches.partitions">Partitioner</a></li>
 <li><a href="org/apache/datasketches/partitions/Partitioner.PartitionBoundsRow.html" title="class in org.apache.datasketches.partitions">Partitioner.PartitionBoundsRow</a></li>
 <li><a href="org/apache/datasketches/partitions/Partitioner.StackElement.html" title="class in org.apache.datasketches.partitions">Partitioner.StackElement</a></li>
@@ -180,6 +179,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
 <li><a href="org/apache/datasketches/common/SketchesReadOnlyException.html" title="class in org.apache.datasketches.common">SketchesReadOnlyException</a></li>
 <li><a href="org/apache/datasketches/common/SketchesStateException.html" title="class in org.apache.datasketches.common">SketchesStateException</a></li>
 <li><a href="org/apache/datasketches/partitions/SketchFillRequest.html" title="interface in org.apache.datasketches.partitions"><span class="interfaceName">SketchFillRequest</span></a></li>
+<li><a href="org/apache/datasketches/quantilescommon/SketchPartitionLimits.html" title="interface in org.apache.datasketches.quantilescommon"><span class="interfaceName">SketchPartitionLimits</span></a></li>
 <li><a href="org/apache/datasketches/tdigest/Sort.html" title="class in org.apache.datasketches.tdigest">Sort</a></li>
 <li><a href="org/apache/datasketches/quantilescommon/SortedView.html" title="interface in org.apache.datasketches.quantilescommon"><span class="interfaceName">SortedView</span></a></li>
 <li><a href="org/apache/datasketches/quantilescommon/SortedViewIterator.html" title="class in org.apache.datasketches.quantilescommon">SortedViewIterator</a></li>

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

@@ -131,15 +131,11 @@ <h2 title="Class GenericPartitionBoundaries" class="title">Class GenericPartitio
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
-<dl>
-<dt>All Implemented Interfaces:</dt>
-<dd><code><a href="PartitionBoundaries.html" title="interface in org.apache.datasketches.quantilescommon">PartitionBoundaries</a></code></dd>
-</dl>
 <hr>
 <pre>public final class <span class="typeNameLabel">GenericPartitionBoundaries&lt;T&gt;</span>
-extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>
-implements <a href="PartitionBoundaries.html" title="interface in org.apache.datasketches.quantilescommon">PartitionBoundaries</a></pre>
-<div class="block">Implements PartitionBoundaries</div>
+extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></pre>
+<div class="block">This defines the returned results of the getParitionBoundaries() function and
+ includes the basic methods needed to construct actual partitions.</div>
 </li>
 </ul>
 </div>
@@ -310,11 +306,8 @@ <h3>Method Detail</h3>
 <li class="blockList">
 <h4>getN</h4>
 <pre class="methodSignature">public&nbsp;long&nbsp;getN()</pre>
-<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="PartitionBoundaries.html#getN()">PartitionBoundaries</a></code></span></div>
 <div class="block">Gets the length of the input stream offered to the underlying sketch.</div>
 <dl>
-<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
-<dd><code><a href="PartitionBoundaries.html#getN()">getN</a></code>&nbsp;in interface&nbsp;<code><a href="PartitionBoundaries.html" title="interface in org.apache.datasketches.quantilescommon">PartitionBoundaries</a></code></dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the length of the input stream offered to the underlying sketch.</dd>
 </dl>
@@ -364,12 +357,9 @@ <h4>getBoundaries</h4>
 <li class="blockList">
 <h4>getNaturalRanks</h4>
 <pre class="methodSignature">public&nbsp;long[]&nbsp;getNaturalRanks()</pre>
-<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="PartitionBoundaries.html#getNaturalRanks()">PartitionBoundaries</a></code></span></div>
 <div class="block">Gets an ordered array of natural ranks of the associated array of partition boundaries utilizing
  a specified search criterion. Natural ranks are integral values on the interval [1, N]</div>
 <dl>
-<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
-<dd><code><a href="PartitionBoundaries.html#getNaturalRanks()">getNaturalRanks</a></code>&nbsp;in interface&nbsp;<code><a href="PartitionBoundaries.html" title="interface in org.apache.datasketches.quantilescommon">PartitionBoundaries</a></code></dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>an array of natural ranks.</dd>
 </dl>
@@ -382,12 +372,9 @@ <h4>getNaturalRanks</h4>
 <li class="blockList">
 <h4>getNormalizedRanks</h4>
 <pre class="methodSignature">public&nbsp;double[]&nbsp;getNormalizedRanks()</pre>
-<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="PartitionBoundaries.html#getNormalizedRanks()">PartitionBoundaries</a></code></span></div>
 <div class="block">Gets an ordered array of normalized ranks of the associated array of partition boundaries utilizing
  a specified search criterion. Normalized ranks are double values on the interval [0.0, 1.0].</div>
 <dl>
-<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
-<dd><code><a href="PartitionBoundaries.html#getNormalizedRanks()">getNormalizedRanks</a></code>&nbsp;in interface&nbsp;<code><a href="PartitionBoundaries.html" title="interface in org.apache.datasketches.quantilescommon">PartitionBoundaries</a></code></dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>an array of normalized ranks.</dd>
 </dl>
@@ -400,13 +387,10 @@ <h4>getNormalizedRanks</h4>
 <li class="blockList">
 <h4>getNumDeltaItems</h4>
 <pre class="methodSignature">public&nbsp;long[]&nbsp;getNumDeltaItems()</pre>
-<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="PartitionBoundaries.html#getNumDeltaItems()">PartitionBoundaries</a></code></span></div>
 <div class="block">Gets the number of items to be included for each partition as an array.
  The count at index 0 is 0.  The number of items included in the first partition, defined by the boundaries at
  index 0 and index 1, is at index 1 in this array, etc.</div>
 <dl>
-<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
-<dd><code><a href="PartitionBoundaries.html#getNumDeltaItems()">getNumDeltaItems</a></code>&nbsp;in interface&nbsp;<code><a href="PartitionBoundaries.html" title="interface in org.apache.datasketches.quantilescommon">PartitionBoundaries</a></code></dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the number of items to be included for each partition as an array.</dd>
 </dl>
@@ -419,11 +403,8 @@ <h4>getNumDeltaItems</h4>
 <li class="blockList">
 <h4>getNumPartitions</h4>
 <pre class="methodSignature">public&nbsp;int&nbsp;getNumPartitions()</pre>
-<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="PartitionBoundaries.html#getNumPartitions()">PartitionBoundaries</a></code></span></div>
 <div class="block">Gets the number of partitions</div>
 <dl>
-<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
-<dd><code><a href="PartitionBoundaries.html#getNumPartitions()">getNumPartitions</a></code>&nbsp;in interface&nbsp;<code><a href="PartitionBoundaries.html" title="interface in org.apache.datasketches.quantilescommon">PartitionBoundaries</a></code></dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the number of partitions</dd>
 </dl>
@@ -470,11 +451,8 @@ <h4>getMinItem</h4>
 <li class="blockList">
 <h4>getSearchCriteria</h4>
 <pre class="methodSignature">public&nbsp;<a href="QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a>&nbsp;getSearchCriteria()</pre>
-<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="PartitionBoundaries.html#getSearchCriteria()">PartitionBoundaries</a></code></span></div>
 <div class="block">Gets the search criteria specified for the source sketch</div>
 <dl>
-<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
-<dd><code><a href="PartitionBoundaries.html#getSearchCriteria()">getSearchCriteria</a></code>&nbsp;in interface&nbsp;<code><a href="PartitionBoundaries.html" title="interface in org.apache.datasketches.quantilescommon">PartitionBoundaries</a></code></dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>The search criteria specified for the source sketch</dd>
 </dl>

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

@@ -129,15 +129,15 @@ <h2 title="Interface GenericSortedView" class="title">Interface GenericSortedVie
 </dl>
 <dl>
 <dt>All Superinterfaces:</dt>
-<dd><code><a href="PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a>&lt;T&gt;</code>, <code><a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></code></dd>
+<dd><code><a href="PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a>&lt;T&gt;</code>, <code><a href="SketchPartitionLimits.html" title="interface in org.apache.datasketches.quantilescommon">SketchPartitionLimits</a></code>, <code><a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></code></dd>
 </dl>
 <dl>
 <dt>All Known Implementing Classes:</dt>
 <dd><code><a href="ItemsSketchSortedView.html" title="class in org.apache.datasketches.quantilescommon">ItemsSketchSortedView</a></code></dd>
 </dl>
 <hr>
 <pre>public interface <span class="typeNameLabel">GenericSortedView&lt;T&gt;</span>
-extends <a href="PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a>&lt;T&gt;, <a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></pre>
+extends <a href="PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a>&lt;T&gt;, <a href="SketchPartitionLimits.html" title="interface in org.apache.datasketches.quantilescommon">SketchPartitionLimits</a>, <a href="SortedView.html" title="interface in org.apache.datasketches.quantilescommon">SortedView</a></pre>
 <div class="block">The Sorted View for quantiles of generic type.</div>
 <dl>
 <dt><span class="simpleTagLabel">Author:</span></dt>
@@ -243,7 +243,14 @@ <h3>Method Summary</h3>
 <!--   -->
 </a>
 <h3>Methods inherited from interface&nbsp;org.apache.datasketches.quantilescommon.<a href="PartitioningFeature.html" title="interface in org.apache.datasketches.quantilescommon">PartitioningFeature</a></h3>
-<code><a href="PartitioningFeature.html#getPartitionBoundaries(int)">getPartitionBoundaries</a>, <a href="PartitioningFeature.html#getPartitionBoundaries(int,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getPartitionBoundaries</a></code></li>
+<code><a href="PartitioningFeature.html#getPartitionBoundariesFromNumParts(int)">getPartitionBoundariesFromNumParts</a>, <a href="PartitioningFeature.html#getPartitionBoundariesFromNumParts(int,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getPartitionBoundariesFromNumParts</a>, <a href="PartitioningFeature.html#getPartitionBoundariesFromPartSize(long)">getPartitionBoundariesFromPartSize</a>, <a href="PartitioningFeature.html#getPartitionBoundariesFromPartSize(long,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getPartitionBoundariesFromPartSize</a></code></li>
+</ul>
+<ul class="blockList">
+<li class="blockList"><a id="methods.inherited.from.class.org.apache.datasketches.quantilescommon.SketchPartitionLimits">
+<!--   -->
+</a>
+<h3>Methods inherited from interface&nbsp;org.apache.datasketches.quantilescommon.<a href="SketchPartitionLimits.html" title="interface in org.apache.datasketches.quantilescommon">SketchPartitionLimits</a></h3>
+<code><a href="SketchPartitionLimits.html#getMaxPartitions()">getMaxPartitions</a>, <a href="SketchPartitionLimits.html#getMinPartitionSizeItems()">getMinPartitionSizeItems</a>, <a href="SketchPartitionLimits.html#getN()">getN</a></code></li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a id="methods.inherited.from.class.org.apache.datasketches.quantilescommon.SortedView">