@inaut/math-functions
Version:
Executes code-lines with function calls like Excel
744 lines • 54.5 kB
HTML
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Function_BAND | @inaut/math-functions</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">@inaut/math-functions</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/_math_functions_functions_function_band_.html">"math-functions/functions/function-band"</a>
</li>
<li>
<a href="_math_functions_functions_function_band_.function_band.html">Function_BAND</a>
</li>
</ul>
<h1>Class Function_BAND</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>Function BAND</p>
</div>
<p>Returns the binary AND of two numbers. Executes an AND-Operation (&&) on each bit-pair. A bit is true, if the bits at both numbers at the same index are true. Requires two arguments from type boolean or number.</p>
<ul>
<li>Name: <code>BAND</code></li>
</ul>
<p>Signature:</p>
<pre><code>(<span class="hljs-built_in">number</span> | <span class="hljs-built_in">boolean</span>) & <span class="hljs-function">(<span class="hljs-params"><span class="hljs-built_in">number</span>|<span class="hljs-built_in">boolean</span></span>) =></span> <span class="hljs-built_in">number</span>
BAND(<span class="hljs-built_in">number</span>|<span class="hljs-built_in">boolean</span>, <span class="hljs-built_in">number</span>|<span class="hljs-built_in">boolean</span>) => <span class="hljs-built_in">number</span>
BAND( <span class="hljs-function">(<span class="hljs-params"><span class="hljs-built_in">number</span>|<span class="hljs-built_in">boolean</span></span>)[2] ) =></span> <span class="hljs-built_in">number</span></code></pre>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="_math_functions_functions_function_binary_operation_.binaryoperation.html" class="tsd-signature-type">BinaryOperation</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">Function_BAND</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implements</h3>
<ul class="tsd-hierarchy">
<li><a href="../interfaces/_math_functions_functions_base_function_interface_.ibasefunction.html" class="tsd-signature-type">IBaseFunction</a></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 tsd-is-private tsd-is-private-protected">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite tsd-is-private"><a href="_math_functions_functions_function_band_.function_band.html#constructor" class="tsd-kind-icon">constructor</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 tsd-is-overwrite"><a href="_math_functions_functions_function_band_.function_band.html#clone" class="tsd-kind-icon">clone</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited"><a href="_math_functions_functions_function_band_.function_band.html#execute" class="tsd-kind-icon">execute</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_math_functions_functions_function_band_.function_band.html#executeasync" class="tsd-kind-icon">execute<wbr>Async</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected"><a href="_math_functions_functions_function_band_.function_band.html#executebinaryoperation" class="tsd-kind-icon">execute<wbr>Binary<wbr>Operation</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="_math_functions_functions_function_band_.function_band.html#getargumenterror" class="tsd-kind-icon">get<wbr>Argument<wbr>Error</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="_math_functions_functions_function_band_.function_band.html#getargumentvalue" class="tsd-kind-icon">get<wbr>Argument<wbr>Value</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_math_functions_functions_function_band_.function_band.html#getdescription" class="tsd-kind-icon">get<wbr>Description</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_math_functions_functions_function_band_.function_band.html#getname" class="tsd-kind-icon">get<wbr>Name</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_math_functions_functions_function_band_.function_band.html#getoperator" class="tsd-kind-icon">get<wbr>Operator</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_math_functions_functions_function_band_.function_band.html#getpriority" class="tsd-kind-icon">get<wbr>Priority</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="_math_functions_functions_function_band_.function_band.html#hasargumenterror" class="tsd-kind-icon">has<wbr>Argument<wbr>Error</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_math_functions_functions_function_band_.function_band.html#hashigherprioritythan" class="tsd-kind-icon">has<wbr>Higher<wbr>Priority<wbr>Than</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_math_functions_functions_function_band_.function_band.html#isasyncron" class="tsd-kind-icon">is<wbr>Asyncron</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_math_functions_functions_function_band_.function_band.html#isoperator" class="tsd-kind-icon">is<wbr>Operator</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_math_functions_functions_function_band_.function_band.html#ispreexecutedargument" class="tsd-kind-icon">is<wbr>Preexecuted<wbr>Argument</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_math_functions_functions_function_band_.function_band.html#isstoring" class="tsd-kind-icon">is<wbr>Storing</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_math_functions_functions_function_band_.function_band.html#tostring" class="tsd-kind-icon">to<wbr>String</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_math_functions_functions_function_band_.function_band.html#meta" class="tsd-kind-icon">META</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite tsd-is-private">
<a name="constructor" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite tsd-is-private">
<li class="tsd-signature tsd-kind-icon">new <wbr>Function_<wbr>BAND<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_math_functions_functions_function_band_.function_band.html" class="tsd-signature-type">Function_BAND</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="_math_functions_functions_base_function_.basefunction.html">BaseFunction</a>.<a href="_math_functions_functions_base_function_.basefunction.html#constructor">constructor</a></p>
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/function-band.ts:24</li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="_math_functions_functions_function_band_.function_band.html" class="tsd-signature-type">Function_BAND</a></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 tsd-is-overwrite">
<a name="clone" class="tsd-anchor"></a>
<h3>clone</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<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="_math_functions_functions_function_band_.function_band.html" class="tsd-signature-type">Function_BAND</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/_math_functions_functions_base_function_interface_.ibasefunction.html">IBaseFunction</a>.<a href="../interfaces/_math_functions_functions_base_function_interface_.ibasefunction.html#clone">clone</a></p>
<p>Overrides <a href="_math_functions_functions_base_function_.basefunction.html">BaseFunction</a>.<a href="_math_functions_functions_base_function_.basefunction.html#clone">clone</a></p>
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/function-band.ts:34</li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="_math_functions_functions_function_band_.function_band.html" class="tsd-signature-type">Function_BAND</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited">
<a name="execute" class="tsd-anchor"></a>
<h3>execute</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">execute<span class="tsd-signature-symbol">(</span>preexcArguments<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span>, environment<span class="tsd-signature-symbol">: </span><a href="../interfaces/_math_functions_script_environment_.scriptenvironment.html" class="tsd-signature-type">ScriptEnvironment</a>, node<span class="tsd-signature-symbol">: </span><a href="_math_functions_nodes_node_class_.node.html" class="tsd-signature-type">Node</a>, execPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="_math_functions_functions_function_binary_operation_.binaryoperation.html">BinaryOperation</a>.<a href="_math_functions_functions_function_binary_operation_.binaryoperation.html#execute">execute</a></p>
<p>Overrides <a href="_math_functions_functions_base_function_.basefunction.html">BaseFunction</a>.<a href="_math_functions_functions_base_function_.basefunction.html#execute">execute</a></p>
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/function-binary-operation.ts:11</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>preexcArguments: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
<li>
<h5>environment: <a href="../interfaces/_math_functions_script_environment_.scriptenvironment.html" class="tsd-signature-type">ScriptEnvironment</a></h5>
</li>
<li>
<h5>node: <a href="_math_functions_nodes_node_class_.node.html" class="tsd-signature-type">Node</a></h5>
</li>
<li>
<h5>execPath: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="executeasync" class="tsd-anchor"></a>
<h3>execute<wbr>Async</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">execute<wbr>Async<span class="tsd-signature-symbol">(</span>preexecutedArguments<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span>, environment<span class="tsd-signature-symbol">: </span><a href="../interfaces/_math_functions_script_environment_.scriptenvironment.html" class="tsd-signature-type">ScriptEnvironment</a>, node<span class="tsd-signature-symbol">: </span><a href="_math_functions_nodes_node_class_.node.html" class="tsd-signature-type">Node</a>, execPath<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="_math_functions_functions_base_function_.basefunction.html">BaseFunction</a>.<a href="_math_functions_functions_base_function_.basefunction.html#executeasync">executeAsync</a></p>
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/base-function.ts:145</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>preexecutedArguments: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
<li>
<h5>environment: <a href="../interfaces/_math_functions_script_environment_.scriptenvironment.html" class="tsd-signature-type">ScriptEnvironment</a></h5>
</li>
<li>
<h5>node: <a href="_math_functions_nodes_node_class_.node.html" class="tsd-signature-type">Node</a></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> execPath: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected">
<a name="executebinaryoperation" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> execute<wbr>Binary<wbr>Operation</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">execute<wbr>Binary<wbr>Operation<span class="tsd-signature-symbol">(</span>argumentLeft<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, argumentRight<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></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="_math_functions_functions_function_binary_operation_.binaryoperation.html">BinaryOperation</a>.<a href="_math_functions_functions_function_binary_operation_.binaryoperation.html#executebinaryoperation">executeBinaryOperation</a></p>
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/function-band.ts:30</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>argumentLeft: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>argumentRight: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a name="getargumenterror" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> get<wbr>Argument<wbr>Error</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">get<wbr>Argument<wbr>Error<span class="tsd-signature-symbol">(</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_math_functions_errors_expression_error_.expressionerror.html" class="tsd-signature-type">ExpressionError</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="_math_functions_functions_base_function_.basefunction.html">BaseFunction</a>.<a href="_math_functions_functions_base_function_.basefunction.html#getargumenterror">getArgumentError</a></p>
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/base-function.ts:177</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the first argument with error inside args, if args is an array. Or args itself, if args is an object of ExpressionError (or derived).</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_math_functions_errors_expression_error_.expressionerror.html" class="tsd-signature-type">ExpressionError</a>
<span class="tsd-signature-symbol"> | </span>
<span class="tsd-signature-type">undefined</span>
</h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a name="getargumentvalue" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> get<wbr>Argument<wbr>Value</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">get<wbr>Argument<wbr>Value<span class="tsd-signature-symbol">(</span>argument<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, node<span class="tsd-signature-symbol">: </span><a href="_math_functions_nodes_node_class_.node.html" class="tsd-signature-type">Node</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="_math_functions_functions_function_binary_operation_.binaryoperation.html">BinaryOperation</a>.<a href="_math_functions_functions_function_binary_operation_.binaryoperation.html#getargumentvalue">getArgumentValue</a></p>
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/function-binary-operation.ts:36</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the provided argument as integer-number. Throws an error if conversion failed!</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>argument: <span class="tsd-signature-type">any</span></h5>
</li>
<li>
<h5>index: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>node: <a href="_math_functions_nodes_node_class_.node.html" class="tsd-signature-type">Node</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getdescription" class="tsd-anchor"></a>
<h3>get<wbr>Description</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Description<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/_math_functions_functions_base_function_interface_.ibasefunction.html">IBaseFunction</a>.<a href="../interfaces/_math_functions_functions_base_function_interface_.ibasefunction.html#getdescription">getDescription</a></p>
<p>Inherited from <a href="_math_functions_functions_base_function_.basefunction.html">BaseFunction</a>.<a href="_math_functions_functions_base_function_.basefunction.html#getdescription">getDescription</a></p>
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/base-function.ts:63</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the description of this function.
An empty string if a description is not available.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getname" class="tsd-anchor"></a>
<h3>get<wbr>Name</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Name<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/_math_functions_functions_base_function_interface_.ibasefunction.html">IBaseFunction</a>.<a href="../interfaces/_math_functions_functions_base_function_interface_.ibasefunction.html#getname">getName</a></p>
<p>Inherited from <a href="_math_functions_functions_base_function_.basefunction.html">BaseFunction</a>.<a href="_math_functions_functions_base_function_.basefunction.html#getname">getName</a></p>
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/base-function.ts:13</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the name of the function</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getoperator" class="tsd-anchor"></a>
<h3>get<wbr>Operator</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Operator<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/_math_functions_functions_base_function_interface_.ibasefunction.html">IBaseFunction</a>.<a href="../interfaces/_math_functions_functions_base_function_interface_.ibasefunction.html#getoperator">getOperator</a></p>
<p>Inherited from <a href="_math_functions_functions_base_function_.basefunction.html">BaseFunction</a>.<a href="_math_functions_functions_base_function_.basefunction.html#getoperator">getOperator</a></p>
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/base-function.ts:51</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the operator-character of this function.
Throws an error if this function is not useable as operation.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="getpriority" class="tsd-anchor"></a>
<h3>get<wbr>Priority</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">get<wbr>Priority<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>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/_math_functions_functions_base_function_interface_.ibasefunction.html">IBaseFunction</a>.<a href="../interfaces/_math_functions_functions_base_function_interface_.ibasefunction.html#getpriority">getPriority</a></p>
<p>Inherited from <a href="_math_functions_functions_base_function_.basefunction.html">BaseFunction</a>.<a href="_math_functions_functions_base_function_.basefunction.html#getpriority">getPriority</a></p>
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/base-function.ts:33</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the priority of this function.
Only needed for operators.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a name="hasargumenterror" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> has<wbr>Argument<wbr>Error</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">has<wbr>Argument<wbr>Error<span class="tsd-signature-symbol">(</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><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">
<p>Inherited from <a href="_math_functions_functions_base_function_.basefunction.html">BaseFunction</a>.<a href="_math_functions_functions_base_function_.basefunction.html#hasargumenterror">hasArgumentError</a></p>
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/base-function.ts:164</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns true if args is an ExpressionError-object or an array which contains an ExpressionError-object.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="hashigherprioritythan" class="tsd-anchor"></a>
<h3>has<wbr>Higher<wbr>Priority<wbr>Than</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">has<wbr>Higher<wbr>Priority<wbr>Than<span class="tsd-signature-symbol">(</span>priority<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">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/_math_functions_functions_base_function_interface_.ibasefunction.html">IBaseFunction</a>.<a href="../interfaces/_math_functions_functions_base_function_interface_.ibasefunction.html#hashigherprioritythan">hasHigherPriorityThan</a></p>
<p>Inherited from <a href="_math_functions_functions_base_function_.basefunction.html">BaseFunction</a>.<a href="_math_functions_functions_base_function_.basefunction.html#hashigherprioritythan">hasHigherPriorityThan</a></p>
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/base-function.ts:42</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns true if the priority of this function is higher than the provided priority</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>priority: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="isasyncron" class="tsd-anchor"></a>
<h3>is<wbr>Asyncron</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">is<wbr>Asyncron<span class="tsd-signature-symbol">(</span><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">
<p>Implementation of <a href="../interfaces/_math_functions_functions_base_function_interface_.ibasefunction.html">IBaseFunction</a>.<a href="../interfaces/_math_functions_functions_base_function_interface_.ibasefunction.html#isasyncron">isAsyncron</a></p>
<p>Inherited from <a href="_math_functions_functions_base_function_.basefunction.html">BaseFunction</a>.<a href="_math_functions_functions_base_function_.basefunction.html#isasyncron">isAsyncron</a></p>
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/base-function.ts:81</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns true if this function must be called asyncron and returns the value not immediately.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="isoperator" class="tsd-anchor"></a>
<h3>is<wbr>Operator</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">is<wbr>Operator<span class="tsd-signature-symbol">(</span><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">
<p>Implementation of <a href="../interfaces/_math_functions_functions_base_function_interface_.ibasefunction.html">IBaseFunction</a>.<a href="../interfaces/_math_functions_functions_base_function_interface_.ibasefunction.html#isoperator">isOperator</a></p>
<p>Inherited from <a href="_math_functions_functions_base_function_.basefunction.html">BaseFunction</a>.<a href="_math_functions_functions_base_function_.basefunction.html#isoperator">isOperator</a></p>
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/base-function.ts:24</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns true if this function is also available as operation (using operator)</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="ispreexecutedargument" class="tsd-anchor"></a>
<h3>is<wbr>Preexecuted<wbr>Argument</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">is<wbr>Preexecuted<wbr>Argument<span class="tsd-signature-symbol">(</span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, node<span class="tsd-signature-symbol">: </span><a href="_math_functions_nodes_node_class_.node.html" class="tsd-signature-type">Node</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">
<p>Inherited from <a href="_math_functions_functions_base_function_.basefunction.html">BaseFunction</a>.<a href="_math_functions_functions_base_function_.basefunction.html#ispreexecutedargument">isPreexecutedArgument</a></p>
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/base-function.ts:157</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns true, if the argument (node-children) should be executed before <code>execute</code> of this function is called.
By default, returns true for all arguments. Override in function if certain arguments are executed for getting ther value inside the <code>execute</code>-method.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>index: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>Zero-based index of the argument</p>
</div>
</li>
<li>
<h5>node: <a href="_math_functions_nodes_node_class_.node.html" class="tsd-signature-type">Node</a></h5>
<div class="tsd-comment tsd-typography">
<p>The node, none executed (result is not availabe at that time)</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="isstoring" class="tsd-anchor"></a>
<h3>is<wbr>Storing</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">is<wbr>Storing<span class="tsd-signature-symbol">(</span><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">
<p>Implementation of <a href="../interfaces/_math_functions_functions_base_function_interface_.ibasefunction.html">IBaseFunction</a>.<a href="../interfaces/_math_functions_functions_base_function_interface_.ibasefunction.html#isstoring">isStoring</a></p>
<p>Inherited from <a href="_math_functions_functions_base_function_.basefunction.html">BaseFunction</a>.<a href="_math_functions_functions_base_function_.basefunction.html#isstoring">isStoring</a></p>
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/base-function.ts:74</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns true if this function is storing values between the calls. So, an instance needs to be created for each occurrence.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="tostring" class="tsd-anchor"></a>
<h3>to<wbr>String</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">to<wbr>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/_math_functions_functions_base_function_interface_.ibasefunction.html">IBaseFunction</a>.<a href="../interfaces/_math_functions_functions_base_function_interface_.ibasefunction.html#tostring">toString</a></p>
<p>Inherited from <a href="_math_functions_functions_base_function_.basefunction.html">BaseFunction</a>.<a href="_math_functions_functions_base_function_.basefunction.html#tostring">toString</a></p>
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/base-function.ts:17</li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="meta" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> META</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">META<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_math_functions_functions_function_band_.function_band.html" class="tsd-signature-type">Function_BAND</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/function-band.ts:22</li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="_math_functions_functions_function_band_.function_band.html" class="tsd-signature-type">Function_BAND</a></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
<li class="current tsd-kind-external-module">
<a href="../modules/_math_functions_functions_function_band_.html">"math-<wbr>functions/functions/function-<wbr>band"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-external-module">
<a href="_math_functions_functions_function_band_.function_band.html" class="tsd-kind-icon">Function_<wbr>BAND</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite tsd-is-private">
<a href="_math_functions_functions_function_band_.function_band.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a href="_math_functions_functions_function_band_.function_band.html#clone" class="tsd-kind-icon">clone</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited">
<a href="_math_functions_functions_function_band_.function_band.html#execute" class="tsd-kind-icon">execute</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="_math_functions_functions_function_band_.function_band.html#executeasync" class="tsd-kind-icon">execute<wbr>Async</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected">
<a href="_math_functions_functions_function_band_.function_band.html#executebinaryoperation" class="tsd-kind-icon">execute<wbr>Binary<wbr>Operation</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a href="_math_functions_functions_function_band_.function_band.html#getargumenterror" class="tsd-kind-icon">get<wbr>Argument<wbr>Error</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a href="_math_functions_functions_function_band_.function_band.html#getargumentvalue" class="tsd-kind-icon">get<wbr>Argument<wbr>Value</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="_math_functions_functions_function_band_.function_band.html#getdescription" class="tsd-kind-icon">get<wbr>Description</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="_math_functions_functions_function_band_.function_band.html#getname" class="tsd-kind-icon">get<wbr>Name</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="_math_functions_functions_function_band_.function_band.html#getoperator" class="tsd-kind-icon">get<wbr>Operator</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="_math_functions_functions_function_band_.function_band.html#getpriority" class="tsd-kind-icon">get<wbr>Priority</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a href="_math_functions_functions_function_band_.function_band.html#hasargumenterror" class="tsd-kind-icon">has<wbr>Argument<wbr>Error</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="_math_functions_functions_function_band_.function_band.html#hashigherprioritythan" class="tsd-kind-icon">has<wbr>Higher<wbr>Priority<wbr>Than</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="_math_functions_functions_function_band_.function_band.html#isasyncron" class="tsd-kind-icon">is<wbr>Asyncron</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="_math_functions_functions_function_band_.function_band.html#isoperator" class="tsd-kind-icon">is<wbr>Operator</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="_math_functions_functions_function_band_.function_band.html#ispreexecutedargument" class="tsd-kind-icon">is<wbr>Preexecuted<wbr>Argument</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="_math_functions_functions_function_band_.function_band.html#isstoring" class="tsd-kind-icon">is<wbr>Storing</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="_math_functions_functions_function_band_.function_band.html#tostring" class="tsd-kind-icon">to<wbr>String</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="_math_functions_functions_function_band_.function_band.html#meta" class="tsd-kind-icon">META</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind