Added: websites/production/commons/content/proper/commons-rng/commons-rng-sampling/javadocs/api-1.1/org/apache/commons/rng/sampling/distribution/InverseTransformContinuousSampler.html ============================================================================== --- websites/production/commons/content/proper/commons-rng/commons-rng-sampling/javadocs/api-1.1/org/apache/commons/rng/sampling/distribution/InverseTransformContinuousSampler.html (added) +++ websites/production/commons/content/proper/commons-rng/commons-rng-sampling/javadocs/api-1.1/org/apache/commons/rng/sampling/distribution/InverseTransformContinuousSampler.html Tue Aug 14 13:05:46 2018 @@ -0,0 +1,388 @@ +<!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>InverseTransformContinuousSampler (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="InverseTransformContinuousSampler (Apache Commons RNG Sampling 1.1 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +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><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/InverseTransformContinuousSampler.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../org/apache/commons/rng/sampling/distribution/GaussianSampler.html" title="class in org.apache.commons.rng.sampling.distribution"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/commons/rng/sampling/distribution/InverseTransformDiscreteSampler.html" title="class in org.apache.commons.rng.sampling.distribution"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/commons/rng/sampling/distribution/InverseTransformContinuousSampler.html" target="_top">Frames</a></li> +<li><a href="InverseTransformContinuousSampler.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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </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 ========= --> +</div> +<div class="navPadding"> </div> +<script type="text/javascript"><!-- +$('.navPadding').css('padding-top', $('.fixedNav').css("height")); +//--> +</script> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="../../../../../../org/apache/commons/rng/sampling/distribution/package-summary.html">org.apache.commons.rng.sampling.distribution</a></div> +<h2 title="Class InverseTransformContinuousSampler" class="title">Class InverseTransformContinuousSampler</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../../org/apache/commons/rng/sampling/distribution/SamplerBase.html" title="class in org.apache.commons.rng.sampling.distribution">org.apache.commons.rng.sampling.distribution.SamplerBase</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.commons.rng.sampling.distribution.InverseTransformContinuousSampler</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="../../../../../../org/apache/commons/rng/sampling/distribution/ContinuousSampler.html" title="interface in org.apache.commons.rng.sampling.distribution">ContinuousSampler</a></code></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">InverseTransformContinuousSampler</span> +extends <a href="../../../../../../org/apache/commons/rng/sampling/distribution/SamplerBase.html" title="class in org.apache.commons.rng.sampling.distribution">SamplerBase</a> +implements <a href="../../../../../../org/apache/commons/rng/sampling/distribution/ContinuousSampler.html" title="interface in org.apache.commons.rng.sampling.distribution">ContinuousSampler</a></pre> +<div class="block">Distribution sampler that uses the + <a href="https://en.wikipedia.org/wiki/Inverse_transform_sampling";> + inversion method</a>. + + It can be used to sample any distribution that provides access to its + <em>inverse cumulative probabilty function</em>. + + <p>Example:</p> + <pre><code> + import org.apache.commons.math3.distribution.RealDistribution; + import org.apache.commons.math3.distribution.ChiSquaredDistribution; + + import org.apache.commons.rng.simple.RandomSource; + import org.apache.commons.rng.sampling.distribution.ContinuousSampler; + import org.apache.commons.rng.sampling.distribution.InverseTransformContinuousSampler; + import org.apache.commons.rng.sampling.distribution.ContinuousInverseCumulativeProbabilityFunction; + + // Distribution to sample. + final RealDistribution dist = new ChiSquaredDistribution(9); + // Create the sampler. + final ContinuousSampler chiSquareSampler = + new InverseTransformContinuousSampler(RandomSource.create(RandomSource.MT), + new ContinuousInverseCumulativeProbabilityFunction() { + public double inverseCumulativeProbability(double p) { + return dist.inverseCumulativeProbability(p); + } + }); + + // Generate random deviate. + double random = chiSquareSampler.sample(); + </code></pre></div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>1.0</dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Constructor</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tr class="altColor"> +<th class="colConstructorName" scope="row"><code><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</a></span>​(org.apache.commons.rng.UniformRandomProvider rng, + <a href="../../../../../../org/apache/commons/rng/sampling/distribution/ContinuousInverseCumulativeProbabilityFunction.html" title="interface in org.apache.commons.rng.sampling.distribution">ContinuousInverseCumulativeProbabilityFunction</a> function)</code></th> +<td class="colLast"> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colSecond" scope="col">Method</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>double</code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/rng/sampling/distribution/InverseTransformContinuousSampler.html#sample--">sample</a></span>​()</code></th> +<td class="colLast"> +<div class="block">Creates a sample.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/rng/sampling/distribution/InverseTransformContinuousSampler.html#toString--">toString</a></span>​()</code></th> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.commons.rng.sampling.distribution.SamplerBase"> +<!-- --> +</a> +<h3>Methods inherited from 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></h3> +<code><a href="../../../../../../org/apache/commons/rng/sampling/distribution/SamplerBase.html#nextDouble--">nextDouble</a>, <a href="../../../../../../org/apache/commons/rng/sampling/distribution/SamplerBase.html#nextInt--">nextInt</a>, <a href="../../../../../../org/apache/commons/rng/sampling/distribution/SamplerBase.html#nextInt-int-">nextInt</a>, <a href="../../../../../../org/apache/commons/rng/sampling/distribution/SamplerBase.html#nextLong--">nextLong</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="InverseTransformContinuousSampler-org.apache.commons.rng.UniformRandomProvider-org.apache.commons.rng.sampling.distribution.ContinuousInverseCumulativeProbabilityFunction-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>InverseTransformContinuousSampler</h4> +<pre>public InverseTransformContinuousSampler​(org.apache.commons.rng.UniformRandomProvider rng, + <a href="../../../../../../org/apache/commons/rng/sampling/distribution/ContinuousInverseCumulativeProbabilityFunction.html" title="interface in org.apache.commons.rng.sampling.distribution">ContinuousInverseCumulativeProbabilityFunction</a> function)</pre> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>rng</code> - Generator of uniformly distributed random numbers.</dd> +<dd><code>function</code> - Inverse cumulative probability function.</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="sample--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>sample</h4> +<pre>public double sample​()</pre> +<div class="block">Creates a sample.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/commons/rng/sampling/distribution/ContinuousSampler.html#sample--">sample</a></code> in interface <code><a href="../../../../../../org/apache/commons/rng/sampling/distribution/ContinuousSampler.html" title="interface in org.apache.commons.rng.sampling.distribution">ContinuousSampler</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a sample.</dd> +</dl> +</li> +</ul> +<a name="toString--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString​()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../../org/apache/commons/rng/sampling/distribution/SamplerBase.html#toString--">toString</a></code> in class <code><a href="../../../../../../org/apache/commons/rng/sampling/distribution/SamplerBase.html" title="class in org.apache.commons.rng.sampling.distribution">SamplerBase</a></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> +<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><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/InverseTransformContinuousSampler.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../org/apache/commons/rng/sampling/distribution/GaussianSampler.html" title="class in org.apache.commons.rng.sampling.distribution"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/commons/rng/sampling/distribution/InverseTransformDiscreteSampler.html" title="class in org.apache.commons.rng.sampling.distribution"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/commons/rng/sampling/distribution/InverseTransformContinuousSampler.html" target="_top">Frames</a></li> +<li><a href="InverseTransformContinuousSampler.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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </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 © 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/org/apache/commons/rng/sampling/distribution/InverseTransformDiscreteSampler.html ============================================================================== --- websites/production/commons/content/proper/commons-rng/commons-rng-sampling/javadocs/api-1.1/org/apache/commons/rng/sampling/distribution/InverseTransformDiscreteSampler.html (added) +++ websites/production/commons/content/proper/commons-rng/commons-rng-sampling/javadocs/api-1.1/org/apache/commons/rng/sampling/distribution/InverseTransformDiscreteSampler.html Tue Aug 14 13:05:46 2018 @@ -0,0 +1,388 @@ +<!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>InverseTransformDiscreteSampler (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="InverseTransformDiscreteSampler (Apache Commons RNG Sampling 1.1 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +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><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/InverseTransformDiscreteSampler.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../org/apache/commons/rng/sampling/distribution/InverseTransformContinuousSampler.html" title="class in org.apache.commons.rng.sampling.distribution"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/commons/rng/sampling/distribution/InverseTransformParetoSampler.html" title="class in org.apache.commons.rng.sampling.distribution"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/commons/rng/sampling/distribution/InverseTransformDiscreteSampler.html" target="_top">Frames</a></li> +<li><a href="InverseTransformDiscreteSampler.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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </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 ========= --> +</div> +<div class="navPadding"> </div> +<script type="text/javascript"><!-- +$('.navPadding').css('padding-top', $('.fixedNav').css("height")); +//--> +</script> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="../../../../../../org/apache/commons/rng/sampling/distribution/package-summary.html">org.apache.commons.rng.sampling.distribution</a></div> +<h2 title="Class InverseTransformDiscreteSampler" class="title">Class InverseTransformDiscreteSampler</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../../org/apache/commons/rng/sampling/distribution/SamplerBase.html" title="class in org.apache.commons.rng.sampling.distribution">org.apache.commons.rng.sampling.distribution.SamplerBase</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.commons.rng.sampling.distribution.InverseTransformDiscreteSampler</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="../../../../../../org/apache/commons/rng/sampling/distribution/DiscreteSampler.html" title="interface in org.apache.commons.rng.sampling.distribution">DiscreteSampler</a></code></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">InverseTransformDiscreteSampler</span> +extends <a href="../../../../../../org/apache/commons/rng/sampling/distribution/SamplerBase.html" title="class in org.apache.commons.rng.sampling.distribution">SamplerBase</a> +implements <a href="../../../../../../org/apache/commons/rng/sampling/distribution/DiscreteSampler.html" title="interface in org.apache.commons.rng.sampling.distribution">DiscreteSampler</a></pre> +<div class="block">Distribution sampler that uses the + <a href="https://en.wikipedia.org/wiki/Inverse_transform_sampling";> + inversion method</a>. + + It can be used to sample any distribution that provides access to its + <em>inverse cumulative probabilty function</em>. + + <p>Example:</p> + <pre><code> + import org.apache.commons.math3.distribution.IntegerDistribution; + import org.apache.commons.math3.distribution.BinomialDistribution; + + import org.apache.commons.rng.simple.RandomSource; + import org.apache.commons.rng.sampling.distribution.DiscreteSampler; + import org.apache.commons.rng.sampling.distribution.InverseTransformDiscreteSampler; + import org.apache.commons.rng.sampling.distribution.DiscreteInverseCumulativeProbabilityFunction; + + // Distribution to sample. + final IntegerDistribution dist = new BinomialDistribution(11, 0.56); + // Create the sampler. + final DiscreteSampler binomialSampler = + new InverseTransformDiscreteSampler(RandomSource.create(RandomSource.MT), + new DiscreteInverseCumulativeProbabilityFunction() { + public int inverseCumulativeProbability(double p) { + return dist.inverseCumulativeProbability(p); + } + }); + + // Generate random deviate. + int random = binomialSampler.sample(); + </code></pre></div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>1.0</dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Constructor</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tr class="altColor"> +<th class="colConstructorName" scope="row"><code><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</a></span>​(org.apache.commons.rng.UniformRandomProvider rng, + <a href="../../../../../../org/apache/commons/rng/sampling/distribution/DiscreteInverseCumulativeProbabilityFunction.html" title="interface in org.apache.commons.rng.sampling.distribution">DiscreteInverseCumulativeProbabilityFunction</a> function)</code></th> +<td class="colLast"> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colSecond" scope="col">Method</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>int</code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/rng/sampling/distribution/InverseTransformDiscreteSampler.html#sample--">sample</a></span>​()</code></th> +<td class="colLast"> +<div class="block">Creates a sample.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/rng/sampling/distribution/InverseTransformDiscreteSampler.html#toString--">toString</a></span>​()</code></th> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.commons.rng.sampling.distribution.SamplerBase"> +<!-- --> +</a> +<h3>Methods inherited from 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></h3> +<code><a href="../../../../../../org/apache/commons/rng/sampling/distribution/SamplerBase.html#nextDouble--">nextDouble</a>, <a href="../../../../../../org/apache/commons/rng/sampling/distribution/SamplerBase.html#nextInt--">nextInt</a>, <a href="../../../../../../org/apache/commons/rng/sampling/distribution/SamplerBase.html#nextInt-int-">nextInt</a>, <a href="../../../../../../org/apache/commons/rng/sampling/distribution/SamplerBase.html#nextLong--">nextLong</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="InverseTransformDiscreteSampler-org.apache.commons.rng.UniformRandomProvider-org.apache.commons.rng.sampling.distribution.DiscreteInverseCumulativeProbabilityFunction-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>InverseTransformDiscreteSampler</h4> +<pre>public InverseTransformDiscreteSampler​(org.apache.commons.rng.UniformRandomProvider rng, + <a href="../../../../../../org/apache/commons/rng/sampling/distribution/DiscreteInverseCumulativeProbabilityFunction.html" title="interface in org.apache.commons.rng.sampling.distribution">DiscreteInverseCumulativeProbabilityFunction</a> function)</pre> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>rng</code> - Generator of uniformly distributed random numbers.</dd> +<dd><code>function</code> - Inverse cumulative probability function.</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="sample--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>sample</h4> +<pre>public int sample​()</pre> +<div class="block">Creates a sample.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/commons/rng/sampling/distribution/DiscreteSampler.html#sample--">sample</a></code> in interface <code><a href="../../../../../../org/apache/commons/rng/sampling/distribution/DiscreteSampler.html" title="interface in org.apache.commons.rng.sampling.distribution">DiscreteSampler</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a sample.</dd> +</dl> +</li> +</ul> +<a name="toString--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString​()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../../org/apache/commons/rng/sampling/distribution/SamplerBase.html#toString--">toString</a></code> in class <code><a href="../../../../../../org/apache/commons/rng/sampling/distribution/SamplerBase.html" title="class in org.apache.commons.rng.sampling.distribution">SamplerBase</a></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> +<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><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/InverseTransformDiscreteSampler.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../org/apache/commons/rng/sampling/distribution/InverseTransformContinuousSampler.html" title="class in org.apache.commons.rng.sampling.distribution"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/commons/rng/sampling/distribution/InverseTransformParetoSampler.html" title="class in org.apache.commons.rng.sampling.distribution"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/commons/rng/sampling/distribution/InverseTransformDiscreteSampler.html" target="_top">Frames</a></li> +<li><a href="InverseTransformDiscreteSampler.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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </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 © 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/org/apache/commons/rng/sampling/distribution/InverseTransformParetoSampler.html ============================================================================== --- websites/production/commons/content/proper/commons-rng/commons-rng-sampling/javadocs/api-1.1/org/apache/commons/rng/sampling/distribution/InverseTransformParetoSampler.html (added) +++ websites/production/commons/content/proper/commons-rng/commons-rng-sampling/javadocs/api-1.1/org/apache/commons/rng/sampling/distribution/InverseTransformParetoSampler.html Tue Aug 14 13:05:46 2018 @@ -0,0 +1,357 @@ +<!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>InverseTransformParetoSampler (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="InverseTransformParetoSampler (Apache Commons RNG Sampling 1.1 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +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><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/InverseTransformParetoSampler.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../org/apache/commons/rng/sampling/distribution/InverseTransformDiscreteSampler.html" title="class in org.apache.commons.rng.sampling.distribution"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/commons/rng/sampling/distribution/LargeMeanPoissonSampler.html" title="class in org.apache.commons.rng.sampling.distribution"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/commons/rng/sampling/distribution/InverseTransformParetoSampler.html" target="_top">Frames</a></li> +<li><a href="InverseTransformParetoSampler.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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </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 ========= --> +</div> +<div class="navPadding"> </div> +<script type="text/javascript"><!-- +$('.navPadding').css('padding-top', $('.fixedNav').css("height")); +//--> +</script> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="../../../../../../org/apache/commons/rng/sampling/distribution/package-summary.html">org.apache.commons.rng.sampling.distribution</a></div> +<h2 title="Class InverseTransformParetoSampler" class="title">Class InverseTransformParetoSampler</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../../org/apache/commons/rng/sampling/distribution/SamplerBase.html" title="class in org.apache.commons.rng.sampling.distribution">org.apache.commons.rng.sampling.distribution.SamplerBase</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.commons.rng.sampling.distribution.InverseTransformParetoSampler</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="../../../../../../org/apache/commons/rng/sampling/distribution/ContinuousSampler.html" title="interface in org.apache.commons.rng.sampling.distribution">ContinuousSampler</a></code></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">InverseTransformParetoSampler</span> +extends <a href="../../../../../../org/apache/commons/rng/sampling/distribution/SamplerBase.html" title="class in org.apache.commons.rng.sampling.distribution">SamplerBase</a> +implements <a href="../../../../../../org/apache/commons/rng/sampling/distribution/ContinuousSampler.html" title="interface in org.apache.commons.rng.sampling.distribution">ContinuousSampler</a></pre> +<div class="block">Sampling from a <a href="https://en.wikipedia.org/wiki/Pareto_distribution";>Pareto distribution</a>.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Constructor</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tr class="altColor"> +<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/rng/sampling/distribution/InverseTransformParetoSampler.html#InverseTransformParetoSampler-org.apache.commons.rng.UniformRandomProvider-double-double-">InverseTransformParetoSampler</a></span>​(org.apache.commons.rng.UniformRandomProvider rng, + double scale, + double shape)</code></th> +<td class="colLast"> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colSecond" scope="col">Method</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>double</code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/rng/sampling/distribution/InverseTransformParetoSampler.html#sample--">sample</a></span>​()</code></th> +<td class="colLast"> +<div class="block">Creates a sample.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/rng/sampling/distribution/InverseTransformParetoSampler.html#toString--">toString</a></span>​()</code></th> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.commons.rng.sampling.distribution.SamplerBase"> +<!-- --> +</a> +<h3>Methods inherited from 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></h3> +<code><a href="../../../../../../org/apache/commons/rng/sampling/distribution/SamplerBase.html#nextDouble--">nextDouble</a>, <a href="../../../../../../org/apache/commons/rng/sampling/distribution/SamplerBase.html#nextInt--">nextInt</a>, <a href="../../../../../../org/apache/commons/rng/sampling/distribution/SamplerBase.html#nextInt-int-">nextInt</a>, <a href="../../../../../../org/apache/commons/rng/sampling/distribution/SamplerBase.html#nextLong--">nextLong</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="InverseTransformParetoSampler-org.apache.commons.rng.UniformRandomProvider-double-double-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>InverseTransformParetoSampler</h4> +<pre>public InverseTransformParetoSampler​(org.apache.commons.rng.UniformRandomProvider rng, + double scale, + double shape)</pre> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>rng</code> - Generator of uniformly distributed random numbers.</dd> +<dd><code>scale</code> - Scale of the distribution.</dd> +<dd><code>shape</code> - Shape of the distribution.</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="sample--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>sample</h4> +<pre>public double sample​()</pre> +<div class="block">Creates a sample.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/commons/rng/sampling/distribution/ContinuousSampler.html#sample--">sample</a></code> in interface <code><a href="../../../../../../org/apache/commons/rng/sampling/distribution/ContinuousSampler.html" title="interface in org.apache.commons.rng.sampling.distribution">ContinuousSampler</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a sample.</dd> +</dl> +</li> +</ul> +<a name="toString--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString​()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../../../org/apache/commons/rng/sampling/distribution/SamplerBase.html#toString--">toString</a></code> in class <code><a href="../../../../../../org/apache/commons/rng/sampling/distribution/SamplerBase.html" title="class in org.apache.commons.rng.sampling.distribution">SamplerBase</a></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> +<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><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/InverseTransformParetoSampler.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../org/apache/commons/rng/sampling/distribution/InverseTransformDiscreteSampler.html" title="class in org.apache.commons.rng.sampling.distribution"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/commons/rng/sampling/distribution/LargeMeanPoissonSampler.html" title="class in org.apache.commons.rng.sampling.distribution"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/commons/rng/sampling/distribution/InverseTransformParetoSampler.html" target="_top">Frames</a></li> +<li><a href="InverseTransformParetoSampler.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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </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 © 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/org/apache/commons/rng/sampling/distribution/LargeMeanPoissonSampler.html ============================================================================== --- websites/production/commons/content/proper/commons-rng/commons-rng-sampling/javadocs/api-1.1/org/apache/commons/rng/sampling/distribution/LargeMeanPoissonSampler.html (added) +++ websites/production/commons/content/proper/commons-rng/commons-rng-sampling/javadocs/api-1.1/org/apache/commons/rng/sampling/distribution/LargeMeanPoissonSampler.html Tue Aug 14 13:05:46 2018 @@ -0,0 +1,360 @@ +<!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>LargeMeanPoissonSampler (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="LargeMeanPoissonSampler (Apache Commons RNG Sampling 1.1 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +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><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/LargeMeanPoissonSampler.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../org/apache/commons/rng/sampling/distribution/InverseTransformParetoSampler.html" title="class in org.apache.commons.rng.sampling.distribution"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/commons/rng/sampling/distribution/LogNormalSampler.html" title="class in org.apache.commons.rng.sampling.distribution"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/commons/rng/sampling/distribution/LargeMeanPoissonSampler.html" target="_top">Frames</a></li> +<li><a href="LargeMeanPoissonSampler.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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </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 ========= --> +</div> +<div class="navPadding"> </div> +<script type="text/javascript"><!-- +$('.navPadding').css('padding-top', $('.fixedNav').css("height")); +//--> +</script> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="../../../../../../org/apache/commons/rng/sampling/distribution/package-summary.html">org.apache.commons.rng.sampling.distribution</a></div> +<h2 title="Class LargeMeanPoissonSampler" class="title">Class LargeMeanPoissonSampler</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.commons.rng.sampling.distribution.LargeMeanPoissonSampler</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="../../../../../../org/apache/commons/rng/sampling/distribution/DiscreteSampler.html" title="interface in org.apache.commons.rng.sampling.distribution">DiscreteSampler</a></code></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">LargeMeanPoissonSampler</span> +extends java.lang.Object +implements <a href="../../../../../../org/apache/commons/rng/sampling/distribution/DiscreteSampler.html" title="interface in org.apache.commons.rng.sampling.distribution">DiscreteSampler</a></pre> +<div class="block">Sampler for the <a href="http://mathworld.wolfram.com/PoissonDistribution.html";>Poisson distribution</a>. + + <ul> + <li> + For large means, we use the rejection algorithm described in + <blockquote> + Devroye, Luc. (1981).<i>The Computer Generation of Poisson Random Variables</i><br> + <strong>Computing</strong> vol. 26 pp. 197-207. + </blockquote> + </li> + </ul></div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>1.1 + + This sampler is suitable for <code>mean >= 40</code>.</dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Constructor</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tr class="altColor"> +<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/rng/sampling/distribution/LargeMeanPoissonSampler.html#LargeMeanPoissonSampler-org.apache.commons.rng.UniformRandomProvider-double-">LargeMeanPoissonSampler</a></span>​(org.apache.commons.rng.UniformRandomProvider rng, + double mean)</code></th> +<td class="colLast"> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colSecond" scope="col">Method</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>int</code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/rng/sampling/distribution/LargeMeanPoissonSampler.html#sample--">sample</a></span>​()</code></th> +<td class="colLast"> +<div class="block">Creates a sample.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/rng/sampling/distribution/LargeMeanPoissonSampler.html#toString--">toString</a></span>​()</code></th> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</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="LargeMeanPoissonSampler-org.apache.commons.rng.UniformRandomProvider-double-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>LargeMeanPoissonSampler</h4> +<pre>public LargeMeanPoissonSampler​(org.apache.commons.rng.UniformRandomProvider rng, + double mean)</pre> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>rng</code> - Generator of uniformly distributed random numbers.</dd> +<dd><code>mean</code> - Mean.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if <code>mean <= 0</code>.</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="sample--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>sample</h4> +<pre>public int sample​()</pre> +<div class="block">Creates a sample.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/commons/rng/sampling/distribution/DiscreteSampler.html#sample--">sample</a></code> in interface <code><a href="../../../../../../org/apache/commons/rng/sampling/distribution/DiscreteSampler.html" title="interface in org.apache.commons.rng.sampling.distribution">DiscreteSampler</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a sample.</dd> +</dl> +</li> +</ul> +<a name="toString--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString​()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>toString</code> in class <code>java.lang.Object</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> +<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><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/LargeMeanPoissonSampler.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../org/apache/commons/rng/sampling/distribution/InverseTransformParetoSampler.html" title="class in org.apache.commons.rng.sampling.distribution"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/commons/rng/sampling/distribution/LogNormalSampler.html" title="class in org.apache.commons.rng.sampling.distribution"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/commons/rng/sampling/distribution/LargeMeanPoissonSampler.html" target="_top">Frames</a></li> +<li><a href="LargeMeanPoissonSampler.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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </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 © 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/org/apache/commons/rng/sampling/distribution/LogNormalSampler.html ============================================================================== --- websites/production/commons/content/proper/commons-rng/commons-rng-sampling/javadocs/api-1.1/org/apache/commons/rng/sampling/distribution/LogNormalSampler.html (added) +++ websites/production/commons/content/proper/commons-rng/commons-rng-sampling/javadocs/api-1.1/org/apache/commons/rng/sampling/distribution/LogNormalSampler.html Tue Aug 14 13:05:46 2018 @@ -0,0 +1,349 @@ +<!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>LogNormalSampler (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="LogNormalSampler (Apache Commons RNG Sampling 1.1 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +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><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/LogNormalSampler.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../org/apache/commons/rng/sampling/distribution/LargeMeanPoissonSampler.html" title="class in org.apache.commons.rng.sampling.distribution"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/commons/rng/sampling/distribution/MarsagliaNormalizedGaussianSampler.html" title="class in org.apache.commons.rng.sampling.distribution"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/commons/rng/sampling/distribution/LogNormalSampler.html" target="_top">Frames</a></li> +<li><a href="LogNormalSampler.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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </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 ========= --> +</div> +<div class="navPadding"> </div> +<script type="text/javascript"><!-- +$('.navPadding').css('padding-top', $('.fixedNav').css("height")); +//--> +</script> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="../../../../../../org/apache/commons/rng/sampling/distribution/package-summary.html">org.apache.commons.rng.sampling.distribution</a></div> +<h2 title="Class LogNormalSampler" class="title">Class LogNormalSampler</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.commons.rng.sampling.distribution.LogNormalSampler</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><code><a href="../../../../../../org/apache/commons/rng/sampling/distribution/ContinuousSampler.html" title="interface in org.apache.commons.rng.sampling.distribution">ContinuousSampler</a></code></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">LogNormalSampler</span> +extends java.lang.Object +implements <a href="../../../../../../org/apache/commons/rng/sampling/distribution/ContinuousSampler.html" title="interface in org.apache.commons.rng.sampling.distribution">ContinuousSampler</a></pre> +<div class="block">Sampling from a log-normal distribution.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>1.1</dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Constructor</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tr class="altColor"> +<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/rng/sampling/distribution/LogNormalSampler.html#LogNormalSampler-org.apache.commons.rng.sampling.distribution.NormalizedGaussianSampler-double-double-">LogNormalSampler</a></span>​(<a href="../../../../../../org/apache/commons/rng/sampling/distribution/NormalizedGaussianSampler.html" title="interface in org.apache.commons.rng.sampling.distribution">NormalizedGaussianSampler</a> gaussian, + double scale, + double shape)</code></th> +<td class="colLast"> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colSecond" scope="col">Method</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>double</code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/rng/sampling/distribution/LogNormalSampler.html#sample--">sample</a></span>​()</code></th> +<td class="colLast"> +<div class="block">Creates a sample.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../../../org/apache/commons/rng/sampling/distribution/LogNormalSampler.html#toString--">toString</a></span>​()</code></th> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</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="LogNormalSampler-org.apache.commons.rng.sampling.distribution.NormalizedGaussianSampler-double-double-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>LogNormalSampler</h4> +<pre>public LogNormalSampler​(<a href="../../../../../../org/apache/commons/rng/sampling/distribution/NormalizedGaussianSampler.html" title="interface in org.apache.commons.rng.sampling.distribution">NormalizedGaussianSampler</a> gaussian, + double scale, + double shape)</pre> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>gaussian</code> - N(0,1) generator.</dd> +<dd><code>scale</code> - Scale of the log-normal distribution.</dd> +<dd><code>shape</code> - Shape of the log-normal distribution.</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="sample--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>sample</h4> +<pre>public double sample​()</pre> +<div class="block">Creates a sample.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/commons/rng/sampling/distribution/ContinuousSampler.html#sample--">sample</a></code> in interface <code><a href="../../../../../../org/apache/commons/rng/sampling/distribution/ContinuousSampler.html" title="interface in org.apache.commons.rng.sampling.distribution">ContinuousSampler</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a sample.</dd> +</dl> +</li> +</ul> +<a name="toString--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString​()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>toString</code> in class <code>java.lang.Object</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> +<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><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/LogNormalSampler.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../../org/apache/commons/rng/sampling/distribution/LargeMeanPoissonSampler.html" title="class in org.apache.commons.rng.sampling.distribution"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/commons/rng/sampling/distribution/MarsagliaNormalizedGaussianSampler.html" title="class in org.apache.commons.rng.sampling.distribution"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/commons/rng/sampling/distribution/LogNormalSampler.html" target="_top">Frames</a></li> +<li><a href="LogNormalSampler.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> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </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 © 2016–2018 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
