| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>org.apache.datasketches.thetacommon (datasketches-java 4.0.0 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <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.0.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="org.apache.datasketches.thetacommon (datasketches-java 4.0.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| 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 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" 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="Package" class="title">Package org.apache.datasketches.thetacommon</h1> |
| </div> |
| <div class="contentContainer"> |
| <section><a id="package.description"> |
| <!-- --> |
| </a> |
| <div class="block">This package contains common tools and methods for the <i>theta</i>, |
| <i>tuple</i>, <i>tuple/*</i> and <i>fdt</i> packages.</div> |
| </section> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <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"> |
| <th class="colFirst" scope="row"><a href="BinomialBoundsN.html" title="class in org.apache.datasketches.thetacommon">BinomialBoundsN</a></th> |
| <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="rowColor"> |
| <th class="colFirst" scope="row"><a href="BoundsOnRatiosInThetaSketchedSets.html" title="class in org.apache.datasketches.thetacommon">BoundsOnRatiosInThetaSketchedSets</a></th> |
| <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="altColor"> |
| <th class="colFirst" scope="row"><a href="BoundsOnRatiosInTupleSketchedSets.html" title="class in org.apache.datasketches.thetacommon">BoundsOnRatiosInTupleSketchedSets</a></th> |
| <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 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> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="HashOperations.html" title="class in org.apache.datasketches.thetacommon">HashOperations</a></th> |
| <td class="colLast"> |
| <div class="block">Helper class for the common hash table methods.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="QuickSelect.html" title="class in org.apache.datasketches.thetacommon">QuickSelect</a></th> |
| <td class="colLast"> |
| <div class="block">QuickSelect algorithm improved from Sedgewick.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SetOperationCornerCases.html" title="class in org.apache.datasketches.thetacommon">SetOperationCornerCases</a></th> |
| <td class="colLast"> |
| <div class="block">Simplifies and speeds up set operations by resolving specific corner cases.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="ThetaUtil.html" title="class in org.apache.datasketches.thetacommon">ThetaUtil</a></th> |
| <td class="colLast"> |
| <div class="block">Utility methods for the Theta Family of sketches</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <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"> |
| <th class="colFirst" scope="row"><a href="SetOperationCornerCases.AnotbAction.html" title="enum in org.apache.datasketches.thetacommon">SetOperationCornerCases.AnotbAction</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SetOperationCornerCases.CornerCase.html" title="enum in org.apache.datasketches.thetacommon">SetOperationCornerCases.CornerCase</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SetOperationCornerCases.IntersectAction.html" title="enum in org.apache.datasketches.thetacommon">SetOperationCornerCases.IntersectAction</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SetOperationCornerCases.UnionAction.html" title="enum in org.apache.datasketches.thetacommon">SetOperationCornerCases.UnionAction</a></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </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 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" 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–2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
