<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Class: Counter</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: Counter</h1> <section> <header> <h2> <span class="ancestors"><a href="module-Counter.html">Counter</a>~</span>Counter</h2> <div class="class-description">Class representing allocatable and deallocatable counters Counters are allocated in sequential manner, this applies to deallocated counters Once a counter is deallocated, it will be reused on the next allocation</div> </header> <article> <div class="container-overview"> <h2>Constructor</h2> <h4 class="name" id="Counter"><span class="type-signature"></span>new Counter<span class="signature">(begin<span class="signature-attributes">opt</span>, blockSize<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> Creates a counter instance </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>begin</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">Defaults to 0</td> </tr> <tr> <td class="name"><code>blockSize</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last">Must be a multiple of 32, defaults to 32</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Counter.js.html">Counter.js</a>, <a href="Counter.js.html#line336">line 336</a> </li></ul></dd> </dl> </div> <h3 class="subsection-title">Methods</h3> <h4 class="name" id="allocate"><span class="type-signature"></span>allocate<span class="signature">(counter<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {number|boolean}</span></h4> <div class="description"> Allocates a counter sequentially If a counter is specified, it will allocate it explicitly But it will skip over intermediate children, and subsequent allocations is still sequential </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>counter</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Counter.js.html">Counter.js</a>, <a href="Counter.js.html#line365">line 365</a> </li></ul></dd> </dl> <h5>Throws:</h5> <dl> <dt> <div class="param-desc"> - Will throw if the explicitly allocated counter is out of bounds </div> </dt> <dd></dd> <dt> <dl> <dt> Type </dt> <dd> <span class="param-type">RangeError</span> </dd> </dl> </dt> <dd></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">number</span> | <span class="param-type">boolean</span> </dd> </dl> <h4 class="name" id="check"><span class="type-signature"></span>check<span class="signature">(counter)</span><span class="type-signature"> → {boolean}</span></h4> <div class="description"> Checks if a number has been allocated or not </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>counter</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Counter.js.html">Counter.js</a>, <a href="Counter.js.html#line418">line 418</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="deallocate"><span class="type-signature"></span>deallocate<span class="signature">(counter)</span><span class="type-signature"> → {boolean}</span></h4> <div class="description"> Deallocates a number, it makes it available for reuse </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>counter</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="Counter.js.html">Counter.js</a>, <a href="Counter.js.html#line400">line 400</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">boolean</span> </dd> </dl> </article> </section> </div> <nav> <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Counter.html">Counter</a></li></ul><h3>Classes</h3><ul><li><a href="module-Counter-BitMapTree.html">BitMapTree</a></li><li><a href="module-Counter-Counter.html">Counter</a></li><li><a href="module-Counter-Leaf.html">Leaf</a></li><li><a href="module-Counter-Node.html">Node</a></li></ul> </nav> <br class="clear"> <footer> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Thu Jan 25 2018 22:15:24 GMT+1100 (AEDT) </footer> <script> prettyPrint(); </script> <script src="scripts/linenumber.js"> </script> </body> </html>