| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>RandomData (Apache Commons Math 3.3 API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="RandomData (Apache Commons Math 3.3 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/RandomData.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><em><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script></em></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/commons/math3/random/RandomAdaptor.html" title="class in org.apache.commons.math3.random"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/commons/math3/random/RandomDataGenerator.html" title="class in org.apache.commons.math3.random"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/commons/math3/random/RandomData.html" target="_top">Frames</a></li> |
| <li><a href="RandomData.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.commons.math3.random</div> |
| <h2 title="Interface RandomData" class="title">Interface RandomData</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/apache/commons/math3/random/RandomDataGenerator.html" title="class in org.apache.commons.math3.random">RandomDataGenerator</a>, <a href="../../../../../org/apache/commons/math3/random/RandomDataImpl.html" title="class in org.apache.commons.math3.random">RandomDataImpl</a></dd> |
| </dl> |
| <hr> |
| <div class="block"><strong>Deprecated.</strong> |
| <div class="block"><i>to be removed in 4.0. Use <a href="../../../../../org/apache/commons/math3/random/RandomDataGenerator.html" title="class in org.apache.commons.math3.random"><code>RandomDataGenerator</code></a> directly</i></div> |
| </div> |
| <br> |
| <pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public interface <span class="strong">RandomData</span></pre> |
| <div class="block">Random data generation utilities.</div> |
| <dl><dt><span class="strong">Version:</span></dt> |
| <dd>$Id: RandomData.java 1499808 2013-07-04 17:00:42Z sebb $</dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/random/RandomData.html#nextExponential(double)">nextExponential</a></strong>(double mean)</code> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| <div class="block">Generates a random value from the exponential distribution |
| with specified mean.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/random/RandomData.html#nextGaussian(double, double)">nextGaussian</a></strong>(double mu, |
| double sigma)</code> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| <div class="block">Generates a random value from the Normal (or Gaussian) distribution with |
| specified mean and standard deviation.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/random/RandomData.html#nextHexString(int)">nextHexString</a></strong>(int len)</code> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| <div class="block">Generates a random string of hex characters of length <code>len</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/random/RandomData.html#nextInt(int, int)">nextInt</a></strong>(int lower, |
| int upper)</code> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| <div class="block">Generates a uniformly distributed random integer between <code>lower</code> |
| and <code>upper</code> (endpoints included).</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/random/RandomData.html#nextLong(long, long)">nextLong</a></strong>(long lower, |
| long upper)</code> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| <div class="block">Generates a uniformly distributed random long integer between |
| <code>lower</code> and <code>upper</code> (endpoints included).</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/random/RandomData.html#nextPermutation(int, int)">nextPermutation</a></strong>(int n, |
| int k)</code> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| <div class="block">Generates an integer array of length <code>k</code> whose entries are selected |
| randomly, without repetition, from the integers <code>0, ..., n - 1</code> |
| (inclusive).</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/random/RandomData.html#nextPoisson(double)">nextPoisson</a></strong>(double mean)</code> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| <div class="block">Generates a random value from the Poisson distribution with the given |
| mean.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/random/RandomData.html#nextSample(java.util.Collection, int)">nextSample</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><?> c, |
| int k)</code> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| <div class="block">Returns an array of <code>k</code> objects selected randomly from the |
| Collection <code>c</code>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/random/RandomData.html#nextSecureHexString(int)">nextSecureHexString</a></strong>(int len)</code> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| <div class="block">Generates a random string of hex characters from a secure random |
| sequence.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/random/RandomData.html#nextSecureInt(int, int)">nextSecureInt</a></strong>(int lower, |
| int upper)</code> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| <div class="block">Generates a uniformly distributed random integer between <code>lower</code> |
| and <code>upper</code> (endpoints included) from a secure random sequence.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/random/RandomData.html#nextSecureLong(long, long)">nextSecureLong</a></strong>(long lower, |
| long upper)</code> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| <div class="block">Generates a uniformly distributed random long integer between |
| <code>lower</code> and <code>upper</code> (endpoints included) from a secure random |
| sequence.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/random/RandomData.html#nextUniform(double, double)">nextUniform</a></strong>(double lower, |
| double upper)</code> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| <div class="block">Generates a uniformly distributed random value from the open interval |
| <code>(lower, upper)</code> (i.e., endpoints excluded).</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/random/RandomData.html#nextUniform(double, double, boolean)">nextUniform</a></strong>(double lower, |
| double upper, |
| boolean lowerInclusive)</code> |
| <div class="block"><strong>Deprecated.</strong> </div> |
| <div class="block">Generates a uniformly distributed random value from the interval |
| <code>(lower, upper)</code> or the interval <code>[lower, upper)</code>.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="nextHexString(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>nextHexString</h4> |
| <pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> nextHexString(int len) |
| throws <a href="../../../../../org/apache/commons/math3/exception/NotStrictlyPositiveException.html" title="class in org.apache.commons.math3.exception">NotStrictlyPositiveException</a></pre> |
| <div class="block"><span class="strong">Deprecated.</span> </div> |
| <div class="block">Generates a random string of hex characters of length <code>len</code>. |
| <p> |
| The generated string will be random, but not cryptographically |
| secure. To generate cryptographically secure strings, use |
| <a href="../../../../../org/apache/commons/math3/random/RandomData.html#nextSecureHexString(int)"><code>nextSecureHexString(int)</code></a>. |
| </p></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>len</code> - the length of the string to be generated</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a random string of hex characters of length <code>len</code></dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/commons/math3/exception/NotStrictlyPositiveException.html" title="class in org.apache.commons.math3.exception">NotStrictlyPositiveException</a></code> - if <code>len <= 0</code></dd></dl> |
| </li> |
| </ul> |
| <a name="nextInt(int, int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>nextInt</h4> |
| <pre>int nextInt(int lower, |
| int upper) |
| throws <a href="../../../../../org/apache/commons/math3/exception/NumberIsTooLargeException.html" title="class in org.apache.commons.math3.exception">NumberIsTooLargeException</a></pre> |
| <div class="block"><span class="strong">Deprecated.</span> </div> |
| <div class="block">Generates a uniformly distributed random integer between <code>lower</code> |
| and <code>upper</code> (endpoints included). |
| <p> |
| The generated integer will be random, but not cryptographically secure. |
| To generate cryptographically secure integer sequences, use |
| <a href="../../../../../org/apache/commons/math3/random/RandomData.html#nextSecureInt(int, int)"><code>nextSecureInt(int, int)</code></a>. |
| </p></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>lower</code> - lower bound for generated integer</dd><dd><code>upper</code> - upper bound for generated integer</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a random integer greater than or equal to <code>lower</code> |
| and less than or equal to <code>upper</code></dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/commons/math3/exception/NumberIsTooLargeException.html" title="class in org.apache.commons.math3.exception">NumberIsTooLargeException</a></code> - if <code>lower >= upper</code></dd></dl> |
| </li> |
| </ul> |
| <a name="nextLong(long, long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>nextLong</h4> |
| <pre>long nextLong(long lower, |
| long upper) |
| throws <a href="../../../../../org/apache/commons/math3/exception/NumberIsTooLargeException.html" title="class in org.apache.commons.math3.exception">NumberIsTooLargeException</a></pre> |
| <div class="block"><span class="strong">Deprecated.</span> </div> |
| <div class="block">Generates a uniformly distributed random long integer between |
| <code>lower</code> and <code>upper</code> (endpoints included). |
| <p> |
| The generated long integer values will be random, but not |
| cryptographically secure. To generate cryptographically secure sequences |
| of longs, use <a href="../../../../../org/apache/commons/math3/random/RandomData.html#nextSecureLong(long, long)"><code>nextSecureLong(long, long)</code></a>. |
| </p></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>lower</code> - lower bound for generated long integer</dd><dd><code>upper</code> - upper bound for generated long integer</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a random long integer greater than or equal to <code>lower</code> and |
| less than or equal to <code>upper</code></dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/commons/math3/exception/NumberIsTooLargeException.html" title="class in org.apache.commons.math3.exception">NumberIsTooLargeException</a></code> - if <code>lower >= upper</code></dd></dl> |
| </li> |
| </ul> |
| <a name="nextSecureHexString(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>nextSecureHexString</h4> |
| <pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> nextSecureHexString(int len) |
| throws <a href="../../../../../org/apache/commons/math3/exception/NotStrictlyPositiveException.html" title="class in org.apache.commons.math3.exception">NotStrictlyPositiveException</a></pre> |
| <div class="block"><span class="strong">Deprecated.</span> </div> |
| <div class="block">Generates a random string of hex characters from a secure random |
| sequence. |
| <p> |
| If cryptographic security is not required, use |
| <a href="../../../../../org/apache/commons/math3/random/RandomData.html#nextHexString(int)"><code>nextHexString(int)</code></a>. |
| </p></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>len</code> - the length of the string to be generated</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a random string of hex characters of length <code>len</code></dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/commons/math3/exception/NotStrictlyPositiveException.html" title="class in org.apache.commons.math3.exception">NotStrictlyPositiveException</a></code> - if <code>len <= 0</code></dd></dl> |
| </li> |
| </ul> |
| <a name="nextSecureInt(int, int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>nextSecureInt</h4> |
| <pre>int nextSecureInt(int lower, |
| int upper) |
| throws <a href="../../../../../org/apache/commons/math3/exception/NumberIsTooLargeException.html" title="class in org.apache.commons.math3.exception">NumberIsTooLargeException</a></pre> |
| <div class="block"><span class="strong">Deprecated.</span> </div> |
| <div class="block">Generates a uniformly distributed random integer between <code>lower</code> |
| and <code>upper</code> (endpoints included) from a secure random sequence. |
| <p> |
| Sequences of integers generated using this method will be |
| cryptographically secure. If cryptographic security is not required, |
| <a href="../../../../../org/apache/commons/math3/random/RandomData.html#nextInt(int, int)"><code>nextInt(int, int)</code></a> should be used instead of this method.</p> |
| <p> |
| <strong>Definition</strong>: |
| <a href="http://en.wikipedia.org/wiki/Cryptographically_secure_pseudo-random_number_generator"> |
| Secure Random Sequence</a></p></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>lower</code> - lower bound for generated integer</dd><dd><code>upper</code> - upper bound for generated integer</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a random integer greater than or equal to <code>lower</code> and less |
| than or equal to <code>upper</code>.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/commons/math3/exception/NumberIsTooLargeException.html" title="class in org.apache.commons.math3.exception">NumberIsTooLargeException</a></code> - if <code>lower >= upper</code>.</dd></dl> |
| </li> |
| </ul> |
| <a name="nextSecureLong(long, long)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>nextSecureLong</h4> |
| <pre>long nextSecureLong(long lower, |
| long upper) |
| throws <a href="../../../../../org/apache/commons/math3/exception/NumberIsTooLargeException.html" title="class in org.apache.commons.math3.exception">NumberIsTooLargeException</a></pre> |
| <div class="block"><span class="strong">Deprecated.</span> </div> |
| <div class="block">Generates a uniformly distributed random long integer between |
| <code>lower</code> and <code>upper</code> (endpoints included) from a secure random |
| sequence. |
| <p> |
| Sequences of long values generated using this method will be |
| cryptographically secure. If cryptographic security is not required, |
| <a href="../../../../../org/apache/commons/math3/random/RandomData.html#nextLong(long, long)"><code>nextLong(long, long)</code></a> should be used instead of this method.</p> |
| <p> |
| <strong>Definition</strong>: |
| <a href="http://en.wikipedia.org/wiki/Cryptographically_secure_pseudo-random_number_generator"> |
| Secure Random Sequence</a></p></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>lower</code> - lower bound for generated integer</dd><dd><code>upper</code> - upper bound for generated integer</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a random long integer greater than or equal to <code>lower</code> and |
| less than or equal to <code>upper</code>.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/commons/math3/exception/NumberIsTooLargeException.html" title="class in org.apache.commons.math3.exception">NumberIsTooLargeException</a></code> - if <code>lower >= upper</code>.</dd></dl> |
| </li> |
| </ul> |
| <a name="nextPoisson(double)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>nextPoisson</h4> |
| <pre>long nextPoisson(double mean) |
| throws <a href="../../../../../org/apache/commons/math3/exception/NotStrictlyPositiveException.html" title="class in org.apache.commons.math3.exception">NotStrictlyPositiveException</a></pre> |
| <div class="block"><span class="strong">Deprecated.</span> </div> |
| <div class="block">Generates a random value from the Poisson distribution with the given |
| mean. |
| <p> |
| <strong>Definition</strong>: |
| <a href="http://www.itl.nist.gov/div898/handbook/eda/section3/eda366j.htm"> |
| Poisson Distribution</a></p></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>mean</code> - the mean of the Poisson distribution</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a random value following the specified Poisson distribution</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/commons/math3/exception/NotStrictlyPositiveException.html" title="class in org.apache.commons.math3.exception">NotStrictlyPositiveException</a></code> - if <code>mean <= 0</code>.</dd></dl> |
| </li> |
| </ul> |
| <a name="nextGaussian(double, double)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>nextGaussian</h4> |
| <pre>double nextGaussian(double mu, |
| double sigma) |
| throws <a href="../../../../../org/apache/commons/math3/exception/NotStrictlyPositiveException.html" title="class in org.apache.commons.math3.exception">NotStrictlyPositiveException</a></pre> |
| <div class="block"><span class="strong">Deprecated.</span> </div> |
| <div class="block">Generates a random value from the Normal (or Gaussian) distribution with |
| specified mean and standard deviation. |
| <p> |
| <strong>Definition</strong>: |
| <a href="http://www.itl.nist.gov/div898/handbook/eda/section3/eda3661.htm"> |
| Normal Distribution</a></p></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>mu</code> - the mean of the distribution</dd><dd><code>sigma</code> - the standard deviation of the distribution</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a random value following the specified Gaussian distribution</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/commons/math3/exception/NotStrictlyPositiveException.html" title="class in org.apache.commons.math3.exception">NotStrictlyPositiveException</a></code> - if <code>sigma <= 0</code>.</dd></dl> |
| </li> |
| </ul> |
| <a name="nextExponential(double)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>nextExponential</h4> |
| <pre>double nextExponential(double mean) |
| throws <a href="../../../../../org/apache/commons/math3/exception/NotStrictlyPositiveException.html" title="class in org.apache.commons.math3.exception">NotStrictlyPositiveException</a></pre> |
| <div class="block"><span class="strong">Deprecated.</span> </div> |
| <div class="block">Generates a random value from the exponential distribution |
| with specified mean. |
| <p> |
| <strong>Definition</strong>: |
| <a href="http://www.itl.nist.gov/div898/handbook/eda/section3/eda3667.htm"> |
| Exponential Distribution</a></p></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>mean</code> - the mean of the distribution</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a random value following the specified exponential distribution</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/commons/math3/exception/NotStrictlyPositiveException.html" title="class in org.apache.commons.math3.exception">NotStrictlyPositiveException</a></code> - if <code>mean <= 0</code>.</dd></dl> |
| </li> |
| </ul> |
| <a name="nextUniform(double, double)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>nextUniform</h4> |
| <pre>double nextUniform(double lower, |
| double upper) |
| throws <a href="../../../../../org/apache/commons/math3/exception/NumberIsTooLargeException.html" title="class in org.apache.commons.math3.exception">NumberIsTooLargeException</a>, |
| <a href="../../../../../org/apache/commons/math3/exception/NotFiniteNumberException.html" title="class in org.apache.commons.math3.exception">NotFiniteNumberException</a>, |
| <a href="../../../../../org/apache/commons/math3/exception/NotANumberException.html" title="class in org.apache.commons.math3.exception">NotANumberException</a></pre> |
| <div class="block"><span class="strong">Deprecated.</span> </div> |
| <div class="block">Generates a uniformly distributed random value from the open interval |
| <code>(lower, upper)</code> (i.e., endpoints excluded). |
| <p> |
| <strong>Definition</strong>: |
| <a href="http://www.itl.nist.gov/div898/handbook/eda/section3/eda3662.htm"> |
| Uniform Distribution</a> <code>lower</code> and <code>upper - lower</code> are the |
| <a href = "http://www.itl.nist.gov/div898/handbook/eda/section3/eda364.htm"> |
| location and scale parameters</a>, respectively.</p></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>lower</code> - the exclusive lower bound of the support</dd><dd><code>upper</code> - the exclusive upper bound of the support</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a uniformly distributed random value between lower and upper |
| (exclusive)</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/commons/math3/exception/NumberIsTooLargeException.html" title="class in org.apache.commons.math3.exception">NumberIsTooLargeException</a></code> - if <code>lower >= upper</code></dd> |
| <dd><code><a href="../../../../../org/apache/commons/math3/exception/NotFiniteNumberException.html" title="class in org.apache.commons.math3.exception">NotFiniteNumberException</a></code> - if one of the bounds is infinite</dd> |
| <dd><code><a href="../../../../../org/apache/commons/math3/exception/NotANumberException.html" title="class in org.apache.commons.math3.exception">NotANumberException</a></code> - if one of the bounds is NaN</dd></dl> |
| </li> |
| </ul> |
| <a name="nextUniform(double, double, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>nextUniform</h4> |
| <pre>double nextUniform(double lower, |
| double upper, |
| boolean lowerInclusive) |
| throws <a href="../../../../../org/apache/commons/math3/exception/NumberIsTooLargeException.html" title="class in org.apache.commons.math3.exception">NumberIsTooLargeException</a>, |
| <a href="../../../../../org/apache/commons/math3/exception/NotFiniteNumberException.html" title="class in org.apache.commons.math3.exception">NotFiniteNumberException</a>, |
| <a href="../../../../../org/apache/commons/math3/exception/NotANumberException.html" title="class in org.apache.commons.math3.exception">NotANumberException</a></pre> |
| <div class="block"><span class="strong">Deprecated.</span> </div> |
| <div class="block">Generates a uniformly distributed random value from the interval |
| <code>(lower, upper)</code> or the interval <code>[lower, upper)</code>. The lower |
| bound is thus optionally included, while the upper bound is always |
| excluded. |
| <p> |
| <strong>Definition</strong>: |
| <a href="http://www.itl.nist.gov/div898/handbook/eda/section3/eda3662.htm"> |
| Uniform Distribution</a> <code>lower</code> and <code>upper - lower</code> are the |
| <a href = "http://www.itl.nist.gov/div898/handbook/eda/section3/eda364.htm"> |
| location and scale parameters</a>, respectively.</p></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>lower</code> - the lower bound of the support</dd><dd><code>upper</code> - the exclusive upper bound of the support</dd><dd><code>lowerInclusive</code> - <code>true</code> if the lower bound is inclusive</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>uniformly distributed random value in the <code>(lower, upper)</code> |
| interval, if <code>lowerInclusive</code> is <code>false</code>, or in the |
| <code>[lower, upper)</code> interval, if <code>lowerInclusive</code> is |
| <code>true</code></dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/commons/math3/exception/NumberIsTooLargeException.html" title="class in org.apache.commons.math3.exception">NumberIsTooLargeException</a></code> - if <code>lower >= upper</code></dd> |
| <dd><code><a href="../../../../../org/apache/commons/math3/exception/NotFiniteNumberException.html" title="class in org.apache.commons.math3.exception">NotFiniteNumberException</a></code> - if one of the bounds is infinite</dd> |
| <dd><code><a href="../../../../../org/apache/commons/math3/exception/NotANumberException.html" title="class in org.apache.commons.math3.exception">NotANumberException</a></code> - if one of the bounds is NaN</dd></dl> |
| </li> |
| </ul> |
| <a name="nextPermutation(int, int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>nextPermutation</h4> |
| <pre>int[] nextPermutation(int n, |
| int k) |
| throws <a href="../../../../../org/apache/commons/math3/exception/NumberIsTooLargeException.html" title="class in org.apache.commons.math3.exception">NumberIsTooLargeException</a>, |
| <a href="../../../../../org/apache/commons/math3/exception/NotStrictlyPositiveException.html" title="class in org.apache.commons.math3.exception">NotStrictlyPositiveException</a></pre> |
| <div class="block"><span class="strong">Deprecated.</span> </div> |
| <div class="block">Generates an integer array of length <code>k</code> whose entries are selected |
| randomly, without repetition, from the integers <code>0, ..., n - 1</code> |
| (inclusive). |
| <p> |
| Generated arrays represent permutations of <code>n</code> taken <code>k</code> at a |
| time.</p></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>n</code> - the domain of the permutation</dd><dd><code>k</code> - the size of the permutation</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a random <code>k</code>-permutation of <code>n</code>, as an array of |
| integers</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/commons/math3/exception/NumberIsTooLargeException.html" title="class in org.apache.commons.math3.exception">NumberIsTooLargeException</a></code> - if <code>k > n</code>.</dd> |
| <dd><code><a href="../../../../../org/apache/commons/math3/exception/NotStrictlyPositiveException.html" title="class in org.apache.commons.math3.exception">NotStrictlyPositiveException</a></code> - if <code>k <= 0</code>.</dd></dl> |
| </li> |
| </ul> |
| <a name="nextSample(java.util.Collection, int)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>nextSample</h4> |
| <pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>[] nextSample(<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><?> c, |
| int k) |
| throws <a href="../../../../../org/apache/commons/math3/exception/NumberIsTooLargeException.html" title="class in org.apache.commons.math3.exception">NumberIsTooLargeException</a>, |
| <a href="../../../../../org/apache/commons/math3/exception/NotStrictlyPositiveException.html" title="class in org.apache.commons.math3.exception">NotStrictlyPositiveException</a></pre> |
| <div class="block"><span class="strong">Deprecated.</span> </div> |
| <div class="block">Returns an array of <code>k</code> objects selected randomly from the |
| Collection <code>c</code>. |
| <p> |
| Sampling from <code>c</code> is without replacement; but if <code>c</code> contains |
| identical objects, the sample may include repeats. If all elements of |
| <code>c</code> are distinct, the resulting object array represents a |
| <a href="http://rkb.home.cern.ch/rkb/AN16pp/node250.html#SECTION0002500000000000000000"> |
| Simple Random Sample</a> of size <code>k</code> from the elements of |
| <code>c</code>.</p></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>c</code> - the collection to be sampled</dd><dd><code>k</code> - the size of the sample</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a random sample of <code>k</code> elements from <code>c</code></dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/commons/math3/exception/NumberIsTooLargeException.html" title="class in org.apache.commons.math3.exception">NumberIsTooLargeException</a></code> - if <code>k > c.size()</code>.</dd> |
| <dd><code><a href="../../../../../org/apache/commons/math3/exception/NotStrictlyPositiveException.html" title="class in org.apache.commons.math3.exception">NotStrictlyPositiveException</a></code> - if <code>k <= 0</code>.</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/RandomData.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><em><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script></em></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/commons/math3/random/RandomAdaptor.html" title="class in org.apache.commons.math3.random"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/commons/math3/random/RandomDataGenerator.html" title="class in org.apache.commons.math3.random"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/commons/math3/random/RandomData.html" target="_top">Frames</a></li> |
| <li><a href="RandomData.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2003–2014 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |