diff options
Diffstat (limited to 'commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/stat/interval/BinomialConfidenceInterval.html')
| -rw-r--r-- | commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/stat/interval/BinomialConfidenceInterval.html | 250 |
1 files changed, 250 insertions, 0 deletions
diff --git a/commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/stat/interval/BinomialConfidenceInterval.html b/commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/stat/interval/BinomialConfidenceInterval.html new file mode 100644 index 0000000..82a2ce6 --- /dev/null +++ b/commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/stat/interval/BinomialConfidenceInterval.html @@ -0,0 +1,250 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>BinomialConfidenceInterval (Apache Commons Math 3.6.1 API)</title> +<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="BinomialConfidenceInterval (Apache Commons Math 3.6.1 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/BinomialConfidenceInterval.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 class="aboutLanguage"><em><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script></em></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../org/apache/commons/math3/stat/interval/AgrestiCoullInterval.html" title="class in org.apache.commons.math3.stat.interval"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/commons/math3/stat/interval/ClopperPearsonInterval.html" title="class in org.apache.commons.math3.stat.interval"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/commons/math3/stat/interval/BinomialConfidenceInterval.html" target="_top">Frames</a></li> +<li><a href="BinomialConfidenceInterval.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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.commons.math3.stat.interval</div> +<h2 title="Interface BinomialConfidenceInterval" class="title">Interface BinomialConfidenceInterval</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../../../org/apache/commons/math3/stat/interval/AgrestiCoullInterval.html" title="class in org.apache.commons.math3.stat.interval">AgrestiCoullInterval</a>, <a href="../../../../../../org/apache/commons/math3/stat/interval/ClopperPearsonInterval.html" title="class in org.apache.commons.math3.stat.interval">ClopperPearsonInterval</a>, <a href="../../../../../../org/apache/commons/math3/stat/interval/NormalApproximationInterval.html" title="class in org.apache.commons.math3.stat.interval">NormalApproximationInterval</a>, <a href="../../../../../../org/apache/commons/math3/stat/interval/WilsonScoreInterval.html" title="class in org.apache.commons.math3.stat.interval">WilsonScoreInterval</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">BinomialConfidenceInterval</span></pre> +<div class="block">Interface to generate confidence intervals for a binomial proportion.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>3.3</dd> +<dt><span class="strong">See Also:</span></dt><dd><a + href="http://en.wikipedia.org/wiki/Binomial_proportion_confidence_interval">Binomial + proportion confidence interval (Wikipedia)</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/commons/math3/stat/interval/ConfidenceInterval.html" title="class in org.apache.commons.math3.stat.interval">ConfidenceInterval</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/math3/stat/interval/BinomialConfidenceInterval.html#createInterval(int,%20int,%20double)">createInterval</a></strong>(int numberOfTrials, + int numberOfSuccesses, + double confidenceLevel)</code> +<div class="block">Create a confidence interval for the true probability of success + of an unknown binomial distribution with the given observed number + of trials, successes and confidence level.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="createInterval(int, int, double)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>createInterval</h4> +<pre><a href="../../../../../../org/apache/commons/math3/stat/interval/ConfidenceInterval.html" title="class in org.apache.commons.math3.stat.interval">ConfidenceInterval</a> createInterval(int numberOfTrials, + int numberOfSuccesses, + double confidenceLevel) + throws <a href="../../../../../../org/apache/commons/math3/exception/NotStrictlyPositiveException.html" title="class in org.apache.commons.math3.exception">NotStrictlyPositiveException</a>, + <a href="../../../../../../org/apache/commons/math3/exception/NotPositiveException.html" title="class in org.apache.commons.math3.exception">NotPositiveException</a>, + <a href="../../../../../../org/apache/commons/math3/exception/NumberIsTooLargeException.html" title="class in org.apache.commons.math3.exception">NumberIsTooLargeException</a>, + <a href="../../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a></pre> +<div class="block">Create a confidence interval for the true probability of success + of an unknown binomial distribution with the given observed number + of trials, successes and confidence level. + <p> + Preconditions: + <ul> + <li><code>numberOfTrials</code> must be positive</li> + <li><code>numberOfSuccesses</code> may not exceed <code>numberOfTrials</code></li> + <li><code>confidenceLevel</code> must be strictly between 0 and 1 (exclusive)</li> + </ul> + </p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>numberOfTrials</code> - number of trials</dd><dd><code>numberOfSuccesses</code> - number of successes</dd><dd><code>confidenceLevel</code> - desired probability that the true probability of + success falls within the returned interval</dd> +<dt><span class="strong">Returns:</span></dt><dd>Confidence interval containing the probability of success with + probability <code>confidenceLevel</code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../../org/apache/commons/math3/exception/NotStrictlyPositiveException.html" title="class in org.apache.commons.math3.exception">NotStrictlyPositiveException</a></code> - if <code>numberOfTrials <= 0</code>.</dd> +<dd><code><a href="../../../../../../org/apache/commons/math3/exception/NotPositiveException.html" title="class in org.apache.commons.math3.exception">NotPositiveException</a></code> - if <code>numberOfSuccesses < 0</code>.</dd> +<dd><code><a href="../../../../../../org/apache/commons/math3/exception/NumberIsTooLargeException.html" title="class in org.apache.commons.math3.exception">NumberIsTooLargeException</a></code> - if <code>numberOfSuccesses > numberOfTrials</code>.</dd> +<dd><code><a href="../../../../../../org/apache/commons/math3/exception/OutOfRangeException.html" title="class in org.apache.commons.math3.exception">OutOfRangeException</a></code> - if <code>confidenceLevel</code> is not in the interval <code>(0, 1)</code>.</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/BinomialConfidenceInterval.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 class="aboutLanguage"><em><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script></em></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../org/apache/commons/math3/stat/interval/AgrestiCoullInterval.html" title="class in org.apache.commons.math3.stat.interval"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/commons/math3/stat/interval/ClopperPearsonInterval.html" title="class in org.apache.commons.math3.stat.interval"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/commons/math3/stat/interval/BinomialConfidenceInterval.html" target="_top">Frames</a></li> +<li><a href="BinomialConfidenceInterval.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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2003–2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> |