| <!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 (9) on Fri Oct 01 19:18:47 PDT 2021 --> |
| <title>FdtSketch (datasketches-java 3.1.0-SNAPSHOT API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="date" content="2021-10-01"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.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-1.10.2.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="FdtSketch (datasketches-java 3.1.0-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"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":10,"i16":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 = "../../../../";loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="fixedNav"> |
| <!-- ========= 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/FdtSketch.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>Prev Class</li> |
| <li><a href="../../../../org/apache/datasketches/fdt/Group.html" title="class in org.apache.datasketches.fdt"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/datasketches/fdt/FdtSketch.html" target="_top">Frames</a></li> |
| <li><a href="FdtSketch.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> |
| <ul class="navListSearch"> |
| <li><span>SEARCH: </span> |
| <input type="text" id="search" value=" " disabled="disabled"> |
| <input type="reset" id="reset" value=" " 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="#fields.inherited.from.class.org.apache.datasketches.tuple.Sketch">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="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> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="../../../../org/apache/datasketches/fdt/package-summary.html">org.apache.datasketches.fdt</a></div> |
| <h2 title="Class FdtSketch" class="title">Class FdtSketch</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/9/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><a href="../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">org.apache.datasketches.tuple.Sketch</a><S></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html" title="class in org.apache.datasketches.tuple">org.apache.datasketches.tuple.UpdatableSketch</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[],<a href="../../../../org/apache/datasketches/tuple/strings/ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a>></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../org/apache/datasketches/tuple/strings/ArrayOfStringsSketch.html" title="class in org.apache.datasketches.tuple.strings">org.apache.datasketches.tuple.strings.ArrayOfStringsSketch</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.datasketches.fdt.FdtSketch</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">FdtSketch</span> |
| extends <a href="../../../../org/apache/datasketches/tuple/strings/ArrayOfStringsSketch.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSketch</a></pre> |
| <div class="block">A Frequent Distinct Tuples sketch. |
| |
| <p>Suppose our data is a stream of pairs {IP address, User ID} and we want to identify the |
| IP addresses that have the most distinct User IDs. Or conversely, we would like to identify |
| the User IDs that have the most distinct IP addresses. This is a common challenge in the |
| analysis of big data and the FDT sketch helps solve this problem using probabilistic techniques. |
| |
| <p>More generally, given a multiset of tuples with dimensions <i>{d1,d2, d3, ..., dN}</i>, |
| and a primary subset of dimensions <i>M < N</i>, our task is to identify the combinations of |
| <i>M</i> subset dimensions that have the most frequent number of distinct combinations of |
| the <i>N-M</i> non-primary dimensions. |
| |
| <p>Please refer to the web page |
| <a href="https://datasketches.apache.org/docs/Frequency/FrequentDistinctTuplesSketch.html"> |
| https://datasketches.apache.org/docs/Frequency/FrequentDistinctTuplesSketch.html</a> for a more |
| complete discussion about this sketch.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>Lee Rhodes</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.datasketches.tuple.Sketch"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.datasketches.tuple.<a href="../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a></h3> |
| <code><a href="../../../../org/apache/datasketches/tuple/Sketch.html#PREAMBLE_LONGS">PREAMBLE_LONGS</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/fdt/FdtSketch.html#FdtSketch-double-double-">FdtSketch</a></span>​(double threshold, |
| double rse)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a new instance of Frequent Distinct Tuples sketch with a size determined by the given |
| threshold and rse.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/fdt/FdtSketch.html#FdtSketch-int-">FdtSketch</a></span>​(int lgK)</code></th> |
| <td class="colLast"> |
| <div class="block">Create new instance of Frequent Distinct Tuples sketch with the given |
| Log-base2 of required nominal entries.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" 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="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="../../../../org/apache/datasketches/tuple/CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><S></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/fdt/FdtSketch.html#compact--">compact</a></span>​()</code></th> |
| <td class="colLast"> |
| <div class="block">Converts the current state of the sketch into a compact sketch</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="../../../../org/apache/datasketches/fdt/FdtSketch.html#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="../../../../org/apache/datasketches/fdt/FdtSketch.html#getCurrentCapacity--">getCurrentCapacity</a></span>​()</code></th> |
| <td class="colLast"> |
| <div class="block">Get current capacity</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/fdt/FdtSketch.html#getLgK--">getLgK</a></span>​()</code></th> |
| <td class="colLast"> |
| <div class="block">Get log_base2 of Nominal Entries</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/fdt/FdtSketch.html#getNominalEntries--">getNominalEntries</a></span>​()</code></th> |
| <td class="colLast"> |
| <div class="block">Get configured nominal number of entries</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/datasketches/fdt/PostProcessor.html" title="class in org.apache.datasketches.fdt">PostProcessor</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/fdt/FdtSketch.html#getPostProcessor--">getPostProcessor</a></span>​()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the PostProcessor that enables multiple queries against the sketch results.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/datasketches/fdt/PostProcessor.html" title="class in org.apache.datasketches.fdt">PostProcessor</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/fdt/FdtSketch.html#getPostProcessor-org.apache.datasketches.fdt.Group-char-">getPostProcessor</a></span>​(<a href="../../../../org/apache/datasketches/fdt/Group.html" title="class in org.apache.datasketches.fdt">Group</a> group, |
| char sep)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the PostProcessor that enables multiple queries against the sketch results.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/datasketches/ResizeFactor.html" title="enum in org.apache.datasketches">ResizeFactor</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/fdt/FdtSketch.html#getResizeFactor--">getResizeFactor</a></span>​()</code></th> |
| <td class="colLast"> |
| <div class="block">Get configured resize factor</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/datasketches/fdt/Group.html" title="class in org.apache.datasketches.fdt">Group</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/fdt/FdtSketch.html#getResult-int:A-int-int-char-">getResult</a></span>​(int[] priKeyIndices, |
| int limit, |
| int numStdDev, |
| char sep)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns an ordered List of Groups of the most frequent distinct population of subset tuples |
| represented by the count of entries of each group.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/fdt/FdtSketch.html#getRetainedEntries--">getRetainedEntries</a></span>​()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>float</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/fdt/FdtSketch.html#getSamplingProbability--">getSamplingProbability</a></span>​()</code></th> |
| <td class="colLast"> |
| <div class="block">Get configured sampling probability</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/fdt/FdtSketch.html#insertSummary-int-S-">insertSummary</a></span>​(int index, |
| S summary)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/datasketches/tuple/SketchIterator.html" title="class in org.apache.datasketches.tuple">SketchIterator</a><S></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/fdt/FdtSketch.html#iterator--">iterator</a></span>​()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a SketchIterator</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/fdt/FdtSketch.html#reset--">reset</a></span>​()</code></th> |
| <td class="colLast"> |
| <div class="block">Resets this sketch an empty state.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/fdt/FdtSketch.html#toByteArray--">toByteArray</a></span>​()</code></th> |
| <td class="colLast"> |
| <div class="block">This is to serialize an instance to a byte array.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/fdt/FdtSketch.html#trim--">trim</a></span>​()</code></th> |
| <td class="colLast"> |
| <div class="block">Rebuilds reducing the actual number of entries to the nominal number of entries if needed</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/fdt/FdtSketch.html#update-java.lang.String:A-">update</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] tuple)</code></th> |
| <td class="colLast"> |
| <div class="block">Update the sketch with the given string array tuple.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.datasketches.tuple.strings.ArrayOfStringsSketch"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.datasketches.tuple.strings.<a href="../../../../org/apache/datasketches/tuple/strings/ArrayOfStringsSketch.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSketch</a></h3> |
| <code><a href="../../../../org/apache/datasketches/tuple/strings/ArrayOfStringsSketch.html#update-java.lang.String:A-java.lang.String:A-">update</a></code></li> |
| </ul> |
| <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/9/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/9/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/9/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/9/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/9/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/9/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/9/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/9/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/9/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/9/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/9/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.datasketches.tuple.Sketch"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.datasketches.tuple.<a href="../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a></h3> |
| <code><a href="../../../../org/apache/datasketches/tuple/Sketch.html#getEstimate--">getEstimate</a>, <a href="../../../../org/apache/datasketches/tuple/Sketch.html#getEstimate-int-">getEstimate</a>, <a href="../../../../org/apache/datasketches/tuple/Sketch.html#getLowerBound-int-">getLowerBound</a>, <a href="../../../../org/apache/datasketches/tuple/Sketch.html#getLowerBound-int-int-">getLowerBound</a>, <a href="../../../../org/apache/datasketches/tuple/Sketch.html#getTheta--">getTheta</a>, <a href="../../../../org/apache/datasketches/tuple/Sketch.html#getThetaLong--">getThetaLong</a>, <a href="../../../../org/apache/datasketches/tuple/Sketch.html#getUpperBound-int-">getUpperBound</a>, <a href="../../../../org/apache/datasketches/tuple/Sketch.html#getUpperBound-int-int-">getUpperBound</a>, <a href="../../../../org/apache/datasketches/tuple/Sketch.html#isEmpty--">isEmpty</a>, <a href="../../../../org/apache/datasketches/tuple/Sketch.html#isEstimationMode--">isEstimationMode</a>, <a href="../../../../org/apache/datasketches/tuple/Sketch.html#toString--">toString</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.datasketches.tuple.UpdatableSketch"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.datasketches.tuple.<a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a></h3> |
| <code><a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html#update-byte:A-U-">update</a>, <a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html#update-double-U-">update</a>, <a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html#update-int:A-U-">update</a>, <a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html#update-long:A-U-">update</a>, <a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html#update-long-U-">update</a>, <a href="../../../../org/apache/datasketches/tuple/UpdatableSketch.html#update-java.lang.String-U-">update</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="FdtSketch-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>FdtSketch</h4> |
| <pre>public FdtSketch​(int lgK)</pre> |
| <div class="block">Create new instance of Frequent Distinct Tuples sketch with the given |
| Log-base2 of required nominal entries.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>lgK</code> - Log-base2 of required nominal entries.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="FdtSketch-double-double-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>FdtSketch</h4> |
| <pre>public FdtSketch​(double threshold, |
| double rse)</pre> |
| <div class="block">Create a new instance of Frequent Distinct Tuples sketch with a size determined by the given |
| threshold and rse.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>threshold</code> - : the fraction, between zero and 1.0, of the total distinct stream length |
| that defines a "Frequent" (or heavy) item.</dd> |
| <dd><code>rse</code> - the maximum Relative Standard Error for the estimate of the distinct population of a |
| reported tuple (selected with a primary key) at the threshold.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="update-java.lang.String:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>update</h4> |
| <pre>public void update​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] tuple)</pre> |
| <div class="block">Update the sketch with the given string array tuple.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>tuple</code> - the given string array tuple.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getResult-int:A-int-int-char-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResult</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/datasketches/fdt/Group.html" title="class in org.apache.datasketches.fdt">Group</a>> getResult​(int[] priKeyIndices, |
| int limit, |
| int numStdDev, |
| char sep)</pre> |
| <div class="block">Returns an ordered List of Groups of the most frequent distinct population of subset tuples |
| represented by the count of entries of each group.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>priKeyIndices</code> - these indices define the dimensions used for the Primary Keys.</dd> |
| <dd><code>limit</code> - the maximum number of groups to return. If this value is ≤ 0, all |
| groups will be returned.</dd> |
| <dd><code>numStdDev</code> - the number of standard deviations for the upper and lower error bounds, |
| this value is an integer and must be one of 1, 2, or 3. |
| <a href="../../../../resources/dictionary.html#numStdDev">See Number of Standard Deviations</a></dd> |
| <dd><code>sep</code> - the separator character</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an ordered List of Groups of the most frequent distinct population of subset tuples |
| represented by the count of entries of each group.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPostProcessor--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPostProcessor</h4> |
| <pre>public <a href="../../../../org/apache/datasketches/fdt/PostProcessor.html" title="class in org.apache.datasketches.fdt">PostProcessor</a> getPostProcessor​()</pre> |
| <div class="block">Returns the PostProcessor that enables multiple queries against the sketch results. |
| This assumes the default Group and the default separator character '|'.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the PostProcessor</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPostProcessor-org.apache.datasketches.fdt.Group-char-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPostProcessor</h4> |
| <pre>public <a href="../../../../org/apache/datasketches/fdt/PostProcessor.html" title="class in org.apache.datasketches.fdt">PostProcessor</a> getPostProcessor​(<a href="../../../../org/apache/datasketches/fdt/Group.html" title="class in org.apache.datasketches.fdt">Group</a> group, |
| char sep)</pre> |
| <div class="block">Returns the PostProcessor that enables multiple queries against the sketch results.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>group</code> - the Group class to use during post processing.</dd> |
| <dd><code>sep</code> - the separator character.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the PostProcessor</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRetainedEntries--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRetainedEntries</h4> |
| <pre>public int getRetainedEntries​()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/datasketches/tuple/Sketch.html#getRetainedEntries--">getRetainedEntries</a></code> in class <code><a href="../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S extends <a href="../../../../org/apache/datasketches/tuple/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 name="getCountLessThanThetaLong-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCountLessThanThetaLong</h4> |
| <pre>public int getCountLessThanThetaLong​(long thetaLong)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/datasketches/tuple/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="../../../../org/apache/datasketches/tuple/Sketch.html#getCountLessThanThetaLong-long-">getCountLessThanThetaLong</a></code> in class <code><a href="../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S extends <a href="../../../../org/apache/datasketches/tuple/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 name="getNominalEntries--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNominalEntries</h4> |
| <pre>public int getNominalEntries​()</pre> |
| <div class="block">Get configured nominal number of entries</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>nominal number of entries</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLgK--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLgK</h4> |
| <pre>public int getLgK​()</pre> |
| <div class="block">Get log_base2 of Nominal Entries</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>log_base2 of Nominal Entries</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSamplingProbability--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSamplingProbability</h4> |
| <pre>public float getSamplingProbability​()</pre> |
| <div class="block">Get configured sampling probability</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>sampling probability</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCurrentCapacity--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCurrentCapacity</h4> |
| <pre>public int getCurrentCapacity​()</pre> |
| <div class="block">Get current capacity</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>current capacity</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getResizeFactor--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResizeFactor</h4> |
| <pre>public <a href="../../../../org/apache/datasketches/ResizeFactor.html" title="enum in org.apache.datasketches">ResizeFactor</a> getResizeFactor​()</pre> |
| <div class="block">Get configured resize factor</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>resize factor</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="trim--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>trim</h4> |
| <pre>public void trim​()</pre> |
| <div class="block">Rebuilds reducing the actual number of entries to the nominal number of entries if needed</div> |
| </li> |
| </ul> |
| <a name="reset--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reset</h4> |
| <pre>public void reset​()</pre> |
| <div class="block">Resets this sketch an empty state.</div> |
| </li> |
| </ul> |
| <a name="compact--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>compact</h4> |
| <pre>public <a href="../../../../org/apache/datasketches/tuple/CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><S> compact​()</pre> |
| <div class="block">Converts the current state of the sketch into a compact sketch</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/datasketches/tuple/Sketch.html#compact--">compact</a></code> in class <code><a href="../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S extends <a href="../../../../org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>compact sketch</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toByteArray--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toByteArray</h4> |
| <pre>public byte[] toByteArray​()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/datasketches/tuple/Sketch.html#toByteArray--">Sketch</a></code></span></div> |
| <div class="block">This is to serialize an instance to a byte array.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/datasketches/tuple/Sketch.html#toByteArray--">toByteArray</a></code> in class <code><a href="../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S extends <a href="../../../../org/apache/datasketches/tuple/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 name="insertSummary-int-org.apache.datasketches.tuple.Summary-"> |
| <!-- --> |
| </a><a name="insertSummary-int-S-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>insertSummary</h4> |
| <pre>protected void insertSummary​(int index, |
| S summary)</pre> |
| </li> |
| </ul> |
| <a name="iterator--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>iterator</h4> |
| <pre>public <a href="../../../../org/apache/datasketches/tuple/SketchIterator.html" title="class in org.apache.datasketches.tuple">SketchIterator</a><S> iterator​()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/datasketches/tuple/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="../../../../org/apache/datasketches/tuple/Sketch.html#iterator--">iterator</a></code> in class <code><a href="../../../../org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S extends <a href="../../../../org/apache/datasketches/tuple/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> |
| </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/FdtSketch.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>Prev Class</li> |
| <li><a href="../../../../org/apache/datasketches/fdt/Group.html" title="class in org.apache.datasketches.fdt"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/datasketches/fdt/FdtSketch.html" target="_top">Frames</a></li> |
| <li><a href="FdtSketch.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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#fields.inherited.from.class.org.apache.datasketches.tuple.Sketch">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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–2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |