kscience/kmath
9
0
Fork 1
Code Issues Pull Requests 6 Packages Projects Releases 16 Wiki Activity
gh-pages
kmath/kmath-ast/space.kscience.kmath.ast/index.html

184 lines
22 KiB
HTML
Raw Permalink Blame History

<!doctype html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>space.kscience.kmath.ast</title>
<link href="../../images/logo-icon.svg" rel="icon" type="image/svg"><script>var pathToRoot = "../../";</script> <script>const storage = localStorage.getItem("dokka-dark-mode")
if (storage == null) {
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
if (osDarkSchemePreferred === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
} else {
const savedDarkMode = JSON.parse(storage)
if(savedDarkMode === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
}
</script>
<script type="text/javascript" src="../../scripts/sourceset_dependencies.js" async></script>
<link href="../../styles/style.css" rel="Stylesheet">
<link href="../../styles/jetbrains-mono.css" rel="Stylesheet">
<link href="../../styles/main.css" rel="Stylesheet">
<link href="../../styles/prism.css" rel="Stylesheet">
<link href="../../styles/logo-styles.css" rel="Stylesheet">
<script type="text/javascript" src="../../scripts/clipboard.js" async></script>
<script type="text/javascript" src="../../scripts/navigation-loader.js" async></script>
<script type="text/javascript" src="../../scripts/platform-content-handler.js" async></script>
<script type="text/javascript" src="../../scripts/main.js" defer></script>
<script type="text/javascript" src="../../scripts/prism.js" async></script>
<script type="text/javascript" src="../../scripts/symbol-parameters-wrapper_deferred.js" defer></script></head>
<body>
<div class="navigation-wrapper" id="navigation-wrapper">
<div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="library-name">
<a href="../../index.html">
<span>kmath</span> </a> </div>
<div>0.3.1-dev-RC
</div>
<div class="pull-right d-flex">
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector common-like" data-active="" data-filter=":kmath-ast:dokkaHtmlPartial/commonMain">common</button>
</div>
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
<div id="searchBar"></div>
</div>
</div>
<div id="container">
<div id="leftColumn">
<div id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="package" id="content" pageids="kmath-ast::space.kscience.kmath.ast////PointingToDeclaration//353974653">
<div class="breadcrumbs"><a href="../index.html">kmath-ast</a><span class="delimiter">/</span><span class="current">space.kscience.kmath.ast</span></div>
<div class="cover ">
<h1 class="cover"><span><span>Package-level</span></span> <span><span>declarations</span></span></h1>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="TYPE">Types</button><button class="section-tab" data-togglable="FUNCTION,EXTENSION_FUNCTION">Functions</button></div>
<div class="tabs-section-body">
<div data-togglable="TYPE">
<h2 class="">Types</h2>
<div class="table"><a data-name="572514358%2FClasslikes%2F353974653" anchor-label="ArithmeticsEvaluator" id="572514358%2FClasslikes%2F353974653" data-filterable-set=":kmath-ast:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-ast:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-ast:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-arithmetics-evaluator/index.html"><span>Arithmetics</span><wbr><span><span>Evaluator</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="572514358%2FClasslikes%2F353974653"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-ast:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">object </span><a href="-arithmetics-evaluator/index.html">ArithmeticsEvaluator</a> : <span data-unresolved-link="com.github.h0tk3y.betterParse.grammar/Grammar///PointingToDeclaration/">Grammar</span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../../kmath-core/space.kscience.kmath.expressions/-m-s-t/index.html">MST</a><span class="token operator">&gt; </span></div><div class="brief "><p class="paragraph">better-parse implementation of grammar defined in the ArithmeticsEvaluator.g4.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1995117784%2FClasslikes%2F353974653" anchor-label="TypedMst" id="1995117784%2FClasslikes%2F353974653" data-filterable-set=":kmath-ast:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-ast:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-ast:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-typed-mst/index.html"><span>Typed</span><wbr><span><span>Mst</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1995117784%2FClasslikes%2F353974653"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-ast:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">interface </span><a href="-typed-mst/index.html">TypedMst</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-typed-mst/index.html">T</a><span class="token operator">&gt;</span></div><div class="brief "><p class="paragraph">MST form where all values belong to the type <a href="-typed-mst/index.html">T</a>. It is optimal for constant folding, dynamic compilation, etc.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div data-togglable="EXTENSION_FUNCTION">
<h2 class="">Functions</h2>
<div class="table"><a data-name="-129561362%2FFunctions%2F353974653" anchor-label="evaluateConstants" id="-129561362%2FFunctions%2F353974653" data-filterable-set=":kmath-ast:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":kmath-ast:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-ast:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="evaluate-constants.html"><span>evaluate</span><wbr><span><span>Constants</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-129561362%2FFunctions%2F353974653"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-ast:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="evaluate-constants.html">T</a><span class="token operator">&gt; </span><a href="../../kmath-core/space.kscience.kmath.expressions/-m-s-t/index.html">MST</a><span class="token punctuation">.</span><a href="evaluate-constants.html"><span class="token function">evaluateConstants</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">algebra<span class="token operator">: </span><a href="../../kmath-core/space.kscience.kmath.operations/-algebra/index.html">Algebra</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="evaluate-constants.html">T</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-typed-mst/index.html">TypedMst</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="evaluate-constants.html">T</a><span class="token operator">&gt;</span></div><div class="brief "><p class="paragraph">Evaluates constants in given <a href="../../kmath-core/space.kscience.kmath.expressions/-m-s-t/index.html">MST</a> for given <a href="evaluate-constants.html">algebra</a> at the same time with converting to <a href="-typed-mst/index.html">TypedMst</a>.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1211644009%2FFunctions%2F353974653" anchor-label="interpret" id="-1211644009%2FFunctions%2F353974653" data-filterable-set=":kmath-ast:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":kmath-ast:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-ast:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="interpret.html"><span><span>interpret</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1211644009%2FFunctions%2F353974653"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-ast:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="interpret.html">T</a><span class="token operator">&gt; </span><a href="-typed-mst/index.html">TypedMst</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="interpret.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="interpret.html"><span class="token function">interpret</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">algebra<span class="token operator">: </span><a href="../../kmath-core/space.kscience.kmath.operations/-algebra/index.html">Algebra</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="interpret.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">vararg </span>arguments<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html">Pair</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../../kmath-core/space.kscience.kmath.expressions/-symbol/index.html">Symbol</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="interpret.html">T</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="interpret.html">T</a></div><div class="brief "><p class="paragraph">Interprets the <a href="-typed-mst/index.html">TypedMst</a> node with this <a href="../../kmath-core/space.kscience.kmath.operations/-algebra/index.html">Algebra</a> and optional <a href="interpret.html">arguments</a>.</p></div><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="interpret.html">T</a><span class="token operator">&gt; </span><a href="-typed-mst/index.html">TypedMst</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="interpret.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="interpret.html"><span class="token function">interpret</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">algebra<span class="token operator">: </span><a href="../../kmath-core/space.kscience.kmath.operations/-algebra/index.html">Algebra</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="interpret.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">, </span></span><span class="parameter ">arguments<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../../kmath-core/space.kscience.kmath.expressions/-symbol/index.html">Symbol</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="interpret.html">T</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="interpret.html">T</a></div><div class="brief "><p class="paragraph">Interprets the <a href="-typed-mst/index.html">TypedMst</a> node with this <a href="../../kmath-core/space.kscience.kmath.operations/-algebra/index.html">Algebra</a> and <a href="interpret.html">arguments</a>.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="320959774%2FFunctions%2F353974653" anchor-label="parseMath" id="320959774%2FFunctions%2F353974653" data-filterable-set=":kmath-ast:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":kmath-ast:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-ast:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="parse-math.html"><span>parse</span><wbr><span><span>Math</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="320959774%2FFunctions%2F353974653"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-ast:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">.</span><a href="parse-math.html"><span class="token function">parseMath</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../kmath-core/space.kscience.kmath.expressions/-m-s-t/index.html">MST</a></div><div class="brief "><p class="paragraph">Parses the string into <a href="../../kmath-core/space.kscience.kmath.expressions/-m-s-t/index.html">MST</a> using <a href="-arithmetics-evaluator/index.html">ArithmeticsEvaluator</a>.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="2087520594%2FFunctions%2F353974653" anchor-label="toExpression" id="2087520594%2FFunctions%2F353974653" data-filterable-set=":kmath-ast:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":kmath-ast:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-ast:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="to-expression.html"><span>to</span><wbr><span><span>Expression</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2087520594%2FFunctions%2F353974653"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-ast:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="to-expression.html">T</a><span class="token operator"> : </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">&gt; </span><a href="-typed-mst/index.html">TypedMst</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="to-expression.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="to-expression.html"><span class="token function">toExpression</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">algebra<span class="token operator">: </span><a href="../../kmath-core/space.kscience.kmath.operations/-algebra/index.html">Algebra</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="to-expression.html">T</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../kmath-core/space.kscience.kmath.expressions/-expression/index.html">Expression</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="to-expression.html">T</a><span class="token operator">&gt;</span></div><div class="brief "><p class="paragraph">Interpret this <a href="-typed-mst/index.html">TypedMst</a> node as expression.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1074205975%2FFunctions%2F353974653" anchor-label="tryParseMath" id="1074205975%2FFunctions%2F353974653" data-filterable-set=":kmath-ast:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":kmath-ast:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-ast:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="try-parse-math.html"><span>try</span><wbr><span>Parse</span><wbr><span><span>Math</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1074205975%2FFunctions%2F353974653"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-ast:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">.</span><a href="try-parse-math.html"><span class="token function">tryParseMath</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="com.github.h0tk3y.betterParse.parser/ParseResult///PointingToDeclaration/">ParseResult</span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../../kmath-core/space.kscience.kmath.expressions/-m-s-t/index.html">MST</a><span class="token operator">&gt;</span></div><div class="brief "><p class="paragraph">Tries to parse the string into <a href="../../kmath-core/space.kscience.kmath.expressions/-m-s-t/index.html">MST</a> using <a href="-arithmetics-evaluator/index.html">ArithmeticsEvaluator</a>. Returns <span data-unresolved-link="com.github.h0tk3y.betterParse.parser/ParseResult///PointingToDeclaration/">ParseResult</span> representing expression or error.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>
</div>
</div>
</body>
</html>
View Git Blame Copy Permalink