| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>CompactSketch (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="CompactSketch (datasketches-java 4.0.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10}; |
| var tabs = {65535:["t0","All 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/CompactSketch.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>Nested | </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.tuple</a></div> |
| <h2 title="Class CompactSketch" class="title">Class CompactSketch<S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></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="Sketch.html" title="class in org.apache.datasketches.tuple">org.apache.datasketches.tuple.Sketch</a><S></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.datasketches.tuple.CompactSketch<S></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>S</code> - type of Summary</dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">CompactSketch<S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></span> |
| extends <a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S></pre> |
| <div class="block">CompactSketches are never created directly. They are created as a result of |
| the compact() method of an UpdatableSketch or as a result of the getResult() |
| method of a set operation like Union, Intersection or AnotB. CompactSketch |
| consists of a compact list (i.e. no intervening spaces) of hash values, |
| corresponding list of Summaries, and a value for theta. The lists may or may |
| not be ordered. CompactSketch is read-only.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== 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.tuple.Sketch"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.datasketches.tuple.<a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a></h3> |
| <code><a href="Sketch.html#PREAMBLE_LONGS">PREAMBLE_LONGS</a>, <a href="Sketch.html#summaryFactory_">summaryFactory_</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="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><a href="CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="CompactSketch.html" title="type parameter in CompactSketch">S</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#compact()">compact</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Converts this sketch to a CompactSketch on the Java heap.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCountLessThanThetaLong(long)">getCountLessThanThetaLong</a></span>​(long thetaLong)</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the number of hash values less than the given theta expressed as a long.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRetainedEntries()">getRetainedEntries</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="TupleSketchIterator.html" title="class in org.apache.datasketches.tuple">TupleSketchIterator</a><<a href="CompactSketch.html" title="type parameter in CompactSketch">S</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">Returns a SketchIterator</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <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">This is to serialize a sketch instance to a byte array.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.apache.datasketches.tuple.Sketch"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.datasketches.tuple.<a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a></h3> |
| <code><a href="Sketch.html#getEstimate()">getEstimate</a>, <a href="Sketch.html#getEstimate(int)">getEstimate</a>, <a href="Sketch.html#getLowerBound(int)">getLowerBound</a>, <a href="Sketch.html#getLowerBound(int,int)">getLowerBound</a>, <a href="Sketch.html#getSummaryFactory()">getSummaryFactory</a>, <a href="Sketch.html#getTheta()">getTheta</a>, <a href="Sketch.html#getThetaLong()">getThetaLong</a>, <a href="Sketch.html#getUpperBound(int)">getUpperBound</a>, <a href="Sketch.html#getUpperBound(int,int)">getUpperBound</a>, <a href="Sketch.html#isEmpty()">isEmpty</a>, <a href="Sketch.html#isEstimationMode()">isEstimationMode</a>, <a href="Sketch.html#toString()">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> |
| </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="compact()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>compact</h4> |
| <pre class="methodSignature">public <a href="CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="CompactSketch.html" title="type parameter in CompactSketch">S</a>> compact()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="Sketch.html#compact()">Sketch</a></code></span></div> |
| <div class="block">Converts this sketch to a CompactSketch on the Java heap. |
| |
| <p>If this sketch is already in compact form this operation returns <i>this</i>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="Sketch.html#compact()">compact</a></code> in class <code><a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="CompactSketch.html" title="type parameter in CompactSketch">S</a> extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this sketch as a CompactSketch on the Java heap.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getRetainedEntries()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRetainedEntries</h4> |
| <pre class="methodSignature">public int getRetainedEntries()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="Sketch.html#getRetainedEntries()">getRetainedEntries</a></code> in class <code><a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="CompactSketch.html" title="type parameter in CompactSketch">S</a> extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>number of retained entries</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getCountLessThanThetaLong(long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCountLessThanThetaLong</h4> |
| <pre class="methodSignature">public int getCountLessThanThetaLong​(long thetaLong)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="Sketch.html#getCountLessThanThetaLong(long)">Sketch</a></code></span></div> |
| <div class="block">Gets the number of hash values less than the given theta expressed as a long.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="Sketch.html#getCountLessThanThetaLong(long)">getCountLessThanThetaLong</a></code> in class <code><a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="CompactSketch.html" title="type parameter in CompactSketch">S</a> extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>thetaLong</code> - the given theta as a long between zero and <i>Long.MAX_VALUE</i>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of hash values less than the given thetaLong.</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 class: <code><a href="Sketch.html#toByteArray()">Sketch</a></code></span></div> |
| <div class="block">This is to serialize a sketch instance to a byte array. |
| |
| <p>As of 3.0.0, serializing an UpdatableSketch is deprecated. |
| This capability will be removed in a future release. |
| Serializing a CompactSketch is not deprecated.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="Sketch.html#toByteArray()">toByteArray</a></code> in class <code><a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="CompactSketch.html" title="type parameter in CompactSketch">S</a> extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>serialized representation of the sketch</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="iterator()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>iterator</h4> |
| <pre class="methodSignature">public <a href="TupleSketchIterator.html" title="class in org.apache.datasketches.tuple">TupleSketchIterator</a><<a href="CompactSketch.html" title="type parameter in CompactSketch">S</a>> iterator()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="Sketch.html#iterator()">Sketch</a></code></span></div> |
| <div class="block">Returns a SketchIterator</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="Sketch.html#iterator()">iterator</a></code> in class <code><a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="CompactSketch.html" title="type parameter in CompactSketch">S</a> extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a SketchIterator</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/CompactSketch.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>Nested | </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> |
