blob: fc875aafc06bb683168f1a8a95018f1004bf11a6 [file] [log] [blame]
<!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 (1.8.0_262) on Thu Oct 29 15:52:03 GMT 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>RandomNumberGenerator (Eclipse MOSAIC Parent 20.0 API)</title>
<meta name="date" content="2020-10-29">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="RandomNumberGenerator (Eclipse MOSAIC Parent 20.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":18,"i1":6,"i2":18,"i3":6,"i4":18,"i5":18,"i6":18,"i7":18,"i8":18,"i9":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= 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/RandomNumberGenerator.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/eclipse/mosaic/lib/math/MeanErrorAggregator.html" title="class in org.eclipse.mosaic.lib.math"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/eclipse/mosaic/lib/math/SpeedUtils.html" title="class in org.eclipse.mosaic.lib.math"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/mosaic/lib/math/RandomNumberGenerator.html" target="_top">Frames</a></li>
<li><a href="RandomNumberGenerator.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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.eclipse.mosaic.lib.math</div>
<h2 title="Interface RandomNumberGenerator" class="title">Interface RandomNumberGenerator</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/eclipse/mosaic/lib/math/DefaultRandomNumberGenerator.html" title="class in org.eclipse.mosaic.lib.math">DefaultRandomNumberGenerator</a>, <a href="../../../../../org/eclipse/mosaic/lib/math/KissRandomNumberGenerator.html" title="class in org.eclipse.mosaic.lib.math">KissRandomNumberGenerator</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">RandomNumberGenerator</span></pre>
</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>default boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/lib/math/RandomNumberGenerator.html#nextBoolean--">nextBoolean</a></span>()</code>
<div class="block">Returns a random boolean.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/lib/math/RandomNumberGenerator.html#nextDouble--">nextDouble</a></span>()</code>
<div class="block">Returns a random double between 0 and 1.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>default double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/lib/math/RandomNumberGenerator.html#nextDouble-double-double-">nextDouble</a></span>(double&nbsp;min,
double&nbsp;max)</code>
<div class="block">Returns a random double within the specified range.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/lib/math/RandomNumberGenerator.html#nextGaussian--">nextGaussian</a></span>()</code>
<div class="block">Returns a Gaussian distributed random double between -1.0 and 1.0.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>default double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/lib/math/RandomNumberGenerator.html#nextGaussian-double-double-">nextGaussian</a></span>(double&nbsp;mean,
double&nbsp;deviation)</code>
<div class="block">Returns a Gaussian distributed random double from [mean - deviation * mean, mean + deviation * mean].</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>default int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/lib/math/RandomNumberGenerator.html#nextInt--">nextInt</a></span>()</code>
<div class="block">Returns a random integer;</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>default int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/lib/math/RandomNumberGenerator.html#nextInt-int-">nextInt</a></span>(int&nbsp;max)</code>
<div class="block">Returns a random integer within the specified range.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>default int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/lib/math/RandomNumberGenerator.html#nextInt-int-int-">nextInt</a></span>(int&nbsp;min,
int&nbsp;max)</code>
<div class="block">Returns a random integer within the specified range.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>default long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/lib/math/RandomNumberGenerator.html#nextLong-long-long-">nextLong</a></span>(long&nbsp;min,
long&nbsp;max)</code>
<div class="block">Returns a random long within the specified range.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/eclipse/mosaic/lib/math/RandomNumberGenerator.html#shuffle-java.util.List-">shuffle</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;?&gt;&nbsp;list)</code>
<div class="block">Randomly permutes the specified list using this source of randomness.</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="nextDouble--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nextDouble</h4>
<pre>double&nbsp;nextDouble()</pre>
<div class="block">Returns a random double between 0 and 1.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the random double</dd>
</dl>
</li>
</ul>
<a name="nextDouble-double-double-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nextDouble</h4>
<pre>default&nbsp;double&nbsp;nextDouble(double&nbsp;min,
double&nbsp;max)</pre>
<div class="block">Returns a random double within the specified range.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>min</code> - the smallest value that can be returned (inclusive)</dd>
<dd><code>max</code> - the greatest value that can be returned (exclusive)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the random double</dd>
</dl>
</li>
</ul>
<a name="nextInt--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nextInt</h4>
<pre>default&nbsp;int&nbsp;nextInt()</pre>
<div class="block">Returns a random integer;</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the random int</dd>
</dl>
</li>
</ul>
<a name="nextInt-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nextInt</h4>
<pre>default&nbsp;int&nbsp;nextInt(int&nbsp;max)</pre>
<div class="block">Returns a random integer within the specified range.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>max</code> - the greatest value that can be returned (exclusive)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the random int</dd>
</dl>
</li>
</ul>
<a name="nextInt-int-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nextInt</h4>
<pre>default&nbsp;int&nbsp;nextInt(int&nbsp;min,
int&nbsp;max)</pre>
<div class="block">Returns a random integer within the specified range.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>min</code> - the smallest value that can be returned (inclusive)</dd>
<dd><code>max</code> - the greatest value that can be returned (exclusive)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the random int</dd>
</dl>
</li>
</ul>
<a name="nextLong-long-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nextLong</h4>
<pre>default&nbsp;long&nbsp;nextLong(long&nbsp;min,
long&nbsp;max)</pre>
<div class="block">Returns a random long within the specified range.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>min</code> - the smallest value that can be returned (inclusive)</dd>
<dd><code>max</code> - the greatest value that can be returned (exclusive)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the random long</dd>
</dl>
</li>
</ul>
<a name="nextBoolean--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nextBoolean</h4>
<pre>default&nbsp;boolean&nbsp;nextBoolean()</pre>
<div class="block">Returns a random boolean.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the random boolean</dd>
</dl>
</li>
</ul>
<a name="nextGaussian--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nextGaussian</h4>
<pre>double&nbsp;nextGaussian()</pre>
<div class="block">Returns a Gaussian distributed random double between -1.0 and 1.0.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the Gaussian distributed random double</dd>
</dl>
</li>
</ul>
<a name="nextGaussian-double-double-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nextGaussian</h4>
<pre>default&nbsp;double&nbsp;nextGaussian(double&nbsp;mean,
double&nbsp;deviation)</pre>
<div class="block">Returns a Gaussian distributed random double from [mean - deviation * mean, mean + deviation * mean].</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mean</code> - the mean value of the distribution</dd>
<dd><code>deviation</code> - the standard deviation of the distribution</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the Gaussian distributed random double</dd>
</dl>
</li>
</ul>
<a name="shuffle-java.util.List-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>shuffle</h4>
<pre>void&nbsp;shuffle(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;?&gt;&nbsp;list)</pre>
<div class="block">Randomly permutes the specified list using this source of randomness.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>list</code> - the list to permute</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/RandomNumberGenerator.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/eclipse/mosaic/lib/math/MeanErrorAggregator.html" title="class in org.eclipse.mosaic.lib.math"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/eclipse/mosaic/lib/math/SpeedUtils.html" title="class in org.eclipse.mosaic.lib.math"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/eclipse/mosaic/lib/math/RandomNumberGenerator.html" target="_top">Frames</a></li>
<li><a href="RandomNumberGenerator.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 &#169; 2020 <a href="https://www.fokus.fraunhofer.de/">Fraunhofer FOKUS</a>. All rights reserved.</small></p>
</body>
</html>