mirrors/CyberChef
1
0
Fork 0
mirror of https://github.com/gchq/CyberChef.git synced 2025-04-20 14:56:19 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
CyberChef/docs/BitwiseOp.html

3501 lines
42 KiB
HTML
Raw Normal View History

Initial pages commit
2016-11-28 11:01:54 +00:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width">
<title>CyberChef Namespace: BitwiseOp</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.cerulean.css">
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top navbar-inverse">
<div class="container">
<div class="navbar-header">
<a class="navbar-brand" href="index.html"><img class="branding-logo" src="../build/prod/images/cyberchef-32x32.png"
alt="logo"/>CyberChef</a>
<button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
</div>
<div class="navbar-collapse collapse" id="topNavigation">
<ul class="nav navbar-nav">
<li class="dropdown">
<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a>
<ul class="dropdown-menu inline">
<li><a href="FlowControl.html">FlowControl</a></li><li><a href="Utils.html">Utils</a></li><li><a href="Base.html">Base</a></li><li><a href="Base64.html">Base64</a></li><li><a href="BitwiseOp.html">BitwiseOp</a></li><li><a href="ByteRepr.html">ByteRepr</a></li><li><a href="CharEnc.html">CharEnc</a></li><li><a href="Checksum.html">Checksum</a></li><li><a href="Cipher.html">Cipher</a></li><li><a href="Code.html">Code</a></li><li><a href="Compress.html">Compress</a></li><li><a href="Convert.html">Convert</a></li><li><a href="DateTime.html">DateTime</a></li><li><a href="Endian.html">Endian</a></li><li><a href="Entropy.html">Entropy</a></li><li><a href="Extract.html">Extract</a></li><li><a href="FileType.html">FileType</a></li><li><a href="HTML.html">HTML</a></li><li><a href="HTTP.html">HTTP</a></li><li><a href="Hash.html">Hash</a></li><li><a href="Hexdump.html">Hexdump</a></li><li><a href="IP.html">IP</a></li><li><a href="JS.html">JS</a></li><li><a href="MAC.html">MAC</a></li><li><a href="Numberwang.html">Numberwang</a></li><li><a href="OS.html">OS</a></li><li><a href="PublicKey.html">PublicKey</a></li><li><a href="Punycode.html">Punycode</a></li><li><a href="QuotedPrintable.html">QuotedPrintable</a></li><li><a href="Rotate.html">Rotate</a></li><li><a href="SeqUtils.html">SeqUtils</a></li><li><a href="StrUtils.html">StrUtils</a></li><li><a href="Tidy.html">Tidy</a></li><li><a href="URL_.html">URL_</a></li><li><a href="UUID.html">UUID</a></li><li><a href="Unicode.html">Unicode</a></li>
</ul>
</li>
<li class="dropdown">
<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
<ul class="dropdown-menu inline">
<li><a href="Chef.html">Chef</a></li><li><a href="Dish.html">Dish</a></li><li><a href="Ingredient.html">Ingredient</a></li><li><a href="Operation.html">Operation</a></li><li><a href="Recipe.html">Recipe</a></li><li><a href="ControlsWaiter.html">ControlsWaiter</a></li><li><a href="HTMLApp.html">HTMLApp</a></li><li><a href="HTMLCategory.html">HTMLCategory</a></li><li><a href="HTMLIngredient.html">HTMLIngredient</a></li><li><a href="HTMLOperation.html">HTMLOperation</a></li><li><a href="HighlighterWaiter.html">HighlighterWaiter</a></li><li><a href="InputWaiter.html">InputWaiter</a></li><li><a href="Manager.html">Manager</a></li><li><a href="OperationsWaiter.html">OperationsWaiter</a></li><li><a href="OptionsWaiter.html">OptionsWaiter</a></li><li><a href="OutputWaiter.html">OutputWaiter</a></li><li><a href="RecipeWaiter.html">RecipeWaiter</a></li><li><a href="SeasonalWaiter.html">SeasonalWaiter</a></li><li><a href="WindowWaiter.html">WindowWaiter</a></li>
</ul>
</li>
<li class="dropdown">
<a href="events.list.html" class="dropdown-toggle" data-toggle="dropdown">Events<b class="caret"></b></a>
<ul class="dropdown-menu inline">
<li><a href="Manager.html#event:appstart">Manager#event:appstart</a></li><li><a href="Manager.html#event:operationadd">Manager#event:operationadd</a></li><li><a href="Manager.html#event:operationremove">Manager#event:operationremove</a></li><li><a href="Manager.html#event:oplistcreate">Manager#event:oplistcreate</a></li><li><a href="Manager.html#event:statechange">Manager#event:statechange</a></li>
</ul>
</li>
<li class="dropdown">
<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
<ul class="dropdown-menu inline">
<li><a href="global.html#Categories">Categories</a></li><li><a href="global.html#OperationConfig">OperationConfig</a></li><li><a href="global.html#main">main</a></li>
</ul>
</li>
</ul>
<div class="col-sm-3 col-md-3">
<form class="navbar-form" role="search">
<div class="input-group">
<input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
<div class="input-group-btn">
<button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
</div>
</div>
</form>
</div>
</div>
</div>
</div>
<div class="container" id="toc-content">
<div class="row">
<div class="col-md-8">
<div id="main">
<h1 class="page-title">Namespace: BitwiseOp</h1>
<section>
<header>
<h2>
BitwiseOp
</h2>
</header>
<article>
<div class="container-overview">
<div class="description"><p>Bitwise operations.</p></div>
<dl class="details">
<dt class="tag-author method-doc-label method-doc-details-label">Author:</dt>
<dd class="tag-author">
<ul>
<li>&lt;p>n1474335 [n1474335@gmail.com]&lt;/p></li>
</ul>
</dd>
<dt class="tag-copyright method-doc-label method-doc-details-label">Copyright:</dt>
<dd class="tag-copyright">
<ul class="dummy">
<li>Crown Copyright 2016</li>
</ul>
</dd>
<dt class="tag-license method-doc-label method-doc-details-label">License:</dt>
<dd class="tag-license">
<ul class="dummy">
<li>Apache-2.0</li>
</ul>
</dd>
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_BitwiseOp.js.html">operations/BitwiseOp.js</a>,
<a href="operations_BitwiseOp.js.html#sunlight-1-line-12">line 12</a>
</li>
</ul>
</dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<dl>
<hr>
<dt class="name" id=".XOR_PRESERVE_NULLS">
<h4 id=".XOR_PRESERVE_NULLS"><span class="type-signature">&lt;static, constant> </span>XOR_PRESERVE_NULLS<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_BitwiseOp.js.html">operations/BitwiseOp.js</a>,
<a href="operations_BitwiseOp.js.html#sunlight-1-line-50">line 50</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt class="name" id=".XOR_DIFFERENTIAL">
<h4 id=".XOR_DIFFERENTIAL"><span class="type-signature">&lt;static, constant> </span>XOR_DIFFERENTIAL<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_BitwiseOp.js.html">operations/BitwiseOp.js</a>,
<a href="operations_BitwiseOp.js.html#sunlight-1-line-55">line 55</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt class="name" id=".KEY_FORMAT">
<h4 id=".KEY_FORMAT"><span class="type-signature">&lt;static, constant> </span>KEY_FORMAT<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
<dd class="tag-default">
<ul class="dummy">
<li>["Hex","Base64","UTF8","UTF16","UTF16LE","UTF16BE","Latin1"]</li>
</ul>
</dd>
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_BitwiseOp.js.html">operations/BitwiseOp.js</a>,
<a href="operations_BitwiseOp.js.html#sunlight-1-line-60">line 60</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt class="name" id=".XOR_BRUTE_KEY_LENGTH">
<h4 id=".XOR_BRUTE_KEY_LENGTH"><span class="type-signature">&lt;static, constant> </span>XOR_BRUTE_KEY_LENGTH<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
<dd class="tag-default">
<ul class="dummy">
<li>["1","2"]</li>
</ul>
</dd>
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_BitwiseOp.js.html">operations/BitwiseOp.js</a>,
<a href="operations_BitwiseOp.js.html#sunlight-1-line-84">line 84</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt class="name" id=".XOR_BRUTE_SAMPLE_LENGTH">
<h4 id=".XOR_BRUTE_SAMPLE_LENGTH"><span class="type-signature">&lt;static, constant> </span>XOR_BRUTE_SAMPLE_LENGTH<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
<dd class="tag-default">
<ul class="dummy">
<li>100</li>
</ul>
</dd>
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_BitwiseOp.js.html">operations/BitwiseOp.js</a>,
<a href="operations_BitwiseOp.js.html#sunlight-1-line-89">line 89</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt class="name" id=".XOR_BRUTE_SAMPLE_OFFSET">
<h4 id=".XOR_BRUTE_SAMPLE_OFFSET"><span class="type-signature">&lt;static, constant> </span>XOR_BRUTE_SAMPLE_OFFSET<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_BitwiseOp.js.html">operations/BitwiseOp.js</a>,
<a href="operations_BitwiseOp.js.html#sunlight-1-line-94">line 94</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt class="name" id=".XOR_BRUTE_PRINT_KEY">
<h4 id=".XOR_BRUTE_PRINT_KEY"><span class="type-signature">&lt;static, constant> </span>XOR_BRUTE_PRINT_KEY<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-default method-doc-label method-doc-details-label">Default Value:</dt>
<dd class="tag-default">
<ul class="dummy">
<li>true</li>
</ul>
</dd>
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_BitwiseOp.js.html">operations/BitwiseOp.js</a>,
<a href="operations_BitwiseOp.js.html#sunlight-1-line-99">line 99</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt class="name" id=".XOR_BRUTE_OUTPUT_HEX">
<h4 id=".XOR_BRUTE_OUTPUT_HEX"><span class="type-signature">&lt;static, constant> </span>XOR_BRUTE_OUTPUT_HEX<span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_BitwiseOp.js.html">operations/BitwiseOp.js</a>,
<a href="operations_BitwiseOp.js.html#sunlight-1-line-104">line 104</a>
</li>
</ul>
</dd>
</dl>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<hr>
<dt>
<h4 class="name" id="._bit_op"><span class="type-signature">&lt;private, static> </span>_bit_op(input, key, func, null_preserving, differential)</h4>
</dt>
<dd>
<div class="description">
<p>Runs bitwise operations across the input data.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>input</code></td>
<td class="type">
<span class="param-type">byte_array</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">byte_array</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>func</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last"><p>The bitwise calculation to carry out</p></td>
</tr>
<tr>
<td class="name"><code>null_preserving</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>differential</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_BitwiseOp.js.html">operations/BitwiseOp.js</a>,
<a href="operations_BitwiseOp.js.html#sunlight-1-line-25">line 25</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">byte_array</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".run_xor"><span class="type-signature">&lt;static> </span>run_xor(input, args)</h4>
</dt>
<dd>
<div class="description">
<p>XOR operation.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>input</code></td>
<td class="type">
<span class="param-type">byte_array</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>args</code></td>
<td class="type">
<span class="param-type"><a href="Array.html">Array</a>.&lt;Object></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_BitwiseOp.js.html">operations/BitwiseOp.js</a>,
<a href="operations_BitwiseOp.js.html#sunlight-1-line-69">line 69</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">byte_array</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".run_xor_brute"><span class="type-signature">&lt;static> </span>run_xor_brute(input, args)</h4>
</dt>
<dd>
<div class="description">
<p>XOR Brute Force operation.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>input</code></td>
<td class="type">
<span class="param-type">byte_array</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>args</code></td>
<td class="type">
<span class="param-type"><a href="Array.html">Array</a>.&lt;Object></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_BitwiseOp.js.html">operations/BitwiseOp.js</a>,
<a href="operations_BitwiseOp.js.html#sunlight-1-line-113">line 113</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".run_not"><span class="type-signature">&lt;static> </span>run_not(input, args)</h4>
</dt>
<dd>
<div class="description">
<p>NOT operation.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>input</code></td>
<td class="type">
<span class="param-type">byte_array</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>args</code></td>
<td class="type">
<span class="param-type"><a href="Array.html">Array</a>.&lt;Object></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_BitwiseOp.js.html">operations/BitwiseOp.js</a>,
<a href="operations_BitwiseOp.js.html#sunlight-1-line-157">line 157</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">byte_array</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".run_and"><span class="type-signature">&lt;static> </span>run_and(input, args)</h4>
</dt>
<dd>
<div class="description">
<p>AND operation.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>input</code></td>
<td class="type">
<span class="param-type">byte_array</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>args</code></td>
<td class="type">
<span class="param-type"><a href="Array.html">Array</a>.&lt;Object></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_BitwiseOp.js.html">operations/BitwiseOp.js</a>,
<a href="operations_BitwiseOp.js.html#sunlight-1-line-169">line 169</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">byte_array</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".run_or"><span class="type-signature">&lt;static> </span>run_or(input, args)</h4>
</dt>
<dd>
<div class="description">
<p>OR operation.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>input</code></td>
<td class="type">
<span class="param-type">byte_array</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>args</code></td>
<td class="type">
<span class="param-type"><a href="Array.html">Array</a>.&lt;Object></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_BitwiseOp.js.html">operations/BitwiseOp.js</a>,
<a href="operations_BitwiseOp.js.html#sunlight-1-line-184">line 184</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">byte_array</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".run_add"><span class="type-signature">&lt;static> </span>run_add(input, args)</h4>
</dt>
<dd>
<div class="description">
<p>ADD operation.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>input</code></td>
<td class="type">
<span class="param-type">byte_array</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>args</code></td>
<td class="type">
<span class="param-type"><a href="Array.html">Array</a>.&lt;Object></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_BitwiseOp.js.html">operations/BitwiseOp.js</a>,
<a href="operations_BitwiseOp.js.html#sunlight-1-line-199">line 199</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">byte_array</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id=".run_sub"><span class="type-signature">&lt;static> </span>run_sub(input, args)</h4>
</dt>
<dd>
<div class="description">
<p>SUB operation.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>input</code></td>
<td class="type">
<span class="param-type">byte_array</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>args</code></td>
<td class="type">
<span class="param-type"><a href="Array.html">Array</a>.&lt;Object></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_BitwiseOp.js.html">operations/BitwiseOp.js</a>,
<a href="operations_BitwiseOp.js.html#sunlight-1-line-214">line 214</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">byte_array</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="._xor"><span class="type-signature">&lt;private, static> </span>_xor(operand, key)</h4>
</dt>
<dd>
<div class="description">
<p>XOR bitwise calculation.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>operand</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>key</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 method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_BitwiseOp.js.html">operations/BitwiseOp.js</a>,
<a href="operations_BitwiseOp.js.html#sunlight-1-line-230">line 230</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="._not"><span class="type-signature">&lt;private, static> </span>_not(operand)</h4>
</dt>
<dd>
<div class="description">
<p>NOT bitwise calculation.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>operand</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 method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_BitwiseOp.js.html">operations/BitwiseOp.js</a>,
<a href="operations_BitwiseOp.js.html#sunlight-1-line-242">line 242</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="._and"><span class="type-signature">&lt;private, static> </span>_and(operand, key)</h4>
</dt>
<dd>
<div class="description">
<p>AND bitwise calculation.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>operand</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>key</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 method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_BitwiseOp.js.html">operations/BitwiseOp.js</a>,
<a href="operations_BitwiseOp.js.html#sunlight-1-line-255">line 255</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="._or"><span class="type-signature">&lt;private, static> </span>_or(operand, key)</h4>
</dt>
<dd>
<div class="description">
<p>OR bitwise calculation.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>operand</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>key</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 method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_BitwiseOp.js.html">operations/BitwiseOp.js</a>,
<a href="operations_BitwiseOp.js.html#sunlight-1-line-268">line 268</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="._add"><span class="type-signature">&lt;private, static> </span>_add(operand, key)</h4>
</dt>
<dd>
<div class="description">
<p>ADD bitwise calculation.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>operand</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>key</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 method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_BitwiseOp.js.html">operations/BitwiseOp.js</a>,
<a href="operations_BitwiseOp.js.html#sunlight-1-line-281">line 281</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="._sub"><span class="type-signature">&lt;private, static> </span>_sub(operand, key)</h4>
</dt>
<dd>
<div class="description">
<p>SUB bitwise calculation.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>operand</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>key</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 method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="operations_BitwiseOp.js.html">operations/BitwiseOp.js</a>,
<a href="operations_BitwiseOp.js.html#sunlight-1-line-294">line 294</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
</dl>
</article>
</section>
</div>
</div>
<div class="clearfix"></div>
<div class="col-md-3">
<div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
</div>
</div>
</div>
<div class="modal fade" id="searchResults">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
<h4 class="modal-title">Search results</h4>
</div>
<div class="modal-body"></div>
<div class="modal-footer">
<button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
</div>
</div><!-- /.modal-content -->
</div><!-- /.modal-dialog -->
</div>
<footer>
<span class="copyright">
&copy; Crown Copyright 2016
</span>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
on Mon Nov 28th 2016
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
</footer>
<script src="scripts/docstrap.lib.js"></script>
<script src="scripts/toc.js"></script>
<script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
<script>
$( function () {
$( "[id*='$']" ).each( function () {
var $this = $( this );
$this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
} );
$( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
var $this = $( this );
var example = $this.find( "code" );
exampleText = example.html();
var lang = /{@lang (.*?)}/.exec( exampleText );
if ( lang && lang[1] ) {
exampleText = exampleText.replace( lang[0], "" );
example.html( exampleText );
lang = lang[1];
} else {
var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
lang = langClassMatch ? langClassMatch[1] : "javascript";
}
if ( lang ) {
$this
.addClass( "sunlight-highlight-" + lang )
.addClass( "linenums" )
.html( example.html() );
}
} );
Sunlight.highlightAll( {
lineNumbers : true,
showMenu : true,
enableDoclinks : true
} );
$.catchAnchorLinks( {
navbarOffset: 10
} );
$( "#toc" ).toc( {
anchorName : function ( i, heading, prefix ) {
return $( heading ).attr( "id" ) || ( prefix + i );
},
selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
showAndHide : false,
smoothScrolling: true
} );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
$( '.dropdown-toggle' ).dropdown();
$( "table" ).each( function () {
var $this = $( this );
$this.addClass('table');
} );
} );
</script>
<!--Navigation and Symbol Display-->
<!--Google Analytics-->
<script type="text/javascript">
$(document).ready(function() {
SearcherDisplay.init();
});
</script>
</body>
</html>
Reference in a new issue Copy permalink