kmath/kmath-kotlingrad/space.kscience.kmath.kotlingrad/-kotlingrad-expression/index.html

135 lines
18 KiB
HTML

<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>KotlingradExpression</title>
</head><body><link href="../../../../../images/logo-icon.svg" rel="icon" type="image/svg"><script>var pathToRoot = "../../../";</script><script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async></script><link href="../../../styles/style.css" rel="Stylesheet"><link href="../../../styles/logo-styles.css" rel="Stylesheet"><link href="../../../styles/jetbrains-mono.css" rel="Stylesheet"><link href="../../../styles/main.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" async></script>
<div id="container">
<div id="leftColumn"><a href="../../../index.html">
<div id="logo"></div>
</a>
<div id="paneSearch"></div>
<div id="sideMenu"></div>
</div>
<div id="main">
<script type="text/javascript" src="../../../scripts/main.js"></script><div id="leftToggler"><span class="icon-toggler"></span></div>
<div class="main-content" id="content" pageids="kmath-kotlingrad::space.kscience.kmath.kotlingrad/KotlingradExpression///PointingToDeclaration//-174194497">
<div class="navigation-wrapper" id="navigation-wrapper">
<div class="breadcrumbs"><a href="../../index.html">kmath-kotlingrad</a>/<a href="../index.html">space.kscience.kmath.kotlingrad</a>/<a href="index.html">KotlingradExpression</a></div>
<div class="pull-right d-flex">
<div id="searchBar"></div>
</div>
</div>
<div class="cover ">
<h1 class="cover"><span>Kotlingrad</span><wbr><span>Expression</span></h1>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-kotlingrad:dokkaHtmlPartial/main"><div class="symbol monospace">class <a href="index.html">KotlingradExpression</a>&lt;<a href="index.html">T</a> : <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.html">Number</a>, <a href="index.html">A</a> : <a href="../../../kmath-core/space.kscience.kmath.operations/-numeric-algebra/index.html">NumericAlgebra</a>&lt;<a href="index.html">T</a>&gt;&gt;(algebra: <a href="index.html">A</a>, mst: <a href="../../../kmath-core/space.kscience.kmath.expressions/-m-s-t/index.html">MST</a>) : <a href="../../../kmath-core/space.kscience.kmath.expressions/-special-differentiable-expression/index.html">SpecialDifferentiableExpression</a>&lt;<a href="index.html">T</a>, <a href="index.html">KotlingradExpression</a>&lt;<a href="index.html">T</a>, <a href="index.html">A</a>&gt;&gt; <span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></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="edu.umontreal.kotlingrad.api/SFun///PointingToDeclaration/">SFun</span>, differentiating it with Kotlin∇, then converting <span data-unresolved-link="edu.umontreal.kotlingrad.api/SFun///PointingToDeclaration/">SFun</span> back to <a href="../../../kmath-core/space.kscience.kmath.expressions/-m-s-t/index.html">MST</a>.</p></div></div>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="Constructors">Constructors</button><button class="section-tab" data-togglable="Functions">Functions</button><button class="section-tab" data-togglable="Properties">Properties</button><button class="section-tab" data-togglable="Parameters">Parameters</button><button class="section-tab" data-togglable="Sources">Sources</button></div>
<div class="tabs-section-body">
<h2 class="">Parameters</h2>
<div data-togglable="Parameters">
<div class="platform-hinted WithExtraAttributes" data-platform-hinted="data-platform-hinted" data-togglable="Parameters"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-kotlingrad:dokkaHtmlPartial/main"><div data-togglable="Parameters"><div class="table" data-togglable="Parameters"><div class="table-row" data-filterable-current=":kmath-kotlingrad:dokkaHtmlPartial/main" data-filterable-set=":kmath-kotlingrad:dokkaHtmlPartial/main"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">T</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">The type of number.</p></div></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 WithExtraAttributes"><div class=""><span class="inline-flex">A</span></div><div><div class="title"><div data-togglable="Parameters"><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>
</div>
<h2 class="tabbedcontent">Constructors</h2>
<div class="table" data-togglable="Constructors"><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-filterable-current=":kmath-kotlingrad:dokkaHtmlPartial/main" data-filterable-set=":kmath-kotlingrad:dokkaHtmlPartial/main">
<div class="main-subrow keyValue TabbedContent">
<div class=""><span class="inline-flex"><a href="-kotlingrad-expression.html">KotlingradExpression</a><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-depenent-content" data-active="" data-togglable=":kmath-kotlingrad:dokkaHtmlPartial/main"><div class="symbol monospace">fun &lt;<a href="index.html">A</a> : <a href="../../../kmath-core/space.kscience.kmath.operations/-numeric-algebra/index.html">NumericAlgebra</a>&lt;<a href="index.html">T</a>&gt;&gt; <a href="-kotlingrad-expression.html">KotlingradExpression</a>(algebra: <a href="index.html">A</a>, mst: <a href="../../../kmath-core/space.kscience.kmath.expressions/-m-s-t/index.html">MST</a>)<span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="brief ">The type of number.</div></div></div>
</div>
</div>
</div>
</div>
</div>
<h2 class="">Functions</h2>
<div class="table" data-togglable="Functions"><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"><a href="derivative-or-null.html">derivativeOrNull</a><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="divergent-group" data-filterable-current=":kmath-kotlingrad:dokkaHtmlPartial/main" data-filterable-set=":kmath-kotlingrad:dokkaHtmlPartial/main"><div class="with-platform-tags"><span class="pull-right"></span></div>
<div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-kotlingrad:dokkaHtmlPartial/main"><div class="symbol monospace">open override fun <a href="derivative-or-null.html">derivativeOrNull</a>(symbols: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a>&lt;<a href="../../../kmath-core/space.kscience.kmath.expressions/-symbol/index.html">Symbol</a>&gt;): <a href="index.html">KotlingradExpression</a>&lt;<a href="index.html">T</a>, <a href="index.html">A</a>&gt;<span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></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"><a href="invoke.html">invoke</a><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="divergent-group" data-filterable-current=":kmath-kotlingrad:dokkaHtmlPartial/main" data-filterable-set=":kmath-kotlingrad:dokkaHtmlPartial/main"><div class="with-platform-tags"><span class="pull-right"></span></div>
<div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-kotlingrad:dokkaHtmlPartial/main"><div class="symbol monospace">open operator override fun <a href="invoke.html">invoke</a>(arguments: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a>&lt;<a href="../../../kmath-core/space.kscience.kmath.expressions/-symbol/index.html">Symbol</a>, <a href="index.html">T</a>&gt;): <a href="index.html">T</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<h2 class="">Properties</h2>
<div class="table" data-togglable="Properties"><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"><a href="algebra.html">algebra</a><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" data-togglable="Properties"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-kotlingrad:dokkaHtmlPartial/main"><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="symbol monospace">val <a href="algebra.html">algebra</a>: <a href="index.html">A</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="brief "><a data-name="-867012571%2FProperties%2F-174194497" anchor-label="algebra" id="-867012571%2FProperties%2F-174194497" data-filterable-set=":kmath-kotlingrad:dokkaHtmlPartial/main"></a>The <a href="index.html">A</a> instance.</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"><a href="mst.html">mst</a><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" data-togglable="Properties"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-kotlingrad:dokkaHtmlPartial/main"><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="symbol monospace">val <a href="mst.html">mst</a>: <a href="../../../kmath-core/space.kscience.kmath.expressions/-m-s-t/index.html">MST</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="brief "><a data-name="702341759%2FProperties%2F-174194497" anchor-label="mst" id="702341759%2FProperties%2F-174194497" data-filterable-set=":kmath-kotlingrad:dokkaHtmlPartial/main"></a>The <a href="../../../kmath-core/space.kscience.kmath.expressions/-m-s-t/index.html">MST</a> node.</div></div></div>
</div>
</div>
</div>
</div>
</div>
<h2 class="">Sources</h2>
<div class="table" data-togglable="Sources"><a data-name="-1880562286%2FSource%2F-174194497" anchor-label="https://github.com/mipt-npm/kmath/tree/master/kmath-kotlingrad/src/main/kotlin/space/kscience/kmath/kotlingrad/KotlingradExpression.kt#L13" id="-1880562286%2FSource%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"><a href="https://github.com/mipt-npm/kmath/tree/master/kmath-kotlingrad/src/main/kotlin/space/kscience/kmath/kotlingrad/KotlingradExpression.kt#L13">jvm source</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1880562286%2FSource%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>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer"><span class="go-to-top-icon"><a href="#content"></a></span><span>© 2021 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>