forked from kscience/kmath
159 lines
17 KiB
HTML
159 lines
17 KiB
HTML
<!doctype html>
|
|
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>KotlingradExpression</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 jvm-like" data-active="" data-filter=":kmath-kotlingrad:dokkaHtmlPartial/main">jvm</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="classlike" id="content" pageids="kmath-kotlingrad::space.kscience.kmath.kotlingrad/KotlingradExpression///PointingToDeclaration//-174194497">
|
|
<div class="breadcrumbs"><a href="../../index.html">kmath-kotlingrad</a><span class="delimiter">/</span><a href="../index.html">space.kscience.kmath.kotlingrad</a><span class="delimiter">/</span><span class="current">KotlingradExpression</span></div>
|
|
<div class="cover ">
|
|
<h1 class="cover"><span>Kotlingrad</span><wbr><span><span>Expression</span></span></h1>
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-kotlingrad:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword">class </span><a href="index.html">KotlingradExpression</a><span class="token operator"><</span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator"> : </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.html">Number</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="index.html">A</a><span class="token operator"> : </span><a href="../../../kmath-core/space.kscience.kmath.operations/-numeric-algebra/index.html">NumericAlgebra</a><span class="token operator"><</span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator">></span><span class="token operator">></span><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>algebra<span class="token operator">: </span><a href="index.html">A</a><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>mst<span class="token operator">: </span><a href="../../../kmath-core/space.kscience.kmath.expressions/-m-s-t/index.html">MST</a></span></span><span class="token punctuation">)</span> : <a href="../../../kmath-core/space.kscience.kmath.expressions/-special-differentiable-expression/index.html">SpecialDifferentiableExpression</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">KotlingradExpression</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-kotlingrad/src/main/kotlin/space/kscience/kmath/kotlingrad/KotlingradExpression.kt#L24">source</a>)</span></span></div><p class="paragraph">Represents <a href="../../../kmath-core/space.kscience.kmath.expressions/-m-s-t/index.html">MST</a> based <a href="../../../kmath-core/space.kscience.kmath.expressions/-differentiable-expression/index.html">DifferentiableExpression</a> relying on <a href="https://github.com/breandan/kotlingrad">Kotlin∇</a>.</p><p class="paragraph">The principle of this API is converting the <a href="mst.html">mst</a> to an <span data-unresolved-link="ai.hypergraph.kotlingrad.api/SFun///PointingToDeclaration/">SFun</span>, differentiating it with Kotlin∇, then converting <span data-unresolved-link="ai.hypergraph.kotlingrad.api/SFun///PointingToDeclaration/">SFun</span> back to <a href="../../../kmath-core/space.kscience.kmath.expressions/-m-s-t/index.html">MST</a>.</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":kmath-kotlingrad:dokkaHtmlPartial/main" data-filterable-set=":kmath-kotlingrad:dokkaHtmlPartial/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>T</span></span></u></div></span></div><div><div class="title"><p class="paragraph">The type of number.</p></div></div></div></div><div class="table-row" data-filterable-current=":kmath-kotlingrad:dokkaHtmlPartial/main" data-filterable-set=":kmath-kotlingrad:dokkaHtmlPartial/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>A</span></span></u></div></span></div><div><div class="title"><p class="paragraph">The <a href="../../../kmath-core/space.kscience.kmath.operations/-numeric-algebra/index.html">NumericAlgebra</a> of <a href="index.html">T</a>.</p></div></div></div></div></div></div></div>
|
|
</div>
|
|
<div class="tabbedcontent">
|
|
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,FUNCTION,PROPERTY">Members</button></div>
|
|
<div class="tabs-section-body">
|
|
<div data-togglable="CONSTRUCTOR">
|
|
<h2 class="">Constructors</h2>
|
|
<div class="table"><a data-name="-1167957987%2FConstructors%2F-174194497" anchor-label="KotlingradExpression" id="-1167957987%2FConstructors%2F-174194497" data-filterable-set=":kmath-kotlingrad:dokkaHtmlPartial/main"></a>
|
|
<div class="table-row" data-togglable="CONSTRUCTOR" data-filterable-current=":kmath-kotlingrad:dokkaHtmlPartial/main" data-filterable-set=":kmath-kotlingrad:dokkaHtmlPartial/main">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="-kotlingrad-expression.html"><span>Kotlingrad</span><wbr><span><span>Expression</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1167957987%2FConstructors%2F-174194497"></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-kotlingrad:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">algebra<span class="token operator">: </span><a href="index.html">A</a><span class="token punctuation">, </span></span><span class="parameter ">mst<span class="token operator">: </span><a href="../../../kmath-core/space.kscience.kmath.expressions/-m-s-t/index.html">MST</a></span></span><span class="token punctuation">)</span></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div data-togglable="FUNCTION">
|
|
<h2 class="">Functions</h2>
|
|
<div class="table"><a data-name="89204411%2FFunctions%2F-174194497" anchor-label="derivativeOrNull" id="89204411%2FFunctions%2F-174194497" data-filterable-set=":kmath-kotlingrad:dokkaHtmlPartial/main"></a>
|
|
<div class="table-row" data-filterable-current=":kmath-kotlingrad:dokkaHtmlPartial/main" data-filterable-set=":kmath-kotlingrad:dokkaHtmlPartial/main">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="derivative-or-null.html"><span>derivative</span><wbr><span>Or</span><wbr><span><span>Null</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="89204411%2FFunctions%2F-174194497"></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-kotlingrad:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="derivative-or-null.html"><span class="token function">derivativeOrNull</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">symbols<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator"><</span><span class="token keyword"></span><a href="../../../kmath-core/space.kscience.kmath.expressions/-symbol/index.html">Symbol</a><span class="token operator">></span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">KotlingradExpression</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></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-164894772%2FFunctions%2F-174194497" anchor-label="invoke" id="-164894772%2FFunctions%2F-174194497" data-filterable-set=":kmath-kotlingrad:dokkaHtmlPartial/main"></a>
|
|
<div class="table-row" data-filterable-current=":kmath-kotlingrad:dokkaHtmlPartial/main" data-filterable-set=":kmath-kotlingrad:dokkaHtmlPartial/main">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="invoke.html"><span><span>invoke</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-164894772%2FFunctions%2F-174194497"></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-kotlingrad:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">operator override </span><span class="token keyword">fun </span><a href="invoke.html"><span class="token function">invoke</span></a><span class="token punctuation">(</span><span class="parameters "><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"><</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="index.html">T</a><span class="token operator">></span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">T</a></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div data-togglable="PROPERTY">
|
|
<h2 class="">Properties</h2>
|
|
<div class="table"><a data-name="-867012571%2FProperties%2F-174194497" anchor-label="algebra" id="-867012571%2FProperties%2F-174194497" data-filterable-set=":kmath-kotlingrad:dokkaHtmlPartial/main"></a>
|
|
<div class="table-row" data-filterable-current=":kmath-kotlingrad:dokkaHtmlPartial/main" data-filterable-set=":kmath-kotlingrad:dokkaHtmlPartial/main">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="algebra.html"><span><span>algebra</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-867012571%2FProperties%2F-174194497"></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-kotlingrad:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="algebra.html">algebra</a><span class="token operator">: </span><a href="index.html">A</a></div><div class="brief "><p class="paragraph">The <a href="index.html">A</a> instance.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="702341759%2FProperties%2F-174194497" anchor-label="mst" id="702341759%2FProperties%2F-174194497" data-filterable-set=":kmath-kotlingrad:dokkaHtmlPartial/main"></a>
|
|
<div class="table-row" data-filterable-current=":kmath-kotlingrad:dokkaHtmlPartial/main" data-filterable-set=":kmath-kotlingrad:dokkaHtmlPartial/main">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="mst.html"><span><span>mst</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="702341759%2FProperties%2F-174194497"></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-kotlingrad:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="mst.html">mst</a><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">The <a href="../../../kmath-core/space.kscience.kmath.expressions/-m-s-t/index.html">MST</a> node.</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>
|
|
|