cell-bitset
Version:
Fast JS BitSet implementation. Beyond 32bit restrictions.
888 lines • 155 kB
HTML
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>BitSet | cell-bitset</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">cell-bitset</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../globals.html">Globals</a>
</li>
<li>
<a href="../modules/_bitset_.html">"BitSet"</a>
</li>
<li>
<a href="_bitset_.bitset.html">BitSet</a>
</li>
</ul>
<h1>Class BitSet</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Fast JS BitSet implementation. Beyond 32bit restrictions.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">BitSet</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_bitset_.bitset.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_bitset_.bitset.html#___tostringtag" class="tsd-kind-icon">__@to<wbr>String<wbr>Tag</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_bitset_.bitset.html#_length" class="tsd-kind-icon">_length</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_bitset_.bitset.html#words" class="tsd-kind-icon">words</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="_bitset_.bitset.html#___species" class="tsd-kind-icon">__@species</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="_bitset_.bitset.html#cardinality" class="tsd-kind-icon">cardinality</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="_bitset_.bitset.html#length" class="tsd-kind-icon">length</a></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="_bitset_.bitset.html#size" class="tsd-kind-icon">size</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#and" class="tsd-kind-icon">And</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#complement" class="tsd-kind-icon">Complement</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#difference" class="tsd-kind-icon">Difference</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#exclusion" class="tsd-kind-icon">Exclusion</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#intersection" class="tsd-kind-icon">Intersection</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#or" class="tsd-kind-icon">Or</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#symmetricdifference" class="tsd-kind-icon">Symmetric<wbr>Difference</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#union" class="tsd-kind-icon">Union</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#xor" class="tsd-kind-icon">XOR</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#___iterator" class="tsd-kind-icon">__@iterator</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#add" class="tsd-kind-icon">add</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#and-1" class="tsd-kind-icon">and</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#clear" class="tsd-kind-icon">clear</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#clone" class="tsd-kind-icon">clone</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#complement-1" class="tsd-kind-icon">complement</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#contains" class="tsd-kind-icon">contains</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#del" class="tsd-kind-icon">del</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#difference-1" class="tsd-kind-icon">difference</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#each" class="tsd-kind-icon">each</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#eachall" class="tsd-kind-icon">each<wbr>All</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#entries" class="tsd-kind-icon">entries</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#equals" class="tsd-kind-icon">equals</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#exclusion-1" class="tsd-kind-icon">exclusion</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#fits" class="tsd-kind-icon">fits</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#flip" class="tsd-kind-icon">flip</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#foreach" class="tsd-kind-icon">for<wbr>Each</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#foreachall" class="tsd-kind-icon">for<wbr>Each<wbr>All</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#get" class="tsd-kind-icon">get</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#has" class="tsd-kind-icon">has</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#init" class="tsd-kind-icon">init</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#intersection-1" class="tsd-kind-icon">intersection</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#intersects" class="tsd-kind-icon">intersects</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#iscontainedin" class="tsd-kind-icon">is<wbr>Contained<wbr>In</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#isempty" class="tsd-kind-icon">is<wbr>Empty</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#ismember" class="tsd-kind-icon">is<wbr>Member</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#issubsetof" class="tsd-kind-icon">is<wbr>Subset<wbr>Of</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#keys" class="tsd-kind-icon">keys</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#lsb" class="tsd-kind-icon">lsb</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#max" class="tsd-kind-icon">max</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#min" class="tsd-kind-icon">min</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#msb" class="tsd-kind-icon">msb</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#or-1" class="tsd-kind-icon">or</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#remove" class="tsd-kind-icon">remove</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#resize" class="tsd-kind-icon">resize</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#set" class="tsd-kind-icon">set</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#stringify" class="tsd-kind-icon">stringify</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#symmetricdifference-1" class="tsd-kind-icon">symmetric<wbr>Difference</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#toarray" class="tsd-kind-icon">to<wbr>Array</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#tobitarray" class="tsd-kind-icon">to<wbr>Bit<wbr>Array</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#tobitstring" class="tsd-kind-icon">to<wbr>Bit<wbr>String</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#tobooleanarray" class="tsd-kind-icon">to<wbr>Boolean<wbr>Array</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#tostring" class="tsd-kind-icon">to<wbr>String</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#trim" class="tsd-kind-icon">trim</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#trimtrailingbits" class="tsd-kind-icon">trim<wbr>Trailing<wbr>Bits</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#union-1" class="tsd-kind-icon">union</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#values" class="tsd-kind-icon">values</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_bitset_.bitset.html#xor-1" class="tsd-kind-icon">xor</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_bitset_.bitset.html#create" class="tsd-kind-icon">create</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_bitset_.bitset.html#hammingweight" class="tsd-kind-icon">hamming<wbr>Weight</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_bitset_.bitset.html#lsb-1" class="tsd-kind-icon">lsb</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_bitset_.bitset.html#msb-1" class="tsd-kind-icon">msb</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_bitset_.bitset.html#popcount" class="tsd-kind-icon">pop<wbr>Count</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_bitset_.bitset.html#spawn" class="tsd-kind-icon">spawn</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Object literals</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-object-literal tsd-parent-kind-class tsd-is-static"><a href="_bitset_.bitset.html#info" class="tsd-kind-icon">info</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Bit<wbr>Set<span class="tsd-signature-symbol">(</span>indices_length<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Iterable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/unnoon/cell-bitset/blob/535b20a/src/BitSet.ts#L126">BitSet.ts:126</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>BitSet constructor.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> indices_length: <span class="tsd-signature-type">Iterable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = WORD_SIZE</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Length for the underlying bitvector or an Iterable<number> with indices.</p>
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a></h4>
<p>a new BitSet.</p>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="___tostringtag" class="tsd-anchor"></a>
<h3>__@to<wbr>String<wbr>Tag</h3>
<div class="tsd-signature tsd-kind-icon">__@to<wbr>String<wbr>Tag<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "BitSet"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/unnoon/cell-bitset/blob/535b20a/src/BitSet.ts#L118">BitSet.ts:118</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Custom name for Object.prototype.toString.call(bitset) === [object BitSet]</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="_length" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _length</h3>
<div class="tsd-signature tsd-kind-icon">_length<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/unnoon/cell-bitset/blob/535b20a/src/BitSet.ts#L126">BitSet.ts:126</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="words" class="tsd-anchor"></a>
<h3>words</h3>
<div class="tsd-signature tsd-kind-icon">words<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Int32Array</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/unnoon/cell-bitset/blob/535b20a/src/BitSet.ts#L123">BitSet.ts:123</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Array of 32bit words.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static">
<a name="___species" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> __@species</h3>
<div class="tsd-signature tsd-kind-icon">__@species<span class="tsd-signature-symbol">:</span> <a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a><span class="tsd-signature-symbol"> = BitSet</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/unnoon/cell-bitset/blob/535b20a/src/BitSet.ts#L41">BitSet.ts:41</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The species of the BitSet. Which is just the BitSet constructor.</p>
</div>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
<a name="cardinality" class="tsd-anchor"></a>
<h3>cardinality</h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> cardinality<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> cardinality<span class="tsd-signature-symbol">(</span>v<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/unnoon/cell-bitset/blob/535b20a/src/BitSet.ts#L159">BitSet.ts:159</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Getter for the cardinality of the set. In case of a set it will return a warning.</p>
</div>
<dl class="tsd-comment-tags">
<dt>aliases:</dt>
<dd><p><a href="_bitset_.bitset.html#size">size</a></p>
</dd>
<dt>readonly</dt>
<dd></dd>
<dt>type</dt>
<dd><p>number</p>
</dd>
</dl>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/unnoon/cell-bitset/blob/535b20a/src/BitSet.ts#L159">BitSet.ts:159</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Getter for the cardinality of the set. In case of a set it will return a warning.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>v: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
<a name="length" class="tsd-anchor"></a>
<h3>length</h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> length<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> length<span class="tsd-signature-symbol">(</span>v<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/unnoon/cell-bitset/blob/535b20a/src/BitSet.ts#L643">BitSet.ts:643</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Getter for the length of the underlying bitvector.
In case of a set it will return a warning.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/unnoon/cell-bitset/blob/535b20a/src/BitSet.ts#L647">BitSet.ts:647</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Getter for the length of the underlying bitvector.
In case of a set it will return a warning.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>v: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
<a name="size" class="tsd-anchor"></a>
<h3>size</h3>
<ul class="tsd-signatures tsd-kind-accessor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> size<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> size<span class="tsd-signature-symbol">(</span>v<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/unnoon/cell-bitset/blob/535b20a/src/BitSet.ts#L161">BitSet.ts:161</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Alias of <a href="_bitset_.bitset.html#cardinality">cardinality</a></p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/unnoon/cell-bitset/blob/535b20a/src/BitSet.ts#L174">BitSet.ts:174</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Alias of <a href="_bitset_.bitset.html#cardinality">cardinality</a></p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>v: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="and" class="tsd-anchor"></a>
<h3>And</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">And<span class="tsd-signature-symbol">(</span>bitset<span class="tsd-signature-symbol">: </span><a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/unnoon/cell-bitset/blob/535b20a/src/BitSet.ts#L570">BitSet.ts:570</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Alias of <a href="_bitset_.bitset.html#intersection">Intersection</a></p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>bitset: <a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="complement" class="tsd-anchor"></a>
<h3>Complement</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">Complement<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/unnoon/cell-bitset/blob/535b20a/src/BitSet.ts#L253">BitSet.ts:253</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Calculates the inverse of the set. Any trailing bits outside the length bound will be set to 0.
The result will be a new instance of a BitSet.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a></h4>
<p>a new BitSet of the complement.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="difference" class="tsd-anchor"></a>
<h3>Difference</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">Difference<span class="tsd-signature-symbol">(</span>bitset<span class="tsd-signature-symbol">: </span><a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/unnoon/cell-bitset/blob/535b20a/src/BitSet.ts#L315">BitSet.ts:315</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Calculates the difference between 2 bitsets.
The result will be a new instance of BitSet.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>bitset: <a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a></h5>
<div class="tsd-comment tsd-typography">
<p>The bit set to subtract from the current one.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a></h4>
<p>a new BitSet of the difference.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="exclusion" class="tsd-anchor"></a>
<h3>Exclusion</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">Exclusion<span class="tsd-signature-symbol">(</span>bitset<span class="tsd-signature-symbol">: </span><a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/unnoon/cell-bitset/blob/535b20a/src/BitSet.ts#L454">BitSet.ts:454</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Calculates the exclusion/symmetric difference between to bitsets.
The result is a new instance of BitSet.</p>
</div>
<dl class="tsd-comment-tags">
<dt>aliases:</dt>
<dd><p><a href="_bitset_.bitset.html#symmetricdifference">SymmetricDifference</a>, <a href="_bitset_.bitset.html#xor">XOR</a></p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>bitset: <a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a></h5>
<div class="tsd-comment tsd-typography">
<p>The bitset to calculate the symmetric difference with.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a></h4>
<p>a new BitSet of the exclusion.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="intersection" class="tsd-anchor"></a>
<h3>Intersection</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">Intersection<span class="tsd-signature-symbol">(</span>bitset<span class="tsd-signature-symbol">: </span><a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/unnoon/cell-bitset/blob/535b20a/src/BitSet.ts#L568">BitSet.ts:568</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Calculates the intersection between two bitsets.
The result is a new instance of BitSet.</p>
</div>
<dl class="tsd-comment-tags">
<dt>aliases:</dt>
<dd><p><a href="_bitset_.bitset.html#and">And</a></p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>bitset: <a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a></h5>
<div class="tsd-comment tsd-typography">
<p>The bitset to calculate the intersection with.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a></h4>
<p>a new bitset intersection.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="or" class="tsd-anchor"></a>
<h3>Or</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">Or<span class="tsd-signature-symbol">(</span>bitset<span class="tsd-signature-symbol">: </span><a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/unnoon/cell-bitset/blob/535b20a/src/BitSet.ts#L962">BitSet.ts:962</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Alias of <a href="_bitset_.bitset.html#union">Union</a></p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>bitset: <a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="symmetricdifference" class="tsd-anchor"></a>
<h3>Symmetric<wbr>Difference</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">Symmetric<wbr>Difference<span class="tsd-signature-symbol">(</span>bitset<span class="tsd-signature-symbol">: </span><a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/unnoon/cell-bitset/blob/535b20a/src/BitSet.ts#L456">BitSet.ts:456</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Alias of <a href="_bitset_.bitset.html#exclusion">Exclusion</a></p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>bitset: <a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="union" class="tsd-anchor"></a>
<h3>Union</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">Union<span class="tsd-signature-symbol">(</span>bitset<span class="tsd-signature-symbol">: </span><a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/unnoon/cell-bitset/blob/535b20a/src/BitSet.ts#L960">BitSet.ts:960</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Calculates the union between 2 bitsets.
The result is a new BitSet.</p>
</div>
<dl class="tsd-comment-tags">
<dt>aliases:</dt>
<dd><p><a href="_bitset_.bitset.html#or">Or</a></p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>bitset: <a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a></h5>
<div class="tsd-comment tsd-typography">
<p>Bitset to calculate the union with.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a></h4>
<p>a new BitSet of the union of the two bitsets.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="xor" class="tsd-anchor"></a>
<h3>XOR</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">XOR<span class="tsd-signature-symbol">(</span>bitset<span class="tsd-signature-symbol">: </span><a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/unnoon/cell-bitset/blob/535b20a/src/BitSet.ts#L458">BitSet.ts:458</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Alias of <a href="_bitset_.bitset.html#exclusion">Exclusion</a></p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>bitset: <a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="___iterator" class="tsd-anchor"></a>
<h3>__@iterator</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">__@iterator<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IterableIterator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/unnoon/cell-bitset/blob/535b20a/src/BitSet.ts#L146">BitSet.ts:146</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Prototype Symbol.iterator to make BitSet iterable.
Returns a new Iterator object that contains the indices in the BitSet object.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IterableIterator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4>
<p>iterable iterator containing the indices.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="add" class="tsd-anchor"></a>
<h3>add</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">add<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>indices<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/unnoon/cell-bitset/blob/535b20a/src/BitSet.ts#L186">BitSet.ts:186</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Adds numbers(indices) to the set. It will resize the set in case the index falls out of bounds.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>indices: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography">
<p>Indices/numbers to add to the set.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a></h4>
<p>this.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="and-1" class="tsd-anchor"></a>
<h3>and</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">and<span class="tsd-signature-symbol">(</span>bitset<span class="tsd-signature-symbol">: </span><a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/unnoon/cell-bitset/blob/535b20a/src/BitSet.ts#L545">BitSet.ts:545</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Alias of <a href="_bitset_.bitset.html#intersection-1">intersection</a></p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>bitset: <a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="clear" class="tsd-anchor"></a>
<h3>clear</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">clear<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/unnoon/cell-bitset/blob/535b20a/src/BitSet.ts#L201">BitSet.ts:201</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Clears the bitset. Length will be maintained.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a></h4>
<p>this.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="clone" class="tsd-anchor"></a>
<h3>clone</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">clone<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/unnoon/cell-bitset/blob/535b20a/src/BitSet.ts#L217">BitSet.ts:217</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Creates a clone of the bitset.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a></h4>
<p>clone.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="complement-1" class="tsd-anchor"></a>
<h3>complement</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">complement<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/unnoon/cell-bitset/blob/535b20a/src/BitSet.ts#L232">BitSet.ts:232</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Calculates the inverse of the set. Any trailing bits outside the length bound will be set to 0.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a></h4>
<p>this.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="contains" class="tsd-anchor"></a>
<h3>contains</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">contains<span class="tsd-signature-symbol">(</span>mask<span class="tsd-signature-symbol">: </span><a href="_bitset_.bitset.html" class="tsd-signature-type">BitSet</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/unnoon/cell-bitset/blob/535b20a/src/BitSet.ts#L268">BitSet.ts:268</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Calculates if the bitset contains a certain bitset.
In bitmask terms it will calculate if a bitmask fits a bitset.</p>
</div>
<dl class="tsd-comment-tags">
<dt>aliases:</dt>
<dd><p><a href="_bitset_.bitset.html#fits">fits</a></p>
</dd>
</dl>
</