| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>KllFloatsSketch (datasketches-java 4.0.0 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.6.0.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.min.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="KllFloatsSketch (datasketches-java 4.0.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":9,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":9,"i16":10,"i17":9,"i18":9,"i19":9,"i20":9,"i21":10,"i22":10,"i23":9,"i24":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/KllFloatsSketch.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" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.datasketches.kll</a></div> |
| <h2 title="Class KllFloatsSketch" class="title">Class KllFloatsSketch</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><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">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="KllSketch.html" title="class in org.apache.datasketches.kll">org.apache.datasketches.kll.KllSketch</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.datasketches.kll.KllFloatsSketch</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code>, <code><a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public abstract class <span class="typeNameLabel">KllFloatsSketch</span> |
| extends <a href="KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a> |
| implements <a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></pre> |
| <div class="block">This variation of the KllSketch implements primitive floats.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="KllSketch.html" title="class in org.apache.datasketches.kll"><code>KllSketch</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.classes.inherited.from.class.org.apache.datasketches.kll.KllSketch"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from class org.apache.datasketches.kll.<a href="KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></h3> |
| <code><a href="KllSketch.SketchType.html" title="enum in org.apache.datasketches.kll">KllSketch.SketchType</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.classes.inherited.from.class.org.apache.datasketches.quantilescommon.QuantilesFloatsAPI"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.apache.datasketches.quantilescommon.<a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></h3> |
| <code><a href="../quantilescommon/QuantilesFloatsAPI.FloatsPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI.FloatsPartitionBoundaries</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.apache.datasketches.kll.KllSketch"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.datasketches.kll.<a href="KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></h3> |
| <code><a href="KllSketch.html#DEFAULT_K">DEFAULT_K</a>, <a href="KllSketch.html#MAX_K">MAX_K</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>double[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCDF(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getCDF</a></span>​(float[] splitPoints, |
| <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></th> |
| <td class="colLast"> |
| <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="i1" class="rowColor"> |
| <td class="colFirst"><code>float</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaxItem()">getMaxItem</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the maximum item of the stream.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaxSerializedSizeBytes(int,long,boolean)">getMaxSerializedSizeBytes</a></span>​(int k, |
| long n, |
| boolean updatableMemoryFormat)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns upper bound on the serialized size of a KllFloatsSketch given the following parameters.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>float</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMinItem()">getMinItem</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the minimum item of the stream.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../quantilescommon/QuantilesFloatsAPI.FloatsPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI.FloatsPartitionBoundaries</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPartitionBoundaries(int,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getPartitionBoundaries</a></span>​(int numEquallyWeighted, |
| <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></th> |
| <td class="colLast"> |
| <div class="block">This method returns an instance of <a href="../quantilescommon/QuantilesFloatsAPI.FloatsPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>FloatsPartitionBoundaries</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>double[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPMF(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getPMF</a></span>​(float[] splitPoints, |
| <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></th> |
| <td class="colLast"> |
| <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="i6" class="altColor"> |
| <td class="colFirst"><code>float</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getQuantile</a></span>​(double rank, |
| <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>float</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getQuantileLowerBound(double)">getQuantileLowerBound</a></span>​(double rank)</code></th> |
| <td class="colLast"> |
| <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="i8" class="altColor"> |
| <td class="colFirst"><code>float[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getQuantiles</a></span>​(double[] ranks, |
| <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></th> |
| <td class="colLast"> |
| <div class="block">Gets an array of quantiles from the given array of normalized ranks.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>float</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getQuantileUpperBound(double)">getQuantileUpperBound</a></span>​(double rank)</code></th> |
| <td class="colLast"> |
| <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="i10" class="altColor"> |
| <td class="colFirst"><code>double</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRank(float,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getRank</a></span>​(float quantile, |
| <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the normalized rank corresponding to the given a quantile.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>double</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRankLowerBound(double)">getRankLowerBound</a></span>​(double rank)</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the lower bound of the rank confidence interval in which the true rank of the |
| given rank exists.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>double[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRanks(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getRanks</a></span>​(float[] quantiles, |
| <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</code></th> |
| <td class="colLast"> |
| <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="i13" class="rowColor"> |
| <td class="colFirst"><code>double</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRankUpperBound(double)">getRankUpperBound</a></span>​(double rank)</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the upper bound of the rank confidence interval in which the true rank of the |
| given rank exists.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="../quantilescommon/FloatsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">FloatsSortedView</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSortedView()">getSortedView</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the sorted view of this sketch</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>static <a href="KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#heapify(org.apache.datasketches.memory.Memory)">heapify</a></span>​(org.apache.datasketches.memory.Memory srcMem)</code></th> |
| <td class="colLast"> |
| <div class="block">Factory heapify takes the sketch image in Memory and instantiates an on-heap sketch.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="../quantilescommon/QuantilesFloatsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsSketchIterator</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#iterator()">iterator</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the iterator for this sketch, which is not sorted.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>static <a href="KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newDirectInstance(int,org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)">newDirectInstance</a></span>​(int k, |
| org.apache.datasketches.memory.WritableMemory dstMem, |
| org.apache.datasketches.memory.MemoryRequestServer memReqSvr)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a new direct instance of this sketch with a given <em>k</em>.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>static <a href="KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newDirectInstance(org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)">newDirectInstance</a></span>​(org.apache.datasketches.memory.WritableMemory dstMem, |
| org.apache.datasketches.memory.MemoryRequestServer memReqSvr)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a new direct instance of this sketch with the default <em>k</em>.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>static <a href="KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newHeapInstance()">newHeapInstance</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Create a new heap instance of this sketch with the default <em>k = 200</em>.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>static <a href="KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#newHeapInstance(int)">newHeapInstance</a></span>​(int k)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a new heap instance of this sketch with a given parameter <em>k</em>.</div> |
| </td> |
| </tr> |
| <tr id="i21" 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">Returns a byte array representation of this sketch.</div> |
| </td> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#update(float)">update</a></span>​(float item)</code></th> |
| <td class="colLast"> |
| <div class="block">Updates this sketch with the given item.</div> |
| </td> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><code>static <a href="KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#wrap(org.apache.datasketches.memory.Memory)">wrap</a></span>​(org.apache.datasketches.memory.Memory srcMem)</code></th> |
| <td class="colLast"> |
| <div class="block">Wrap a sketch around the given read only source Memory containing sketch data |
| that originated from this sketch.</div> |
| </td> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><code>static <a href="KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#writableWrap(org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)">writableWrap</a></span>​(org.apache.datasketches.memory.WritableMemory srcMem, |
| org.apache.datasketches.memory.MemoryRequestServer memReqSvr)</code></th> |
| <td class="colLast"> |
| <div class="block">Wrap a sketch around the given source Writable Memory containing sketch data |
| that originated from this sketch.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.datasketches.kll.KllSketch"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.datasketches.kll.<a href="KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></h3> |
| <code><a href="KllSketch.html#getCurrentCompactSerializedSizeBytes()">getCurrentCompactSerializedSizeBytes</a>, <a href="KllSketch.html#getCurrentUpdatableSerializedSizeBytes()">getCurrentUpdatableSerializedSizeBytes</a>, <a href="KllSketch.html#getK()">getK</a>, <a href="KllSketch.html#getKFromEpsilon(double,boolean)">getKFromEpsilon</a>, <a href="KllSketch.html#getMaxSerializedSizeBytes(int,long,org.apache.datasketches.kll.KllSketch.SketchType,boolean)">getMaxSerializedSizeBytes</a>, <a href="KllSketch.html#getN()">getN</a>, <a href="KllSketch.html#getNormalizedRankError(boolean)">getNormalizedRankError</a>, <a href="KllSketch.html#getNormalizedRankError(int,boolean)">getNormalizedRankError</a>, <a href="KllSketch.html#getNumRetained()">getNumRetained</a>, <a href="KllSketch.html#getSerializedSizeBytes()">getSerializedSizeBytes</a>, <a href="KllSketch.html#hasMemory()">hasMemory</a>, <a href="KllSketch.html#isDirect()">isDirect</a>, <a href="KllSketch.html#isEmpty()">isEmpty</a>, <a href="KllSketch.html#isEstimationMode()">isEstimationMode</a>, <a href="KllSketch.html#isMemoryUpdatableFormat()">isMemoryUpdatableFormat</a>, <a href="KllSketch.html#isReadOnly()">isReadOnly</a>, <a href="KllSketch.html#isSameResource(org.apache.datasketches.memory.Memory)">isSameResource</a>, <a href="KllSketch.html#merge(org.apache.datasketches.kll.KllSketch)">merge</a>, <a href="KllSketch.html#reset()">reset</a>, <a href="KllSketch.html#toString()">toString</a>, <a href="KllSketch.html#toString(boolean,boolean)">toString</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<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></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.datasketches.quantilescommon.QuantilesAPI"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.datasketches.quantilescommon.<a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></h3> |
| <code><a href="../quantilescommon/QuantilesAPI.html#getK()">getK</a>, <a href="../quantilescommon/QuantilesAPI.html#getN()">getN</a>, <a href="../quantilescommon/QuantilesAPI.html#getNumRetained()">getNumRetained</a>, <a href="../quantilescommon/QuantilesAPI.html#hasMemory()">hasMemory</a>, <a href="../quantilescommon/QuantilesAPI.html#isDirect()">isDirect</a>, <a href="../quantilescommon/QuantilesAPI.html#isEmpty()">isEmpty</a>, <a href="../quantilescommon/QuantilesAPI.html#isEstimationMode()">isEstimationMode</a>, <a href="../quantilescommon/QuantilesAPI.html#isReadOnly()">isReadOnly</a>, <a href="../quantilescommon/QuantilesAPI.html#reset()">reset</a>, <a href="../quantilescommon/QuantilesAPI.html#toString()">toString</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.datasketches.quantilescommon.QuantilesFloatsAPI"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.datasketches.quantilescommon.<a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></h3> |
| <code><a href="../quantilescommon/QuantilesFloatsAPI.html#getCDF(float%5B%5D)">getCDF</a>, <a href="../quantilescommon/QuantilesFloatsAPI.html#getPartitionBoundaries(int)">getPartitionBoundaries</a>, <a href="../quantilescommon/QuantilesFloatsAPI.html#getPMF(float%5B%5D)">getPMF</a>, <a href="../quantilescommon/QuantilesFloatsAPI.html#getQuantile(double)">getQuantile</a>, <a href="../quantilescommon/QuantilesFloatsAPI.html#getQuantiles(double%5B%5D)">getQuantiles</a>, <a href="../quantilescommon/QuantilesFloatsAPI.html#getRank(float)">getRank</a>, <a href="../quantilescommon/QuantilesFloatsAPI.html#getRanks(float%5B%5D)">getRanks</a>, <a href="../quantilescommon/QuantilesFloatsAPI.html#getSerializedSizeBytes()">getSerializedSizeBytes</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getMaxSerializedSizeBytes(int,long,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxSerializedSizeBytes</h4> |
| <pre class="methodSignature">public static int getMaxSerializedSizeBytes​(int k, |
| long n, |
| boolean updatableMemoryFormat)</pre> |
| <div class="block">Returns upper bound on the serialized size of a KllFloatsSketch given the following parameters.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>k</code> - parameter that controls size of the sketch and accuracy of estimates</dd> |
| <dd><code>n</code> - stream length</dd> |
| <dd><code>updatableMemoryFormat</code> - true if updatable Memory format, otherwise the standard compact format.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>upper bound on the serialized size of a KllSketch.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="heapify(org.apache.datasketches.memory.Memory)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>heapify</h4> |
| <pre class="methodSignature">public static <a href="KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a> heapify​(org.apache.datasketches.memory.Memory srcMem)</pre> |
| <div class="block">Factory heapify takes the sketch image in Memory and instantiates an on-heap sketch. |
| The resulting sketch will not retain any link to the source Memory.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>srcMem</code> - a Memory image of a sketch serialized by this sketch. |
| <a href="../../../../resources/dictionary.html#mem">See Memory</a></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a heap-based sketch based on the given Memory.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="newDirectInstance(int,org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newDirectInstance</h4> |
| <pre class="methodSignature">public static <a href="KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a> newDirectInstance​(int k, |
| org.apache.datasketches.memory.WritableMemory dstMem, |
| org.apache.datasketches.memory.MemoryRequestServer memReqSvr)</pre> |
| <div class="block">Create a new direct instance of this sketch with a given <em>k</em>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>k</code> - parameter that controls size of the sketch and accuracy of estimates.</dd> |
| <dd><code>dstMem</code> - the given destination WritableMemory object for use by the sketch</dd> |
| <dd><code>memReqSvr</code> - the given MemoryRequestServer to request a larger WritableMemory</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new direct instance of this sketch</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="newDirectInstance(org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newDirectInstance</h4> |
| <pre class="methodSignature">public static <a href="KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a> newDirectInstance​(org.apache.datasketches.memory.WritableMemory dstMem, |
| org.apache.datasketches.memory.MemoryRequestServer memReqSvr)</pre> |
| <div class="block">Create a new direct instance of this sketch with the default <em>k</em>. |
| The default <em>k</em> = 200 results in a normalized rank error of about |
| 1.65%. Larger <em>k</em> will have smaller error but the sketch will be larger (and slower).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dstMem</code> - the given destination WritableMemory object for use by the sketch</dd> |
| <dd><code>memReqSvr</code> - the given MemoryRequestServer to request a larger WritableMemory</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new direct instance of this sketch</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="newHeapInstance()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newHeapInstance</h4> |
| <pre class="methodSignature">public static <a href="KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a> newHeapInstance()</pre> |
| <div class="block">Create a new heap instance of this sketch with the default <em>k = 200</em>. |
| The default <em>k</em> = 200 results in a normalized rank error of about |
| 1.65%. Larger K will have smaller error but the sketch will be larger (and slower). |
| This will have a rank error of about 1.65%.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>new KllFloatsSketch on the heap.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="newHeapInstance(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newHeapInstance</h4> |
| <pre class="methodSignature">public static <a href="KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a> newHeapInstance​(int k)</pre> |
| <div class="block">Create a new heap instance of this sketch with a given parameter <em>k</em>. |
| <em>k</em> can be between DEFAULT_M and 65535, inclusive. |
| The default <em>k</em> = 200 results in a normalized rank error of about |
| 1.65%. Larger K will have smaller error but the sketch will be larger (and slower).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>k</code> - parameter that controls size of the sketch and accuracy of estimates.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>new KllFloatsSketch on the heap.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="wrap(org.apache.datasketches.memory.Memory)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>wrap</h4> |
| <pre class="methodSignature">public static <a href="KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a> wrap​(org.apache.datasketches.memory.Memory srcMem)</pre> |
| <div class="block">Wrap a sketch around the given read only source Memory containing sketch data |
| that originated from this sketch.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>srcMem</code> - the read only source Memory</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>instance of this sketch</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="writableWrap(org.apache.datasketches.memory.WritableMemory,org.apache.datasketches.memory.MemoryRequestServer)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writableWrap</h4> |
| <pre class="methodSignature">public static <a href="KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a> writableWrap​(org.apache.datasketches.memory.WritableMemory srcMem, |
| org.apache.datasketches.memory.MemoryRequestServer memReqSvr)</pre> |
| <div class="block">Wrap a sketch around the given source Writable Memory containing sketch data |
| that originated from this sketch.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>srcMem</code> - a WritableMemory that contains data.</dd> |
| <dd><code>memReqSvr</code> - the given MemoryRequestServer to request a larger WritableMemory</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>instance of this sketch</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getCDF(float[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCDF</h4> |
| <pre class="methodSignature">public double[] getCDF​(float[] splitPoints, |
| <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../quantilescommon/QuantilesFloatsAPI.html#getCDF(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesFloatsAPI</a></code></span></div> |
| <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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../quantilescommon/QuantilesFloatsAPI.html#getCDF(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getCDF</a></code> in interface <code><a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code></dd> |
| <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> |
| </dl> |
| </li> |
| </ul> |
| <a id="getMaxItem()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxItem</h4> |
| <pre class="methodSignature">public float getMaxItem()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../quantilescommon/QuantilesFloatsAPI.html#getMaxItem()">QuantilesFloatsAPI</a></code></span></div> |
| <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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../quantilescommon/QuantilesFloatsAPI.html#getMaxItem()">getMaxItem</a></code> in interface <code><a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the maximum item of the stream</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getMinItem()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMinItem</h4> |
| <pre class="methodSignature">public float getMinItem()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../quantilescommon/QuantilesFloatsAPI.html#getMinItem()">QuantilesFloatsAPI</a></code></span></div> |
| <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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../quantilescommon/QuantilesFloatsAPI.html#getMinItem()">getMinItem</a></code> in interface <code><a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the minimum item of the stream</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getPartitionBoundaries(int,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPartitionBoundaries</h4> |
| <pre class="methodSignature">public <a href="../quantilescommon/QuantilesFloatsAPI.FloatsPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI.FloatsPartitionBoundaries</a> getPartitionBoundaries​(int numEquallyWeighted, |
| <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../quantilescommon/QuantilesFloatsAPI.html#getPartitionBoundaries(int,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesFloatsAPI</a></code></span></div> |
| <div class="block">This method returns an instance of <a href="../quantilescommon/QuantilesFloatsAPI.FloatsPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>FloatsPartitionBoundaries</code></a> which provides |
| sufficient information for the user to create the given number of equally weighted partitions.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../quantilescommon/QuantilesFloatsAPI.html#getPartitionBoundaries(int,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getPartitionBoundaries</a></code> in interface <code><a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>numEquallyWeighted</code> - an integer that specifies the number of equally weighted partitions between |
| <a href="../quantilescommon/QuantilesFloatsAPI.html#getMinItem()"><code>getMinItem()</code></a> and <a href="../quantilescommon/QuantilesFloatsAPI.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="../quantilescommon/QuantilesFloatsAPI.FloatsPartitionBoundaries.html" title="class in org.apache.datasketches.quantilescommon"><code>FloatsPartitionBoundaries</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getPMF(float[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPMF</h4> |
| <pre class="methodSignature">public double[] getPMF​(float[] splitPoints, |
| <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../quantilescommon/QuantilesFloatsAPI.html#getPMF(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesFloatsAPI</a></code></span></div> |
| <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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../quantilescommon/QuantilesFloatsAPI.html#getPMF(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getPMF</a></code> in interface <code><a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code></dd> |
| <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> |
| </dl> |
| </li> |
| </ul> |
| <a id="getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQuantile</h4> |
| <pre class="methodSignature">public float getQuantile​(double rank, |
| <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../quantilescommon/QuantilesFloatsAPI.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesFloatsAPI</a></code></span></div> |
| <div class="block">Gets the approximate quantile of the given normalized rank and the given search criterion.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../quantilescommon/QuantilesFloatsAPI.html#getQuantile(double,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getQuantile</a></code> in interface <code><a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code></dd> |
| <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 ≤ |
| the quantile directly corresponding to the given rank. |
| If EXCLUSIVE, he given rank includes all quantiles < |
| 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="seeLabel">See Also:</span></dt> |
| <dd><a href="../quantilescommon/QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getQuantiles(double[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQuantiles</h4> |
| <pre class="methodSignature">public float[] getQuantiles​(double[] ranks, |
| <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../quantilescommon/QuantilesFloatsAPI.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesFloatsAPI</a></code></span></div> |
| <div class="block">Gets an array of quantiles from the given array of normalized ranks.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../quantilescommon/QuantilesFloatsAPI.html#getQuantiles(double%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getQuantiles</a></code> in interface <code><a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code></dd> |
| <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 ≤ |
| 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="seeLabel">See Also:</span></dt> |
| <dd><a href="../quantilescommon/QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getQuantileLowerBound(double)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQuantileLowerBound</h4> |
| <pre class="methodSignature">public float getQuantileLowerBound​(double 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 probablity 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> |
| The approximate probability that the true quantile is within the confidence interval |
| specified by the upper and lower quantile bounds for this sketch is 0.99.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../quantilescommon/QuantilesFloatsAPI.html#getQuantileLowerBound(double)">getQuantileLowerBound</a></code> in interface <code><a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code></dd> |
| <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> |
| </dl> |
| </li> |
| </ul> |
| <a id="getQuantileUpperBound(double)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQuantileUpperBound</h4> |
| <pre class="methodSignature">public float getQuantileUpperBound​(double 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 probablity 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> |
| The approximate probability that the true quantile is within the confidence interval |
| specified by the upper and lower quantile bounds for this sketch is 0.99.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../quantilescommon/QuantilesFloatsAPI.html#getQuantileUpperBound(double)">getQuantileUpperBound</a></code> in interface <code><a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code></dd> |
| <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> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRank(float,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRank</h4> |
| <pre class="methodSignature">public double getRank​(float quantile, |
| <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../quantilescommon/QuantilesFloatsAPI.html#getRank(float,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesFloatsAPI</a></code></span></div> |
| <div class="block">Gets the normalized rank corresponding to the given a quantile.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../quantilescommon/QuantilesFloatsAPI.html#getRank(float,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getRank</a></code> in interface <code><a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code></dd> |
| <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="seeLabel">See Also:</span></dt> |
| <dd><a href="../quantilescommon/QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRankLowerBound(double)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRankLowerBound</h4> |
| <pre class="methodSignature">public double getRankLowerBound​(double rank)</pre> |
| <div class="block">Gets the lower bound of the rank confidence interval in which the true rank of the |
| given rank exists. |
| The approximate probability that the true rank is within the confidence interval |
| specified by the upper and lower rank bounds for this sketch is 0.99.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../quantilescommon/QuantilesAPI.html#getRankLowerBound(double)">getRankLowerBound</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> |
| <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 rank confidence interval in which the true rank of the |
| given rank exists.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRankUpperBound(double)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRankUpperBound</h4> |
| <pre class="methodSignature">public double getRankUpperBound​(double rank)</pre> |
| <div class="block">Gets the upper bound of the rank confidence interval in which the true rank of the |
| given rank exists. |
| The approximate probability that the true rank is within the confidence interval |
| specified by the upper and lower rank bounds for this sketch is 0.99.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../quantilescommon/QuantilesAPI.html#getRankUpperBound(double)">getRankUpperBound</a></code> in interface <code><a href="../quantilescommon/QuantilesAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesAPI</a></code></dd> |
| <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 rank confidence interval in which the true rank of the |
| given rank exists.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRanks(float[],org.apache.datasketches.quantilescommon.QuantileSearchCriteria)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRanks</h4> |
| <pre class="methodSignature">public double[] getRanks​(float[] quantiles, |
| <a href="../quantilescommon/QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon">QuantileSearchCriteria</a> searchCrit)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../quantilescommon/QuantilesFloatsAPI.html#getRanks(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">QuantilesFloatsAPI</a></code></span></div> |
| <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="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../quantilescommon/QuantilesFloatsAPI.html#getRanks(float%5B%5D,org.apache.datasketches.quantilescommon.QuantileSearchCriteria)">getRanks</a></code> in interface <code><a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code></dd> |
| <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="seeLabel">See Also:</span></dt> |
| <dd><a href="../quantilescommon/QuantileSearchCriteria.html" title="enum in org.apache.datasketches.quantilescommon"><code>QuantileSearchCriteria</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="iterator()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>iterator</h4> |
| <pre class="methodSignature">public <a href="../quantilescommon/QuantilesFloatsSketchIterator.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsSketchIterator</a> iterator()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../quantilescommon/QuantilesFloatsAPI.html#iterator()">QuantilesFloatsAPI</a></code></span></div> |
| <div class="block">Gets the iterator for this sketch, which is not sorted.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../quantilescommon/QuantilesFloatsAPI.html#iterator()">iterator</a></code> in interface <code><a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the iterator for this sketch</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toByteArray()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toByteArray</h4> |
| <pre class="methodSignature">public byte[] toByteArray()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../quantilescommon/QuantilesFloatsAPI.html#toByteArray()">QuantilesFloatsAPI</a></code></span></div> |
| <div class="block">Returns a byte array representation of this sketch.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../quantilescommon/QuantilesFloatsAPI.html#toByteArray()">toByteArray</a></code> in interface <code><a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a byte array representation of this sketch.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="update(float)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>update</h4> |
| <pre class="methodSignature">public void update​(float item)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../quantilescommon/QuantilesFloatsAPI.html#update(float)">QuantilesFloatsAPI</a></code></span></div> |
| <div class="block">Updates this sketch with the given item.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../quantilescommon/QuantilesFloatsAPI.html#update(float)">update</a></code> in interface <code><a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>item</code> - from a stream of quantiles. NaNs are ignored.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getSortedView()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getSortedView</h4> |
| <pre class="methodSignature">public <a href="../quantilescommon/FloatsSortedView.html" title="interface in org.apache.datasketches.quantilescommon">FloatsSortedView</a> getSortedView()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../quantilescommon/QuantilesFloatsAPI.html#getSortedView()">QuantilesFloatsAPI</a></code></span></div> |
| <div class="block">Gets the sorted view of this sketch</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../quantilescommon/QuantilesFloatsAPI.html#getSortedView()">getSortedView</a></code> in interface <code><a href="../quantilescommon/QuantilesFloatsAPI.html" title="interface in org.apache.datasketches.quantilescommon">QuantilesFloatsAPI</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the sorted view of this sketch</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/KllFloatsSketch.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" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.html">All 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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2015–2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
