| <!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 (1.8.0_302) on Wed Jan 26 15:15:51 PST 2022 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>ArrayOfDoublesSketch (datasketches-java 3.1.0 API)</title> |
| <meta name="date" content="2022-01-26"> |
| <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="ArrayOfDoublesSketch (datasketches-java 3.1.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":6,"i2":6,"i3":10,"i4":10,"i5":6,"i6":10,"i7":6,"i8":10,"i9":10,"i10":6,"i11":6,"i12":9,"i13":9,"i14":10,"i15":10,"i16":6,"i17":6,"i18":10,"i19":9,"i20":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete 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/ArrayOfDoublesSketch.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/tuple/arrayofdoubles/ArrayOfDoublesSetOperationBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketches.html" title="class in org.apache.datasketches.tuple.arrayofdoubles"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html" target="_top">Frames</a></li> |
| <li><a href="ArrayOfDoublesSketch.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </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 name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.datasketches.tuple.arrayofdoubles</div> |
| <h2 title="Class ArrayOfDoublesSketch" class="title">Class ArrayOfDoublesSketch</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">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.datasketches.tuple.arrayofdoubles.ArrayOfDoublesSketch</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../../org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a>, <a href="../../../../../org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">ArrayOfDoublesSketch</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| <div class="block">The base class for the tuple sketch of type ArrayOfDoubles, where an array of double values |
| is associated with each key. |
| A primitive array of doubles is used here, as opposed to a generic Summary object, |
| for improved performance.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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"> </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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html#compact--">compact</a></span>()</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../../org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html#compact-org.apache.datasketches.memory.WritableMemory-">compact</a></span>(org.apache.datasketches.memory.WritableMemory dstMem)</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>abstract int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html#getCurrentBytes--">getCurrentBytes</a></span>()</code> |
| <div class="block">For compact sketches this is the same as getMaxBytes().</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/tuple/arrayofdoubles/ArrayOfDoublesSketch.html#getEstimate--">getEstimate</a></span>()</code> |
| <div class="block">Estimates the cardinality of the set (number of unique values presented to the sketch)</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html#getLowerBound-int-">getLowerBound</a></span>(int numStdDev)</code> |
| <div class="block">Gets the approximate lower error bound given the specified number of Standard Deviations.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>abstract int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html#getMaxBytes--">getMaxBytes</a></span>()</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html#getNumValues--">getNumValues</a></span>()</code> </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>abstract int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html#getRetainedEntries--">getRetainedEntries</a></span>()</code> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html#getTheta--">getTheta</a></span>()</code> |
| <div class="block">Gets the value of theta as a double between zero and one</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/tuple/arrayofdoubles/ArrayOfDoublesSketch.html#getUpperBound-int-">getUpperBound</a></span>(int numStdDev)</code> |
| <div class="block">Gets the approximate upper error bound given the specified number of Standard Deviations.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>abstract double[][]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html#getValues--">getValues</a></span>()</code> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>abstract boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html#hasMemory--">hasMemory</a></span>()</code> |
| <div class="block">Returns true if this sketch's data structure is backed by Memory or WritableMemory.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html#heapify-org.apache.datasketches.memory.Memory-">heapify</a></span>(org.apache.datasketches.memory.Memory mem)</code> |
| <div class="block">Heapify the given Memory as an ArrayOfDoublesSketch</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html#heapify-org.apache.datasketches.memory.Memory-long-">heapify</a></span>(org.apache.datasketches.memory.Memory mem, |
| long seed)</code> |
| <div class="block">Heapify the given Memory and seed as a ArrayOfDoublesSketch</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html#isEmpty--">isEmpty</a></span>()</code> |
| <div class="block"><a href="../../../../../resources/dictionary.html#empty">See Empty</a></div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html#isEstimationMode--">isEstimationMode</a></span>()</code> |
| <div class="block">Returns true if the sketch is Estimation Mode (as opposed to Exact Mode).</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../../org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketchIterator.html" title="interface in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketchIterator</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html#iterator--">iterator</a></span>()</code> </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>abstract byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html#toByteArray--">toByteArray</a></span>()</code> </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html#toString--">toString</a></span>()</code> </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html#wrap-org.apache.datasketches.memory.Memory-">wrap</a></span>(org.apache.datasketches.memory.Memory mem)</code> |
| <div class="block">Wrap the given Memory as an ArrayOfDoublesSketch</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html#wrap-org.apache.datasketches.memory.Memory-long-">wrap</a></span>(org.apache.datasketches.memory.Memory mem, |
| long seed)</code> |
| <div class="block">Wrap the given Memory and seed as a ArrayOfDoublesSketch</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="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">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">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">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">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">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">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">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">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">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">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">wait</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="heapify-org.apache.datasketches.memory.Memory-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>heapify</h4> |
| <pre>public static <a href="../../../../../org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a> heapify(org.apache.datasketches.memory.Memory mem)</pre> |
| <div class="block">Heapify the given Memory as an ArrayOfDoublesSketch</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>mem</code> - the given Memory</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an ArrayOfDoublesSketch</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="heapify-org.apache.datasketches.memory.Memory-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>heapify</h4> |
| <pre>public static <a href="../../../../../org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a> heapify(org.apache.datasketches.memory.Memory mem, |
| long seed)</pre> |
| <div class="block">Heapify the given Memory and seed as a ArrayOfDoublesSketch</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>mem</code> - the given Memory</dd> |
| <dd><code>seed</code> - the given seed</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an ArrayOfDoublesSketch</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="wrap-org.apache.datasketches.memory.Memory-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>wrap</h4> |
| <pre>public static <a href="../../../../../org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a> wrap(org.apache.datasketches.memory.Memory mem)</pre> |
| <div class="block">Wrap the given Memory as an ArrayOfDoublesSketch</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>mem</code> - the given Memory</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an ArrayOfDoublesSketch</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="wrap-org.apache.datasketches.memory.Memory-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>wrap</h4> |
| <pre>public static <a href="../../../../../org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a> wrap(org.apache.datasketches.memory.Memory mem, |
| long seed)</pre> |
| <div class="block">Wrap the given Memory and seed as a ArrayOfDoublesSketch</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>mem</code> - the given Memory</dd> |
| <dd><code>seed</code> - the given seed</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an ArrayOfDoublesSketch</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEstimate--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEstimate</h4> |
| <pre>public double getEstimate()</pre> |
| <div class="block">Estimates the cardinality of the set (number of unique values presented to the sketch)</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>best estimate of the number of unique values</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getUpperBound-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUpperBound</h4> |
| <pre>public double getUpperBound(int numStdDev)</pre> |
| <div class="block">Gets the approximate upper error bound given the specified number of Standard Deviations. |
| This will return getEstimate() if isEmpty() is true.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>numStdDev</code> - <a href="../../../../../resources/dictionary.html#numStdDev">See Number of Standard Deviations</a></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the upper bound.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLowerBound-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLowerBound</h4> |
| <pre>public double getLowerBound(int numStdDev)</pre> |
| <div class="block">Gets the approximate lower error bound given the specified number of Standard Deviations. |
| This will return getEstimate() if isEmpty() is true.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>numStdDev</code> - <a href="../../../../../resources/dictionary.html#numStdDev">See Number of Standard Deviations</a></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the lower bound.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hasMemory--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasMemory</h4> |
| <pre>public abstract boolean hasMemory()</pre> |
| <div class="block">Returns true if this sketch's data structure is backed by Memory or WritableMemory.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if this sketch's data structure is backed by Memory or WritableMemory.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isEmpty--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isEmpty</h4> |
| <pre>public boolean isEmpty()</pre> |
| <div class="block"><a href="../../../../../resources/dictionary.html#empty">See Empty</a></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if empty.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getNumValues--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNumValues</h4> |
| <pre>public int getNumValues()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>number of double values associated with each key</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isEstimationMode--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isEstimationMode</h4> |
| <pre>public boolean isEstimationMode()</pre> |
| <div class="block">Returns true if the sketch is Estimation Mode (as opposed to Exact Mode). |
| This is true if theta < 1.0 AND isEmpty() is false.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if the sketch is in estimation mode.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTheta--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTheta</h4> |
| <pre>public double getTheta()</pre> |
| <div class="block">Gets the value of theta as a double between zero and one</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value of theta as a double</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRetainedEntries--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRetainedEntries</h4> |
| <pre>public abstract int getRetainedEntries()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>number of retained entries</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMaxBytes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxBytes</h4> |
| <pre>public abstract int getMaxBytes()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the maximum number of bytes for this sketch when serialized.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCurrentBytes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCurrentBytes</h4> |
| <pre>public abstract int getCurrentBytes()</pre> |
| <div class="block">For compact sketches this is the same as getMaxBytes().</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current number of bytes for this sketch when serialized.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toByteArray--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toByteArray</h4> |
| <pre>public abstract byte[] toByteArray()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>serialized representation of the sketch</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getValues--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValues</h4> |
| <pre>public abstract double[][] getValues()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>array of arrays of double values in the sketch</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="iterator--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>iterator</h4> |
| <pre>public abstract <a href="../../../../../org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketchIterator.html" title="interface in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketchIterator</a> iterator()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>iterator over the sketch</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="compact--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>compact</h4> |
| <pre>public <a href="../../../../../org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a> compact()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this sketch in compact form, which is immutable.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="compact-org.apache.datasketches.memory.WritableMemory-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>compact</h4> |
| <pre>public abstract <a href="../../../../../org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a> compact(org.apache.datasketches.memory.WritableMemory dstMem)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dstMem</code> - the destination WritableMemory</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this sketch in compact form, which is immutable.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></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/ArrayOfDoublesSketch.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/tuple/arrayofdoubles/ArrayOfDoublesSetOperationBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketches.html" title="class in org.apache.datasketches.tuple.arrayofdoubles"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html" target="_top">Frames</a></li> |
| <li><a href="ArrayOfDoublesSketch.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </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 name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2015–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |