xethya-random-bbs
Version:
An implementation of the Blum Blum Shub PRNG.
568 lines (143 loc) • 6.29 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: BlumBlumShub</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: BlumBlumShub</h1>
<section>
<header>
<h2>BlumBlumShub</h2>
<div class="class-description">Instantiates a Blum Blum Shub PRNG.</div>
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="BlumBlumShub"><span class="type-signature"></span>new BlumBlumShub<span class="signature">(p, q, seedNumber)</span><span class="type-signature"></span></h4>
<div class="description">
Initializes the generator.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>p</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">A prime value (defaults to P).</td>
</tr>
<tr>
<td class="name"><code>q</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">A prime value (defaults to Q).</td>
</tr>
<tr>
<td class="name"><code>seedNumber</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">A seed number to feed the generator (defaults to any value
in DefaultSeeds).</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="BlumBlumShub.js.html">BlumBlumShub.js</a>, <a href="BlumBlumShub.js.html#line34">line 34</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id=".recommendsToReinstantiate"><span class="type-signature">(static) </span>recommendsToReinstantiate<span class="signature">()</span><span class="type-signature"> → {Boolean}</span></h4>
<div class="description">
Determines if the generator works better by being reinstantiated after
every generated number.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="BlumBlumShub.js.html">BlumBlumShub.js</a>, <a href="BlumBlumShub.js.html#line77">line 77</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Boolean</span>
</dd>
</dl>
<h4 class="name" id="generateRandom"><span class="type-signature"></span>generateRandom<span class="signature">()</span><span class="type-signature"> → {Number}</span></h4>
<div class="description">
Generates a pseudo-random number and updates the seed for a next roll.
Number is always between 0 and 1.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="BlumBlumShub.js.html">BlumBlumShub.js</a>, <a href="BlumBlumShub.js.html#line87">line 87</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Number</span>
</dd>
</dl>
<h4 class="name" id="generateRandomInteger"><span class="type-signature"></span>generateRandomInteger<span class="signature">()</span><span class="type-signature"> → {Number}</span></h4>
<div class="description">
Same as `generateRandom()`, but converts the number to an Integer.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="BlumBlumShub.js.html">BlumBlumShub.js</a>, <a href="BlumBlumShub.js.html#line98">line 98</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Number</span>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BlumBlumShub.html">BlumBlumShub</a></li></ul><h3>Global</h3><ul><li><a href="global.html#DefaultSeeds">DefaultSeeds</a></li><li><a href="global.html#P">P</a></li><li><a href="global.html#Q">Q</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.1</a> on Sun Sep 18 2016 12:08:21 GMT-0300 (ART)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>