Added: websites/production/commons/content/proper/commons-rng/commons-rng-sampling/javadocs/api-1.1/index-all.html ============================================================================== --- websites/production/commons/content/proper/commons-rng/commons-rng-sampling/javadocs/api-1.1/index-all.html (added) +++ websites/production/commons/content/proper/commons-rng/commons-rng-sampling/javadocs/api-1.1/index-all.html Tue Aug 14 13:05:46 2018 @@ -0,0 +1,651 @@ +<!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 --> +<title>Index (Apache Commons RNG Sampling 1.1 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.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-1.10.2.js"></script> +<script type="text/javascript" src="jquery/jquery-ui.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Index (Apache Commons RNG Sampling 1.1 API)"; + } + } + catch(err) { + } +//--> +var pathtoroot = "./";loadScripts(document, 'script');</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<div class="fixedNav"> +<!-- ========= 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>Package</li> +<li>Class</li> +<li>Use</li> +<li><a href="overview-tree.html">Tree</a></li> +<li><a href="deprecated-list.html">Deprecated</a></li> +<li class="navBarCell1Rev">Index</li> +<li><a href="help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="index.html?index-all.html" target="_top">Frames</a></li> +<li><a href="index-all.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> +<ul class="navListSearch"> +<li><span>SEARCH: </span> +<input type="text" id="search" value=" " disabled="disabled"> +<input type="reset" id="reset" value=" " 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 name="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> +<div class="contentContainer"><a href="#I:A">A</a> <a href="#I:B">B</a> <a href="#I:C">C</a> <a href="#I:D">D</a> <a href="#I:G">G</a> <a href="#I:I">I</a> <a href="#I:L">L</a> <a href="#I:M">M</a> <a href="#I:N">N</a> <a href="#I:O">O</a> <a href="#I:P">P</a> <a href="#I:R">R</a> <a href="#I:S">S</a> <a href="#I:T">T</a> <a href="#I:U">U</a> <a href="#I:Z">Z</a> <a name="I:A"> +<!-- --> +</a> +<h2 class="title">A</h2> +<dl> +<dt><a href="org/apache/commons/rng/sampling/distribution/AhrensDieterExponentialSampler.html" title="class in org.apache.commons.rng.sampling.distribution"><span class="typeNameLink">AhrensDieterExponentialSampler</span></a> - Class in <a href="org/apache/commons/rng/sampling/distribution/package-summary.html">org.apache.commons.rng.sampling.distribution</a></dt> +<dd> +<div class="block">Sampling from an <a href="http://mathworld.wolfram.com/ExponentialDistribution.html">exponential distribution</a>.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/AhrensDieterExponentialSampler.html#AhrensDieterExponentialSampler-org.apache.commons.rng.UniformRandomProvider-double-">AhrensDieterExponentialSampler(UniformRandomProvider, double)</a></span> - Constructor for class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/AhrensDieterExponentialSampler.html" title="class in org.apache.commons.rng.sampling.distribution">AhrensDieterExponentialSampler</a></dt> +<dd> </dd> +<dt><a href="org/apache/commons/rng/sampling/distribution/AhrensDieterMarsagliaTsangGammaSampler.html" title="class in org.apache.commons.rng.sampling.distribution"><span class="typeNameLink">AhrensDieterMarsagliaTsangGammaSampler</span></a> - Class in <a href="org/apache/commons/rng/sampling/distribution/package-summary.html">org.apache.commons.rng.sampling.distribution</a></dt> +<dd> +<div class="block">Sampling from the <a href="http://mathworld.wolfram.com/GammaDistribution.html">Gamma distribution</a>.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/AhrensDieterMarsagliaTsangGammaSampler.html#AhrensDieterMarsagliaTsangGammaSampler-org.apache.commons.rng.UniformRandomProvider-double-double-">AhrensDieterMarsagliaTsangGammaSampler(UniformRandomProvider, double, double)</a></span> - Constructor for class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/AhrensDieterMarsagliaTsangGammaSampler.html" title="class in org.apache.commons.rng.sampling.distribution">AhrensDieterMarsagliaTsangGammaSampler</a></dt> +<dd> </dd> +</dl> +<a name="I:B"> +<!-- --> +</a> +<h2 class="title">B</h2> +<dl> +<dt><a href="org/apache/commons/rng/sampling/distribution/BoxMullerGaussianSampler.html" title="class in org.apache.commons.rng.sampling.distribution"><span class="typeNameLink">BoxMullerGaussianSampler</span></a> - Class in <a href="org/apache/commons/rng/sampling/distribution/package-summary.html">org.apache.commons.rng.sampling.distribution</a></dt> +<dd> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">Since v1.1. Please use <a href="org/apache/commons/rng/sampling/distribution/BoxMullerNormalizedGaussianSampler.html" title="class in org.apache.commons.rng.sampling.distribution"><code>BoxMullerNormalizedGaussianSampler</code></a> + and <a href="org/apache/commons/rng/sampling/distribution/GaussianSampler.html" title="class in org.apache.commons.rng.sampling.distribution"><code>GaussianSampler</code></a> instead.</span></div> +</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/BoxMullerGaussianSampler.html#BoxMullerGaussianSampler-org.apache.commons.rng.UniformRandomProvider-double-double-">BoxMullerGaussianSampler(UniformRandomProvider, double, double)</a></span> - Constructor for class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/BoxMullerGaussianSampler.html" title="class in org.apache.commons.rng.sampling.distribution">BoxMullerGaussianSampler</a></dt> +<dd> +<div class="block"><span class="deprecatedLabel">Deprecated.</span></div> + </dd> +<dt><a href="org/apache/commons/rng/sampling/distribution/BoxMullerLogNormalSampler.html" title="class in org.apache.commons.rng.sampling.distribution"><span class="typeNameLink">BoxMullerLogNormalSampler</span></a> - Class in <a href="org/apache/commons/rng/sampling/distribution/package-summary.html">org.apache.commons.rng.sampling.distribution</a></dt> +<dd> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">since 1.1. Please use <a href="org/apache/commons/rng/sampling/distribution/LogNormalSampler.html" title="class in org.apache.commons.rng.sampling.distribution"><code>LogNormalSampler</code></a> instead.</span></div> +</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/BoxMullerLogNormalSampler.html#BoxMullerLogNormalSampler-org.apache.commons.rng.UniformRandomProvider-double-double-">BoxMullerLogNormalSampler(UniformRandomProvider, double, double)</a></span> - Constructor for class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/BoxMullerLogNormalSampler.html" title="class in org.apache.commons.rng.sampling.distribution">BoxMullerLogNormalSampler</a></dt> +<dd> +<div class="block"><span class="deprecatedLabel">Deprecated.</span></div> + </dd> +<dt><a href="org/apache/commons/rng/sampling/distribution/BoxMullerNormalizedGaussianSampler.html" title="class in org.apache.commons.rng.sampling.distribution"><span class="typeNameLink">BoxMullerNormalizedGaussianSampler</span></a> - Class in <a href="org/apache/commons/rng/sampling/distribution/package-summary.html">org.apache.commons.rng.sampling.distribution</a></dt> +<dd> +<div class="block"><a href="https://en.wikipedia.org/wiki/Box%E2%80%93Muller_transform"> + Box-Muller algorithm</a> for sampling from Gaussian distribution with + mean 0 and standard deviation 1.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/BoxMullerNormalizedGaussianSampler.html#BoxMullerNormalizedGaussianSampler-org.apache.commons.rng.UniformRandomProvider-">BoxMullerNormalizedGaussianSampler(UniformRandomProvider)</a></span> - Constructor for class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/BoxMullerNormalizedGaussianSampler.html" title="class in org.apache.commons.rng.sampling.distribution">BoxMullerNormalizedGaussianSampler</a></dt> +<dd> </dd> +</dl> +<a name="I:C"> +<!-- --> +</a> +<h2 class="title">C</h2> +<dl> +<dt><a href="org/apache/commons/rng/sampling/distribution/ChengBetaSampler.html" title="class in org.apache.commons.rng.sampling.distribution"><span class="typeNameLink">ChengBetaSampler</span></a> - Class in <a href="org/apache/commons/rng/sampling/distribution/package-summary.html">org.apache.commons.rng.sampling.distribution</a></dt> +<dd> +<div class="block">Utility class implementing Cheng's algorithms for beta distribution sampling.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/ChengBetaSampler.html#ChengBetaSampler-org.apache.commons.rng.UniformRandomProvider-double-double-">ChengBetaSampler(UniformRandomProvider, double, double)</a></span> - Constructor for class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/ChengBetaSampler.html" title="class in org.apache.commons.rng.sampling.distribution">ChengBetaSampler</a></dt> +<dd> +<div class="block">Creates a sampler instance.</div> +</dd> +<dt><a href="org/apache/commons/rng/sampling/CollectionSampler.html" title="class in org.apache.commons.rng.sampling"><span class="typeNameLink">CollectionSampler</span></a><<a href="org/apache/commons/rng/sampling/CollectionSampler.html" title="type parameter in CollectionSampler">T</a>> - Class in <a href="org/apache/commons/rng/sampling/package-summary.html">org.apache.commons.rng.sampling</a></dt> +<dd> +<div class="block">Sampling from a <code>Collection</code>.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/CollectionSampler.html#CollectionSampler-org.apache.commons.rng.UniformRandomProvider-java.util.Collection-">CollectionSampler(UniformRandomProvider, Collection<T>)</a></span> - Constructor for class org.apache.commons.rng.sampling.<a href="org/apache/commons/rng/sampling/CollectionSampler.html" title="class in org.apache.commons.rng.sampling">CollectionSampler</a></dt> +<dd> +<div class="block">Creates a sampler.</div> +</dd> +<dt><a href="org/apache/commons/rng/sampling/distribution/ContinuousInverseCumulativeProbabilityFunction.html" title="interface in org.apache.commons.rng.sampling.distribution"><span class="typeNameLink">ContinuousInverseCumulativeProbabilityFunction</span></a> - Interface in <a href="org/apache/commons/rng/sampling/distribution/package-summary.html">org.apache.commons.rng.sampling.distribution</a></dt> +<dd> +<div class="block">Interface for a continuous distribution that can be sampled using + the <a href="https://en.wikipedia.org/wiki/Inverse_transform_sampling"> + inversion method</a>.</div> +</dd> +<dt><a href="org/apache/commons/rng/sampling/distribution/ContinuousSampler.html" title="interface in org.apache.commons.rng.sampling.distribution"><span class="typeNameLink">ContinuousSampler</span></a> - Interface in <a href="org/apache/commons/rng/sampling/distribution/package-summary.html">org.apache.commons.rng.sampling.distribution</a></dt> +<dd> +<div class="block">Sampler that generates values of type <code>double</code>.</div> +</dd> +<dt><a href="org/apache/commons/rng/sampling/distribution/ContinuousUniformSampler.html" title="class in org.apache.commons.rng.sampling.distribution"><span class="typeNameLink">ContinuousUniformSampler</span></a> - Class in <a href="org/apache/commons/rng/sampling/distribution/package-summary.html">org.apache.commons.rng.sampling.distribution</a></dt> +<dd> +<div class="block">Sampling from a uniform distribution.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/ContinuousUniformSampler.html#ContinuousUniformSampler-org.apache.commons.rng.UniformRandomProvider-double-double-">ContinuousUniformSampler(UniformRandomProvider, double, double)</a></span> - Constructor for class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/ContinuousUniformSampler.html" title="class in org.apache.commons.rng.sampling.distribution">ContinuousUniformSampler</a></dt> +<dd> </dd> +</dl> +<a name="I:D"> +<!-- --> +</a> +<h2 class="title">D</h2> +<dl> +<dt><a href="org/apache/commons/rng/sampling/distribution/DiscreteInverseCumulativeProbabilityFunction.html" title="interface in org.apache.commons.rng.sampling.distribution"><span class="typeNameLink">DiscreteInverseCumulativeProbabilityFunction</span></a> - Interface in <a href="org/apache/commons/rng/sampling/distribution/package-summary.html">org.apache.commons.rng.sampling.distribution</a></dt> +<dd> +<div class="block">Interface for a discrete distribution that can be sampled using + the <a href="https://en.wikipedia.org/wiki/Inverse_transform_sampling"> + inversion method</a>.</div> +</dd> +<dt><a href="org/apache/commons/rng/sampling/DiscreteProbabilityCollectionSampler.html" title="class in org.apache.commons.rng.sampling"><span class="typeNameLink">DiscreteProbabilityCollectionSampler</span></a><<a href="org/apache/commons/rng/sampling/DiscreteProbabilityCollectionSampler.html" title="type parameter in DiscreteProbabilityCollectionSampler">T</a>> - Class in <a href="org/apache/commons/rng/sampling/package-summary.html">org.apache.commons.rng.sampling</a></dt> +<dd> +<div class="block">Sampling from a collection of items with user-defined + <a href="http://en.wikipedia.org/wiki/Probability_distribution#Discrete_probability_distribution"> + probabilities</a>.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/DiscreteProbabilityCollectionSampler.html#DiscreteProbabilityCollectionSampler-org.apache.commons.rng.UniformRandomProvider-java.util.List-double:A-">DiscreteProbabilityCollectionSampler(UniformRandomProvider, List<T>, double[])</a></span> - Constructor for class org.apache.commons.rng.sampling.<a href="org/apache/commons/rng/sampling/DiscreteProbabilityCollectionSampler.html" title="class in org.apache.commons.rng.sampling">DiscreteProbabilityCollectionSampler</a></dt> +<dd> +<div class="block">Creates a sampler.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/DiscreteProbabilityCollectionSampler.html#DiscreteProbabilityCollectionSampler-org.apache.commons.rng.UniformRandomProvider-java.util.Map-">DiscreteProbabilityCollectionSampler(UniformRandomProvider, Map<T, Double>)</a></span> - Constructor for class org.apache.commons.rng.sampling.<a href="org/apache/commons/rng/sampling/DiscreteProbabilityCollectionSampler.html" title="class in org.apache.commons.rng.sampling">DiscreteProbabilityCollectionSampler</a></dt> +<dd> +<div class="block">Creates a sampler.</div> +</dd> +<dt><a href="org/apache/commons/rng/sampling/distribution/DiscreteSampler.html" title="interface in org.apache.commons.rng.sampling.distribution"><span class="typeNameLink">DiscreteSampler</span></a> - Interface in <a href="org/apache/commons/rng/sampling/distribution/package-summary.html">org.apache.commons.rng.sampling.distribution</a></dt> +<dd> +<div class="block">Sampler that generates values of type <code>int</code>.</div> +</dd> +<dt><a href="org/apache/commons/rng/sampling/distribution/DiscreteUniformSampler.html" title="class in org.apache.commons.rng.sampling.distribution"><span class="typeNameLink">DiscreteUniformSampler</span></a> - Class in <a href="org/apache/commons/rng/sampling/distribution/package-summary.html">org.apache.commons.rng.sampling.distribution</a></dt> +<dd> +<div class="block">Discrete uniform distribution sampler.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/DiscreteUniformSampler.html#DiscreteUniformSampler-org.apache.commons.rng.UniformRandomProvider-int-int-">DiscreteUniformSampler(UniformRandomProvider, int, int)</a></span> - Constructor for class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/DiscreteUniformSampler.html" title="class in org.apache.commons.rng.sampling.distribution">DiscreteUniformSampler</a></dt> +<dd> </dd> +</dl> +<a name="I:G"> +<!-- --> +</a> +<h2 class="title">G</h2> +<dl> +<dt><a href="org/apache/commons/rng/sampling/distribution/GaussianSampler.html" title="class in org.apache.commons.rng.sampling.distribution"><span class="typeNameLink">GaussianSampler</span></a> - Class in <a href="org/apache/commons/rng/sampling/distribution/package-summary.html">org.apache.commons.rng.sampling.distribution</a></dt> +<dd> +<div class="block">Sampling from a Gaussian distribution with given mean and + standard deviation.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/GaussianSampler.html#GaussianSampler-org.apache.commons.rng.sampling.distribution.NormalizedGaussianSampler-double-double-">GaussianSampler(NormalizedGaussianSampler, double, double)</a></span> - Constructor for class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/GaussianSampler.html" title="class in org.apache.commons.rng.sampling.distribution">GaussianSampler</a></dt> +<dd> </dd> +</dl> +<a name="I:I"> +<!-- --> +</a> +<h2 class="title">I</h2> +<dl> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/ContinuousInverseCumulativeProbabilityFunction.html#inverseCumulativeProbability-double-">inverseCumulativeProbability(double)</a></span> - Method in interface org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/ContinuousInverseCumulativeProbabilityFunction.html" title="interface in org.apache.commons.rng.sampling.distribution">ContinuousInverseCumulativeProbabilityFunction</a></dt> +<dd> +<div class="block">Computes the quantile function of the distribution.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/DiscreteInverseCumulativeProbabilityFunction.html#inverseCumulativeProbability-double-">inverseCumulativeProbability(double)</a></span> - Method in interface org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/DiscreteInverseCumulativeProbabilityFunction.html" title="interface in org.apache.commons.rng.sampling.distribution">DiscreteInverseCumulativeProbabilityFunction</a></dt> +<dd> +<div class="block">Computes the quantile function of the distribution.</div> +</dd> +<dt><a href="org/apache/commons/rng/sampling/distribution/InverseTransformContinuousSampler.html" title="class in org.apache.commons.rng.sampling.distribution"><span class="typeNameLink">InverseTransformContinuousSampler</span></a> - Class in <a href="org/apache/commons/rng/sampling/distribution/package-summary.html">org.apache.commons.rng.sampling.distribution</a></dt> +<dd> +<div class="block">Distribution sampler that uses the + <a href="https://en.wikipedia.org/wiki/Inverse_transform_sampling"> + inversion method</a>.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/InverseTransformContinuousSampler.html#InverseTransformContinuousSampler-org.apache.commons.rng.UniformRandomProvider-org.apache.commons.rng.sampling.distribution.ContinuousInverseCumulativeProbabilityFunction-">InverseTransformContinuousSampler(UniformRandomProvider, ContinuousInverseCumulativeProbabilityFunction)</a></span> - Constructor for class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/InverseTransformContinuousSampler.html" title="class in org.apache.commons.rng.sampling.distribution">InverseTransformContinuousSampler</a></dt> +<dd> </dd> +<dt><a href="org/apache/commons/rng/sampling/distribution/InverseTransformDiscreteSampler.html" title="class in org.apache.commons.rng.sampling.distribution"><span class="typeNameLink">InverseTransformDiscreteSampler</span></a> - Class in <a href="org/apache/commons/rng/sampling/distribution/package-summary.html">org.apache.commons.rng.sampling.distribution</a></dt> +<dd> +<div class="block">Distribution sampler that uses the + <a href="https://en.wikipedia.org/wiki/Inverse_transform_sampling"> + inversion method</a>.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/InverseTransformDiscreteSampler.html#InverseTransformDiscreteSampler-org.apache.commons.rng.UniformRandomProvider-org.apache.commons.rng.sampling.distribution.DiscreteInverseCumulativeProbabilityFunction-">InverseTransformDiscreteSampler(UniformRandomProvider, DiscreteInverseCumulativeProbabilityFunction)</a></span> - Constructor for class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/InverseTransformDiscreteSampler.html" title="class in org.apache.commons.rng.sampling.distribution">InverseTransformDiscreteSampler</a></dt> +<dd> </dd> +<dt><a href="org/apache/commons/rng/sampling/distribution/InverseTransformParetoSampler.html" title="class in org.apache.commons.rng.sampling.distribution"><span class="typeNameLink">InverseTransformParetoSampler</span></a> - Class in <a href="org/apache/commons/rng/sampling/distribution/package-summary.html">org.apache.commons.rng.sampling.distribution</a></dt> +<dd> +<div class="block">Sampling from a <a href="https://en.wikipedia.org/wiki/Pareto_distribution">Pareto distribution</a>.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/InverseTransformParetoSampler.html#InverseTransformParetoSampler-org.apache.commons.rng.UniformRandomProvider-double-double-">InverseTransformParetoSampler(UniformRandomProvider, double, double)</a></span> - Constructor for class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/InverseTransformParetoSampler.html" title="class in org.apache.commons.rng.sampling.distribution">InverseTransformParetoSampler</a></dt> +<dd> </dd> +</dl> +<a name="I:L"> +<!-- --> +</a> +<h2 class="title">L</h2> +<dl> +<dt><a href="org/apache/commons/rng/sampling/distribution/LargeMeanPoissonSampler.html" title="class in org.apache.commons.rng.sampling.distribution"><span class="typeNameLink">LargeMeanPoissonSampler</span></a> - Class in <a href="org/apache/commons/rng/sampling/distribution/package-summary.html">org.apache.commons.rng.sampling.distribution</a></dt> +<dd> +<div class="block">Sampler for the <a href="http://mathworld.wolfram.com/PoissonDistribution.html">Poisson distribution</a>.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/LargeMeanPoissonSampler.html#LargeMeanPoissonSampler-org.apache.commons.rng.UniformRandomProvider-double-">LargeMeanPoissonSampler(UniformRandomProvider, double)</a></span> - Constructor for class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/LargeMeanPoissonSampler.html" title="class in org.apache.commons.rng.sampling.distribution">LargeMeanPoissonSampler</a></dt> +<dd> </dd> +<dt><a href="org/apache/commons/rng/sampling/ListSampler.html" title="class in org.apache.commons.rng.sampling"><span class="typeNameLink">ListSampler</span></a> - Class in <a href="org/apache/commons/rng/sampling/package-summary.html">org.apache.commons.rng.sampling</a></dt> +<dd> +<div class="block">Sampling from a <code>List</code>.</div> +</dd> +<dt><a href="org/apache/commons/rng/sampling/distribution/LogNormalSampler.html" title="class in org.apache.commons.rng.sampling.distribution"><span class="typeNameLink">LogNormalSampler</span></a> - Class in <a href="org/apache/commons/rng/sampling/distribution/package-summary.html">org.apache.commons.rng.sampling.distribution</a></dt> +<dd> +<div class="block">Sampling from a log-normal distribution.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/LogNormalSampler.html#LogNormalSampler-org.apache.commons.rng.sampling.distribution.NormalizedGaussianSampler-double-double-">LogNormalSampler(NormalizedGaussianSampler, double, double)</a></span> - Constructor for class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/LogNormalSampler.html" title="class in org.apache.commons.rng.sampling.distribution">LogNormalSampler</a></dt> +<dd> </dd> +</dl> +<a name="I:M"> +<!-- --> +</a> +<h2 class="title">M</h2> +<dl> +<dt><a href="org/apache/commons/rng/sampling/distribution/MarsagliaNormalizedGaussianSampler.html" title="class in org.apache.commons.rng.sampling.distribution"><span class="typeNameLink">MarsagliaNormalizedGaussianSampler</span></a> - Class in <a href="org/apache/commons/rng/sampling/distribution/package-summary.html">org.apache.commons.rng.sampling.distribution</a></dt> +<dd> +<div class="block"><a href="https://en.wikipedia.org/wiki/Marsaglia_polar_method"> + Marsaglia polar method</a> for sampling from a Gaussian distribution + with mean 0 and standard deviation 1.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/MarsagliaNormalizedGaussianSampler.html#MarsagliaNormalizedGaussianSampler-org.apache.commons.rng.UniformRandomProvider-">MarsagliaNormalizedGaussianSampler(UniformRandomProvider)</a></span> - Constructor for class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/MarsagliaNormalizedGaussianSampler.html" title="class in org.apache.commons.rng.sampling.distribution">MarsagliaNormalizedGaussianSampler</a></dt> +<dd> </dd> +</dl> +<a name="I:N"> +<!-- --> +</a> +<h2 class="title">N</h2> +<dl> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/PermutationSampler.html#natural-int-">natural(int)</a></span> - Static method in class org.apache.commons.rng.sampling.<a href="org/apache/commons/rng/sampling/PermutationSampler.html" title="class in org.apache.commons.rng.sampling">PermutationSampler</a></dt> +<dd> +<div class="block">Creates an array representing the natural number <code>n</code>.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/SamplerBase.html#nextDouble--">nextDouble()</a></span> - Method in class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/SamplerBase.html" title="class in org.apache.commons.rng.sampling.distribution">SamplerBase</a></dt> +<dd> +<div class="block"><span class="deprecatedLabel">Deprecated.</span></div> + </dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/SamplerBase.html#nextInt--">nextInt()</a></span> - Method in class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/SamplerBase.html" title="class in org.apache.commons.rng.sampling.distribution">SamplerBase</a></dt> +<dd> +<div class="block"><span class="deprecatedLabel">Deprecated.</span></div> + </dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/SamplerBase.html#nextInt-int-">nextInt(int)</a></span> - Method in class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/SamplerBase.html" title="class in org.apache.commons.rng.sampling.distribution">SamplerBase</a></dt> +<dd> +<div class="block"><span class="deprecatedLabel">Deprecated.</span></div> + </dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/SamplerBase.html#nextLong--">nextLong()</a></span> - Method in class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/SamplerBase.html" title="class in org.apache.commons.rng.sampling.distribution">SamplerBase</a></dt> +<dd> +<div class="block"><span class="deprecatedLabel">Deprecated.</span></div> + </dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/UnitSphereSampler.html#nextVector--">nextVector()</a></span> - Method in class org.apache.commons.rng.sampling.<a href="org/apache/commons/rng/sampling/UnitSphereSampler.html" title="class in org.apache.commons.rng.sampling">UnitSphereSampler</a></dt> +<dd> </dd> +<dt><a href="org/apache/commons/rng/sampling/distribution/NormalizedGaussianSampler.html" title="interface in org.apache.commons.rng.sampling.distribution"><span class="typeNameLink">NormalizedGaussianSampler</span></a> - Interface in <a href="org/apache/commons/rng/sampling/distribution/package-summary.html">org.apache.commons.rng.sampling.distribution</a></dt> +<dd> +<div class="block">Marker interface for a sampler that generates values from an N(0,1) + <a href="https://en.wikipedia.org/wiki/Normal_distribution"> + Gaussian distribution</a>.</div> +</dd> +</dl> +<a name="I:O"> +<!-- --> +</a> +<h2 class="title">O</h2> +<dl> +<dt><a href="org/apache/commons/rng/sampling/package-summary.html">org.apache.commons.rng.sampling</a> - package org.apache.commons.rng.sampling</dt> +<dd> +<div class="block">Samplers</div> +</dd> +<dt><a href="org/apache/commons/rng/sampling/distribution/package-summary.html">org.apache.commons.rng.sampling.distribution</a> - package org.apache.commons.rng.sampling.distribution</dt> +<dd> +<div class="block">Distribution samplers</div> +</dd> +</dl> +<a name="I:P"> +<!-- --> +</a> +<h2 class="title">P</h2> +<dl> +<dt><a href="org/apache/commons/rng/sampling/PermutationSampler.html" title="class in org.apache.commons.rng.sampling"><span class="typeNameLink">PermutationSampler</span></a> - Class in <a href="org/apache/commons/rng/sampling/package-summary.html">org.apache.commons.rng.sampling</a></dt> +<dd> +<div class="block">Class for representing permutations of a sequence of integers.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/PermutationSampler.html#PermutationSampler-org.apache.commons.rng.UniformRandomProvider-int-int-">PermutationSampler(UniformRandomProvider, int, int)</a></span> - Constructor for class org.apache.commons.rng.sampling.<a href="org/apache/commons/rng/sampling/PermutationSampler.html" title="class in org.apache.commons.rng.sampling">PermutationSampler</a></dt> +<dd> +<div class="block">Creates a generator of permutations.</div> +</dd> +<dt><a href="org/apache/commons/rng/sampling/distribution/PoissonSampler.html" title="class in org.apache.commons.rng.sampling.distribution"><span class="typeNameLink">PoissonSampler</span></a> - Class in <a href="org/apache/commons/rng/sampling/distribution/package-summary.html">org.apache.commons.rng.sampling.distribution</a></dt> +<dd> +<div class="block">Sampler for the <a href="http://mathworld.wolfram.com/PoissonDistribution.html">Poisson distribution</a>.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/PoissonSampler.html#PoissonSampler-org.apache.commons.rng.UniformRandomProvider-double-">PoissonSampler(UniformRandomProvider, double)</a></span> - Constructor for class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/PoissonSampler.html" title="class in org.apache.commons.rng.sampling.distribution">PoissonSampler</a></dt> +<dd> </dd> +</dl> +<a name="I:R"> +<!-- --> +</a> +<h2 class="title">R</h2> +<dl> +<dt><a href="org/apache/commons/rng/sampling/distribution/RejectionInversionZipfSampler.html" title="class in org.apache.commons.rng.sampling.distribution"><span class="typeNameLink">RejectionInversionZipfSampler</span></a> - Class in <a href="org/apache/commons/rng/sampling/distribution/package-summary.html">org.apache.commons.rng.sampling.distribution</a></dt> +<dd> +<div class="block">Implementation of the <a href="https://en.wikipedia.org/wiki/Zipf's_law">Zipf distribution</a>.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/RejectionInversionZipfSampler.html#RejectionInversionZipfSampler-org.apache.commons.rng.UniformRandomProvider-int-double-">RejectionInversionZipfSampler(UniformRandomProvider, int, double)</a></span> - Constructor for class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/RejectionInversionZipfSampler.html" title="class in org.apache.commons.rng.sampling.distribution">RejectionInversionZipfSampler</a></dt> +<dd> </dd> +</dl> +<a name="I:S"> +<!-- --> +</a> +<h2 class="title">S</h2> +<dl> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/CollectionSampler.html#sample--">sample()</a></span> - Method in class org.apache.commons.rng.sampling.<a href="org/apache/commons/rng/sampling/CollectionSampler.html" title="class in org.apache.commons.rng.sampling">CollectionSampler</a></dt> +<dd> +<div class="block">Picks one of the items from the + <a href="org/apache/commons/rng/sampling/CollectionSampler.html#CollectionSampler-org.apache.commons.rng.UniformRandomProvider-java.util.Collection-"><code>collection passed to the constructor</code></a>.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/DiscreteProbabilityCollectionSampler.html#sample--">sample()</a></span> - Method in class org.apache.commons.rng.sampling.<a href="org/apache/commons/rng/sampling/DiscreteProbabilityCollectionSampler.html" title="class in org.apache.commons.rng.sampling">DiscreteProbabilityCollectionSampler</a></dt> +<dd> +<div class="block">Picks one of the items from the collection passed to the constructor.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/AhrensDieterExponentialSampler.html#sample--">sample()</a></span> - Method in class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/AhrensDieterExponentialSampler.html" title="class in org.apache.commons.rng.sampling.distribution">AhrensDieterExponentialSampler</a></dt> +<dd> +<div class="block">Creates a sample.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/AhrensDieterMarsagliaTsangGammaSampler.html#sample--">sample()</a></span> - Method in class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/AhrensDieterMarsagliaTsangGammaSampler.html" title="class in org.apache.commons.rng.sampling.distribution">AhrensDieterMarsagliaTsangGammaSampler</a></dt> +<dd> +<div class="block">Creates a sample.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/BoxMullerGaussianSampler.html#sample--">sample()</a></span> - Method in class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/BoxMullerGaussianSampler.html" title="class in org.apache.commons.rng.sampling.distribution">BoxMullerGaussianSampler</a></dt> +<dd> +<div class="block"><span class="deprecatedLabel">Deprecated.</span></div> +<div class="block">Creates a sample.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/BoxMullerLogNormalSampler.html#sample--">sample()</a></span> - Method in class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/BoxMullerLogNormalSampler.html" title="class in org.apache.commons.rng.sampling.distribution">BoxMullerLogNormalSampler</a></dt> +<dd> +<div class="block"><span class="deprecatedLabel">Deprecated.</span></div> +<div class="block">Creates a sample.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/BoxMullerNormalizedGaussianSampler.html#sample--">sample()</a></span> - Method in class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/BoxMullerNormalizedGaussianSampler.html" title="class in org.apache.commons.rng.sampling.distribution">BoxMullerNormalizedGaussianSampler</a></dt> +<dd> +<div class="block">Creates a sample.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/ChengBetaSampler.html#sample--">sample()</a></span> - Method in class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/ChengBetaSampler.html" title="class in org.apache.commons.rng.sampling.distribution">ChengBetaSampler</a></dt> +<dd> +<div class="block">Creates a sample.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/ContinuousSampler.html#sample--">sample()</a></span> - Method in interface org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/ContinuousSampler.html" title="interface in org.apache.commons.rng.sampling.distribution">ContinuousSampler</a></dt> +<dd> +<div class="block">Creates a sample.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/ContinuousUniformSampler.html#sample--">sample()</a></span> - Method in class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/ContinuousUniformSampler.html" title="class in org.apache.commons.rng.sampling.distribution">ContinuousUniformSampler</a></dt> +<dd> +<div class="block">Creates a sample.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/DiscreteSampler.html#sample--">sample()</a></span> - Method in interface org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/DiscreteSampler.html" title="interface in org.apache.commons.rng.sampling.distribution">DiscreteSampler</a></dt> +<dd> +<div class="block">Creates a sample.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/DiscreteUniformSampler.html#sample--">sample()</a></span> - Method in class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/DiscreteUniformSampler.html" title="class in org.apache.commons.rng.sampling.distribution">DiscreteUniformSampler</a></dt> +<dd> +<div class="block">Creates a sample.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/GaussianSampler.html#sample--">sample()</a></span> - Method in class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/GaussianSampler.html" title="class in org.apache.commons.rng.sampling.distribution">GaussianSampler</a></dt> +<dd> +<div class="block">Creates a sample.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/InverseTransformContinuousSampler.html#sample--">sample()</a></span> - Method in class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/InverseTransformContinuousSampler.html" title="class in org.apache.commons.rng.sampling.distribution">InverseTransformContinuousSampler</a></dt> +<dd> +<div class="block">Creates a sample.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/InverseTransformDiscreteSampler.html#sample--">sample()</a></span> - Method in class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/InverseTransformDiscreteSampler.html" title="class in org.apache.commons.rng.sampling.distribution">InverseTransformDiscreteSampler</a></dt> +<dd> +<div class="block">Creates a sample.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/InverseTransformParetoSampler.html#sample--">sample()</a></span> - Method in class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/InverseTransformParetoSampler.html" title="class in org.apache.commons.rng.sampling.distribution">InverseTransformParetoSampler</a></dt> +<dd> +<div class="block">Creates a sample.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/LargeMeanPoissonSampler.html#sample--">sample()</a></span> - Method in class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/LargeMeanPoissonSampler.html" title="class in org.apache.commons.rng.sampling.distribution">LargeMeanPoissonSampler</a></dt> +<dd> +<div class="block">Creates a sample.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/LogNormalSampler.html#sample--">sample()</a></span> - Method in class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/LogNormalSampler.html" title="class in org.apache.commons.rng.sampling.distribution">LogNormalSampler</a></dt> +<dd> +<div class="block">Creates a sample.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/MarsagliaNormalizedGaussianSampler.html#sample--">sample()</a></span> - Method in class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/MarsagliaNormalizedGaussianSampler.html" title="class in org.apache.commons.rng.sampling.distribution">MarsagliaNormalizedGaussianSampler</a></dt> +<dd> +<div class="block">Creates a sample.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/PoissonSampler.html#sample--">sample()</a></span> - Method in class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/PoissonSampler.html" title="class in org.apache.commons.rng.sampling.distribution">PoissonSampler</a></dt> +<dd> +<div class="block">Creates a sample.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/RejectionInversionZipfSampler.html#sample--">sample()</a></span> - Method in class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/RejectionInversionZipfSampler.html" title="class in org.apache.commons.rng.sampling.distribution">RejectionInversionZipfSampler</a></dt> +<dd> +<div class="block">Rejection inversion sampling method for a discrete, bounded Zipf + distribution that is based on the method described in + + Wolfgang Hörmann and Gerhard Derflinger.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/SmallMeanPoissonSampler.html#sample--">sample()</a></span> - Method in class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/SmallMeanPoissonSampler.html" title="class in org.apache.commons.rng.sampling.distribution">SmallMeanPoissonSampler</a></dt> +<dd> +<div class="block">Creates a sample.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/ZigguratNormalizedGaussianSampler.html#sample--">sample()</a></span> - Method in class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/ZigguratNormalizedGaussianSampler.html" title="class in org.apache.commons.rng.sampling.distribution">ZigguratNormalizedGaussianSampler</a></dt> +<dd> +<div class="block">Creates a sample.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/PermutationSampler.html#sample--">sample()</a></span> - Method in class org.apache.commons.rng.sampling.<a href="org/apache/commons/rng/sampling/PermutationSampler.html" title="class in org.apache.commons.rng.sampling">PermutationSampler</a></dt> +<dd> </dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/ListSampler.html#sample-org.apache.commons.rng.UniformRandomProvider-java.util.List-int-">sample(UniformRandomProvider, List<T>, int)</a></span> - Static method in class org.apache.commons.rng.sampling.<a href="org/apache/commons/rng/sampling/ListSampler.html" title="class in org.apache.commons.rng.sampling">ListSampler</a></dt> +<dd> +<div class="block">Generates a list of size <code>k</code> whose entries are selected + randomly, without repetition, from the items in the given + <code>collection</code>.</div> +</dd> +<dt><a href="org/apache/commons/rng/sampling/distribution/SamplerBase.html" title="class in org.apache.commons.rng.sampling.distribution"><span class="typeNameLink">SamplerBase</span></a> - Class in <a href="org/apache/commons/rng/sampling/distribution/package-summary.html">org.apache.commons.rng.sampling.distribution</a></dt> +<dd> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">Since version 1.1. Class intended for internal use only.</span></div> +</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/SamplerBase.html#SamplerBase-org.apache.commons.rng.UniformRandomProvider-">SamplerBase(UniformRandomProvider)</a></span> - Constructor for class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/SamplerBase.html" title="class in org.apache.commons.rng.sampling.distribution">SamplerBase</a></dt> +<dd> +<div class="block"><span class="deprecatedLabel">Deprecated.</span></div> + </dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/PermutationSampler.html#shuffle-org.apache.commons.rng.UniformRandomProvider-int:A-">shuffle(UniformRandomProvider, int[])</a></span> - Static method in class org.apache.commons.rng.sampling.<a href="org/apache/commons/rng/sampling/PermutationSampler.html" title="class in org.apache.commons.rng.sampling">PermutationSampler</a></dt> +<dd> +<div class="block">Shuffles the entries of the given array.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/PermutationSampler.html#shuffle-org.apache.commons.rng.UniformRandomProvider-int:A-int-boolean-">shuffle(UniformRandomProvider, int[], int, boolean)</a></span> - Static method in class org.apache.commons.rng.sampling.<a href="org/apache/commons/rng/sampling/PermutationSampler.html" title="class in org.apache.commons.rng.sampling">PermutationSampler</a></dt> +<dd> +<div class="block">Shuffles the entries of the given array, using the + <a href="http://en.wikipedia.org/wiki/Fisher-Yates_shuffle#The_modern_algorithm"> + Fisher-Yates</a> algorithm.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/ListSampler.html#shuffle-org.apache.commons.rng.UniformRandomProvider-java.util.List-">shuffle(UniformRandomProvider, List<T>)</a></span> - Static method in class org.apache.commons.rng.sampling.<a href="org/apache/commons/rng/sampling/ListSampler.html" title="class in org.apache.commons.rng.sampling">ListSampler</a></dt> +<dd> +<div class="block">Shuffles the entries of the given array.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/ListSampler.html#shuffle-org.apache.commons.rng.UniformRandomProvider-java.util.List-int-boolean-">shuffle(UniformRandomProvider, List<T>, int, boolean)</a></span> - Static method in class org.apache.commons.rng.sampling.<a href="org/apache/commons/rng/sampling/ListSampler.html" title="class in org.apache.commons.rng.sampling">ListSampler</a></dt> +<dd> +<div class="block">Shuffles the entries of the given array, using the + <a href="http://en.wikipedia.org/wiki/Fisher-Yates_shuffle#The_modern_algorithm"> + Fisher-Yates</a> algorithm.</div> +</dd> +<dt><a href="org/apache/commons/rng/sampling/distribution/SmallMeanPoissonSampler.html" title="class in org.apache.commons.rng.sampling.distribution"><span class="typeNameLink">SmallMeanPoissonSampler</span></a> - Class in <a href="org/apache/commons/rng/sampling/distribution/package-summary.html">org.apache.commons.rng.sampling.distribution</a></dt> +<dd> +<div class="block">Sampler for the <a href="http://mathworld.wolfram.com/PoissonDistribution.html">Poisson distribution</a>.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/SmallMeanPoissonSampler.html#SmallMeanPoissonSampler-org.apache.commons.rng.UniformRandomProvider-double-">SmallMeanPoissonSampler(UniformRandomProvider, double)</a></span> - Constructor for class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/SmallMeanPoissonSampler.html" title="class in org.apache.commons.rng.sampling.distribution">SmallMeanPoissonSampler</a></dt> +<dd> </dd> +</dl> +<a name="I:T"> +<!-- --> +</a> +<h2 class="title">T</h2> +<dl> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/AhrensDieterExponentialSampler.html#toString--">toString()</a></span> - Method in class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/AhrensDieterExponentialSampler.html" title="class in org.apache.commons.rng.sampling.distribution">AhrensDieterExponentialSampler</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/AhrensDieterMarsagliaTsangGammaSampler.html#toString--">toString()</a></span> - Method in class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/AhrensDieterMarsagliaTsangGammaSampler.html" title="class in org.apache.commons.rng.sampling.distribution">AhrensDieterMarsagliaTsangGammaSampler</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/BoxMullerGaussianSampler.html#toString--">toString()</a></span> - Method in class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/BoxMullerGaussianSampler.html" title="class in org.apache.commons.rng.sampling.distribution">BoxMullerGaussianSampler</a></dt> +<dd> +<div class="block"><span class="deprecatedLabel">Deprecated.</span></div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/BoxMullerLogNormalSampler.html#toString--">toString()</a></span> - Method in class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/BoxMullerLogNormalSampler.html" title="class in org.apache.commons.rng.sampling.distribution">BoxMullerLogNormalSampler</a></dt> +<dd> +<div class="block"><span class="deprecatedLabel">Deprecated.</span></div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/BoxMullerNormalizedGaussianSampler.html#toString--">toString()</a></span> - Method in class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/BoxMullerNormalizedGaussianSampler.html" title="class in org.apache.commons.rng.sampling.distribution">BoxMullerNormalizedGaussianSampler</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/ChengBetaSampler.html#toString--">toString()</a></span> - Method in class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/ChengBetaSampler.html" title="class in org.apache.commons.rng.sampling.distribution">ChengBetaSampler</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/ContinuousUniformSampler.html#toString--">toString()</a></span> - Method in class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/ContinuousUniformSampler.html" title="class in org.apache.commons.rng.sampling.distribution">ContinuousUniformSampler</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/DiscreteUniformSampler.html#toString--">toString()</a></span> - Method in class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/DiscreteUniformSampler.html" title="class in org.apache.commons.rng.sampling.distribution">DiscreteUniformSampler</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/GaussianSampler.html#toString--">toString()</a></span> - Method in class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/GaussianSampler.html" title="class in org.apache.commons.rng.sampling.distribution">GaussianSampler</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/InverseTransformContinuousSampler.html#toString--">toString()</a></span> - Method in class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/InverseTransformContinuousSampler.html" title="class in org.apache.commons.rng.sampling.distribution">InverseTransformContinuousSampler</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/InverseTransformDiscreteSampler.html#toString--">toString()</a></span> - Method in class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/InverseTransformDiscreteSampler.html" title="class in org.apache.commons.rng.sampling.distribution">InverseTransformDiscreteSampler</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/InverseTransformParetoSampler.html#toString--">toString()</a></span> - Method in class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/InverseTransformParetoSampler.html" title="class in org.apache.commons.rng.sampling.distribution">InverseTransformParetoSampler</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/LargeMeanPoissonSampler.html#toString--">toString()</a></span> - Method in class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/LargeMeanPoissonSampler.html" title="class in org.apache.commons.rng.sampling.distribution">LargeMeanPoissonSampler</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/LogNormalSampler.html#toString--">toString()</a></span> - Method in class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/LogNormalSampler.html" title="class in org.apache.commons.rng.sampling.distribution">LogNormalSampler</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/MarsagliaNormalizedGaussianSampler.html#toString--">toString()</a></span> - Method in class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/MarsagliaNormalizedGaussianSampler.html" title="class in org.apache.commons.rng.sampling.distribution">MarsagliaNormalizedGaussianSampler</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/PoissonSampler.html#toString--">toString()</a></span> - Method in class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/PoissonSampler.html" title="class in org.apache.commons.rng.sampling.distribution">PoissonSampler</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/RejectionInversionZipfSampler.html#toString--">toString()</a></span> - Method in class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/RejectionInversionZipfSampler.html" title="class in org.apache.commons.rng.sampling.distribution">RejectionInversionZipfSampler</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/SamplerBase.html#toString--">toString()</a></span> - Method in class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/SamplerBase.html" title="class in org.apache.commons.rng.sampling.distribution">SamplerBase</a></dt> +<dd> +<div class="block"><span class="deprecatedLabel">Deprecated.</span></div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/SmallMeanPoissonSampler.html#toString--">toString()</a></span> - Method in class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/SmallMeanPoissonSampler.html" title="class in org.apache.commons.rng.sampling.distribution">SmallMeanPoissonSampler</a></dt> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/ZigguratNormalizedGaussianSampler.html#toString--">toString()</a></span> - Method in class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/ZigguratNormalizedGaussianSampler.html" title="class in org.apache.commons.rng.sampling.distribution">ZigguratNormalizedGaussianSampler</a></dt> +</dl> +<a name="I:U"> +<!-- --> +</a> +<h2 class="title">U</h2> +<dl> +<dt><a href="org/apache/commons/rng/sampling/UnitSphereSampler.html" title="class in org.apache.commons.rng.sampling"><span class="typeNameLink">UnitSphereSampler</span></a> - Class in <a href="org/apache/commons/rng/sampling/package-summary.html">org.apache.commons.rng.sampling</a></dt> +<dd> +<div class="block">Generate vectors <a href="http://mathworld.wolfram.com/SpherePointPicking.html"> + isotropically located on the surface of a sphere</a>.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/UnitSphereSampler.html#UnitSphereSampler-int-org.apache.commons.rng.UniformRandomProvider-">UnitSphereSampler(int, UniformRandomProvider)</a></span> - Constructor for class org.apache.commons.rng.sampling.<a href="org/apache/commons/rng/sampling/UnitSphereSampler.html" title="class in org.apache.commons.rng.sampling">UnitSphereSampler</a></dt> +<dd> </dd> +</dl> +<a name="I:Z"> +<!-- --> +</a> +<h2 class="title">Z</h2> +<dl> +<dt><a href="org/apache/commons/rng/sampling/distribution/ZigguratNormalizedGaussianSampler.html" title="class in org.apache.commons.rng.sampling.distribution"><span class="typeNameLink">ZigguratNormalizedGaussianSampler</span></a> - Class in <a href="org/apache/commons/rng/sampling/distribution/package-summary.html">org.apache.commons.rng.sampling.distribution</a></dt> +<dd> +<div class="block"><a href="https://en.wikipedia.org/wiki/Ziggurat_algorithm"> + Marsaglia and Tsang "Ziggurat" method</a> for sampling from a Gaussian + distribution with mean 0 and standard deviation 1.</div> +</dd> +<dt><span class="memberNameLink"><a href="org/apache/commons/rng/sampling/distribution/ZigguratNormalizedGaussianSampler.html#ZigguratNormalizedGaussianSampler-org.apache.commons.rng.UniformRandomProvider-">ZigguratNormalizedGaussianSampler(UniformRandomProvider)</a></span> - Constructor for class org.apache.commons.rng.sampling.distribution.<a href="org/apache/commons/rng/sampling/distribution/ZigguratNormalizedGaussianSampler.html" title="class in org.apache.commons.rng.sampling.distribution">ZigguratNormalizedGaussianSampler</a></dt> +<dd> </dd> +</dl> +<a href="#I:A">A</a> <a href="#I:B">B</a> <a href="#I:C">C</a> <a href="#I:D">D</a> <a href="#I:G">G</a> <a href="#I:I">I</a> <a href="#I:L">L</a> <a href="#I:M">M</a> <a href="#I:N">N</a> <a href="#I:O">O</a> <a href="#I:P">P</a> <a href="#I:R">R</a> <a href="#I:S">S</a> <a href="#I:T">T</a> <a href="#I:U">U</a> <a href="#I:Z">Z</a> </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>Package</li> +<li>Class</li> +<li>Use</li> +<li><a href="overview-tree.html">Tree</a></li> +<li><a href="deprecated-list.html">Deprecated</a></li> +<li class="navBarCell1Rev">Index</li> +<li><a href="help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="index.html?index-all.html" target="_top">Frames</a></li> +<li><a href="index-all.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> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2016–2018 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
Added: websites/production/commons/content/proper/commons-rng/commons-rng-sampling/javadocs/api-1.1/index.html ============================================================================== --- websites/production/commons/content/proper/commons-rng/commons-rng-sampling/javadocs/api-1.1/index.html (added) +++ websites/production/commons/content/proper/commons-rng/commons-rng-sampling/javadocs/api-1.1/index.html Tue Aug 14 13:05:46 2018 @@ -0,0 +1,83 @@ +<!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 --> +<title>Apache Commons RNG Sampling 1.1 API</title> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> +<script type="text/javascript"> + tmpTargetPage = "" + window.location.search; + if (tmpTargetPage != "" && tmpTargetPage != "undefined") + tmpTargetPage = tmpTargetPage.substring(1); + if (tmpTargetPage.indexOf(":") != -1 || (tmpTargetPage != "" && !validURL(tmpTargetPage))) + tmpTargetPage = "undefined"; + targetPage = tmpTargetPage; + function validURL(url) { + try { + url = decodeURIComponent(url); + } + catch (error) { + return false; + } + var pos = url.indexOf(".html"); + if (pos == -1 || pos != url.length - 5) + return false; + var allowNumber = false; + var allowSep = false; + var seenDot = false; + for (var i = 0; i < url.length - 5; i++) { + var ch = url.charAt(i); + if ('a' <= ch && ch <= 'z' || + 'A' <= ch && ch <= 'Z' || + ch == '$' || + ch == '_' || + ch.charCodeAt(0) > 127) { + allowNumber = true; + allowSep = true; + } else if ('0' <= ch && ch <= '9' + || ch == '-') { + if (!allowNumber) + return false; + } else if (ch == '/' || ch == '.') { + if (!allowSep) + return false; + allowNumber = false; + allowSep = false; + if (ch == '.') + seenDot = true; + if (ch == '/' && seenDot) + return false; + } else { + return false; + } + } + return true; + } + function loadFrames() { + if (targetPage != "" && targetPage != "undefined") + top.classFrame.location = top.targetPage; + } +</script> +</head> +<body onload="loadFrames()"> +<script type="text/javascript"> +if (targetPage == "" || targetPage == "undefined") + window.location.replace('overview-summary.html'); +</script> +<noscript>JavaScript is disabled on your browser.</noscript> +<div class="mainContainer"> +<div class="leftContainer"> +<div class="leftTop"> +<iframe src="overview-frame.html" name="packageListFrame" title="All Packages"></iframe> +</div> +<div class="leftBottom"> +<iframe src="allclasses-frame.html" name="packageFrame" title="All classes and interfaces (except non-static nested types)"></iframe> +</div> +</div> +<div class="rightContainer"> +<iframe src="overview-summary.html" name="classFrame" title="Package, class and interface descriptions" class="rightIframe"></iframe> +</div> +</div> +</body> +</html>