forked from kscience/kmath
67 lines
7.2 KiB
HTML
67 lines
7.2 KiB
HTML
|
<!doctype html>
|
||
|
|
<html>
|
||
|
|
<head>
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
||
|
|
<title>bindSymbolOrNull</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-core: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="member" id="content" pageids="kmath-core::space.kscience.kmath.expressions/DSAlgebra/bindSymbolOrNull/#kotlin.String/PointingToDeclaration//244675578">
|
||
|
|
<div class="breadcrumbs"><a href="../../index.html">kmath-core</a><span class="delimiter">/</span><a href="../index.html">space.kscience.kmath.expressions</a><span class="delimiter">/</span><a href="index.html">DSAlgebra</a><span class="delimiter">/</span><span class="current">bindSymbolOrNull</span></div>
|
||
|
|
<div class="cover ">
|
||
|
|
<h1 class="cover"><span>bind</span><wbr><span>Symbol</span><wbr><span>Or</span><wbr><span><span>Null</span></span></h1>
|
||
|
|
</div>
|
||
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-core:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="bind-symbol-or-null.html"><span class="token function">bindSymbolOrNull</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">value<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-d-s-symbol/index.html">DSAlgebra.DSSymbol</a><span class="token operator"><</span><span class="token keyword"></span><a href="index.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="index.html">A</a><span class="token operator">></span><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/SciProgCentre/kmath/tree/master/kmath-core/src/commonMain/kotlin/space/kscience/kmath/expressions/DSAlgebra.kt#L214">source</a>)</span></span></div><p class="paragraph">Wraps a raw string to <a href="index.html">T</a> object. This method is designed for three purposes:</p><ol><li><p class="paragraph">Mathematical constants (<code class="lang-kotlin">e</code>, <code class="lang-kotlin">pi</code>).</p></li><li><p class="paragraph">Variables for expression-like contexts (<code class="lang-kotlin">a</code>, <code class="lang-kotlin">b</code>, <code class="lang-kotlin">c</code>…).</p></li><li><p class="paragraph">Literals (<code class="lang-kotlin">{1, 2}</code>, (<code class="lang-kotlin">(3; 4)</code>)).</p></li></ol><p class="paragraph">If algebra can't parse the string, then this method must throw <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-state-exception/index.html">kotlin.IllegalStateException</a>.</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">an object or <code class="lang-kotlin">null</code> if symbol could not be bound to the context.</p></span><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":kmath-core:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>value</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the raw string.</p></div></div></div></div></div><hr><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="bind-symbol-or-null.html"><span class="token function">bindSymbolOrNull</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">symbol<span class="token operator">: </span><a href="../-symbol/index.html">Symbol</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-d-s-symbol/index.html">DSAlgebra.DSSymbol</a><span class="token operator"><</span><span class="token keyword"></span><a href="index.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="index.html">A</a><span class="token operator">></span><span class="token operator">?</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/SciProgCentre/kmath/tree/master/kmath-core/src/commonMain/kotlin/space/kscience/kmath/expressions/DSAlgebra.kt#L219">source</a>)</span></span></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>
|
||
|
|
|