| <!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_162) on Thu Oct 25 17:06:10 PDT 2018 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>Family (com.yahoo.datasketches:sketches-core 0.12.1-SNAPSHOT API)</title> |
| <meta name="date" content="2018-10-25"> |
| <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="Family (com.yahoo.datasketches:sketches-core 0.12.1-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":9,"i6":9,"i7":10,"i8":9,"i9":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </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/Family.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="../../../com/yahoo/sketches/ByteArrayUtil.html" title="class in com.yahoo.sketches"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../com/yahoo/sketches/HashOperations.html" title="class in com.yahoo.sketches"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?com/yahoo/sketches/Family.html" target="_top">Frames</a></li> |
| <li><a href="Family.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><a href="#enum.constant.summary">Enum Constants</a> | </li> |
| <li>Field | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#enum.constant.detail">Enum Constants</a> | </li> |
| <li>Field | </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">com.yahoo.sketches</div> |
| <h2 title="Enum Family" class="title">Enum Family</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><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">java.lang.Enum</a><<a href="../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a>></li> |
| <li> |
| <ul class="inheritance"> |
| <li>com.yahoo.sketches.Family</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><<a href="../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a>></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public enum <span class="typeNameLabel">Family</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a><<a href="../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a>></pre> |
| <div class="block">Defines the various families of sketch and set operation classes. A family defines a set of |
| classes that share fundamental algorithms and behaviors. The classes within a family may |
| still differ by how they are stored and accessed. For example, internally there are separate |
| classes for the QuickSelect sketch algorithm that operate on the Java heap and off-heap. |
| Not all of these families have parallel forms on and off-heap but are included for completeness.</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"> |
| <!-- =========== ENUM CONSTANT SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="enum.constant.summary"> |
| <!-- --> |
| </a> |
| <h3>Enum Constant Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> |
| <caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Enum Constant and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../com/yahoo/sketches/Family.html#A_NOT_B">A_NOT_B</a></span></code> |
| <div class="block">The A and not B family is an operation for the Theta Sketch Framework of sketches.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../com/yahoo/sketches/Family.html#ALPHA">ALPHA</a></span></code> |
| <div class="block">The Alpha Sketch family is a member of the Theta Sketch Framework of sketches and is best |
| suited for real-time processes where both the updating of the sketch and getting the estimate |
| is performed directly on the sketch.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../com/yahoo/sketches/Family.html#COMPACT">COMPACT</a></span></code> |
| <div class="block">The Compact Sketch family is a member of the Theta Sketch Framework of sketches.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../com/yahoo/sketches/Family.html#CPC">CPC</a></span></code> |
| <div class="block">Compressed Probabilistic Counting (CPC) Sketch</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../com/yahoo/sketches/Family.html#FREQUENCY">FREQUENCY</a></span></code> |
| <div class="block">The Frequency family of sketches.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../com/yahoo/sketches/Family.html#HLL">HLL</a></span></code> |
| <div class="block">The HLL family of sketches.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../com/yahoo/sketches/Family.html#INTERSECTION">INTERSECTION</a></span></code> |
| <div class="block">The Intersection family is an operation for the Theta Sketch Framework of sketches.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../com/yahoo/sketches/Family.html#KLL">KLL</a></span></code> |
| <div class="block">KLL quanliles sketch</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../com/yahoo/sketches/Family.html#QUANTILES">QUANTILES</a></span></code> |
| <div class="block">The Quantiles family of sketches.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../com/yahoo/sketches/Family.html#QUICKSELECT">QUICKSELECT</a></span></code> |
| <div class="block">The QuickSelect Sketch family is a member of the Theta Sketch Framework of sketches and |
| is the workhorse of the Theta Sketch Families and can be constructed for either on-heap or |
| off-heap operation.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../com/yahoo/sketches/Family.html#RESERVOIR">RESERVOIR</a></span></code> |
| <div class="block">The Reservoir family of sketches.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../com/yahoo/sketches/Family.html#RESERVOIR_UNION">RESERVOIR_UNION</a></span></code> |
| <div class="block">The reservoir sampling family of Union operations.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../com/yahoo/sketches/Family.html#TUPLE">TUPLE</a></span></code> |
| <div class="block">The Tuple family of sketches is a large family of sketches that are extensions of the |
| Theta Sketch Framework.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../com/yahoo/sketches/Family.html#UNION">UNION</a></span></code> |
| <div class="block">The Union family is an operation for the Theta Sketch Framework of sketches.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../com/yahoo/sketches/Family.html#VAROPT">VAROPT</a></span></code> |
| <div class="block">The VarOpt family of sketches.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../com/yahoo/sketches/Family.html#VAROPT_UNION">VAROPT_UNION</a></span></code> |
| <div class="block">The VarOpt family of sketches.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/yahoo/sketches/Family.html#checkFamilyID-int-">checkFamilyID</a></span>(int id)</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <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="../../../com/yahoo/sketches/Family.html#getFamilyName--">getFamilyName</a></span>()</code> |
| <div class="block">Returns the name for this family</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/yahoo/sketches/Family.html#getID--">getID</a></span>()</code> |
| <div class="block">Returns the byte ID for this family</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/yahoo/sketches/Family.html#getMaxPreLongs--">getMaxPreLongs</a></span>()</code> |
| <div class="block">Returns the maximum preamble size for this family in longs</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/yahoo/sketches/Family.html#getMinPreLongs--">getMinPreLongs</a></span>()</code> |
| <div class="block">Returns the minimum preamble size for this family in longs</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/yahoo/sketches/Family.html#idToFamily-int-">idToFamily</a></span>(int id)</code> |
| <div class="block">Returns the Family given the ID</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/yahoo/sketches/Family.html#stringToFamily-java.lang.String-">stringToFamily</a></span>(<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> famName)</code> |
| <div class="block">Returns the Family given the family name</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <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="../../../com/yahoo/sketches/Family.html#toString--">toString</a></span>()</code> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/yahoo/sketches/Family.html#valueOf-java.lang.String-">valueOf</a></span>(<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> name)</code> |
| <div class="block">Returns the enum constant of this type with the specified name.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/yahoo/sketches/Family.html#values--">values</a></span>()</code> |
| <div class="block">Returns an array containing the constants of this enum type, in |
| the order they are declared.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.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/Enum.html?is-external=true#compareTo-E-" title="class or interface in java.lang">compareTo</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.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/Enum.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/Enum.html?is-external=true#getDeclaringClass--" title="class or interface in java.lang">getDeclaringClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.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/Enum.html?is-external=true#name--" title="class or interface in java.lang">name</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#ordinal--" title="class or interface in java.lang">ordinal</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#valueOf-java.lang.Class-java.lang.String-" title="class or interface in java.lang">valueOf</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/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#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#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"> |
| <!-- ============ ENUM CONSTANT DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="enum.constant.detail"> |
| <!-- --> |
| </a> |
| <h3>Enum Constant Detail</h3> |
| <a name="ALPHA"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ALPHA</h4> |
| <pre>public static final <a href="../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a> ALPHA</pre> |
| <div class="block">The Alpha Sketch family is a member of the Theta Sketch Framework of sketches and is best |
| suited for real-time processes where both the updating of the sketch and getting the estimate |
| is performed directly on the sketch. In this situation the AlphaSketch has roughly a |
| 30% improvement (~1/sqrt(2*k)) in its error distribution as compared to the QuickSelect |
| (or similar KMV-derived) sketches. |
| |
| <p>If the AlphaSketch is fed into any SetOperation, the error distribution reverts back to the |
| normal QuickSelect/KMV error distribution (~1/sqrt(k)). For this reason, the AlphaSketch |
| does not have a sister class for off-heap operation. The Alpha Sketch has a roughly 30% faster |
| overall update time as compared to the QuickSelect sketch family.</p> |
| |
| <p>The Alpha Sketch is created using the UpdateSketch.builder(). |
| <a href="../../../resources/dictionary.html#alphaTCF">See Alpha TCF</a> and |
| <a href="../../../resources/dictionary.html#thetaSketch">Theta Sketch Framework</a></div> |
| </li> |
| </ul> |
| <a name="QUICKSELECT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>QUICKSELECT</h4> |
| <pre>public static final <a href="../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a> QUICKSELECT</pre> |
| <div class="block">The QuickSelect Sketch family is a member of the Theta Sketch Framework of sketches and |
| is the workhorse of the Theta Sketch Families and can be constructed for either on-heap or |
| off-heap operation. |
| The QuickSelect Sketch is created using the UpdateSketch.builder(). |
| <a href="../../../resources/dictionary.html#quickSelectTCF">See Quick Select TCF</a></div> |
| </li> |
| </ul> |
| <a name="COMPACT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>COMPACT</h4> |
| <pre>public static final <a href="../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a> COMPACT</pre> |
| <div class="block">The Compact Sketch family is a member of the Theta Sketch Framework of sketches. |
| The are read-only and cannot be updated, but can participate in any of the Set Operations. |
| The compact sketches are never created directly with a constructor or Builder. |
| Instead they are created as a result of the compact() |
| method of an UpdateSketch or as a result of a getSketchSamples() of a SetOperation.</div> |
| </li> |
| </ul> |
| <a name="UNION"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>UNION</h4> |
| <pre>public static final <a href="../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a> UNION</pre> |
| <div class="block">The Union family is an operation for the Theta Sketch Framework of sketches. |
| The Union is constructed using the SetOperation.builder().</div> |
| </li> |
| </ul> |
| <a name="INTERSECTION"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>INTERSECTION</h4> |
| <pre>public static final <a href="../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a> INTERSECTION</pre> |
| <div class="block">The Intersection family is an operation for the Theta Sketch Framework of sketches. |
| The Intersection is constructed using the SetOperation.builder().</div> |
| </li> |
| </ul> |
| <a name="A_NOT_B"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>A_NOT_B</h4> |
| <pre>public static final <a href="../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a> A_NOT_B</pre> |
| <div class="block">The A and not B family is an operation for the Theta Sketch Framework of sketches. |
| The AnotB operation is constructed using the SetOperation.builder().</div> |
| </li> |
| </ul> |
| <a name="HLL"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>HLL</h4> |
| <pre>public static final <a href="../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a> HLL</pre> |
| <div class="block">The HLL family of sketches. (Not part of TSF.)</div> |
| </li> |
| </ul> |
| <a name="QUANTILES"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>QUANTILES</h4> |
| <pre>public static final <a href="../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a> QUANTILES</pre> |
| <div class="block">The Quantiles family of sketches. (Not part of TSF.)</div> |
| </li> |
| </ul> |
| <a name="TUPLE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TUPLE</h4> |
| <pre>public static final <a href="../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a> TUPLE</pre> |
| <div class="block">The Tuple family of sketches is a large family of sketches that are extensions of the |
| Theta Sketch Framework.</div> |
| </li> |
| </ul> |
| <a name="FREQUENCY"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>FREQUENCY</h4> |
| <pre>public static final <a href="../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a> FREQUENCY</pre> |
| <div class="block">The Frequency family of sketches. (Not part of TSF.)</div> |
| </li> |
| </ul> |
| <a name="RESERVOIR"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>RESERVOIR</h4> |
| <pre>public static final <a href="../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a> RESERVOIR</pre> |
| <div class="block">The Reservoir family of sketches. (Not part of TSF.)</div> |
| </li> |
| </ul> |
| <a name="RESERVOIR_UNION"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>RESERVOIR_UNION</h4> |
| <pre>public static final <a href="../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a> RESERVOIR_UNION</pre> |
| <div class="block">The reservoir sampling family of Union operations. (Not part of TSF.)</div> |
| </li> |
| </ul> |
| <a name="VAROPT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>VAROPT</h4> |
| <pre>public static final <a href="../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a> VAROPT</pre> |
| <div class="block">The VarOpt family of sketches. (Not part of TSF.)</div> |
| </li> |
| </ul> |
| <a name="VAROPT_UNION"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>VAROPT_UNION</h4> |
| <pre>public static final <a href="../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a> VAROPT_UNION</pre> |
| <div class="block">The VarOpt family of sketches. (Not part of TSF.)</div> |
| </li> |
| </ul> |
| <a name="KLL"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>KLL</h4> |
| <pre>public static final <a href="../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a> KLL</pre> |
| <div class="block">KLL quanliles sketch</div> |
| </li> |
| </ul> |
| <a name="CPC"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>CPC</h4> |
| <pre>public static final <a href="../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a> CPC</pre> |
| <div class="block">Compressed Probabilistic Counting (CPC) Sketch</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="values--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>values</h4> |
| <pre>public static <a href="../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a>[] values()</pre> |
| <div class="block">Returns an array containing the constants of this enum type, in |
| the order they are declared. This method may be used to iterate |
| over the constants as follows: |
| <pre> |
| for (Family c : Family.values()) |
| System.out.println(c); |
| </pre></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an array containing the constants of this enum type, in the order they are declared</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="valueOf-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>valueOf</h4> |
| <pre>public static <a href="../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a> valueOf(<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> name)</pre> |
| <div class="block">Returns the enum constant of this type with the specified name. |
| The string must match <i>exactly</i> an identifier used to declare an |
| enum constant in this type. (Extraneous whitespace characters are |
| not permitted.)</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - the name of the enum constant to be returned.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the enum constant with the specified name</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if the argument is null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getID--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getID</h4> |
| <pre>public int getID()</pre> |
| <div class="block">Returns the byte ID for this family</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the byte ID for this family</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="checkFamilyID-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkFamilyID</h4> |
| <pre>public void checkFamilyID(int id)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>id</code> - the given id, a value < 128.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFamilyName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFamilyName</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> getFamilyName()</pre> |
| <div class="block">Returns the name for this family</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the name for this family</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMinPreLongs--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMinPreLongs</h4> |
| <pre>public int getMinPreLongs()</pre> |
| <div class="block">Returns the minimum preamble size for this family in longs</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the minimum preamble size for this family in longs</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMaxPreLongs--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxPreLongs</h4> |
| <pre>public int getMaxPreLongs()</pre> |
| <div class="block">Returns the maximum preamble size for this family in longs</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the maximum preamble size for this family in longs</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <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/Enum.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/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a><<a href="../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="idToFamily-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>idToFamily</h4> |
| <pre>public static <a href="../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a> idToFamily(int id)</pre> |
| <div class="block">Returns the Family given the ID</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>id</code> - the given ID</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Family given the ID</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="stringToFamily-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>stringToFamily</h4> |
| <pre>public static <a href="../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a> stringToFamily(<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> famName)</pre> |
| <div class="block">Returns the Family given the family name</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>famName</code> - the family name</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Family given the family name</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/Family.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="../../../com/yahoo/sketches/ByteArrayUtil.html" title="class in com.yahoo.sketches"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../com/yahoo/sketches/HashOperations.html" title="class in com.yahoo.sketches"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?com/yahoo/sketches/Family.html" target="_top">Frames</a></li> |
| <li><a href="Family.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><a href="#enum.constant.summary">Enum Constants</a> | </li> |
| <li>Field | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#enum.constant.detail">Enum Constants</a> | </li> |
| <li>Field | </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–2018. All rights reserved.</small></p> |
| </body> |
| </html> |
