api/java/snapshot/apidocs/org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html - datasketches-website - Git at Google

 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 <!-- NewPage -->
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <title>QuantilesDoublesAPI (datasketches-java 4.1.0 API)</title>
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
             parent.document.title="QuantilesDoublesAPI (datasketches-java 4.1.0 API)";
         }
     }
     catch(err) {
     }
 //-->
 var methods = {"i0":18,"i1":6,"i2":6,"i3":6,"i4":18,"i5":6,"i6":18,"i7":6,"i8":18,"i9":6,"i10":6,"i11":18,"i12":6,"i13":6,"i14":18,"i15":6,"i16":18,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6};
 var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]};
 var altColor = "altColor";
 var rowColor = "rowColor";
 var tableTab = "tableTab";
 var activeTableTab = "activeTableTab";
 </script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="topNav"><a name="navbar.top">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
 <a name="navbar.top.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../../overview-summary.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</li>
 <li><a href="class-use/QuantilesDoublesAPI.html">Use</a></li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../../index-all.html">Index</a></li>
 <li><a href="../../../../help-doc.html">Help</a></li>
 </ul>
 </div>
 <div class="subNav">
 <ul class="navList">
 <li><a href="../../../../org/apache/datasketches/quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.DoublesPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../index.html?org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html" target="_top">Frames</a></li>
 <li><a href="QuantilesDoublesAPI.html" target="_top">No&nbsp;Frames</a></li>
 </ul>
 <ul class="navList" id="allclasses_navbar_top">
 <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
 </ul>
 <div>
 <script type="text/javascript"><!--
   allClassesLink = document.getElementById("allclasses_navbar_top");
   if(window==top) {
     allClassesLink.style.display = "block";
   }
   else {
     allClassesLink.style.display = "none";
   }
   //-->
 </script>
 </div>
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</a></li>
 </ul>
 </div>
 <a name="skip.navbar.top">
 <!--   -->
 </a></div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 <!-- ======== START OF CLASS DATA ======== -->
 <div class="header">
 <div class="subTitle">org.apache.datasketches.quantilescommon</div>
 <h2 title="Interface QuantilesDoublesAPI" class="title">Interface QuantilesDoublesAPI</h2>
 </div>
 <div class="contentContainer">
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <dl>
 <dt>All Superinterfaces:</dt>
 <dd><a href="../../../../org/apache/datasketches/quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></dd>
 </dl>
 <dl>
 <dt>All Known Implementing Classes:</dt>
 <dd><a href="../../../../org/apache/datasketches/quantiles/CompactDoublesSketch.html" title="class in org.apache.datasketches.quantiles">CompactDoublesSketch</a>, <a href="../../../../org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a>, <a href="../../../../org/apache/datasketches/kll/KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a>, <a href="../../../../org/apache/datasketches/quantiles/UpdateDoublesSketch.html" title="class in org.apache.datasketches.quantiles">UpdateDoublesSketch</a></dd>
 </dl>
 <hr>
 <br>
 <pre>public interface <span class="typeNameLabel">QuantilesDoublesAPI</span>
 extends <a href="../../../../org/apache/datasketches/quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></pre>
 <div class="block">The Quantiles API for item type <i>double</i>.</div>
 <dl>
 <dt><span class="simpleTagLabel">Author:</span></dt>
 <dd>Lee Rhodes</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../org/apache/datasketches/quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon"><code>QuantilesAPI</code></a></dd>
 </dl>
 </li>
 </ul>
 </div>
 <div class="summary">
 <ul class="blockList">
 <li class="blockList">
 <!-- ======== NESTED CLASS SUMMARY ======== -->
 <ul class="blockList">
 <li class="blockList"><a name="nested.class.summary">
 <!--   -->
 </a>
 <h3>Nested Class Summary</h3>
 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
 <caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colLast" scope="col">Interface and Description</th>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>static class&nbsp;</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.DoublesPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI.DoublesPartitionBoundaries</a></span></code>
 <div class="block">This encapsulates the essential information needed to construct actual partitions and is returned from the
  <i>getPartitionBoundaries(int, QuantileSearchCritera)</i> method.</div>
 </td>
 </tr>
 </table>
 </li>
 </ul>
 <!-- ========== METHOD SUMMARY =========== -->
 <ul class="blockList">
 <li class="blockList"><a name="method.summary">
 <!--   -->
 </a>
 <h3>Method Summary</h3>
 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colLast" scope="col">Method and Description</th>
 </tr>
 <tr id="i0" class="altColor">
 <td class="colFirst"><code>default double[]</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getCDF-double:A-">getCDF</a></span>(double[]&nbsp;splitPoints)</code>
 <div class="block">This is equivalent to <a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getCDF-double:A-org.apache.datasketches.quantilescommon.QuantileSearchCriteria-"><code>getCDF(splitPoints, INCLUSIVE)</code></a></div>
 </td>
 </tr>
 <tr id="i1" class="rowColor">
 <td class="colFirst"><code>double[]</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getCDF-double:A-org.apache.datasketches.quantilescommon.QuantileSearchCriteria-">getCDF</a></span>(double[]&nbsp;splitPoints,
       <a href="../../../../org/apache/datasketches/quantilescommon/QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a>&nbsp;searchCrit)</code>
 <div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream
  as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0],
  given a set of splitPoints.</div>
 </td>
 </tr>
 <tr id="i2" class="altColor">
 <td class="colFirst"><code>double</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getMaxItem--">getMaxItem</a></span>()</code>
 <div class="block">Returns the maximum item of the stream.</div>
 </td>
 </tr>
 <tr id="i3" class="rowColor">
 <td class="colFirst"><code>double</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getMinItem--">getMinItem</a></span>()</code>
 <div class="block">Returns the minimum item of the stream.</div>
 </td>
 </tr>
 <tr id="i4" class="altColor">
 <td class="colFirst"><code>default <a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.DoublesPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI.DoublesPartitionBoundaries</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getPartitionBoundaries-int-">getPartitionBoundaries</a></span>(int&nbsp;numEquallyWeighted)</code>
 <div class="block">This method returns an instance of <a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.DoublesPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>DoublesPartitionBoundaries</code></a> which provides
  sufficient information for the user to create the given number of equally weighted partitions.</div>
 </td>
 </tr>
 <tr id="i5" class="rowColor">
 <td class="colFirst"><code><a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.DoublesPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI.DoublesPartitionBoundaries</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getPartitionBoundaries-int-org.apache.datasketches.quantilescommon.QuantileSearchCriteria-">getPartitionBoundaries</a></span>(int&nbsp;numEquallyWeighted,
                       <a href="../../../../org/apache/datasketches/quantilescommon/QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a>&nbsp;searchCrit)</code>
 <div class="block">This method returns an instance of <a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.DoublesPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>DoublesPartitionBoundaries</code></a> which provides
  sufficient information for the user to create the given number of equally weighted partitions.</div>
 </td>
 </tr>
 <tr id="i6" class="altColor">
 <td class="colFirst"><code>default double[]</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getPMF-double:A-">getPMF</a></span>(double[]&nbsp;splitPoints)</code>
 <div class="block">This is equivalent to <a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getPMF-double:A-org.apache.datasketches.quantilescommon.QuantileSearchCriteria-"><code>getPMF(splitPoints, INCLUSIVE)</code></a></div>
 </td>
 </tr>
 <tr id="i7" class="rowColor">
 <td class="colFirst"><code>double[]</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getPMF-double:A-org.apache.datasketches.quantilescommon.QuantileSearchCriteria-">getPMF</a></span>(double[]&nbsp;splitPoints,
       <a href="../../../../org/apache/datasketches/quantilescommon/QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a>&nbsp;searchCrit)</code>
 <div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream
  as an array of probability masses as doubles on the interval [0.0, 1.0],
  given a set of splitPoints.</div>
 </td>
 </tr>
 <tr id="i8" class="altColor">
 <td class="colFirst"><code>default double</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getQuantile-double-">getQuantile</a></span>(double&nbsp;rank)</code>
 <div class="block">This is equivalent to <a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getQuantile-double-org.apache.datasketches.quantilescommon.QuantileSearchCriteria-"><code>getQuantile(rank, INCLUSIVE)</code></a></div>
 </td>
 </tr>
 <tr id="i9" class="rowColor">
 <td class="colFirst"><code>double</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getQuantile-double-org.apache.datasketches.quantilescommon.QuantileSearchCriteria-">getQuantile</a></span>(double&nbsp;rank,
            <a href="../../../../org/apache/datasketches/quantilescommon/QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a>&nbsp;searchCrit)</code>
 <div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div>
 </td>
 </tr>
 <tr id="i10" class="altColor">
 <td class="colFirst"><code>double</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getQuantileLowerBound-double-">getQuantileLowerBound</a></span>(double&nbsp;rank)</code>
 <div class="block">Gets the lower bound of the quantile confidence interval in which the quantile of the
  given rank exists.</div>
 </td>
 </tr>
 <tr id="i11" class="rowColor">
 <td class="colFirst"><code>default double[]</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getQuantiles-double:A-">getQuantiles</a></span>(double[]&nbsp;ranks)</code>
 <div class="block">This is equivalent to <a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getQuantiles-double:A-org.apache.datasketches.quantilescommon.QuantileSearchCriteria-"><code>getQuantiles(ranks, INCLUSIVE)</code></a></div>
 </td>
 </tr>
 <tr id="i12" class="altColor">
 <td class="colFirst"><code>double[]</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getQuantiles-double:A-org.apache.datasketches.quantilescommon.QuantileSearchCriteria-">getQuantiles</a></span>(double[]&nbsp;ranks,
             <a href="../../../../org/apache/datasketches/quantilescommon/QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a>&nbsp;searchCrit)</code>
 <div class="block">Gets an array of quantiles from the given array of normalized ranks.</div>
 </td>
 </tr>
 <tr id="i13" class="rowColor">
 <td class="colFirst"><code>double</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getQuantileUpperBound-double-">getQuantileUpperBound</a></span>(double&nbsp;rank)</code>
 <div class="block">Gets the upper bound of the quantile confidence interval in which the true quantile of the
  given rank exists.</div>
 </td>
 </tr>
 <tr id="i14" class="altColor">
 <td class="colFirst"><code>default double</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getRank-double-">getRank</a></span>(double&nbsp;quantile)</code>
 <div class="block">This is equivalent to <a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getRank-double-org.apache.datasketches.quantilescommon.QuantileSearchCriteria-"><code>getRank(quantile, INCLUSIVE)</code></a></div>
 </td>
 </tr>
 <tr id="i15" class="rowColor">
 <td class="colFirst"><code>double</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getRank-double-org.apache.datasketches.quantilescommon.QuantileSearchCriteria-">getRank</a></span>(double&nbsp;quantile,
        <a href="../../../../org/apache/datasketches/quantilescommon/QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a>&nbsp;searchCrit)</code>
 <div class="block">Gets the normalized rank corresponding to the given a quantile.</div>
 </td>
 </tr>
 <tr id="i16" class="altColor">
 <td class="colFirst"><code>default double[]</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getRanks-double:A-">getRanks</a></span>(double[]&nbsp;quantiles)</code>
 <div class="block">This is equivalent to <a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getRanks-double:A-org.apache.datasketches.quantilescommon.QuantileSearchCriteria-"><code>getRanks(quantiles, INCLUSIVE)</code></a></div>
 </td>
 </tr>
 <tr id="i17" class="rowColor">
 <td class="colFirst"><code>double[]</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getRanks-double:A-org.apache.datasketches.quantilescommon.QuantileSearchCriteria-">getRanks</a></span>(double[]&nbsp;quantiles,
         <a href="../../../../org/apache/datasketches/quantilescommon/QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a>&nbsp;searchCrit)</code>
 <div class="block">Gets an array of normalized ranks corresponding to the given array of quantiles and the given
  search criterion.</div>
 </td>
 </tr>
 <tr id="i18" class="altColor">
 <td class="colFirst"><code>int</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getSerializedSizeBytes--">getSerializedSizeBytes</a></span>()</code>
 <div class="block">Returns the current number of bytes this Sketch would require if serialized.</div>
 </td>
 </tr>
 <tr id="i19" class="rowColor">
 <td class="colFirst"><code><a href="../../../../org/apache/datasketches/quantilescommon/DoublesSortedView.html" title="interface in org.apache.datasketches.quantilescommon">DoublesSortedView</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getSortedView--">getSortedView</a></span>()</code>
 <div class="block">Gets the sorted view of this sketch</div>
 </td>
 </tr>
 <tr id="i20" class="altColor">
 <td class="colFirst"><code><a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesSketchIterator</a></code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#iterator--">iterator</a></span>()</code>
 <div class="block">Gets the iterator for this sketch, which is not sorted.</div>
 </td>
 </tr>
 <tr id="i21" class="rowColor">
 <td class="colFirst"><code>byte[]</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#toByteArray--">toByteArray</a></span>()</code>
 <div class="block">Returns a byte array representation of this sketch.</div>
 </td>
 </tr>
 <tr id="i22" class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#update-double-">update</a></span>(double&nbsp;item)</code>
 <div class="block">Updates this sketch with the given item.</div>
 </td>
 </tr>
 </table>
 <ul class="blockList">
 <li class="blockList"><a name="methods.inherited.from.class.org.apache.datasketches.quantilescommon.QuantilesAPI">
 <!--   -->
 </a>
 <h3>Methods inherited from interface&nbsp;org.apache.datasketches.quantilescommon.<a href="../../../../org/apache/datasketches/quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></h3>
 <code><a href="../../../../org/apache/datasketches/quantilescommon/QuantilesAPI.html#getK--">getK</a>, <a href="../../../../org/apache/datasketches/quantilescommon/QuantilesAPI.html#getN--">getN</a>, <a href="../../../../org/apache/datasketches/quantilescommon/QuantilesAPI.html#getNumRetained--">getNumRetained</a>, <a href="../../../../org/apache/datasketches/quantilescommon/QuantilesAPI.html#getRankLowerBound-double-">getRankLowerBound</a>, <a href="../../../../org/apache/datasketches/quantilescommon/QuantilesAPI.html#getRankUpperBound-double-">getRankUpperBound</a>, <a href="../../../../org/apache/datasketches/quantilescommon/QuantilesAPI.html#hasMemory--">hasMemory</a>, <a href="../../../../org/apache/datasketches/quantilescommon/QuantilesAPI.html#isDirect--">isDirect</a>, <a href="../../../../org/apache/datasketches/quantilescommon/QuantilesAPI.html#isEmpty--">isEmpty</a>, <a href="../../../../org/apache/datasketches/quantilescommon/QuantilesAPI.html#isEstimationMode--">isEstimationMode</a>, <a href="../../../../org/apache/datasketches/quantilescommon/QuantilesAPI.html#isReadOnly--">isReadOnly</a>, <a href="../../../../org/apache/datasketches/quantilescommon/QuantilesAPI.html#reset--">reset</a>, <a href="../../../../org/apache/datasketches/quantilescommon/QuantilesAPI.html#toString--">toString</a></code></li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
 </div>
 <div class="details">
 <ul class="blockList">
 <li class="blockList">
 <!-- ============ METHOD DETAIL ========== -->
 <ul class="blockList">
 <li class="blockList"><a name="method.detail">
 <!--   -->
 </a>
 <h3>Method Detail</h3>
 <a name="getCDF-double:A-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getCDF</h4>
 <pre>default&nbsp;double[]&nbsp;getCDF(double[]&nbsp;splitPoints)</pre>
 <div class="block">This is equivalent to <a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getCDF-double:A-org.apache.datasketches.quantilescommon.QuantileSearchCriteria-"><code>getCDF(splitPoints, INCLUSIVE)</code></a></div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>splitPoints</code> - an array of <i>m</i> unique, monotonically increasing items.</dd>
 <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">IllegalArgumentException</a></code> - if sketch is empty.</dd>
 </dl>
 </li>
 </ul>
 <a name="getCDF-double:A-org.apache.datasketches.quantilescommon.QuantileSearchCriteria-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getCDF</h4>
 <pre>double[]&nbsp;getCDF(double[]&nbsp;splitPoints,
                 <a href="../../../../org/apache/datasketches/quantilescommon/QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a>&nbsp;searchCrit)</pre>
 <div class="block">Returns an approximation to the Cumulative Distribution Function (CDF) of the input stream
  as a monotonically increasing array of double ranks (or cumulative probabilities) on the interval [0.0, 1.0],
  given a set of splitPoints.

  <p>The resulting approximations have a probabilistic guarantee that can be obtained from the
  getNormalizedRankError(false) function.</p></div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>splitPoints</code> - an array of <i>m</i> unique, monotonically increasing items
  (of the same type as the input items)
  that divide the item input domain into <i>m+1</i> overlapping intervals.

  <p>The start of each interval is below the lowest item retained by the sketch
  corresponding to a zero rank or zero probability, and the end of the interval
  is the rank or cumulative probability corresponding to the split point.</p>

  <p>The <i>(m+1)th</i> interval represents 100% of the distribution represented by the sketch
  and consistent with the definition of a cumulative probability distribution, thus the <i>(m+1)th</i>
  rank or probability in the returned array is always 1.0.</p>

  <p>If a split point exactly equals a retained item of the sketch and the search criterion is:</p>

  <ul>
  <li>INCLUSIVE, the resulting cumulative probability will include that item.</li>
  <li>EXCLUSIVE, the resulting cumulative probability will not include the weight of that split point.</li>
  </ul>

  <p>It is not recommended to include either the minimum or maximum items of the input stream.</p></dd>
 <dd><code>searchCrit</code> - the desired search criteria.</dd>
 <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">IllegalArgumentException</a></code> - if sketch is empty.</dd>
 </dl>
 </li>
 </ul>
 <a name="getMaxItem--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getMaxItem</h4>
 <pre>double&nbsp;getMaxItem()</pre>
 <div class="block">Returns the maximum item of the stream. This is provided for convenience, but may be different from the largest
  item retained by the sketch algorithm.</div>
 <dl>
 <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">IllegalArgumentException</a></code> - if sketch is empty.</dd>
 </dl>
 </li>
 </ul>
 <a name="getMinItem--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getMinItem</h4>
 <pre>double&nbsp;getMinItem()</pre>
 <div class="block">Returns the minimum item of the stream. This is provided for convenience, but is distinct from the smallest
  item retained by the sketch algorithm.</div>
 <dl>
 <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">IllegalArgumentException</a></code> - if sketch is empty.</dd>
 </dl>
 </li>
 </ul>
 <a name="getPartitionBoundaries-int-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getPartitionBoundaries</h4>
 <pre>default&nbsp;<a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.DoublesPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI.DoublesPartitionBoundaries</a>&nbsp;getPartitionBoundaries(int&nbsp;numEquallyWeighted)</pre>
 <div class="block">This method returns an instance of <a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.DoublesPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>DoublesPartitionBoundaries</code></a> which provides
  sufficient information for the user to create the given number of equally weighted partitions.

  <p>This method is equivalent to
  <a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getPartitionBoundaries-int-org.apache.datasketches.quantilescommon.QuantileSearchCriteria-"><code>getPartitionBoundaries(numEquallyWeighted, INCLUSIVE)</code></a>.
  </p></div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>numEquallyWeighted</code> - an integer that specifies the number of equally weighted partitions between
  <a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getMinItem--"><code>getMinItem()</code></a> and <a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getMaxItem--"><code>getMaxItem()</code></a>.
  This must be a positive integer greater than zero.
  <ul>
  <li>A 1 will return: minItem, maxItem.</li>
  <li>A 2 will return: minItem, median quantile, maxItem.</li>
  <li>Etc.</li>
  </ul></dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>an instance of <a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.DoublesPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>DoublesPartitionBoundaries</code></a>.</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">IllegalArgumentException</a></code> - if sketch is empty.</dd>
 <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">IllegalArgumentException</a></code> - if <i>numEquallyWeighted</i> is less than 1.</dd>
 </dl>
 </li>
 </ul>
 <a name="getPartitionBoundaries-int-org.apache.datasketches.quantilescommon.QuantileSearchCriteria-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getPartitionBoundaries</h4>
 <pre><a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.DoublesPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">QuantilesDoublesAPI.DoublesPartitionBoundaries</a>&nbsp;getPartitionBoundaries(int&nbsp;numEquallyWeighted,
                                                                       <a href="../../../../org/apache/datasketches/quantilescommon/QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a>&nbsp;searchCrit)</pre>
 <div class="block">This method returns an instance of <a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.DoublesPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>DoublesPartitionBoundaries</code></a> which provides
  sufficient information for the user to create the given number of equally weighted partitions.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>numEquallyWeighted</code> - an integer that specifies the number of equally weighted partitions between
  <a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getMinItem--"><code>getMinItem()</code></a> and <a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getMaxItem--"><code>getMaxItem()</code></a>.
  This must be a positive integer greater than zero.
  <ul>
  <li>A 1 will return: minItem, maxItem.</li>
  <li>A 2 will return: minItem, median quantile, maxItem.</li>
  <li>Etc.</li>
  </ul></dd>
 <dd><code>searchCrit</code> - If INCLUSIVE, all the returned quantiles are the upper boundaries of the equally weighted partitions
  with the exception of the lowest returned quantile, which is the lowest boundary of the lowest ranked partition.
  If EXCLUSIVE, all the returned quantiles are the lower boundaries of the equally weighted partitions
  with the exception of the highest returned quantile, which is the upper boundary of the highest ranked partition.</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>an instance of <a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.DoublesPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>DoublesPartitionBoundaries</code></a>.</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">IllegalArgumentException</a></code> - if sketch is empty.</dd>
 <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">IllegalArgumentException</a></code> - if <i>numEquallyWeighted</i> is less than 1.</dd>
 </dl>
 </li>
 </ul>
 <a name="getPMF-double:A-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getPMF</h4>
 <pre>default&nbsp;double[]&nbsp;getPMF(double[]&nbsp;splitPoints)</pre>
 <div class="block">This is equivalent to <a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getPMF-double:A-org.apache.datasketches.quantilescommon.QuantileSearchCriteria-"><code>getPMF(splitPoints, INCLUSIVE)</code></a></div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>splitPoints</code> - an array of <i>m</i> unique, monotonically increasing items.</dd>
 <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">IllegalArgumentException</a></code> - if sketch is empty.</dd>
 </dl>
 </li>
 </ul>
 <a name="getPMF-double:A-org.apache.datasketches.quantilescommon.QuantileSearchCriteria-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getPMF</h4>
 <pre>double[]&nbsp;getPMF(double[]&nbsp;splitPoints,
                 <a href="../../../../org/apache/datasketches/quantilescommon/QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a>&nbsp;searchCrit)</pre>
 <div class="block">Returns an approximation to the Probability Mass Function (PMF) of the input stream
  as an array of probability masses as doubles on the interval [0.0, 1.0],
  given a set of splitPoints.

  <p>The resulting approximations have a probabilistic guarantee that can be obtained from the
  getNormalizedRankError(true) function.</p></div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>splitPoints</code> - an array of <i>m</i> unique, monotonically increasing items
  (of the same type as the input items)
  that divide the item input domain into <i>m+1</i> consecutive, non-overlapping intervals.

  <p>Each interval except for the end intervals starts with a split point and ends with the next split
  point in sequence.</p>

  <p>The first interval starts below the lowest item retained by the sketch
  corresponding to a zero rank or zero probability, and ends with the first split point</p>

  <p>The last <i>(m+1)th</i> interval starts with the last split point and ends after the last
  item retained by the sketch corresponding to a rank or probability of 1.0. </p>

  <p>The sum of the probability masses of all <i>(m+1)</i> intervals is 1.0.</p>

  <p>If the search criterion is:</p>

  <ul>
  <li>INCLUSIVE, and the upper split point of an interval equals an item retained by the sketch, the interval
  will include that item. If the lower split point equals an item retained by the sketch, the interval will exclude
  that item.</li>
  <li>EXCLUSIVE, and the upper split point of an interval equals an item retained by the sketch, the interval
  will exclude that item. If the lower split point equals an item retained by the sketch, the interval will include
  that item.</li>
  </ul>

  <p>It is not recommended to include either the minimum or maximum items of the input stream.</p></dd>
 <dd><code>searchCrit</code> - the desired search criteria.</dd>
 <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">IllegalArgumentException</a></code> - if sketch is empty.</dd>
 </dl>
 </li>
 </ul>
 <a name="getQuantile-double-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getQuantile</h4>
 <pre>default&nbsp;double&nbsp;getQuantile(double&nbsp;rank)</pre>
 <div class="block">This is equivalent to <a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getQuantile-double-org.apache.datasketches.quantilescommon.QuantileSearchCriteria-"><code>getQuantile(rank, INCLUSIVE)</code></a></div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>rank</code> - the given normalized rank, a double in the range [0.0, 1.0].</dd>
 <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">IllegalArgumentException</a></code> - if sketch is empty.</dd>
 </dl>
 </li>
 </ul>
 <a name="getQuantile-double-org.apache.datasketches.quantilescommon.QuantileSearchCriteria-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getQuantile</h4>
 <pre>double&nbsp;getQuantile(double&nbsp;rank,
                    <a href="../../../../org/apache/datasketches/quantilescommon/QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a>&nbsp;searchCrit)</pre>
 <div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>rank</code> - the given normalized rank, a double in the range [0.0, 1.0].</dd>
 <dd><code>searchCrit</code> - If INCLUSIVE, the given rank includes all quantiles &le;
  the quantile directly corresponding to the given rank.
  If EXCLUSIVE, he given rank includes all quantiles &lt;
  the quantile directly corresponding to the given rank.</dd>
 <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">IllegalArgumentException</a></code> - if sketch is empty.</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../org/apache/datasketches/quantilescommon/QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></dd>
 </dl>
 </li>
 </ul>
 <a name="getQuantileLowerBound-double-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getQuantileLowerBound</h4>
 <pre>double&nbsp;getQuantileLowerBound(double&nbsp;rank)</pre>
 <div class="block">Gets the lower bound of the quantile confidence interval in which the quantile of the
  given rank exists.

  <p>Although it is possible to estimate the probability that the true quantile
  exists within the quantile confidence interval specified by the upper and lower quantile bounds,
  it is not possible to guarantee the width of the quantile confidence interval
  as an additive or multiplicative percent of the true quantile.</p></div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>rank</code> - the given normalized rank</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <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">IllegalArgumentException</a></code> - if sketch is empty.</dd>
 </dl>
 </li>
 </ul>
 <a name="getQuantileUpperBound-double-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getQuantileUpperBound</h4>
 <pre>double&nbsp;getQuantileUpperBound(double&nbsp;rank)</pre>
 <div class="block">Gets the upper bound of the quantile confidence interval in which the true quantile of the
  given rank exists.

  <p>Although it is possible to estimate the probability that the true quantile
  exists within the quantile confidence interval specified by the upper and lower quantile bounds,
  it is not possible to guarantee the width of the quantile interval
  as an additive or multiplicative percent of the true quantile.</p></div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>rank</code> - the given normalized rank</dd>
 <dt><span class="returnLabel">Returns:</span></dt>
 <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">IllegalArgumentException</a></code> - if sketch is empty.</dd>
 </dl>
 </li>
 </ul>
 <a name="getQuantiles-double:A-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getQuantiles</h4>
 <pre>default&nbsp;double[]&nbsp;getQuantiles(double[]&nbsp;ranks)</pre>
 <div class="block">This is equivalent to <a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getQuantiles-double:A-org.apache.datasketches.quantilescommon.QuantileSearchCriteria-"><code>getQuantiles(ranks, INCLUSIVE)</code></a></div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>ranks</code> - the given array of normalized ranks, each of which must be
  in the interval [0.0,1.0].</dd>
 <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">IllegalArgumentException</a></code> - if sketch is empty.</dd>
 </dl>
 </li>
 </ul>
 <a name="getQuantiles-double:A-org.apache.datasketches.quantilescommon.QuantileSearchCriteria-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getQuantiles</h4>
 <pre>double[]&nbsp;getQuantiles(double[]&nbsp;ranks,
                       <a href="../../../../org/apache/datasketches/quantilescommon/QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a>&nbsp;searchCrit)</pre>
 <div class="block">Gets an array of quantiles from the given array of normalized ranks.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>ranks</code> - the given array of normalized ranks, each of which must be
  in the interval [0.0,1.0].</dd>
 <dd><code>searchCrit</code> - if INCLUSIVE, the given ranks include all quantiles &le;
  the quantile directly corresponding to each rank.</dd>
 <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">IllegalArgumentException</a></code> - if sketch is empty.</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../org/apache/datasketches/quantilescommon/QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></dd>
 </dl>
 </li>
 </ul>
 <a name="getRank-double-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getRank</h4>
 <pre>default&nbsp;double&nbsp;getRank(double&nbsp;quantile)</pre>
 <div class="block">This is equivalent to <a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getRank-double-org.apache.datasketches.quantilescommon.QuantileSearchCriteria-"><code>getRank(quantile, INCLUSIVE)</code></a></div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>quantile</code> - the given quantile</dd>
 <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">IllegalArgumentException</a></code> - if sketch is empty.</dd>
 </dl>
 </li>
 </ul>
 <a name="getRank-double-org.apache.datasketches.quantilescommon.QuantileSearchCriteria-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getRank</h4>
 <pre>double&nbsp;getRank(double&nbsp;quantile,
                <a href="../../../../org/apache/datasketches/quantilescommon/QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a>&nbsp;searchCrit)</pre>
 <div class="block">Gets the normalized rank corresponding to the given a quantile.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>quantile</code> - the given quantile</dd>
 <dd><code>searchCrit</code> - if INCLUSIVE the given quantile is included into the rank.</dd>
 <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">IllegalArgumentException</a></code> - if sketch is empty.</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../org/apache/datasketches/quantilescommon/QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></dd>
 </dl>
 </li>
 </ul>
 <a name="getRanks-double:A-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getRanks</h4>
 <pre>default&nbsp;double[]&nbsp;getRanks(double[]&nbsp;quantiles)</pre>
 <div class="block">This is equivalent to <a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html#getRanks-double:A-org.apache.datasketches.quantilescommon.QuantileSearchCriteria-"><code>getRanks(quantiles, INCLUSIVE)</code></a></div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>quantiles</code> - the given array of quantiles</dd>
 <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">IllegalArgumentException</a></code> - if sketch is empty.</dd>
 </dl>
 </li>
 </ul>
 <a name="getRanks-double:A-org.apache.datasketches.quantilescommon.QuantileSearchCriteria-">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getRanks</h4>
 <pre>double[]&nbsp;getRanks(double[]&nbsp;quantiles,
                   <a href="../../../../org/apache/datasketches/quantilescommon/QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a>&nbsp;searchCrit)</pre>
 <div class="block">Gets an array of normalized ranks corresponding to the given array of quantiles and the given
  search criterion.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>quantiles</code> - the given array of quantiles</dd>
 <dd><code>searchCrit</code> - if INCLUSIVE, the given quantiles include the rank directly corresponding to each quantile.</dd>
 <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">IllegalArgumentException</a></code> - if sketch is empty.</dd>
 <dt><span class="seeLabel">See Also:</span></dt>
 <dd><a href="../../../../org/apache/datasketches/quantilescommon/QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></dd>
 </dl>
 </li>
 </ul>
 <a name="getSerializedSizeBytes--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getSerializedSizeBytes</h4>
 <pre>int&nbsp;getSerializedSizeBytes()</pre>
 <div class="block">Returns the current number of bytes this Sketch would require if serialized.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the number of bytes this sketch would require if serialized.</dd>
 </dl>
 </li>
 </ul>
 <a name="getSortedView--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getSortedView</h4>
 <pre><a href="../../../../org/apache/datasketches/quantilescommon/DoublesSortedView.html" title="interface in org.apache.datasketches.quantilescommon">DoublesSortedView</a>&nbsp;getSortedView()</pre>
 <div class="block">Gets the sorted view of this sketch</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the sorted view of this sketch</dd>
 </dl>
 </li>
 </ul>
 <a name="iterator--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>iterator</h4>
 <pre><a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesDoublesSketchIterator</a>&nbsp;iterator()</pre>
 <div class="block">Gets the iterator for this sketch, which is not sorted.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>the iterator for this sketch</dd>
 </dl>
 </li>
 </ul>
 <a name="toByteArray--">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>toByteArray</h4>
 <pre>byte[]&nbsp;toByteArray()</pre>
 <div class="block">Returns a byte array representation of this sketch.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>a byte array representation of this sketch.</dd>
 </dl>
 </li>
 </ul>
 <a name="update-double-">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>update</h4>
 <pre>void&nbsp;update(double&nbsp;item)</pre>
 <div class="block">Updates this sketch with the given item.</div>
 <dl>
 <dt><span class="paramLabel">Parameters:</span></dt>
 <dd><code>item</code> - from a stream of quantiles. NaNs are ignored.</dd>
 </dl>
 </li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
 </div>
 </div>
 <!-- ========= END OF CLASS DATA ========= -->
 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 <div class="bottomNav"><a name="navbar.bottom">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
 <a name="navbar.bottom.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../../overview-summary.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</li>
 <li><a href="class-use/QuantilesDoublesAPI.html">Use</a></li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../../index-all.html">Index</a></li>
 <li><a href="../../../../help-doc.html">Help</a></li>
 </ul>
 </div>
 <div class="subNav">
 <ul class="navList">
 <li><a href="../../../../org/apache/datasketches/quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 <li><a href="../../../../org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.DoublesPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../index.html?org/apache/datasketches/quantilescommon/QuantilesDoublesAPI.html" target="_top">Frames</a></li>
 <li><a href="QuantilesDoublesAPI.html" target="_top">No&nbsp;Frames</a></li>
 </ul>
 <ul class="navList" id="allclasses_navbar_bottom">
 <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
 </ul>
 <div>
 <script type="text/javascript"><!--
   allClassesLink = document.getElementById("allclasses_navbar_bottom");
   if(window==top) {
     allClassesLink.style.display = "block";
   }
   else {
     allClassesLink.style.display = "none";
   }
   //-->
 </script>
 </div>
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.detail">Method</a></li>
 </ul>
 </div>
 <a name="skip.navbar.bottom">
 <!--   -->
 </a></div>
 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 <p class="legalCopy"><small>Copyright &#169; 2015&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
 </body>
 </html>