| <!DOCTYPE HTML> |
| <html lang> |
| <head> |
| <!-- Generated by javadoc (25) --> |
| <title>Family (datasketches-java 9.0.1-SNAPSHOT API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.datasketches.common, enum: Family"> |
| <meta name="generator" content="javadoc/ClassWriter"> |
| <link rel="stylesheet" type="text/css" href="../../../../resource-files/jquery-ui.min.css"> |
| <link rel="stylesheet" type="text/css" href="../../../../resource-files/stylesheet.css"> |
| <script type="text/javascript" src="../../../../script-files/script.js"></script> |
| <script type="text/javascript" src="../../../../script-files/jquery-3.7.1.min.js"></script> |
| <script type="text/javascript" src="../../../../script-files/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">const pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="nav-content"> |
| <div class="nav-menu-button"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button></div> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li class="nav-bar-cell1-rev">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="../../../../search.html">Search</a></li> |
| <li><a href="../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| </div> |
| <div class="sub-nav"> |
| <div class="nav-content"> |
| <ol class="sub-nav-list"> |
| <li><a href="package-summary.html">org.apache.datasketches.common</a></li> |
| <li><a href="Family.html" class="current-selection">Family</a></li> |
| </ol> |
| <div class="nav-list-search"><input type="text" id="search-input" disabled placeholder="Search documentation (type /)" aria-label="Search in documentation" autocomplete="off" spellcheck="false"><input type="reset" id="reset-search" disabled value="Reset"></div> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="main-grid"> |
| <nav role="navigation" class="toc" aria-label="Table of contents"> |
| <div class="toc-header">Contents <input type="text" class="filter-input" disabled placeholder="Filter contents (type .)" aria-label="Filter table of contents" autocomplete="off" spellcheck="false"><input type="reset" class="reset-filter" disabled tabindex="-1" value="Reset"></div> |
| <ol class="toc-list" tabindex="-1"> |
| <li><a href="#" tabindex="0">Description</a></li> |
| <li><a href="#nested-class-summary" tabindex="0">Nested Class Summary</a></li> |
| <li><a href="#enum-constant-summary" tabindex="0">Enum Constant Summary</a></li> |
| <li><a href="#method-summary" tabindex="0">Method Summary</a></li> |
| <li><a href="#enum-constant-detail" tabindex="0">Enum Constant Details</a> |
| <ol class="toc-list"> |
| <li><a href="#ALPHA" tabindex="0">ALPHA</a></li> |
| <li><a href="#QUICKSELECT" tabindex="0">QUICKSELECT</a></li> |
| <li><a href="#COMPACT" tabindex="0">COMPACT</a></li> |
| <li><a href="#UNION" tabindex="0">UNION</a></li> |
| <li><a href="#INTERSECTION" tabindex="0">INTERSECTION</a></li> |
| <li><a href="#A_NOT_B" tabindex="0">A_NOT_B</a></li> |
| <li><a href="#HLL" tabindex="0">HLL</a></li> |
| <li><a href="#QUANTILES" tabindex="0">QUANTILES</a></li> |
| <li><a href="#TUPLE" tabindex="0">TUPLE</a></li> |
| <li><a href="#FREQUENCY" tabindex="0">FREQUENCY</a></li> |
| <li><a href="#RESERVOIR" tabindex="0">RESERVOIR</a></li> |
| <li><a href="#RESERVOIR_UNION" tabindex="0">RESERVOIR_UNION</a></li> |
| <li><a href="#VAROPT" tabindex="0">VAROPT</a></li> |
| <li><a href="#VAROPT_UNION" tabindex="0">VAROPT_UNION</a></li> |
| <li><a href="#KLL" tabindex="0">KLL</a></li> |
| <li><a href="#CPC" tabindex="0">CPC</a></li> |
| <li><a href="#REQ" tabindex="0">REQ</a></li> |
| <li><a href="#COUNTMIN" tabindex="0">COUNTMIN</a></li> |
| <li><a href="#EBPPS" tabindex="0">EBPPS</a></li> |
| <li><a href="#TDIGEST" tabindex="0">TDIGEST</a></li> |
| <li><a href="#BLOOMFILTER" tabindex="0">BLOOMFILTER</a></li> |
| </ol> |
| </li> |
| <li><a href="#method-detail" tabindex="0">Method Details</a> |
| <ol class="toc-list"> |
| <li><a href="#values()" tabindex="0">values()</a></li> |
| <li><a href="#valueOf(java.lang.String)" tabindex="0">valueOf(String)</a></li> |
| <li><a href="#getID()" tabindex="0">getID()</a></li> |
| <li><a href="#checkFamilyID(int)" tabindex="0">checkFamilyID(int)</a></li> |
| <li><a href="#getFamilyName()" tabindex="0">getFamilyName()</a></li> |
| <li><a href="#getMinPreLongs()" tabindex="0">getMinPreLongs()</a></li> |
| <li><a href="#getMaxPreLongs()" tabindex="0">getMaxPreLongs()</a></li> |
| <li><a href="#toString()" tabindex="0">toString()</a></li> |
| <li><a href="#idToFamily(int)" tabindex="0">idToFamily(int)</a></li> |
| <li><a href="#stringToFamily(java.lang.String)" tabindex="0">stringToFamily(String)</a></li> |
| </ol> |
| </li> |
| </ol> |
| <button class="hide-sidebar"><span>Hide sidebar </span><img src="../../../../resource-files/left.svg" alt="Hide sidebar"></button><button class="show-sidebar"><img src="../../../../resource-files/right.svg" alt="Show sidebar"><span> Show sidebar</span></button></nav> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <h1 title="Enum Class Family" class="title">Enum Class Family</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">java.lang.Enum</a><<a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a>> |
| <div class="inheritance">org.apache.datasketches.common.Family</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a>>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a></code></dd> |
| </dl> |
| <hr> |
| <div class="horizontal-scroll"> |
| <div class="type-signature"><span class="modifiers">public enum </span><span class="element-name type-name-label">Family</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a>></span></div> |
| <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 class="notes"> |
| <dt>Author:</dt> |
| <dd>Lee Rhodes</dd> |
| </dl> |
| </div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="inherited-list"> |
| <h3 id="nested-classes-inherited-from-class-java.lang.Enum">Nested classes/interfaces inherited from class <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Enum.html#nested-class-summary" title="class or interface in java.lang" class="external-link">Enum</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">Enum.EnumDesc</a><E></code></div> |
| </section> |
| </li> |
| <!-- =========== ENUM CONSTANT SUMMARY =========== --> |
| <li> |
| <section class="constants-summary" id="enum-constant-summary"> |
| <h2>Enum Constant Summary</h2> |
| <div class="caption"><span>Enum Constants</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Enum Constant</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code><a href="#A_NOT_B" class="member-name-link">A_NOT_B</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The A and not B family is an operation for the Theta Sketch Framework of sketches.</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="#ALPHA" class="member-name-link">ALPHA</a></code></div> |
| <div class="col-last odd-row-color"> |
| <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> |
| </div> |
| <div class="col-first even-row-color"><code><a href="#BLOOMFILTER" class="member-name-link">BLOOMFILTER</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Bloom Filter</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="#COMPACT" class="member-name-link">COMPACT</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">The Compact Sketch family is a member of the Theta Sketch Framework of sketches.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="#COUNTMIN" class="member-name-link">COUNTMIN</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">CountMin Sketch</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="#CPC" class="member-name-link">CPC</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Compressed Probabilistic Counting (CPC) Sketch</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="#EBPPS" class="member-name-link">EBPPS</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Exact and Bounded, Probability Proportional to Size (EBPPS)</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="#FREQUENCY" class="member-name-link">FREQUENCY</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">The Frequency family of sketches.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="#HLL" class="member-name-link">HLL</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The HLL family of sketches.</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="#INTERSECTION" class="member-name-link">INTERSECTION</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">The Intersection family is an operation for the Theta Sketch Framework of sketches.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="#KLL" class="member-name-link">KLL</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">KLL quantiles sketch</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="#QUANTILES" class="member-name-link">QUANTILES</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">The Quantiles family of sketches.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="#QUICKSELECT" class="member-name-link">QUICKSELECT</a></code></div> |
| <div class="col-last even-row-color"> |
| <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> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="#REQ" class="member-name-link">REQ</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Relative Error Quantiles Sketch</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="#RESERVOIR" class="member-name-link">RESERVOIR</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The Reservoir family of sketches.</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="#RESERVOIR_UNION" class="member-name-link">RESERVOIR_UNION</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">The reservoir sampling family of Union operations.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="#TDIGEST" class="member-name-link">TDIGEST</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">t-Digest for estimating quantiles and ranks</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="#TUPLE" class="member-name-link">TUPLE</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">The Tuple family of sketches is a large family of sketches that are extensions of the |
| Theta Sketch Framework.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="#UNION" class="member-name-link">UNION</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The Union family is an operation for the Theta Sketch Framework of sketches.</div> |
| </div> |
| <div class="col-first odd-row-color"><code><a href="#VAROPT" class="member-name-link">VAROPT</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">The VarOpt family of sketches.</div> |
| </div> |
| <div class="col-first even-row-color"><code><a href="#VAROPT_UNION" class="member-name-link">VAROPT_UNION</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The VarOpt family of sketches.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#checkFamilyID(int)" class="member-name-link">checkFamilyID</a><wbr>(int id)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Checks the given Family ID</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFamilyName()" class="member-name-link">getFamilyName</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the name for this family</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getID()" class="member-name-link">getID</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the byte ID for this family</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMaxPreLongs()" class="member-name-link">getMaxPreLongs</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the maximum preamble size for this family in longs</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMinPreLongs()" class="member-name-link">getMinPreLongs</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the minimum preamble size for this family in longs</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#idToFamily(int)" class="member-name-link">idToFamily</a><wbr>(int id)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the Family given the ID</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#stringToFamily(java.lang.String)" class="member-name-link">stringToFamily</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> famName)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the Family given the family name</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the enum constant of this class with the specified name.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a>[]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#values()" class="member-name-link">values</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns an array containing the constants of this enum class, in |
| the order they are declared.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Enum">Methods inherited from class <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Enum.html#method-summary" title="class or interface in java.lang" class="external-link">Enum</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Enum.html#compareTo(E)" title="class or interface in java.lang" class="external-link">compareTo</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Enum.html#describeConstable()" title="class or interface in java.lang" class="external-link">describeConstable</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Enum.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Enum.html#getDeclaringClass()" title="class or interface in java.lang" class="external-link">getDeclaringClass</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Enum.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Enum.html#name()" title="class or interface in java.lang" class="external-link">name</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Enum.html#ordinal()" title="class or interface in java.lang" class="external-link">ordinal</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Enum.html#valueOf(java.lang.Class,java.lang.String)" title="class or interface in java.lang" class="external-link">valueOf</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#method-summary" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ ENUM CONSTANT DETAIL =========== --> |
| <li> |
| <section class="constant-details" id="enum-constant-detail"> |
| <h2>Enum Constant Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="ALPHA"> |
| <h3>ALPHA</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">ALPHA</span></div> |
| <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 ThetaSetOperation, 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 AlphaSketch has a roughly 30% faster |
| overall update time as compared to the QuickSelect sketch family.</p> |
| |
| <p>The AlphaSketch is created using the UpdatableThetaSketchBuilder(). |
| <a href="../../../../resources/dictionary.html#alphaTCF">See Alpha TCF</a> and |
| <a href="../../../../resources/dictionary.html#thetaSketch">Theta Sketch Framework</a></div> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="QUICKSELECT"> |
| <h3>QUICKSELECT</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">QUICKSELECT</span></div> |
| <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 UpdatableThetaSketchBuilder(). |
| <a href="../../../../resources/dictionary.html#quickSelectTCF">See Quick Select TCF</a></div> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="COMPACT"> |
| <h3>COMPACT</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">COMPACT</span></div> |
| <div class="block">The Compact Sketch family is a member of the Theta Sketch Framework of sketches. |
| They 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 UpdatableThetaSketch or as a result of a getSketchSamples() of a ThetaSetOperation.</div> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="UNION"> |
| <h3>UNION</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">UNION</span></div> |
| <div class="block">The Union family is an operation for the Theta Sketch Framework of sketches. |
| The Union is constructed using the ThetaSetOperationBuilder().</div> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="INTERSECTION"> |
| <h3>INTERSECTION</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">INTERSECTION</span></div> |
| <div class="block">The Intersection family is an operation for the Theta Sketch Framework of sketches. |
| The ThetaIntersection is constructed using the ThetaSetOperationBuilder().</div> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="A_NOT_B"> |
| <h3>A_NOT_B</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">A_NOT_B</span></div> |
| <div class="block">The A and not B family is an operation for the Theta Sketch Framework of sketches. |
| The ThetaAnotB operation is constructed using the ThetaSetOperationBuilder().</div> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="HLL"> |
| <h3>HLL</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">HLL</span></div> |
| <div class="block">The HLL family of sketches. (Not part of TSF.)</div> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="QUANTILES"> |
| <h3>QUANTILES</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">QUANTILES</span></div> |
| <div class="block">The Quantiles family of sketches. (Not part of TSF.)</div> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="TUPLE"> |
| <h3>TUPLE</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">TUPLE</span></div> |
| <div class="block">The Tuple family of sketches is a large family of sketches that are extensions of the |
| Theta Sketch Framework.</div> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="FREQUENCY"> |
| <h3>FREQUENCY</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">FREQUENCY</span></div> |
| <div class="block">The Frequency family of sketches. (Not part of TSF.)</div> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="RESERVOIR"> |
| <h3>RESERVOIR</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">RESERVOIR</span></div> |
| <div class="block">The Reservoir family of sketches. (Not part of TSF.)</div> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="RESERVOIR_UNION"> |
| <h3>RESERVOIR_UNION</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">RESERVOIR_UNION</span></div> |
| <div class="block">The reservoir sampling family of Union operations. (Not part of TSF.)</div> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="VAROPT"> |
| <h3>VAROPT</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">VAROPT</span></div> |
| <div class="block">The VarOpt family of sketches. (Not part of TSF.)</div> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="VAROPT_UNION"> |
| <h3>VAROPT_UNION</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">VAROPT_UNION</span></div> |
| <div class="block">The VarOpt family of sketches. (Not part of TSF.)</div> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="KLL"> |
| <h3>KLL</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">KLL</span></div> |
| <div class="block">KLL quantiles sketch</div> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="CPC"> |
| <h3>CPC</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">CPC</span></div> |
| <div class="block">Compressed Probabilistic Counting (CPC) Sketch</div> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="REQ"> |
| <h3>REQ</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">REQ</span></div> |
| <div class="block">Relative Error Quantiles Sketch</div> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="COUNTMIN"> |
| <h3>COUNTMIN</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">COUNTMIN</span></div> |
| <div class="block">CountMin Sketch</div> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="EBPPS"> |
| <h3>EBPPS</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">EBPPS</span></div> |
| <div class="block">Exact and Bounded, Probability Proportional to Size (EBPPS)</div> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="TDIGEST"> |
| <h3>TDIGEST</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">TDIGEST</span></div> |
| <div class="block">t-Digest for estimating quantiles and ranks</div> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="BLOOMFILTER"> |
| <h3>BLOOMFILTER</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">BLOOMFILTER</span></div> |
| <div class="block">Bloom Filter</div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="values()"> |
| <h3>values</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a>[]</span> <span class="element-name">values</span>()</div> |
| <div class="block">Returns an array containing the constants of this enum class, in |
| the order they are declared.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>an array containing the constants of this enum class, in the order they are declared</dd> |
| </dl> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="valueOf(java.lang.String)"> |
| <h3>valueOf</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">valueOf</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> |
| <div class="block">Returns the enum constant of this class with the specified name. |
| The string must match <i>exactly</i> an identifier used to declare an |
| enum constant in this class. (Extraneous whitespace characters are |
| not permitted.)</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>name</code> - the name of the enum constant to be returned.</dd> |
| <dt>Returns:</dt> |
| <dd>the enum constant with the specified name</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if this enum class has no constant with the specified name</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if the argument is null</dd> |
| </dl> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getID()"> |
| <h3>getID</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getID</span>()</div> |
| <div class="block">Returns the byte ID for this family</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the byte ID for this family</dd> |
| </dl> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="checkFamilyID(int)"> |
| <h3>checkFamilyID</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">checkFamilyID</span><wbr><span class="parameters">(int id)</span></div> |
| <div class="block">Checks the given Family ID</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>id</code> - the given id, a value < 128.</dd> |
| </dl> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFamilyName()"> |
| <h3>getFamilyName</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getFamilyName</span>()</div> |
| <div class="block">Returns the name for this family</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the name for this family</dd> |
| </dl> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMinPreLongs()"> |
| <h3>getMinPreLongs</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getMinPreLongs</span>()</div> |
| <div class="block">Returns the minimum preamble size for this family in longs</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the minimum preamble size for this family in longs</dd> |
| </dl> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMaxPreLongs()"> |
| <h3>getMaxPreLongs</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getMaxPreLongs</span>()</div> |
| <div class="block">Returns the maximum preamble size for this family in longs</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the maximum preamble size for this family in longs</dd> |
| </dl> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString()"> |
| <h3>toString</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Enum.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a><<a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a>></code></dd> |
| </dl> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="idToFamily(int)"> |
| <h3>idToFamily</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">idToFamily</span><wbr><span class="parameters">(int id)</span></div> |
| <div class="block">Returns the Family given the ID</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>id</code> - the given ID</dd> |
| <dt>Returns:</dt> |
| <dd>the Family given the ID</dd> |
| </dl> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="stringToFamily(java.lang.String)"> |
| <h3>stringToFamily</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="Family.html" title="enum class in org.apache.datasketches.common">Family</a></span> <span class="element-name">stringToFamily</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> famName)</span></div> |
| <div class="block">Returns the Family given the family name</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>famName</code> - the family name</dd> |
| <dt>Returns:</dt> |
| <dd>the Family given the family name</dd> |
| </dl> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2015–2025 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </main> |
| </div> |
| </body> |
| </html> |
