diff options
Diffstat (limited to 'commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/distribution/HypergeometricDistribution.html')
-rw-r--r-- | commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/distribution/HypergeometricDistribution.html | 615 |
1 files changed, 615 insertions, 0 deletions
diff --git a/commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/distribution/HypergeometricDistribution.html b/commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/distribution/HypergeometricDistribution.html new file mode 100644 index 0000000..58b3b2d --- /dev/null +++ b/commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/distribution/HypergeometricDistribution.html @@ -0,0 +1,615 @@ +<!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>HypergeometricDistribution (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="HypergeometricDistribution (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/HypergeometricDistribution.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/distribution/GumbelDistribution.html" title="class in org.apache.commons.math3.distribution"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/commons/math3/distribution/IntegerDistribution.html" title="interface in org.apache.commons.math3.distribution"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/commons/math3/distribution/HypergeometricDistribution.html" target="_top">Frames</a></li> +<li><a href="HypergeometricDistribution.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><a href="#fields_inherited_from_class_org.apache.commons.math3.distribution.AbstractIntegerDistribution">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </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.distribution</div> +<h2 title="Class HypergeometricDistribution" class="title">Class HypergeometricDistribution</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../org/apache/commons/math3/distribution/AbstractIntegerDistribution.html" title="class in org.apache.commons.math3.distribution">org.apache.commons.math3.distribution.AbstractIntegerDistribution</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.commons.math3.distribution.HypergeometricDistribution</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="../../../../../org/apache/commons/math3/distribution/IntegerDistribution.html" title="interface in org.apache.commons.math3.distribution">IntegerDistribution</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">HypergeometricDistribution</span> +extends <a href="../../../../../org/apache/commons/math3/distribution/AbstractIntegerDistribution.html" title="class in org.apache.commons.math3.distribution">AbstractIntegerDistribution</a></pre> +<div class="block">Implementation of the hypergeometric distribution.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="http://en.wikipedia.org/wiki/Hypergeometric_distribution">Hypergeometric distribution (Wikipedia)</a>, +<a href="http://mathworld.wolfram.com/HypergeometricDistribution.html">Hypergeometric distribution (MathWorld)</a>, +<a href="../../../../../serialized-form.html#org.apache.commons.math3.distribution.HypergeometricDistribution">Serialized Form</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_org.apache.commons.math3.distribution.AbstractIntegerDistribution"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.commons.math3.distribution.<a href="../../../../../org/apache/commons/math3/distribution/AbstractIntegerDistribution.html" title="class in org.apache.commons.math3.distribution">AbstractIntegerDistribution</a></h3> +<code><a href="../../../../../org/apache/commons/math3/distribution/AbstractIntegerDistribution.html#random">random</a>, <a href="../../../../../org/apache/commons/math3/distribution/AbstractIntegerDistribution.html#randomData">randomData</a></code></li> +</ul> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/commons/math3/distribution/HypergeometricDistribution.html#HypergeometricDistribution(int,%20int,%20int)">HypergeometricDistribution</a></strong>(int populationSize, + int numberOfSuccesses, + int sampleSize)</code> +<div class="block">Construct a new hypergeometric distribution with the specified population + size, number of successes in the population, and sample size.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/commons/math3/distribution/HypergeometricDistribution.html#HypergeometricDistribution(org.apache.commons.math3.random.RandomGenerator,%20int,%20int,%20int)">HypergeometricDistribution</a></strong>(<a href="../../../../../org/apache/commons/math3/random/RandomGenerator.html" title="interface in org.apache.commons.math3.random">RandomGenerator</a> rng, + int populationSize, + int numberOfSuccesses, + int sampleSize)</code> +<div class="block">Creates a new hypergeometric distribution.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== 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>protected double</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/distribution/HypergeometricDistribution.html#calculateNumericalVariance()">calculateNumericalVariance</a></strong>()</code> +<div class="block">Used by <a href="../../../../../org/apache/commons/math3/distribution/HypergeometricDistribution.html#getNumericalVariance()"><code>getNumericalVariance()</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/distribution/HypergeometricDistribution.html#cumulativeProbability(int)">cumulativeProbability</a></strong>(int x)</code> +<div class="block">For a random variable <code>X</code> whose values are distributed according + to this distribution, this method returns <code>P(X <= x)</code>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/distribution/HypergeometricDistribution.html#getNumberOfSuccesses()">getNumberOfSuccesses</a></strong>()</code> +<div class="block">Access the number of successes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/distribution/HypergeometricDistribution.html#getNumericalMean()">getNumericalMean</a></strong>()</code> +<div class="block">Use this method to get the numerical value of the mean of this + distribution.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/distribution/HypergeometricDistribution.html#getNumericalVariance()">getNumericalVariance</a></strong>()</code> +<div class="block">Use this method to get the numerical value of the variance of this + distribution.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/distribution/HypergeometricDistribution.html#getPopulationSize()">getPopulationSize</a></strong>()</code> +<div class="block">Access the population size.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/distribution/HypergeometricDistribution.html#getSampleSize()">getSampleSize</a></strong>()</code> +<div class="block">Access the sample size.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/distribution/HypergeometricDistribution.html#getSupportLowerBound()">getSupportLowerBound</a></strong>()</code> +<div class="block">Access the lower bound of the support.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/distribution/HypergeometricDistribution.html#getSupportUpperBound()">getSupportUpperBound</a></strong>()</code> +<div class="block">Access the upper bound of the support.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/distribution/HypergeometricDistribution.html#isSupportConnected()">isSupportConnected</a></strong>()</code> +<div class="block">Use this method to get information about whether the support is + connected, i.e.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/distribution/HypergeometricDistribution.html#logProbability(int)">logProbability</a></strong>(int x)</code> +<div class="block">For a random variable <code>X</code> whose values are distributed according to + this distribution, this method returns <code>log(P(X = x))</code>, where + <code>log</code> is the natural logarithm.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/distribution/HypergeometricDistribution.html#probability(int)">probability</a></strong>(int x)</code> +<div class="block">For a random variable <code>X</code> whose values are distributed according + to this distribution, this method returns <code>P(X = x)</code>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/distribution/HypergeometricDistribution.html#upperCumulativeProbability(int)">upperCumulativeProbability</a></strong>(int x)</code> +<div class="block">For this distribution, <code>X</code>, this method returns <code>P(X >= x)</code>.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.commons.math3.distribution.AbstractIntegerDistribution"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.commons.math3.distribution.<a href="../../../../../org/apache/commons/math3/distribution/AbstractIntegerDistribution.html" title="class in org.apache.commons.math3.distribution">AbstractIntegerDistribution</a></h3> +<code><a href="../../../../../org/apache/commons/math3/distribution/AbstractIntegerDistribution.html#cumulativeProbability(int,%20int)">cumulativeProbability</a>, <a href="../../../../../org/apache/commons/math3/distribution/AbstractIntegerDistribution.html#inverseCumulativeProbability(double)">inverseCumulativeProbability</a>, <a href="../../../../../org/apache/commons/math3/distribution/AbstractIntegerDistribution.html#reseedRandomGenerator(long)">reseedRandomGenerator</a>, <a href="../../../../../org/apache/commons/math3/distribution/AbstractIntegerDistribution.html#sample()">sample</a>, <a href="../../../../../org/apache/commons/math3/distribution/AbstractIntegerDistribution.html#sample(int)">sample</a>, <a href="../../../../../org/apache/commons/math3/distribution/AbstractIntegerDistribution.html#solveInverseCumulativeProbability(double,%20int,%20int)">solveInverseCumulativeProbability</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="HypergeometricDistribution(int, int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>HypergeometricDistribution</h4> +<pre>public HypergeometricDistribution(int populationSize, + int numberOfSuccesses, + int sampleSize) + throws <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/NotStrictlyPositiveException.html" title="class in org.apache.commons.math3.exception">NotStrictlyPositiveException</a>, + <a href="../../../../../org/apache/commons/math3/exception/NumberIsTooLargeException.html" title="class in org.apache.commons.math3.exception">NumberIsTooLargeException</a></pre> +<div class="block">Construct a new hypergeometric distribution with the specified population + size, number of successes in the population, and sample size. + <p> + <b>Note:</b> this constructor will implicitly create an instance of + <a href="../../../../../org/apache/commons/math3/random/Well19937c.html" title="class in org.apache.commons.math3.random"><code>Well19937c</code></a> as random generator to be used for sampling only (see + <a href="../../../../../org/apache/commons/math3/distribution/AbstractIntegerDistribution.html#sample()"><code>AbstractIntegerDistribution.sample()</code></a> and <a href="../../../../../org/apache/commons/math3/distribution/AbstractIntegerDistribution.html#sample(int)"><code>AbstractIntegerDistribution.sample(int)</code></a>). In case no sampling is + needed for the created distribution, it is advised to pass <code>null</code> + as random generator via the appropriate constructors to avoid the + additional initialisation overhead.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>populationSize</code> - Population size.</dd><dd><code>numberOfSuccesses</code> - Number of successes in the population.</dd><dd><code>sampleSize</code> - Sample size.</dd> +<dt><span class="strong">Throws:</span></dt> +<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/NotStrictlyPositiveException.html" title="class in org.apache.commons.math3.exception">NotStrictlyPositiveException</a></code> - if <code>populationSize <= 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 > populationSize</code>, + or <code>sampleSize > populationSize</code>.</dd></dl> +</li> +</ul> +<a name="HypergeometricDistribution(org.apache.commons.math3.random.RandomGenerator, int, int, int)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>HypergeometricDistribution</h4> +<pre>public HypergeometricDistribution(<a href="../../../../../org/apache/commons/math3/random/RandomGenerator.html" title="interface in org.apache.commons.math3.random">RandomGenerator</a> rng, + int populationSize, + int numberOfSuccesses, + int sampleSize) + throws <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/NotStrictlyPositiveException.html" title="class in org.apache.commons.math3.exception">NotStrictlyPositiveException</a>, + <a href="../../../../../org/apache/commons/math3/exception/NumberIsTooLargeException.html" title="class in org.apache.commons.math3.exception">NumberIsTooLargeException</a></pre> +<div class="block">Creates a new hypergeometric distribution.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>rng</code> - Random number generator.</dd><dd><code>populationSize</code> - Population size.</dd><dd><code>numberOfSuccesses</code> - Number of successes in the population.</dd><dd><code>sampleSize</code> - Sample size.</dd> +<dt><span class="strong">Throws:</span></dt> +<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/NotStrictlyPositiveException.html" title="class in org.apache.commons.math3.exception">NotStrictlyPositiveException</a></code> - if <code>populationSize <= 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 > populationSize</code>, + or <code>sampleSize > populationSize</code>.</dd><dt><span class="strong">Since:</span></dt> + <dd>3.1</dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="cumulativeProbability(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>cumulativeProbability</h4> +<pre>public double cumulativeProbability(int x)</pre> +<div class="block">For a random variable <code>X</code> whose values are distributed according + to this distribution, this method returns <code>P(X <= x)</code>. In other + words, this method represents the (cumulative) distribution function + (CDF) for this distribution.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>x</code> - the point at which the CDF is evaluated</dd> +<dt><span class="strong">Returns:</span></dt><dd>the probability that a random variable with this + distribution takes a value less than or equal to <code>x</code></dd></dl> +</li> +</ul> +<a name="getNumberOfSuccesses()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNumberOfSuccesses</h4> +<pre>public int getNumberOfSuccesses()</pre> +<div class="block">Access the number of successes.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the number of successes.</dd></dl> +</li> +</ul> +<a name="getPopulationSize()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPopulationSize</h4> +<pre>public int getPopulationSize()</pre> +<div class="block">Access the population size.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the population size.</dd></dl> +</li> +</ul> +<a name="getSampleSize()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSampleSize</h4> +<pre>public int getSampleSize()</pre> +<div class="block">Access the sample size.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the sample size.</dd></dl> +</li> +</ul> +<a name="probability(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>probability</h4> +<pre>public double probability(int x)</pre> +<div class="block">For a random variable <code>X</code> whose values are distributed according + to this distribution, this method returns <code>P(X = x)</code>. In other + words, this method represents the probability mass function (PMF) + for the distribution.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>x</code> - the point at which the PMF is evaluated</dd> +<dt><span class="strong">Returns:</span></dt><dd>the value of the probability mass function at <code>x</code></dd></dl> +</li> +</ul> +<a name="logProbability(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>logProbability</h4> +<pre>public double logProbability(int x)</pre> +<div class="block">For a random variable <code>X</code> whose values are distributed according to + this distribution, this method returns <code>log(P(X = x))</code>, where + <code>log</code> is the natural logarithm. In other words, this method + represents the logarithm of the probability mass function (PMF) for the + distribution. Note that due to the floating point precision and + under/overflow issues, this method will for some distributions be more + precise and faster than computing the logarithm of + <a href="../../../../../org/apache/commons/math3/distribution/IntegerDistribution.html#probability(int)"><code>IntegerDistribution.probability(int)</code></a>. + <p> + The default implementation simply computes the logarithm of <code>probability(x)</code>.</p></div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../../org/apache/commons/math3/distribution/AbstractIntegerDistribution.html#logProbability(int)">logProbability</a></code> in class <code><a href="../../../../../org/apache/commons/math3/distribution/AbstractIntegerDistribution.html" title="class in org.apache.commons.math3.distribution">AbstractIntegerDistribution</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>x</code> - the point at which the PMF is evaluated</dd> +<dt><span class="strong">Returns:</span></dt><dd>the logarithm of the value of the probability mass function at <code>x</code></dd></dl> +</li> +</ul> +<a name="upperCumulativeProbability(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>upperCumulativeProbability</h4> +<pre>public double upperCumulativeProbability(int x)</pre> +<div class="block">For this distribution, <code>X</code>, this method returns <code>P(X >= x)</code>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>x</code> - Value at which the CDF is evaluated.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the upper tail CDF for this distribution.</dd><dt><span class="strong">Since:</span></dt> + <dd>1.1</dd></dl> +</li> +</ul> +<a name="getNumericalMean()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNumericalMean</h4> +<pre>public double getNumericalMean()</pre> +<div class="block">Use this method to get the numerical value of the mean of this + distribution. + + For population size <code>N</code>, number of successes <code>m</code>, and sample + size <code>n</code>, the mean is <code>n * m / N</code>.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the mean or <code>Double.NaN</code> if it is not defined</dd></dl> +</li> +</ul> +<a name="getNumericalVariance()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNumericalVariance</h4> +<pre>public double getNumericalVariance()</pre> +<div class="block">Use this method to get the numerical value of the variance of this + distribution. + + For population size <code>N</code>, number of successes <code>m</code>, and sample + size <code>n</code>, the variance is + <code>[n * m * (N - n) * (N - m)] / [N^2 * (N - 1)]</code>.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the variance (possibly <code>Double.POSITIVE_INFINITY</code> or + <code>Double.NaN</code> if it is not defined)</dd></dl> +</li> +</ul> +<a name="calculateNumericalVariance()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>calculateNumericalVariance</h4> +<pre>protected double calculateNumericalVariance()</pre> +<div class="block">Used by <a href="../../../../../org/apache/commons/math3/distribution/HypergeometricDistribution.html#getNumericalVariance()"><code>getNumericalVariance()</code></a>.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the variance of this distribution</dd></dl> +</li> +</ul> +<a name="getSupportLowerBound()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSupportLowerBound</h4> +<pre>public int getSupportLowerBound()</pre> +<div class="block">Access the lower bound of the support. This method must return the same + value as <code>inverseCumulativeProbability(0)</code>. In other words, this + method must return + <p><code>inf {x in Z | P(X <= x) > 0}</code>.</p> + + For population size <code>N</code>, number of successes <code>m</code>, and sample + size <code>n</code>, the lower bound of the support is + <code>max(0, n + m - N)</code>.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>lower bound of the support</dd></dl> +</li> +</ul> +<a name="getSupportUpperBound()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSupportUpperBound</h4> +<pre>public int getSupportUpperBound()</pre> +<div class="block">Access the upper bound of the support. This method must return the same + value as <code>inverseCumulativeProbability(1)</code>. In other words, this + method must return + <p><code>inf {x in R | P(X <= x) = 1}</code>.</p> + + For number of successes <code>m</code> and sample size <code>n</code>, the upper + bound of the support is <code>min(m, n)</code>.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>upper bound of the support</dd></dl> +</li> +</ul> +<a name="isSupportConnected()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>isSupportConnected</h4> +<pre>public boolean isSupportConnected()</pre> +<div class="block">Use this method to get information about whether the support is + connected, i.e. whether all integers between the lower and upper bound of + the support are included in the support. + + The support of this distribution is connected.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</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/HypergeometricDistribution.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/distribution/GumbelDistribution.html" title="class in org.apache.commons.math3.distribution"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/commons/math3/distribution/IntegerDistribution.html" title="interface in org.apache.commons.math3.distribution"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/commons/math3/distribution/HypergeometricDistribution.html" target="_top">Frames</a></li> +<li><a href="HypergeometricDistribution.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><a href="#fields_inherited_from_class_org.apache.commons.math3.distribution.AbstractIntegerDistribution">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </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> |