blob: a38dab145a210bffeaef41f3009945cbcd39de65 [file]
<!DOCTYPE HTML>
<html lang>
<head>
<!-- Generated by javadoc (25) -->
<title>BoundsOnRatiosInSampledSets (datasketches-java 9.0.1-SNAPSHOT API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.apache.datasketches.common, class: BoundsOnRatiosInSampledSets">
<meta name="generator" content="javadoc/ClassWriter">
<link rel="stylesheet" type="text/css" href="../../../../resource-files/jquery-ui.min.css">
<link rel="stylesheet" type="text/css" href="../../../../resource-files/stylesheet.css">
<script type="text/javascript" src="../../../../script-files/script.js"></script>
<script type="text/javascript" src="../../../../script-files/jquery-3.7.1.min.js"></script>
<script type="text/javascript" src="../../../../script-files/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">const pathtoroot = "../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="nav-content">
<div class="nav-menu-button"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button></div>
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/BoundsOnRatiosInSampledSets.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../search.html">Search</a></li>
<li><a href="../../../../help-doc.html#class">Help</a></li>
</ul>
</div>
</div>
<div class="sub-nav">
<div class="nav-content">
<ol class="sub-nav-list">
<li><a href="package-summary.html">org.apache.datasketches.common</a></li>
<li><a href="BoundsOnRatiosInSampledSets.html" class="current-selection">BoundsOnRatiosInSampledSets</a></li>
</ol>
<div class="nav-list-search"><input type="text" id="search-input" disabled placeholder="Search documentation (type /)" aria-label="Search in documentation" autocomplete="off" spellcheck="false"><input type="reset" id="reset-search" disabled value="Reset"></div>
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="main-grid">
<nav role="navigation" class="toc" aria-label="Table of contents">
<div class="toc-header">Contents&nbsp;<input type="text" class="filter-input" disabled placeholder="Filter contents (type .)" aria-label="Filter table of contents" autocomplete="off" spellcheck="false"><input type="reset" class="reset-filter" disabled tabindex="-1" value="Reset"></div>
<ol class="toc-list" tabindex="-1">
<li><a href="#" tabindex="0">Description</a></li>
<li><a href="#method-summary" tabindex="0">Method Summary</a></li>
<li><a href="#method-detail" tabindex="0">Method Details</a>
<ol class="toc-list">
<li><a href="#getLowerBoundForBoverA(long,long,double)" tabindex="0">getLowerBoundForBoverA(long, long, double)</a></li>
<li><a href="#getUpperBoundForBoverA(long,long,double)" tabindex="0">getUpperBoundForBoverA(long, long, double)</a></li>
<li><a href="#getEstimateOfBoverA(long,long)" tabindex="0">getEstimateOfBoverA(long, long)</a></li>
<li><a href="#getEstimateOfA(long,double)" tabindex="0">getEstimateOfA(long, double)</a></li>
<li><a href="#getEstimateOfB(long,double)" tabindex="0">getEstimateOfB(long, double)</a></li>
</ol>
</li>
</ol>
<button class="hide-sidebar"><span>Hide sidebar&nbsp;</span><img src="../../../../resource-files/left.svg" alt="Hide sidebar"></button><button class="show-sidebar"><img src="../../../../resource-files/right.svg" alt="Show sidebar"><span>&nbsp;Show sidebar</span></button></nav>
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<h1 title="Class BoundsOnRatiosInSampledSets" class="title">Class BoundsOnRatiosInSampledSets</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance">org.apache.datasketches.common.BoundsOnRatiosInSampledSets</div>
</div>
<section class="class-description" id="class-description">
<hr>
<div class="horizontal-scroll">
<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">BoundsOnRatiosInSampledSets</span>
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
<div class="block">This class is used to compute the bounds on the estimate of the ratio <i>|B| / |A|</i>, where:
<ul>
<li><i>|A|</i> is the unknown size of a set <i>A</i> of unique identifiers.</li>
<li><i>|B|</i> is the unknown size of a subset <i>B</i> of <i>A</i>.</li>
<li><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>.</li>
<li><i>b</i> = <i>|S<sub>A</sub> &cap; B|</i> is the observed size of a subset
of <i>S<sub>A</sub></i>.</li>
</ul></div>
<dl class="notes">
<dt>Author:</dt>
<dd>Kevin Lang</dd>
</dl>
</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0">
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getEstimateOfA(long,double)" class="member-name-link">getEstimateOfA</a><wbr>(long&nbsp;a,
double&nbsp;f)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Return the estimate of A.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getEstimateOfB(long,double)" class="member-name-link">getEstimateOfB</a><wbr>(long&nbsp;b,
double&nbsp;f)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Return the estimate of B.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getEstimateOfBoverA(long,long)" class="member-name-link">getEstimateOfBoverA</a><wbr>(long&nbsp;a,
long&nbsp;b)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Return the estimate of b over a</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getLowerBoundForBoverA(long,long,double)" class="member-name-link">getLowerBoundForBoverA</a><wbr>(long&nbsp;a,
long&nbsp;b,
double&nbsp;f)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Return the approximate lower bound based on a 95% confidence interval</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static double</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getUpperBoundForBoverA(long,long,double)" class="member-name-link">getUpperBoundForBoverA</a><wbr>(long&nbsp;a,
long&nbsp;b,
double&nbsp;f)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
<div class="block">Return the approximate upper bound based on a 95% confidence interval</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;<a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#method-summary" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="getLowerBoundForBoverA(long,long,double)">
<h3>getLowerBoundForBoverA</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">getLowerBoundForBoverA</span><wbr><span class="parameters">(long&nbsp;a,
long&nbsp;b,
double&nbsp;f)</span></div>
<div class="block">Return the approximate lower bound based on a 95% confidence interval</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>a</code> - See class javadoc</dd>
<dd><code>b</code> - See class javadoc</dd>
<dd><code>f</code> - the inclusion probability used to produce the set with size <i>a</i> and should
generally be less than 0.5. Above this value, the results not be reliable.
When <i>f</i> = 1.0 this returns the estimate.</dd>
<dt>Returns:</dt>
<dd>the approximate upper bound</dd>
</dl>
</div>
</section>
</li>
<li>
<section class="detail" id="getUpperBoundForBoverA(long,long,double)">
<h3>getUpperBoundForBoverA</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">getUpperBoundForBoverA</span><wbr><span class="parameters">(long&nbsp;a,
long&nbsp;b,
double&nbsp;f)</span></div>
<div class="block">Return the approximate upper bound based on a 95% confidence interval</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>a</code> - See class javadoc</dd>
<dd><code>b</code> - See class javadoc</dd>
<dd><code>f</code> - the inclusion probability used to produce the set with size <i>a</i>.</dd>
<dt>Returns:</dt>
<dd>the approximate lower bound</dd>
</dl>
</div>
</section>
</li>
<li>
<section class="detail" id="getEstimateOfBoverA(long,long)">
<h3>getEstimateOfBoverA</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">getEstimateOfBoverA</span><wbr><span class="parameters">(long&nbsp;a,
long&nbsp;b)</span></div>
<div class="block">Return the estimate of b over a</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>a</code> - See class javadoc</dd>
<dd><code>b</code> - See class javadoc</dd>
<dt>Returns:</dt>
<dd>the estimate of b over a</dd>
</dl>
</div>
</section>
</li>
<li>
<section class="detail" id="getEstimateOfA(long,double)">
<h3>getEstimateOfA</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">getEstimateOfA</span><wbr><span class="parameters">(long&nbsp;a,
double&nbsp;f)</span></div>
<div class="block">Return the estimate of A. See class javadoc.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>a</code> - See class javadoc</dd>
<dd><code>f</code> - the inclusion probability used to produce the set with size <i>a</i>.</dd>
<dt>Returns:</dt>
<dd>the approximate lower bound</dd>
</dl>
</div>
</section>
</li>
<li>
<section class="detail" id="getEstimateOfB(long,double)">
<h3>getEstimateOfB</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">getEstimateOfB</span><wbr><span class="parameters">(long&nbsp;b,
double&nbsp;f)</span></div>
<div class="block">Return the estimate of B. See class javadoc.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>b</code> - See class javadoc</dd>
<dd><code>f</code> - the inclusion probability used to produce the set with size <i>b</i>.</dd>
<dt>Returns:</dt>
<dd>the approximate lower bound</dd>
</dl>
</div>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2015&#x2013;2025 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</main>
</div>
</body>
</html>