forked from kscience/kmath
67 lines
14 KiB
HTML
67 lines
14 KiB
HTML
<!doctype html>
|
|
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>simpleAutoDiff</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//simpleAutoDiff/TypeParam(bounds=[space.kscience.kmath.operations.Field[TypeParam(bounds=[kotlin.Any])]])#kotlin.collections.Map[space.kscience.kmath.expressions.Symbol,TypeParam(bounds=[kotlin.Any])]#kotlin.Function1[space.kscience.kmath.expressions.SimpleAutoDiffField[TypeParam(bounds=[kotlin.Any]),TypeParam(bounds=[space.kscience.kmath.operations.Field[TypeParam(bounds=[kotlin.Any])]])],space.kscience.kmath.expressions.AutoDiffValue[TypeParam(bounds=[kotlin.Any])]]/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><span class="current">simpleAutoDiff</span></div>
|
|
<div class="cover ">
|
|
<h1 class="cover"><span>simple</span><wbr><span>Auto</span><wbr><span><span>Diff</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"></span><span class="token keyword">fun </span><span class="token operator"><</span><span class="token keyword"></span><a href="simple-auto-diff.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 punctuation">, </span><span class="token keyword"></span><a href="simple-auto-diff.html">F</a><span class="token operator"> : </span><a href="../space.kscience.kmath.operations/-field/index.html">Field</a><span class="token operator"><</span><span class="token keyword"></span><a href="simple-auto-diff.html">T</a><span class="token operator">></span><span class="token operator">> </span><a href="simple-auto-diff.html">F</a><span class="token punctuation">.</span><a href="simple-auto-diff.html"><span class="token function">simpleAutoDiff</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">bindings<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="-symbol/index.html">Symbol</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="simple-auto-diff.html">T</a><span class="token operator">></span><span class="token punctuation">, </span></span><span class="parameter ">body<span class="token operator">: </span><span class="token keyword"></span><a href="-simple-auto-diff-field/index.html">SimpleAutoDiffField</a><span class="token operator"><</span><span class="token keyword"></span><a href="simple-auto-diff.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="simple-auto-diff.html">F</a><span class="token operator">></span><span class="token punctuation">.</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -> </span><span class="token keyword"></span><a href="-auto-diff-value/index.html">AutoDiffValue</a><span class="token operator"><</span><span class="token keyword"></span><a href="simple-auto-diff.html">T</a><span class="token operator">></span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-derivation-result/index.html">DerivationResult</a><span class="token operator"><</span><span class="token keyword"></span><a href="simple-auto-diff.html">T</a><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/SimpleAutoDiff.kt#L217">source</a>)</span></span></div><p class="paragraph">Runs differentiation and establishes <a href="-simple-auto-diff-field/index.html">SimpleAutoDiffField</a> context inside the block of code.</p><p class="paragraph">The partial derivatives are placed in argument <code class="lang-kotlin">d</code> variable</p><p class="paragraph">Example:</p><div class="sample-container"><pre><code class="block lang-kotlin" theme="idea">val x by symbol // define variable(s) and their values<br>val y = DoubleField.withAutoDiff() { sqr(x) + 5 * x + 3 } // write formulate in deriv context<br>assertEquals(17.0, y.x) // the value of result (y)<br>assertEquals(9.0, x.d) // dy/dx</code></pre><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><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">the result of differentiation.</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>body</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the action in <a href="-simple-auto-diff-field/index.html">SimpleAutoDiffField</a> context returning <a href="-auto-diff-value/index.html">AutoDiffValue</a> to differentiate with respect to.</p></div></div></div></div></div><hr><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><span class="token operator"><</span><span class="token keyword"></span><a href="simple-auto-diff.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 punctuation">, </span><span class="token keyword"></span><a href="simple-auto-diff.html">F</a><span class="token operator"> : </span><a href="../space.kscience.kmath.operations/-field/index.html">Field</a><span class="token operator"><</span><span class="token keyword"></span><a href="simple-auto-diff.html">T</a><span class="token operator">></span><span class="token operator">> </span><a href="simple-auto-diff.html">F</a><span class="token punctuation">.</span><a href="simple-auto-diff.html"><span class="token function">simpleAutoDiff</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">vararg </span>bindings<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html">Pair</a><span class="token operator"><</span><span class="token keyword"></span><a href="-symbol/index.html">Symbol</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="simple-auto-diff.html">T</a><span class="token operator">></span><span class="token punctuation">, </span></span><span class="parameter ">body<span class="token operator">: </span><span class="token keyword"></span><a href="-simple-auto-diff-field/index.html">SimpleAutoDiffField</a><span class="token operator"><</span><span class="token keyword"></span><a href="simple-auto-diff.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="simple-auto-diff.html">F</a><span class="token operator">></span><span class="token punctuation">.</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -> </span><span class="token keyword"></span><a href="-auto-diff-value/index.html">AutoDiffValue</a><span class="token operator"><</span><span class="token keyword"></span><a href="simple-auto-diff.html">T</a><span class="token operator">></span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-derivation-result/index.html">DerivationResult</a><span class="token operator"><</span><span class="token keyword"></span><a href="simple-auto-diff.html">T</a><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/SimpleAutoDiff.kt#L226">source</a>)</span></span></div><br><hr><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><span class="token operator"><</span><span class="token keyword"></span><a href="simple-auto-diff.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 punctuation">, </span><span class="token keyword"></span><a href="simple-auto-diff.html">F</a><span class="token operator"> : </span><a href="../space.kscience.kmath.operations/-field/index.html">Field</a><span class="token operator"><</span><span class="token keyword"></span><a href="simple-auto-diff.html">T</a><span class="token operator">></span><span class="token operator">> </span><a href="simple-auto-diff.html"><span class="token function">simpleAutoDiff</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">field<span class="token operator">: </span><a href="simple-auto-diff.html">F</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-auto-diff-processor/index.html">AutoDiffProcessor</a><span class="token operator"><</span><span class="token keyword"></span><a href="simple-auto-diff.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="-auto-diff-value/index.html">AutoDiffValue</a><span class="token operator"><</span><span class="token keyword"></span><a href="simple-auto-diff.html">T</a><span class="token operator">></span><span class="token punctuation">, </span><span class="token keyword"></span><a href="-simple-auto-diff-field/index.html">SimpleAutoDiffField</a><span class="token operator"><</span><span class="token keyword"></span><a href="simple-auto-diff.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="simple-auto-diff.html">F</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/SimpleAutoDiff.kt#L254">source</a>)</span></span></div><p class="paragraph">Generate <a href="-auto-diff-processor/index.html">AutoDiffProcessor</a> for <a href="-simple-auto-diff-expression/index.html">SimpleAutoDiffExpression</a></p></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>
|
|
|