| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.19) on Fri Jul 14 14:20:11 PDT 2023 --> |
| <title>All Classes (datasketches-java 3.3.0 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2023-07-14"> |
| <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="jquery/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="script.js"></script> |
| <script type="text/javascript" src="jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="jquery/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="jquery/jquery-ui.min.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="All Classes (datasketches-java 3.3.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":2,"i1":2,"i2":2,"i3":2,"i4":2,"i5":1,"i6":2,"i7":2,"i8":2,"i9":2,"i10":2,"i11":2,"i12":1,"i13":2,"i14":2,"i15":2,"i16":2,"i17":2,"i18":2,"i19":2,"i20":2,"i21":2,"i22":2,"i23":2,"i24":2,"i25":2,"i26":2,"i27":2,"i28":2,"i29":2,"i30":2,"i31":2,"i32":2,"i33":2,"i34":2,"i35":2,"i36":2,"i37":2,"i38":2,"i39":2,"i40":2,"i41":2,"i42":2,"i43":2,"i44":2,"i45":2,"i46":4,"i47":2,"i48":2,"i49":2,"i50":2,"i51":2,"i52":4,"i53":4,"i54":2,"i55":2,"i56":2,"i57":4,"i58":2,"i59":1,"i60":2,"i61":2,"i62":4,"i63":2,"i64":2,"i65":4,"i66":2,"i67":2,"i68":2,"i69":2,"i70":2,"i71":2,"i72":2,"i73":2,"i74":2,"i75":2,"i76":2,"i77":2,"i78":2,"i79":2,"i80":2,"i81":2,"i82":2,"i83":2,"i84":4,"i85":2,"i86":2,"i87":2,"i88":2,"i89":2,"i90":2,"i91":2,"i92":2,"i93":2,"i94":2,"i95":1,"i96":2,"i97":2,"i98":2,"i99":2,"i100":2,"i101":2,"i102":2,"i103":4,"i104":2,"i105":2,"i106":4,"i107":2,"i108":2,"i109":2,"i110":4,"i111":4,"i112":4,"i113":4,"i114":2,"i115":2,"i116":2,"i117":2,"i118":8,"i119":8,"i120":8,"i121":8,"i122":2,"i123":2,"i124":1,"i125":1,"i126":1,"i127":1,"i128":2,"i129":4,"i130":2,"i131":2,"i132":2,"i133":2,"i134":2,"i135":2,"i136":1,"i137":2,"i138":4,"i139":2,"i140":2,"i141":2,"i142":2,"i143":2,"i144":2,"i145":2,"i146":2}; |
| var tabs = {65535:["t0","All Classes"],1:["t1","Interface Summary"],2:["t2","Class Summary"],4:["t3","Enum Summary"],8:["t4","Exception Summary"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "./"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="index.html">Overview</a></li> |
| <li>Package</li> |
| <li>Class</li> |
| <li>Use</li> |
| <li><a href="overview-tree.html">Tree</a></li> |
| <li><a href="deprecated-list.html">Deprecated</a></li> |
| <li><a href="index-all.html">Index</a></li> |
| <li><a href="help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <main role="main"> |
| <div class="header"> |
| <h1 title="All&nbsp;Classes" class="title">All Classes</h1> |
| </div> |
| <div class="allClassesContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Classes</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Interface Summary</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Class Summary</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Enum Summary</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Exception Summary</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/theta/AnotB.html" title="class in org.apache.datasketches.theta">AnotB</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Computes a set difference, A-AND-NOT-B, of two theta sketches.</div> |
| </th> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/AnotB.html" title="class in org.apache.datasketches.tuple">AnotB</a><<a href="org/apache/datasketches/tuple/AnotB.html" title="type parameter in AnotB">S</a> extends <a href="org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Computes a set difference, A-AND-NOT-B, of two generic tuple sketches.</div> |
| </th> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/ArrayOfBooleansSerDe.html" title="class in org.apache.datasketches">ArrayOfBooleansSerDe</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Methods of serializing and deserializing arrays of Boolean as a bit array.</div> |
| </th> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesAnotB.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesAnotB</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Computes a set difference of two tuple sketches of type ArrayOfDoubles</div> |
| </th> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesAnotBImpl.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesAnotBImpl</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Computes a set difference, A-AND-NOT-B, of two ArrayOfDoublesSketches.</div> |
| </th> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesCombiner.html" title="interface in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCombiner</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Combines two arrays of double values for use with ArrayOfDoubles tuple sketches</div> |
| </th> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesCompactSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesCompactSketch</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Top level compact tuple sketch of type ArrayOfDoubles.</div> |
| </th> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesIntersection.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesIntersection</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Computes the intersection of two or more tuple sketches of type ArrayOfDoubles.</div> |
| </th> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/ArrayOfDoublesSerDe.html" title="class in org.apache.datasketches">ArrayOfDoublesSerDe</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Methods of serializing and deserializing arrays of Double.</div> |
| </th> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSetOperationBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSetOperationBuilder</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Builds set operations object for tuple sketches of type ArrayOfDoubles.</div> |
| </th> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketch</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">The base class for the tuple sketch of type ArrayOfDoubles, where an array of double values |
| is associated with each key.</div> |
| </th> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketches.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketches</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Convenient static methods to instantiate tuple sketches of type ArrayOfDoubles.</div> |
| </th> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesSketchIterator.html" title="interface in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesSketchIterator</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Interface for iterating over tuple sketches of type ArrayOfDoubles</div> |
| </th> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUnion.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUnion</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">The base class for unions of tuple sketches of type ArrayOfDoubles.</div> |
| </th> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketch.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketch</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">The top level for updatable tuple sketches of type ArrayOfDoubles.</div> |
| </th> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/arrayofdoubles/ArrayOfDoublesUpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple.arrayofdoubles">ArrayOfDoublesUpdatableSketchBuilder</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">For building a new ArrayOfDoublesUpdatableSketch</div> |
| </th> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/ArrayOfItemsSerDe.html" title="class in org.apache.datasketches">ArrayOfItemsSerDe</a><<a href="org/apache/datasketches/ArrayOfItemsSerDe.html" title="type parameter in ArrayOfItemsSerDe">T</a>></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Base class for serializing and deserializing custom types.</div> |
| </th> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/ArrayOfLongsSerDe.html" title="class in org.apache.datasketches">ArrayOfLongsSerDe</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Methods of serializing and deserializing arrays of Long.</div> |
| </th> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/ArrayOfNumbersSerDe.html" title="class in org.apache.datasketches">ArrayOfNumbersSerDe</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Methods of serializing and deserializing arrays of the object version of primitive types of |
| Number.</div> |
| </th> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/ArrayOfStringsSerDe.html" title="class in org.apache.datasketches">ArrayOfStringsSerDe</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Methods of serializing and deserializing arrays of String.</div> |
| </th> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSketch.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSketch</a></td> |
| <th class="colLast" scope="row"> </th> |
| </tr> |
| <tr id="i21" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSummary.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummary</a></td> |
| <th class="colLast" scope="row"> </th> |
| </tr> |
| <tr id="i22" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSummaryDeserializer.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummaryDeserializer</a></td> |
| <th class="colLast" scope="row"> </th> |
| </tr> |
| <tr id="i23" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSummaryFactory.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummaryFactory</a></td> |
| <th class="colLast" scope="row"> </th> |
| </tr> |
| <tr id="i24" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/strings/ArrayOfStringsSummarySetOperations.html" title="class in org.apache.datasketches.tuple.strings">ArrayOfStringsSummarySetOperations</a></td> |
| <th class="colLast" scope="row"> </th> |
| </tr> |
| <tr id="i25" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/ArrayOfUtf16StringsSerDe.html" title="class in org.apache.datasketches">ArrayOfUtf16StringsSerDe</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Methods of serializing and deserializing arrays of String.</div> |
| </th> |
| </tr> |
| <tr id="i26" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/BinarySearch.html" title="class in org.apache.datasketches">BinarySearch</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Contains common equality binary search algorithms.</div> |
| </th> |
| </tr> |
| <tr id="i27" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/BinomialBoundsN.html" title="class in org.apache.datasketches">BinomialBoundsN</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">This class enables the estimation of error bounds given a sample set size, the sampling |
| probability theta, the number of standard deviations and a simple noDataSeen flag.</div> |
| </th> |
| </tr> |
| <tr id="i28" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/BoundsOnBinomialProportions.html" title="class in org.apache.datasketches">BoundsOnBinomialProportions</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Confidence intervals for binomial proportions.</div> |
| </th> |
| </tr> |
| <tr id="i29" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/BoundsOnRatiosInSampledSets.html" title="class in org.apache.datasketches">BoundsOnRatiosInSampledSets</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">This class is used to compute the bounds on the estimate of the ratio <i>|B| / |A|</i>, where: |
| |
| <i>|A|</i> is the unknown size of a set <i>A</i> of unique identifiers. |
| <i>|B|</i> is the unknown size of a subset <i>B</i> of <i>A</i>. |
| <i>a</i> = <i>|S<sub>A</sub>|</i> is the observed size of a sample of <i>A</i> |
| that was obtained by Bernoulli sampling with a known inclusion probability <i>f</i>. |
| <i>b</i> = <i>|S<sub>A</sub> ∩ B|</i> is the observed size of a subset |
| of <i>S<sub>A</sub></i>. |
| </div> |
| </th> |
| </tr> |
| <tr id="i30" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/BoundsOnRatiosInThetaSketchedSets.html" title="class in org.apache.datasketches">BoundsOnRatiosInThetaSketchedSets</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">This class is used to compute the bounds on the estimate of the ratio <i>B / A</i>, where: |
| |
| <i>A</i> is a Theta Sketch of population <i>PopA</i>. |
| <i>B</i> is a Theta Sketch of population <i>PopB</i> that is a subset of <i>A</i>, |
| obtained by an intersection of <i>A</i> with some other Theta Sketch <i>C</i>, |
| which acts like a predicate or selection clause. |
| The estimate of the ratio <i>PopB/PopA</i> is |
| BoundsOnRatiosInThetaSketchedSets.getEstimateOfBoverA(<i>A, B</i>). |
| The Upper Bound estimate on the ratio PopB/PopA is |
| BoundsOnRatiosInThetaSketchedSets.getUpperBoundForBoverA(<i>A, B</i>). |
| The Lower Bound estimate on the ratio PopB/PopA is |
| BoundsOnRatiosInThetaSketchedSets.getLowerBoundForBoverA(<i>A, B</i>). |
| |
| Note: The theta of <i>A</i> cannot be greater than the theta of <i>B</i>.</div> |
| </th> |
| </tr> |
| <tr id="i31" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/BoundsOnRatiosInTupleSketchedSets.html" title="class in org.apache.datasketches">BoundsOnRatiosInTupleSketchedSets</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">This class is used to compute the bounds on the estimate of the ratio <i>B / A</i>, where: |
| |
| <i>A</i> is a Tuple Sketch of population <i>PopA</i>. |
| <i>B</i> is a Tuple or Theta Sketch of population <i>PopB</i> that is a subset of <i>A</i>, |
| obtained by an intersection of <i>A</i> with some other Tuple or Theta Sketch <i>C</i>, |
| which acts like a predicate or selection clause. |
| The estimate of the ratio <i>PopB/PopA</i> is |
| BoundsOnRatiosInThetaSketchedSets.getEstimateOfBoverA(<i>A, B</i>). |
| The Upper Bound estimate on the ratio PopB/PopA is |
| BoundsOnRatiosInThetaSketchedSets.getUpperBoundForBoverA(<i>A, B</i>). |
| The Lower Bound estimate on the ratio PopB/PopA is |
| BoundsOnRatiosInThetaSketchedSets.getLowerBoundForBoverA(<i>A, B</i>). |
| |
| Note: The theta of <i>A</i> cannot be greater than the theta of <i>B</i>.</div> |
| </th> |
| </tr> |
| <tr id="i32" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/ByteArrayUtil.html" title="class in org.apache.datasketches">ByteArrayUtil</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Useful methods for byte arrays.</div> |
| </th> |
| </tr> |
| <tr id="i33" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/quantiles/CompactDoublesSketch.html" title="class in org.apache.datasketches.quantiles">CompactDoublesSketch</a></td> |
| <th class="colLast" scope="row"> </th> |
| </tr> |
| <tr id="i34" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/theta/CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">The parent class of all the CompactSketches.</div> |
| </th> |
| </tr> |
| <tr id="i35" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><<a href="org/apache/datasketches/tuple/CompactSketch.html" title="type parameter in CompactSketch">S</a> extends <a href="org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></td> |
| <th class="colLast" scope="row"> |
| <div class="block">CompactSketches are never created directly.</div> |
| </th> |
| </tr> |
| <tr id="i36" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/cpc/CompressionCharacterization.html" title="class in org.apache.datasketches.cpc">CompressionCharacterization</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">This code is used both by unit tests, for short running tests, |
| and by the characterization repository for longer running, more exhaustive testing.</div> |
| </th> |
| </tr> |
| <tr id="i37" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/cpc/CpcSketch.html" title="class in org.apache.datasketches.cpc">CpcSketch</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">This is a unique-counting sketch that implements the |
| <i>Compressed Probabilistic Counting (CPC, a.k.a FM85)</i> algorithms developed by Kevin Lang in |
| his paper |
| <a href="https://arxiv.org/abs/1708.06839">Back to the Future: an Even More Nearly |
| Optimal Cardinality Estimation Algorithm</a>.</div> |
| </th> |
| </tr> |
| <tr id="i38" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/cpc/CpcUnion.html" title="class in org.apache.datasketches.cpc">CpcUnion</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">The union (merge) operation for the CPC sketches.</div> |
| </th> |
| </tr> |
| <tr id="i39" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/cpc/CpcWrapper.html" title="class in org.apache.datasketches.cpc">CpcWrapper</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">This provides a read-only view of a serialized image of a CpcSketch, which can be |
| on-heap or off-heap represented as a Memory object, or on-heap represented as a byte array.</div> |
| </th> |
| </tr> |
| <tr id="i40" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/DeserializeResult.html" title="class in org.apache.datasketches.tuple">DeserializeResult</a><<a href="org/apache/datasketches/tuple/DeserializeResult.html" title="type parameter in DeserializeResult">T</a>></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Returns an object and its size in bytes as a result of a deserialize operation</div> |
| </th> |
| </tr> |
| <tr id="i41" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/adouble/DoubleSketch.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSketch</a></td> |
| <th class="colLast" scope="row"> </th> |
| </tr> |
| <tr id="i42" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/quantiles/DoublesSketch.html" title="class in org.apache.datasketches.quantiles">DoublesSketch</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">This is a stochastic streaming sketch that enables near-real time analysis of the |
| approximate distribution of real values from a very large stream in a single pass.</div> |
| </th> |
| </tr> |
| <tr id="i43" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/quantiles/DoublesSketchBuilder.html" title="class in org.apache.datasketches.quantiles">DoublesSketchBuilder</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">For building a new quantiles DoublesSketch.</div> |
| </th> |
| </tr> |
| <tr id="i44" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/quantiles/DoublesSketchIterator.html" title="class in org.apache.datasketches.quantiles">DoublesSketchIterator</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Iterator over DoublesSketch.</div> |
| </th> |
| </tr> |
| <tr id="i45" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/adouble/DoubleSummary.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummary</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Summary for generic tuple sketches of type Double.</div> |
| </th> |
| </tr> |
| <tr id="i46" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/adouble/DoubleSummary.Mode.html" title="enum in org.apache.datasketches.tuple.adouble">DoubleSummary.Mode</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">The aggregation modes for this Summary</div> |
| </th> |
| </tr> |
| <tr id="i47" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/adouble/DoubleSummaryDeserializer.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummaryDeserializer</a></td> |
| <th class="colLast" scope="row"> </th> |
| </tr> |
| <tr id="i48" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/adouble/DoubleSummaryFactory.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummaryFactory</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Factory for DoubleSummary.</div> |
| </th> |
| </tr> |
| <tr id="i49" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/adouble/DoubleSummarySetOperations.html" title="class in org.apache.datasketches.tuple.adouble">DoubleSummarySetOperations</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Methods for defining how unions and intersections of two objects of type DoubleSummary |
| are performed.</div> |
| </th> |
| </tr> |
| <tr id="i50" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/quantiles/DoublesUnion.html" title="class in org.apache.datasketches.quantiles">DoublesUnion</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">The API for Union operations for quantiles DoublesSketches</div> |
| </th> |
| </tr> |
| <tr id="i51" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/quantiles/DoublesUnionBuilder.html" title="class in org.apache.datasketches.quantiles">DoublesUnionBuilder</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">For building a new DoublesSketch Union operation.</div> |
| </th> |
| </tr> |
| <tr id="i52" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/frequencies/ErrorType.html" title="enum in org.apache.datasketches.frequencies">ErrorType</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Specifies one of two types of error regions of the statistical classification Confusion Matrix |
| that can be excluded from a returned sample of Frequent Items.</div> |
| </th> |
| </tr> |
| <tr id="i53" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/Family.html" title="enum in org.apache.datasketches">Family</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Defines the various families of sketch and set operation classes.</div> |
| </th> |
| </tr> |
| <tr id="i54" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/fdt/FdtSketch.html" title="class in org.apache.datasketches.fdt">FdtSketch</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">A Frequent Distinct Tuples sketch.</div> |
| </th> |
| </tr> |
| <tr id="i55" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/Filter.html" title="class in org.apache.datasketches.tuple">Filter</a><<a href="org/apache/datasketches/tuple/Filter.html" title="type parameter in Filter">T</a> extends <a href="org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Class for filtering entries from a <a href="org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple"><code>Sketch</code></a> given a <a href="org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple"><code>Summary</code></a></div> |
| </th> |
| </tr> |
| <tr id="i56" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/GenericInequalitySearch.html" title="class in org.apache.datasketches">GenericInequalitySearch</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">This provides efficient, unique and unambiguous binary searching for inequalities |
| for ordered arrays of increasing values that may include duplicate values.</div> |
| </th> |
| </tr> |
| <tr id="i57" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/GenericInequalitySearch.Inequality.html" title="enum in org.apache.datasketches">GenericInequalitySearch.Inequality</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">The enumerator of inequalities</div> |
| </th> |
| </tr> |
| <tr id="i58" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/fdt/Group.html" title="class in org.apache.datasketches.fdt">Group</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Defines a Group from a Frequent Distinct Tuple query.</div> |
| </th> |
| </tr> |
| <tr id="i59" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/theta/HashIterator.html" title="interface in org.apache.datasketches.theta">HashIterator</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">This is used to iterate over the retained hash values of the Theta sketch.</div> |
| </th> |
| </tr> |
| <tr id="i60" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/HashOperations.html" title="class in org.apache.datasketches">HashOperations</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Helper class for the common hash table methods.</div> |
| </th> |
| </tr> |
| <tr id="i61" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/hll/HllSketch.html" title="class in org.apache.datasketches.hll">HllSketch</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">This is a high performance implementation of Phillipe Flajolet’s HLL sketch but with |
| significantly improved error behavior.</div> |
| </th> |
| </tr> |
| <tr id="i62" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/InequalitySearch.html" title="enum in org.apache.datasketches">InequalitySearch</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">This provides efficient, unique and unambiguous binary searching for inequality comparison criteria |
| for ordered arrays of values that may include duplicate values.</div> |
| </th> |
| </tr> |
| <tr id="i63" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/aninteger/IntegerSketch.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSketch</a></td> |
| <th class="colLast" scope="row"> </th> |
| </tr> |
| <tr id="i64" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/aninteger/IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Summary for generic tuple sketches of type Integer.</div> |
| </th> |
| </tr> |
| <tr id="i65" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/aninteger/IntegerSummary.Mode.html" title="enum in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">The aggregation modes for this Summary</div> |
| </th> |
| </tr> |
| <tr id="i66" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/aninteger/IntegerSummaryDeserializer.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummaryDeserializer</a></td> |
| <th class="colLast" scope="row"> </th> |
| </tr> |
| <tr id="i67" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/aninteger/IntegerSummaryFactory.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummaryFactory</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Factory for IntegerSummary.</div> |
| </th> |
| </tr> |
| <tr id="i68" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/aninteger/IntegerSummarySetOperations.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummarySetOperations</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Methods for defining how unions and intersections of two objects of type IntegerSummary |
| are performed.</div> |
| </th> |
| </tr> |
| <tr id="i69" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/theta/Intersection.html" title="class in org.apache.datasketches.theta">Intersection</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">The API for intersection operations</div> |
| </th> |
| </tr> |
| <tr id="i70" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/Intersection.html" title="class in org.apache.datasketches.tuple">Intersection</a><<a href="org/apache/datasketches/tuple/Intersection.html" title="type parameter in Intersection">S</a> extends <a href="org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Computes an intersection of two or more generic tuple sketches or generic tuple sketches |
| combined with theta sketches.</div> |
| </th> |
| </tr> |
| <tr id="i71" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/hll/IntMemoryPairIterator.html" title="class in org.apache.datasketches.hll">IntMemoryPairIterator</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Iterates within a given Memory extracting integer pairs.</div> |
| </th> |
| </tr> |
| <tr id="i72" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/frequencies/ItemsSketch.html" title="class in org.apache.datasketches.frequencies">ItemsSketch</a><<a href="org/apache/datasketches/frequencies/ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></td> |
| <th class="colLast" scope="row"> |
| <div class="block">This sketch is useful for tracking approximate frequencies of items of type <i><T></i> |
| with optional associated counts (<i><T></i> item, <i>long</i> count) that are members of a |
| multiset of such items.</div> |
| </th> |
| </tr> |
| <tr id="i73" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="class in org.apache.datasketches.quantiles">ItemsSketch</a><<a href="org/apache/datasketches/quantiles/ItemsSketch.html" title="type parameter in ItemsSketch">T</a>></td> |
| <th class="colLast" scope="row"> |
| <div class="block">This is a stochastic streaming sketch that enables near-real time analysis of the |
| approximate distribution of comparable items from a very large stream in a single pass.</div> |
| </th> |
| </tr> |
| <tr id="i74" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/frequencies/ItemsSketch.Row.html" title="class in org.apache.datasketches.frequencies">ItemsSketch.Row</a><<a href="org/apache/datasketches/frequencies/ItemsSketch.Row.html" title="type parameter in ItemsSketch.Row">T</a>></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Row class that defines the return values from a getFrequentItems query.</div> |
| </th> |
| </tr> |
| <tr id="i75" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/quantiles/ItemsSketchIterator.html" title="class in org.apache.datasketches.quantiles">ItemsSketchIterator</a><<a href="org/apache/datasketches/quantiles/ItemsSketchIterator.html" title="type parameter in ItemsSketchIterator">T</a>></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Iterator over ItemsSketch.</div> |
| </th> |
| </tr> |
| <tr id="i76" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/quantiles/ItemsUnion.html" title="class in org.apache.datasketches.quantiles">ItemsUnion</a><<a href="org/apache/datasketches/quantiles/ItemsUnion.html" title="type parameter in ItemsUnion">T</a>></td> |
| <th class="colLast" scope="row"> |
| <div class="block">The API for Union operations for generic ItemsSketches</div> |
| </th> |
| </tr> |
| <tr id="i77" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/theta/JaccardSimilarity.html" title="class in org.apache.datasketches.theta">JaccardSimilarity</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Jaccard similarity of two Theta Sketches.</div> |
| </th> |
| </tr> |
| <tr id="i78" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/JaccardSimilarity.html" title="class in org.apache.datasketches.tuple">JaccardSimilarity</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Jaccard similarity of two Tuple Sketches, or alternatively, of a Tuple and Theta Sketch.</div> |
| </th> |
| </tr> |
| <tr id="i79" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/kll/KllDoublesSketch.html" title="class in org.apache.datasketches.kll">KllDoublesSketch</a></td> |
| <th class="colLast" scope="row"> </th> |
| </tr> |
| <tr id="i80" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/kll/KllDoublesSketchIterator.html" title="class in org.apache.datasketches.kll">KllDoublesSketchIterator</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Iterator over KllDoublesSketch.</div> |
| </th> |
| </tr> |
| <tr id="i81" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/kll/KllFloatsSketch.html" title="class in org.apache.datasketches.kll">KllFloatsSketch</a></td> |
| <th class="colLast" scope="row"> </th> |
| </tr> |
| <tr id="i82" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/kll/KllFloatsSketchIterator.html" title="class in org.apache.datasketches.kll">KllFloatsSketchIterator</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Iterator over KllFloatsSketch.</div> |
| </th> |
| </tr> |
| <tr id="i83" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/kll/KllSketch.html" title="class in org.apache.datasketches.kll">KllSketch</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">This class is the root of the KLL sketch class hierarchy.</div> |
| </th> |
| </tr> |
| <tr id="i84" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/kll/KllSketch.SketchType.html" title="enum in org.apache.datasketches.kll">KllSketch.SketchType</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Used to define the variable type of the current instance of this class.</div> |
| </th> |
| </tr> |
| <tr id="i85" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/frequencies/LongsSketch.html" title="class in org.apache.datasketches.frequencies">LongsSketch</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">This sketch is useful for tracking approximate frequencies of <i>long</i> items with optional |
| associated counts (<i>long</i> item, <i>long</i> count) that are members of a multiset of |
| such items.</div> |
| </th> |
| </tr> |
| <tr id="i86" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/frequencies/LongsSketch.Row.html" title="class in org.apache.datasketches.frequencies">LongsSketch.Row</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Row class that defines the return values from a getFrequentItems query.</div> |
| </th> |
| </tr> |
| <tr id="i87" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/cpc/MergingValidation.html" title="class in org.apache.datasketches.cpc">MergingValidation</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">This code is used both by unit tests, for short running tests, |
| and by the characterization repository for longer running, more exhaustive testing.</div> |
| </th> |
| </tr> |
| <tr id="i88" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/hash/MurmurHash3.html" title="class in org.apache.datasketches.hash">MurmurHash3</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block"> |
| The MurmurHash3 is a fast, non-cryptographic, 128-bit hash function that has |
| excellent avalanche and 2-way bit independence properties.</div> |
| </th> |
| </tr> |
| <tr id="i89" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/hash/MurmurHash3Adaptor.html" title="class in org.apache.datasketches.hash">MurmurHash3Adaptor</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">A general purpose wrapper for the MurmurHash3.</div> |
| </th> |
| </tr> |
| <tr id="i90" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/theta/PairwiseSetOperations.html" title="class in org.apache.datasketches.theta">PairwiseSetOperations</a></td> |
| <th class="colLast" scope="row">Deprecated. |
| <div class="deprecationComment">v2.0.0.</div> |
| </th> |
| </tr> |
| <tr id="i91" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/fdt/PostProcessor.html" title="class in org.apache.datasketches.fdt">PostProcessor</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">This processes the contents of a FDT sketch to extract the |
| primary keys with the most frequent unique combinations of the non-primary dimensions.</div> |
| </th> |
| </tr> |
| <tr id="i92" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/QuantilesHelper.html" title="class in org.apache.datasketches">QuantilesHelper</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Common static methods for classic quantiles and KLL sketches</div> |
| </th> |
| </tr> |
| <tr id="i93" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/cpc/QuickMergingValidation.html" title="class in org.apache.datasketches.cpc">QuickMergingValidation</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">This code is used both by unit tests, for short running tests, |
| and by the characterization repository for longer running, more exhaustive testing.</div> |
| </th> |
| </tr> |
| <tr id="i94" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/QuickSelect.html" title="class in org.apache.datasketches">QuickSelect</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">QuickSelect algorithm improved from Sedgewick.</div> |
| </th> |
| </tr> |
| <tr id="i95" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/req/ReqDebug.html" title="interface in org.apache.datasketches.req">ReqDebug</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">The signaling interface that allows comprehensive analysis of the ReqSketch and ReqCompactor |
| while eliminating code clutter in the main classes.</div> |
| </th> |
| </tr> |
| <tr id="i96" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/req/ReqIterator.html" title="class in org.apache.datasketches.req">ReqIterator</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Iterator over all retained items of the ReqSketch.</div> |
| </th> |
| </tr> |
| <tr id="i97" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/req/ReqSketch.html" title="class in org.apache.datasketches.req">ReqSketch</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">This Relative Error Quantiles Sketch is the Java implementation based on the paper |
| "Relative Error Streaming Quantiles", https://arxiv.org/abs/2004.01668, and loosely derived from |
| a Python prototype written by Pavel Vesely.</div> |
| </th> |
| </tr> |
| <tr id="i98" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/req/ReqSketchBuilder.html" title="class in org.apache.datasketches.req">ReqSketchBuilder</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">For building a new ReqSketch</div> |
| </th> |
| </tr> |
| <tr id="i99" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/sampling/ReservoirItemsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirItemsSketch</a><<a href="org/apache/datasketches/sampling/ReservoirItemsSketch.html" title="type parameter in ReservoirItemsSketch">T</a>></td> |
| <th class="colLast" scope="row"> |
| <div class="block">This sketch provides a reservoir sample over an input stream of items.</div> |
| </th> |
| </tr> |
| <tr id="i100" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/sampling/ReservoirItemsUnion.html" title="class in org.apache.datasketches.sampling">ReservoirItemsUnion</a><<a href="org/apache/datasketches/sampling/ReservoirItemsUnion.html" title="type parameter in ReservoirItemsUnion">T</a>></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Class to union reservoir samples of generic items.</div> |
| </th> |
| </tr> |
| <tr id="i101" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/sampling/ReservoirLongsSketch.html" title="class in org.apache.datasketches.sampling">ReservoirLongsSketch</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">This sketch provides a reservoir sample over an input stream of <code>long</code>s.</div> |
| </th> |
| </tr> |
| <tr id="i102" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/sampling/ReservoirLongsUnion.html" title="class in org.apache.datasketches.sampling">ReservoirLongsUnion</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Class to union reservoir samples of longs.</div> |
| </th> |
| </tr> |
| <tr id="i103" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/ResizeFactor.html" title="enum in org.apache.datasketches">ResizeFactor</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">For the Families that accept this configuration parameter, it controls the size multiple that |
| affects how fast the internal cache grows, when more space is required.</div> |
| </th> |
| </tr> |
| <tr id="i104" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/sampling/SampleSubsetSummary.html" title="class in org.apache.datasketches.sampling">SampleSubsetSummary</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">A simple object o capture the results of a subset sum query on a sampling sketch.</div> |
| </th> |
| </tr> |
| <tr id="i105" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/SerializerDeserializer.html" title="class in org.apache.datasketches.tuple">SerializerDeserializer</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Multipurpose serializer-deserializer for a collection of sketches defined by the enum.</div> |
| </th> |
| </tr> |
| <tr id="i106" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/SerializerDeserializer.SketchType.html" title="enum in org.apache.datasketches.tuple">SerializerDeserializer.SketchType</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Defines the sketch classes that this SerializerDeserializer can handle.</div> |
| </th> |
| </tr> |
| <tr id="i107" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/theta/SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">The parent API for all Set Operations</div> |
| </th> |
| </tr> |
| <tr id="i108" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/theta/SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">For building a new SetOperation.</div> |
| </th> |
| </tr> |
| <tr id="i109" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/SetOperationCornerCases.html" title="class in org.apache.datasketches">SetOperationCornerCases</a></td> |
| <th class="colLast" scope="row"> </th> |
| </tr> |
| <tr id="i110" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/SetOperationCornerCases.AnotbAction.html" title="enum in org.apache.datasketches">SetOperationCornerCases.AnotbAction</a></td> |
| <th class="colLast" scope="row"> </th> |
| </tr> |
| <tr id="i111" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/SetOperationCornerCases.CornerCase.html" title="enum in org.apache.datasketches">SetOperationCornerCases.CornerCase</a></td> |
| <th class="colLast" scope="row"> </th> |
| </tr> |
| <tr id="i112" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/SetOperationCornerCases.IntersectAction.html" title="enum in org.apache.datasketches">SetOperationCornerCases.IntersectAction</a></td> |
| <th class="colLast" scope="row"> </th> |
| </tr> |
| <tr id="i113" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/SetOperationCornerCases.UnionAction.html" title="enum in org.apache.datasketches">SetOperationCornerCases.UnionAction</a></td> |
| <th class="colLast" scope="row"> </th> |
| </tr> |
| <tr id="i114" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">The top-level class for all sketches.</div> |
| </th> |
| </tr> |
| <tr id="i115" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><<a href="org/apache/datasketches/tuple/Sketch.html" title="type parameter in Sketch">S</a> extends <a href="org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></td> |
| <th class="colLast" scope="row"> |
| <div class="block">This is an equivalent to org.apache.datasketches.theta.Sketch with |
| addition of a user-defined Summary object associated with every unique entry |
| in the sketch.</div> |
| </th> |
| </tr> |
| <tr id="i116" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/theta/Sketches.html" title="class in org.apache.datasketches.theta">Sketches</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">This class brings together the common sketch and set operation creation methods and |
| the public static methods into one place.</div> |
| </th> |
| </tr> |
| <tr id="i117" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/Sketches.html" title="class in org.apache.datasketches.tuple">Sketches</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Convenient static methods to instantiate generic tuple sketches.</div> |
| </th> |
| </tr> |
| <tr id="i118" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/SketchesArgumentException.html" title="class in org.apache.datasketches">SketchesArgumentException</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Illegal Arguments Exception class for the library</div> |
| </th> |
| </tr> |
| <tr id="i119" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/SketchesException.html" title="class in org.apache.datasketches">SketchesException</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Exception class for the library</div> |
| </th> |
| </tr> |
| <tr id="i120" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/SketchesReadOnlyException.html" title="class in org.apache.datasketches">SketchesReadOnlyException</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Write operation attempted on a read-only class.</div> |
| </th> |
| </tr> |
| <tr id="i121" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/SketchesStateException.html" title="class in org.apache.datasketches">SketchesStateException</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Illegal State Exception class for the library</div> |
| </th> |
| </tr> |
| <tr id="i122" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/SketchIterator.html" title="class in org.apache.datasketches.tuple">SketchIterator</a><<a href="org/apache/datasketches/tuple/SketchIterator.html" title="type parameter in SketchIterator">S</a> extends <a href="org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Iterator over a generic tuple sketch</div> |
| </th> |
| </tr> |
| <tr id="i123" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/cpc/StreamingValidation.html" title="class in org.apache.datasketches.cpc">StreamingValidation</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">This code is used both by unit tests, for short running tests, |
| and by the characterization repository for longer running, more exhaustive testing.</div> |
| </th> |
| </tr> |
| <tr id="i124" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Interface for user-defined Summary, which is associated with every hash in a tuple sketch</div> |
| </th> |
| </tr> |
| <tr id="i125" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a><<a href="org/apache/datasketches/tuple/SummaryDeserializer.html" title="type parameter in SummaryDeserializer">S</a> extends <a href="org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Interface for deserializing user-defined Summary</div> |
| </th> |
| </tr> |
| <tr id="i126" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a><<a href="org/apache/datasketches/tuple/SummaryFactory.html" title="type parameter in SummaryFactory">S</a> extends <a href="org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Interface for user-defined SummaryFactory</div> |
| </th> |
| </tr> |
| <tr id="i127" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><<a href="org/apache/datasketches/tuple/SummarySetOperations.html" title="type parameter in SummarySetOperations">S</a> extends <a href="org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></td> |
| <th class="colLast" scope="row"> |
| <div class="block">This is to provide methods of producing unions and intersections of two Summary objects.</div> |
| </th> |
| </tr> |
| <tr id="i128" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/cpc/TestUtil.html" title="class in org.apache.datasketches.cpc">TestUtil</a></td> |
| <th class="colLast" scope="row"> </th> |
| </tr> |
| <tr id="i129" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/hll/TgtHllType.html" title="enum in org.apache.datasketches.hll">TgtHllType</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Specifies the target type of HLL sketch to be created.</div> |
| </th> |
| </tr> |
| <tr id="i130" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/hll/Union.html" title="class in org.apache.datasketches.hll">Union</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">This performs union operations for all HllSketches.</div> |
| </th> |
| </tr> |
| <tr id="i131" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/theta/Union.html" title="class in org.apache.datasketches.theta">Union</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Compute the union of two or more theta sketches.</div> |
| </th> |
| </tr> |
| <tr id="i132" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/Union.html" title="class in org.apache.datasketches.tuple">Union</a><<a href="org/apache/datasketches/tuple/Union.html" title="type parameter in Union">S</a> extends <a href="org/apache/datasketches/tuple/Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Compute the union of two or more generic tuple sketches or generic tuple sketches combined with |
| theta sketches.</div> |
| </th> |
| </tr> |
| <tr id="i133" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/hllmap/UniqueCountMap.html" title="class in org.apache.datasketches.hllmap">UniqueCountMap</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">This is a real-time, key-value HLL mapping sketch that tracks approximate unique counts of |
| identifiers (the values) associated with each key.</div> |
| </th> |
| </tr> |
| <tr id="i134" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a><<a href="org/apache/datasketches/tuple/UpdatableSketch.html" title="type parameter in UpdatableSketch">U</a>,​<a href="org/apache/datasketches/tuple/UpdatableSketch.html" title="type parameter in UpdatableSketch">S</a> extends <a href="org/apache/datasketches/tuple/UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><<a href="org/apache/datasketches/tuple/UpdatableSketch.html" title="type parameter in UpdatableSketch">U</a>>></td> |
| <th class="colLast" scope="row"> |
| <div class="block">An extension of QuickSelectSketch<S>, which can be updated with many types of keys.</div> |
| </th> |
| </tr> |
| <tr id="i135" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/UpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple">UpdatableSketchBuilder</a><<a href="org/apache/datasketches/tuple/UpdatableSketchBuilder.html" title="type parameter in UpdatableSketchBuilder">U</a>,​<a href="org/apache/datasketches/tuple/UpdatableSketchBuilder.html" title="type parameter in UpdatableSketchBuilder">S</a> extends <a href="org/apache/datasketches/tuple/UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><<a href="org/apache/datasketches/tuple/UpdatableSketchBuilder.html" title="type parameter in UpdatableSketchBuilder">U</a>>></td> |
| <th class="colLast" scope="row"> |
| <div class="block">For building a new generic tuple UpdatableSketch</div> |
| </th> |
| </tr> |
| <tr id="i136" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><<a href="org/apache/datasketches/tuple/UpdatableSummary.html" title="type parameter in UpdatableSummary">U</a>></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Interface for updating user-defined Summary</div> |
| </th> |
| </tr> |
| <tr id="i137" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/quantiles/UpdateDoublesSketch.html" title="class in org.apache.datasketches.quantiles">UpdateDoublesSketch</a></td> |
| <th class="colLast" scope="row"> </th> |
| </tr> |
| <tr id="i138" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/theta/UpdateReturnState.html" title="enum in org.apache.datasketches.theta">UpdateReturnState</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block"><a href="./resources/dictionary.html#updateReturnState">See Update Return State</a></div> |
| </th> |
| </tr> |
| <tr id="i139" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/theta/UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">The parent class for the Update Sketch families, such as QuickSelect and Alpha.</div> |
| </th> |
| </tr> |
| <tr id="i140" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/theta/UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">For building a new UpdateSketch.</div> |
| </th> |
| </tr> |
| <tr id="i141" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/tuple/Util.html" title="class in org.apache.datasketches.tuple">Util</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Common utility functions for Tuples</div> |
| </th> |
| </tr> |
| <tr id="i142" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/Util.html" title="class in org.apache.datasketches">Util</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Common utility functions.</div> |
| </th> |
| </tr> |
| <tr id="i143" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/sampling/VarOptItemsSamples.html" title="class in org.apache.datasketches.sampling">VarOptItemsSamples</a><<a href="org/apache/datasketches/sampling/VarOptItemsSamples.html" title="type parameter in VarOptItemsSamples">T</a>></td> |
| <th class="colLast" scope="row"> |
| <div class="block">This class provides access to the samples contained in a VarOptItemsSketch.</div> |
| </th> |
| </tr> |
| <tr id="i144" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/sampling/VarOptItemsSketch.html" title="class in org.apache.datasketches.sampling">VarOptItemsSketch</a><<a href="org/apache/datasketches/sampling/VarOptItemsSketch.html" title="type parameter in VarOptItemsSketch">T</a>></td> |
| <th class="colLast" scope="row"> |
| <div class="block">This sketch provides a variance optimal sample over an input stream of weighted items.</div> |
| </th> |
| </tr> |
| <tr id="i145" class="rowColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/sampling/VarOptItemsUnion.html" title="class in org.apache.datasketches.sampling">VarOptItemsUnion</a><<a href="org/apache/datasketches/sampling/VarOptItemsUnion.html" title="type parameter in VarOptItemsUnion">T</a>></td> |
| <th class="colLast" scope="row"> |
| <div class="block">Provides a unioning operation over varopt sketches.</div> |
| </th> |
| </tr> |
| <tr id="i146" class="altColor"> |
| <td class="colFirst"><a href="org/apache/datasketches/hash/XxHash.html" title="class in org.apache.datasketches.hash">XxHash</a></td> |
| <th class="colLast" scope="row"> |
| <div class="block">The XxHash is a fast, non-cryptographic, 64-bit hash function that has |
| excellent avalanche and 2-way bit independence properties.</div> |
| </th> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </div> |
| </main> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="index.html">Overview</a></li> |
| <li>Package</li> |
| <li>Class</li> |
| <li>Use</li> |
| <li><a href="overview-tree.html">Tree</a></li> |
| <li><a href="deprecated-list.html">Deprecated</a></li> |
| <li><a href="index-all.html">Index</a></li> |
| <li><a href="help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2015–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
