| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_162) on Thu Oct 25 17:06:11 PDT 2018 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>com.yahoo.sketches (com.yahoo.datasketches:sketches-core 0.12.1-SNAPSHOT API)</title> |
| <meta name="date" content="2018-10-25"> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="com.yahoo.sketches (com.yahoo.datasketches:sketches-core 0.12.1-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../index-all.html">Index</a></li> |
| <li><a href="../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Package</li> |
| <li><a href="../../../com/yahoo/sketches/cpc/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?com/yahoo/sketches/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="header"> |
| <h1 title="Package" class="title">Package com.yahoo.sketches</h1> |
| <div class="docSummary"> |
| <div class="block">This package is the parent package for all sketch algorithms.</div> |
| </div> |
| <p>See: <a href="#package.description">Description</a></p> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../com/yahoo/sketches/ArrayOfBooleansSerDe.html" title="class in com.yahoo.sketches">ArrayOfBooleansSerDe</a></td> |
| <td class="colLast"> |
| <div class="block">Methods of serializing and deserializing arrays of Boolean as a bit array.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../com/yahoo/sketches/ArrayOfDoublesSerDe.html" title="class in com.yahoo.sketches">ArrayOfDoublesSerDe</a></td> |
| <td class="colLast"> |
| <div class="block">Methods of serializing and deserializing arrays of Double.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../com/yahoo/sketches/ArrayOfItemsSerDe.html" title="class in com.yahoo.sketches">ArrayOfItemsSerDe</a><T></td> |
| <td class="colLast"> |
| <div class="block">Base class for serializing and deserializing custom types.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../com/yahoo/sketches/ArrayOfLongsSerDe.html" title="class in com.yahoo.sketches">ArrayOfLongsSerDe</a></td> |
| <td class="colLast"> |
| <div class="block">Methods of serializing and deserializing arrays of Long.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../com/yahoo/sketches/ArrayOfNumbersSerDe.html" title="class in com.yahoo.sketches">ArrayOfNumbersSerDe</a></td> |
| <td class="colLast"> |
| <div class="block">Methods of serializing and deserializing arrays of the object version of primitive types of |
| Number.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../com/yahoo/sketches/ArrayOfStringsSerDe.html" title="class in com.yahoo.sketches">ArrayOfStringsSerDe</a></td> |
| <td class="colLast"> |
| <div class="block">Methods of serializing and deserializing arrays of String.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../com/yahoo/sketches/ArrayOfUtf16StringsSerDe.html" title="class in com.yahoo.sketches">ArrayOfUtf16StringsSerDe</a></td> |
| <td class="colLast"> |
| <div class="block">Methods of serializing and deserializing arrays of String.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../com/yahoo/sketches/BinomialBoundsN.html" title="class in com.yahoo.sketches">BinomialBoundsN</a></td> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../com/yahoo/sketches/BoundsOnBinomialProportions.html" title="class in com.yahoo.sketches">BoundsOnBinomialProportions</a></td> |
| <td class="colLast"> |
| <div class="block">Confidence intervals for binomial proportions.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../com/yahoo/sketches/BoundsOnRatiosInSampledSets.html" title="class in com.yahoo.sketches">BoundsOnRatiosInSampledSets</a></td> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../com/yahoo/sketches/BoundsOnRatiosInThetaSketchedSets.html" title="class in com.yahoo.sketches">BoundsOnRatiosInThetaSketchedSets</a></td> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../com/yahoo/sketches/ByteArrayUtil.html" title="class in com.yahoo.sketches">ByteArrayUtil</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../com/yahoo/sketches/HashOperations.html" title="class in com.yahoo.sketches">HashOperations</a></td> |
| <td class="colLast"> |
| <div class="block">Helper class for the common hash table methods.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../com/yahoo/sketches/QuantilesHelper.html" title="class in com.yahoo.sketches">QuantilesHelper</a></td> |
| <td class="colLast"> |
| <div class="block">Common static methods for quantiles sketches</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../com/yahoo/sketches/QuickSelect.html" title="class in com.yahoo.sketches">QuickSelect</a></td> |
| <td class="colLast"> |
| <div class="block">QuickSelect algorithm improved from Sedgewick.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../com/yahoo/sketches/Util.html" title="class in com.yahoo.sketches">Util</a></td> |
| <td class="colLast"> |
| <div class="block">Common utility functions.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> |
| <caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Enum</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a></td> |
| <td class="colLast"> |
| <div class="block">Defines the various families of sketch and set operation classes.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../com/yahoo/sketches/ResizeFactor.html" title="enum in com.yahoo.sketches">ResizeFactor</a></td> |
| <td class="colLast"> |
| <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> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation"> |
| <caption><span>Exception Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Exception</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../com/yahoo/sketches/SketchesArgumentException.html" title="class in com.yahoo.sketches">SketchesArgumentException</a></td> |
| <td class="colLast"> |
| <div class="block">Illegal Arguments Exception class for the library</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../com/yahoo/sketches/SketchesException.html" title="class in com.yahoo.sketches">SketchesException</a></td> |
| <td class="colLast"> |
| <div class="block">Exception class for the library</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../com/yahoo/sketches/SketchesReadOnlyException.html" title="class in com.yahoo.sketches">SketchesReadOnlyException</a></td> |
| <td class="colLast"> |
| <div class="block">Write operation attempted on a read-only class.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../com/yahoo/sketches/SketchesStateException.html" title="class in com.yahoo.sketches">SketchesStateException</a></td> |
| <td class="colLast"> |
| <div class="block">Illegal State Exception class for the library</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| <a name="package.description"> |
| <!-- --> |
| </a> |
| <h2 title="Package com.yahoo.sketches Description">Package com.yahoo.sketches Description</h2> |
| <div class="block"><p>This package is the parent package for all sketch algorithms. |
| Classes at this level are used by more than one sub-package.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>Lee Rhodes</dd> |
| </dl> |
| </div> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../index-all.html">Index</a></li> |
| <li><a href="../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Package</li> |
| <li><a href="../../../com/yahoo/sketches/cpc/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?com/yahoo/sketches/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2015–2018. All rights reserved.</small></p> |
| </body> |
| </html> |
