<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: BitMapTree</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: BitMapTree</h1>
<section>
<header>
<h2>
<span class="ancestors"><a href="module-Counter.html">Counter</a>~</span>BitMapTree</h2>
<div class="class-description">Class representing a lazy recursive bitmap tree
Only the leaf bitmaps correspond to counters
Interior bitmaps index their child bitmaps
If an interior bit is set, that means there's no free bits in the child bitmap
If an interior bit is not set, that means there's at least 1 free bit in the child bitmap</div>
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="BitMapTree"><span class="type-signature"></span>new BitMapTree<span class="signature">(begin, depth)</span><span class="type-signature"></span></h4>
<div class="description">
Creates a BitMapTree, this is an abstract class
It is not meant to by directly instantiated
</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>begin</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>depth</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#line88">line 88</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="set"><span class="type-signature"></span>set<span class="signature">(index)</span><span class="type-signature"></span></h4>
<div class="description">
Sets a bit to allocated
</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>index</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#line106">line 106</a>
</li></ul></dd>
</dl>
<h4 class="name" id="unset"><span class="type-signature"></span>unset<span class="signature">(index)</span><span class="type-signature"></span></h4>
<div class="description">
Unsets a bit so that is free
</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>index</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#line114">line 114</a>
</li></ul></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 Jun 22 2017 18:16:31 GMT+1000 (AEST)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>