@inaut/math-functions
Version:
Executes code-lines with function calls like Excel
672 lines • 44.8 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>IBaseFunction | @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_base_function_interface_.html">"math-functions/functions/base-function-interface"</a>
</li>
<li>
<a href="_math_functions_functions_base_function_interface_.ibasefunction.html">IBaseFunction</a>
</li>
</ul>
<h1>Interface IBaseFunction</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">IBaseFunction</span>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implemented by</h3>
<ul class="tsd-hierarchy">
<li><a href="../classes/_math_functions_functions_base_function_.basefunction.html" class="tsd-signature-type">BaseFunction</a></li>
<li><a href="../classes/_math_functions_functions_function_binary_operation_.binaryoperation.html" class="tsd-signature-type">BinaryOperation</a></li>
<li><a href="../classes/_math_functions_functions_function_compare_operation_.comparefunction.html" class="tsd-signature-type">CompareFunction</a></li>
<li><a href="../classes/_math_functions_functions_function_acos_.function_acos.html" class="tsd-signature-type">Function_ACOS</a></li>
<li><a href="../classes/_math_functions_functions_function_and_.function_and.html" class="tsd-signature-type">Function_AND</a></li>
<li><a href="../classes/_math_functions_functions_function_asin_.function_asin.html" class="tsd-signature-type">Function_ASIN</a></li>
<li><a href="../classes/_math_functions_functions_function_atan_.function_atan.html" class="tsd-signature-type">Function_ATAN</a></li>
<li><a href="../classes/_math_functions_functions_function_band_.function_band.html" class="tsd-signature-type">Function_BAND</a></li>
<li><a href="../classes/_math_functions_functions_function_bnot_.function_bnot.html" class="tsd-signature-type">Function_BNOT</a></li>
<li><a href="../classes/_math_functions_functions_function_bor_.function_bor.html" class="tsd-signature-type">Function_BOR</a></li>
<li><a href="../classes/_math_functions_functions_function_bxor_.function_bxor.html" class="tsd-signature-type">Function_BXOR</a></li>
<li><a href="../classes/_math_functions_functions_function_concate_.function_concate.html" class="tsd-signature-type">Function_CONCATE</a></li>
<li><a href="../classes/_math_functions_functions_function_cos_.function_cos.html" class="tsd-signature-type">Function_COS</a></li>
<li><a href="../classes/_math_functions_functions_function_diff_.function_diff.html" class="tsd-signature-type">Function_DIFF</a></li>
<li><a href="../classes/_math_functions_functions_function_div_.function_div.html" class="tsd-signature-type">Function_DIV</a></li>
<li><a href="../classes/_math_functions_functions_function_equal_.function_eq.html" class="tsd-signature-type">Function_EQ</a></li>
<li><a href="../classes/_math_functions_functions_function_greater_equal_.function_ge.html" class="tsd-signature-type">Function_GE</a></li>
<li><a href="../classes/_math_functions_functions_function_get_array_element_.function_get_array_element.html" class="tsd-signature-type">Function_GET_ARRAY_ELEMENT</a></li>
<li><a href="../classes/_math_functions_functions_function_get_array_splice_.function_get_array_splice.html" class="tsd-signature-type">Function_GET_ARRAY_SPLICE</a></li>
<li><a href="../classes/_math_functions_functions_function_get_char_.function_get_char.html" class="tsd-signature-type">Function_GET_CHAR</a></li>
<li><a href="../classes/_math_functions_functions_function_get_date_time_.function_get_date_time.html" class="tsd-signature-type">Function_GET_DATE_TIME</a></li>
<li><a href="../classes/_math_functions_functions_function_get_day_.function_get_day.html" class="tsd-signature-type">Function_GET_DAY</a></li>
<li><a href="../classes/_math_functions_functions_function_get_dow_.function_get_dow.html" class="tsd-signature-type">Function_GET_DOW</a></li>
<li><a href="../classes/_math_functions_functions_function_get_hour_.function_get_hour.html" class="tsd-signature-type">Function_GET_HOUR</a></li>
<li><a href="../classes/_math_functions_functions_function_get_minute_.function_get_minute.html" class="tsd-signature-type">Function_GET_MINUTE</a></li>
<li><a href="../classes/_math_functions_functions_function_get_month_.function_get_month.html" class="tsd-signature-type">Function_GET_MONTH</a></li>
<li><a href="../classes/_math_functions_functions_function_get_second_.function_get_second.html" class="tsd-signature-type">Function_GET_SECOND</a></li>
<li><a href="../classes/_math_functions_functions_function_get_string_.function_get_string.html" class="tsd-signature-type">Function_GET_STRING</a></li>
<li><a href="../classes/_math_functions_functions_function_get_value_.function_get_value.html" class="tsd-signature-type">Function_GET_VALUE</a></li>
<li><a href="../classes/_math_functions_functions_function_get_value_state_.function_get_value_state.html" class="tsd-signature-type">Function_GET_VALUE_STATE</a></li>
<li><a href="../classes/_math_functions_functions_function_get_value_ts_.function_get_value_ts.html" class="tsd-signature-type">Function_GET_VALUE_TS</a></li>
<li><a href="../classes/_math_functions_functions_function_get_year_.function_get_year.html" class="tsd-signature-type">Function_GET_YEAR</a></li>
<li><a href="../classes/_math_functions_functions_function_greater_than_.function_gt.html" class="tsd-signature-type">Function_GT</a></li>
<li><a href="../classes/_math_functions_functions_function_if_.function_if.html" class="tsd-signature-type">Function_IF</a></li>
<li><a href="../classes/_math_functions_functions_function_if_error_.function_if_error.html" class="tsd-signature-type">Function_IF_ERROR</a></li>
<li><a href="../classes/_math_functions_functions_function_in_string_.function_in_string.html" class="tsd-signature-type">Function_IN_STRING</a></li>
<li><a href="../classes/_math_functions_functions_function_join_.function_join.html" class="tsd-signature-type">Function_JOIN</a></li>
<li><a href="../classes/_math_functions_functions_function_less_equal_.function_le.html" class="tsd-signature-type">Function_LE</a></li>
<li><a href="../classes/_math_functions_functions_function_len_.function_len.html" class="tsd-signature-type">Function_LEN</a></li>
<li><a href="../classes/_math_functions_functions_function_less_than_.function_lt.html" class="tsd-signature-type">Function_LT</a></li>
<li><a href="../classes/_math_functions_functions_function_max_.function_max.html" class="tsd-signature-type">Function_MAX</a></li>
<li><a href="../classes/_math_functions_functions_function_mean_.function_mean.html" class="tsd-signature-type">Function_MEAN</a></li>
<li><a href="../classes/_math_functions_functions_function_median_.function_median.html" class="tsd-signature-type">Function_MEDIAN</a></li>
<li><a href="../classes/_math_functions_functions_function_min_.function_min.html" class="tsd-signature-type">Function_MIN</a></li>
<li><a href="../classes/_math_functions_functions_function_mul_.function_mul.html" class="tsd-signature-type">Function_MUL</a></li>
<li><a href="../classes/_math_functions_functions_function_neg_edge_.function_neg_edge.html" class="tsd-signature-type">Function_NEG_EDGE</a></li>
<li><a href="../classes/_math_functions_functions_function_not_equal_.function_neq.html" class="tsd-signature-type">Function_NEQ</a></li>
<li><a href="../classes/_math_functions_functions_function_not_.function_not.html" class="tsd-signature-type">Function_NOT</a></li>
<li><a href="../classes/_math_functions_functions_function_or_.function_or.html" class="tsd-signature-type">Function_OR</a></li>
<li><a href="../classes/_math_functions_functions_function_pi_.function_pi.html" class="tsd-signature-type">Function_PI</a></li>
<li><a href="../classes/_math_functions_functions_function_pos_edge_.function_pos_edge.html" class="tsd-signature-type">Function_POS_EDGE</a></li>
<li><a href="../classes/_math_functions_functions_function_pos_in_string_.function_pos_in_string.html" class="tsd-signature-type">Function_POS_IN_STRING</a></li>
<li><a href="../classes/_math_functions_functions_function_pow_.function_pow.html" class="tsd-signature-type">Function_POW</a></li>
<li><a href="../classes/_math_functions_functions_function_random_.function_random.html" class="tsd-signature-type">Function_RANDOM</a></li>
<li><a href="../classes/_math_functions_functions_function_search_replace_.function_replace.html" class="tsd-signature-type">Function_REPLACE</a></li>
<li><a href="../classes/_math_functions_functions_function_round_.function_round.html" class="tsd-signature-type">Function_ROUND</a></li>
<li><a href="../classes/_math_functions_functions_function_scale_.function_scale.html" class="tsd-signature-type">Function_SCALE</a></li>
<li><a href="../classes/_math_functions_functions_function_set_value_.function_set_value.html" class="tsd-signature-type">Function_SET_VALUE</a></li>
<li><a href="../classes/_math_functions_functions_function_shl_.function_shl.html" class="tsd-signature-type">Function_SHL</a></li>
<li><a href="../classes/_math_functions_functions_function_shr_.function_shr.html" class="tsd-signature-type">Function_SHR</a></li>
<li><a href="../classes/_math_functions_functions_function_sin_.function_sin.html" class="tsd-signature-type">Function_SIN</a></li>
<li><a href="../classes/_math_functions_functions_function_split_.function_split.html" class="tsd-signature-type">Function_SPLIT</a></li>
<li><a href="../classes/_math_functions_functions_function_sqrt_.function_sqrt.html" class="tsd-signature-type">Function_SQRT</a></li>
<li><a href="../classes/_math_functions_functions_function_sum_.function_sum.html" class="tsd-signature-type">Function_SUM</a></li>
<li><a href="../classes/_math_functions_functions_function_tan_.function_tan.html" class="tsd-signature-type">Function_TAN</a></li>
<li><a href="../classes/_math_functions_functions_function_to_lower_case_.function_to_lower_case.html" class="tsd-signature-type">Function_TO_LOWER_CASE</a></li>
<li><a href="../classes/_math_functions_functions_function_to_upper_case_.function_to_upper_case.html" class="tsd-signature-type">Function_TO_UPPER_CASE</a></li>
<li><a href="../classes/_math_functions_functions_function_trim_.function_trim.html" class="tsd-signature-type">Function_TRIM</a></li>
<li><a href="../classes/_math_functions_functions_function_trim_end_.function_trim_end.html" class="tsd-signature-type">Function_TRIM_END</a></li>
<li><a href="../classes/_math_functions_functions_function_trim_start_.function_trim_start.html" class="tsd-signature-type">Function_TRIM_START</a></li>
<li><a href="../classes/_math_functions_functions_function_trunc_.function_trunc.html" class="tsd-signature-type">Function_TRUNC</a></li>
<li><a href="../classes/_math_functions_functions_function_value_changed_.function_value_changed.html" class="tsd-signature-type">Function_VALUE_CHANGED</a></li>
<li><a href="../classes/_math_functions_functions_function_xor_.function_xor.html" class="tsd-signature-type">Function_XOR</a></li>
<li><a href="../classes/_math_functions_functions_function_logical_operations_.logicaloperationfunction.html" class="tsd-signature-type">LogicalOperationFunction</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 ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_math_functions_functions_base_function_interface_.ibasefunction.html#clone" class="tsd-kind-icon">clone</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_math_functions_functions_base_function_interface_.ibasefunction.html#execute" class="tsd-kind-icon">execute</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_math_functions_functions_base_function_interface_.ibasefunction.html#executeasync" class="tsd-kind-icon">execute<wbr>Async</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_math_functions_functions_base_function_interface_.ibasefunction.html#getdescription" class="tsd-kind-icon">get<wbr>Description</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_math_functions_functions_base_function_interface_.ibasefunction.html#getname" class="tsd-kind-icon">get<wbr>Name</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_math_functions_functions_base_function_interface_.ibasefunction.html#getoperator" class="tsd-kind-icon">get<wbr>Operator</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_math_functions_functions_base_function_interface_.ibasefunction.html#getpriority" class="tsd-kind-icon">get<wbr>Priority</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_math_functions_functions_base_function_interface_.ibasefunction.html#hashigherprioritythan" class="tsd-kind-icon">has<wbr>Higher<wbr>Priority<wbr>Than</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_math_functions_functions_base_function_interface_.ibasefunction.html#isasyncron" class="tsd-kind-icon">is<wbr>Asyncron</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_math_functions_functions_base_function_interface_.ibasefunction.html#isoperator" class="tsd-kind-icon">is<wbr>Operator</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_math_functions_functions_base_function_interface_.ibasefunction.html#ispreexecutedargument" class="tsd-kind-icon">is<wbr>Preexecuted<wbr>Argument</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_math_functions_functions_base_function_interface_.ibasefunction.html#isstoring" class="tsd-kind-icon">is<wbr>Storing</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_math_functions_functions_base_function_interface_.ibasefunction.html#tostring" class="tsd-kind-icon">to<wbr>String</a></li>
</ul>
</section>
</div>
</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-interface">
<a name="clone" class="tsd-anchor"></a>
<h3>clone</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<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_base_function_interface_.ibasefunction.html" class="tsd-signature-type">IBaseFunction</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/base-function-interface.ts:69</li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="_math_functions_functions_base_function_interface_.ibasefunction.html" class="tsd-signature-type">IBaseFunction</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="execute" class="tsd-anchor"></a>
<h3>execute</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">execute<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><span class="tsd-signature-type">any</span>, node<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, 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">any</span></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/base-function-interface.ts:51</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>execute function and return the result or an error.</p>
</div>
</div>
<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: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
<p>The script environment. cast to <a href="_math_functions_script_environment_.scriptenvironment.html">ScriptEnvironment</a></p>
</div>
</li>
<li>
<h5>node: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
<p>Node of this function. cast to <a href="../classes/_math_functions_nodes_node_class_.node.html">Node</a></p>
</div>
</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>
<div class="tsd-comment tsd-typography">
</div>
</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-interface">
<a name="executeasync" class="tsd-anchor"></a>
<h3>execute<wbr>Async</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<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><span class="tsd-signature-type">any</span>, node<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, 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">
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/base-function-interface.ts:59</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>asyncron execute of the function. Returns a promise with the result or an error.</p>
</div>
</div>
<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: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
<p>The script environment. cast to <a href="_math_functions_script_environment_.scriptenvironment.html">ScriptEnvironment</a></p>
</div>
</li>
<li>
<h5>node: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
<p>Node of this function. cast to <a href="../classes/_math_functions_nodes_node_class_.node.html">Node</a></p>
</div>
</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>
<div class="tsd-comment tsd-typography">
</div>
</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-interface">
<a name="getdescription" class="tsd-anchor"></a>
<h3>get<wbr>Description</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<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">
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/base-function-interface.ts:33</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-interface">
<a name="getname" class="tsd-anchor"></a>
<h3>get<wbr>Name</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<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">
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/base-function-interface.ts:6</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-interface">
<a name="getoperator" class="tsd-anchor"></a>
<h3>get<wbr>Operator</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<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">
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/base-function-interface.ts:28</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the operator-character of this function.</p>
</div>
<dl class="tsd-comment-tags">
<dt>throws</dt>
<dd><p>Throws an error if this function is not useable as operation.</p>
</dd>
</dl>
</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-interface">
<a name="getpriority" class="tsd-anchor"></a>
<h3>get<wbr>Priority</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<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">
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/base-function-interface.ts:19</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-interface">
<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-interface">
<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">
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/base-function-interface.ts:23</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-interface">
<a name="isasyncron" class="tsd-anchor"></a>
<h3>is<wbr>Asyncron</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<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">
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/base-function-interface.ts:42</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-interface">
<a name="isoperator" class="tsd-anchor"></a>
<h3>is<wbr>Operator</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<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">
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/base-function-interface.ts:13</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-interface">
<a name="ispreexecutedargument" class="tsd-anchor"></a>
<h3>is<wbr>Preexecuted<wbr>Argument</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<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><span class="tsd-signature-type">any</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">
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/base-function-interface.ts:67</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: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
<p>The node, none executed (result is not availabe at that time). cast to <a href="../classes/_math_functions_nodes_node_class_.node.html">Node</a></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-interface">
<a name="isstoring" class="tsd-anchor"></a>
<h3>is<wbr>Storing</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<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">
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/base-function-interface.ts:38</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-interface">
<a name="tostring" class="tsd-anchor"></a>
<h3>to<wbr>String</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<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">
<ul>
<li>Defined in Development/math-functions/src/math-functions/functions/base-function-interface.ts:8</li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></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_base_function_interface_.html">"math-<wbr>functions/functions/base-<wbr>function-<wbr>interface"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-external-module">
<a href="_math_functions_functions_base_function_interface_.ibasefunction.html" class="tsd-kind-icon">IBase<wbr>Function</a>
<ul>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_math_functions_functions_base_function_interface_.ibasefunction.html#clone" class="tsd-kind-icon">clone</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_math_functions_functions_base_function_interface_.ibasefunction.html#execute" class="tsd-kind-icon">execute</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_math_functions_functions_base_function_interface_.ibasefunction.html#executeasync" class="tsd-kind-icon">execute<wbr>Async</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_math_functions_functions_base_function_interface_.ibasefunction.html#getdescription" class="tsd-kind-icon">get<wbr>Description</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_math_functions_functions_base_function_interface_.ibasefunction.html#getname" class="tsd-kind-icon">get<wbr>Name</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_math_functions_functions_base_function_interface_.ibasefunction.html#getoperator" class="tsd-kind-icon">get<wbr>Operator</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_math_functions_functions_base_function_interface_.ibasefunction.html#getpriority" class="tsd-kind-icon">get<wbr>Priority</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_math_functions_functions_base_function_interface_.ibasefunction.html#hashigherprioritythan" class="tsd-kind-icon">has<wbr>Higher<wbr>Priority<wbr>Than</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_math_functions_functions_base_function_interface_.ibasefunction.html#isasyncron" class="tsd-kind-icon">is<wbr>Asyncron</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_math_functions_functions_base_function_interface_.ibasefunction.html#isoperator" class="tsd-kind-icon">is<wbr>Operator</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_math_functions_functions_base_function_interface_.ibasefunction.html#ispreexecutedargument" class="tsd-kind-icon">is<wbr>Preexecuted<wbr>Argument</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_math_functions_functions_base_function_interface_.ibasefunction.html#isstoring" class="tsd-kind-icon">is<wbr>Storing</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_math_functions_functions_base_function_interface_.ibasefunction.html#tostring" class="tsd-kind-icon">to<wbr>String</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-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>