forked from kscience/kmath
106 lines
22 KiB
HTML
106 lines
22 KiB
HTML
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>AutoDiffProcessor</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/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>const storage = localStorage.getItem("dokka-dark-mode")
|
|
const savedDarkMode = storage ? JSON.parse(storage) : false
|
|
if(savedDarkMode === true){
|
|
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
|
}</script>
|
|
|
|
|
|
<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></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" id="content" pageids="kmath-core::space.kscience.kmath.expressions/AutoDiffProcessor///PointingToDeclaration//244675578">
|
|
<div class="breadcrumbs"><a href="../../index.html">kmath-core</a>/<a href="../index.html">space.kscience.kmath.expressions</a>/<a href="index.html">AutoDiffProcessor</a></div>
|
|
<div class="cover ">
|
|
<h1 class="cover"><span>Auto</span><wbr><span>Diff</span><wbr><span><span>Processor</span></span></h1>
|
|
<div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted">
|
|
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark common-like" data-filterable-current=":kmath-core:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain" data-active="" data-toggle=":kmath-core:dokkaHtmlPartial/commonMain">common</button></div>
|
|
<div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-core:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">fun </span><span class="token keyword">interface </span><a href="index.html">AutoDiffProcessor</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">I</a><span class="token punctuation">, </span><span class="token keyword">out </span><a href="index.html">A</a><span class="token operator"> : </span><a href="../../space.kscience.kmath.operations/-algebra/index.html">Algebra</a><span class="token operator"><</span><span class="token keyword"></span><a href="index.html">I</a><span class="token operator">></span><span class="token operator">></span><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">A factory that converts an expression in autodiff variables to a <a href="../-differentiable-expression/index.html">DifferentiableExpression</a></p></div> </div>
|
|
</div>
|
|
<div class="tabbedcontent">
|
|
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="Functions">Functions</button><button class="section-tab" data-togglable="Extensions">Extensions</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 with-platform-tabs" data-platform-hinted="data-platform-hinted" data-togglable="Parameters">
|
|
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark common-like" data-filterable-current=":kmath-core:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain" data-active="" data-toggle=":kmath-core:dokkaHtmlPartial/commonMain">common</button></div>
|
|
<div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-core:dokkaHtmlPartial/commonMain"><div data-togglable="Parameters"><div class="table" data-togglable="Parameters"><div class="table-row" data-filterable-current=":kmath-core:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><div><span><span>T</span></span></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">type of the constants for the expression</p></div></div></div></div></div><div class="table-row" data-filterable-current=":kmath-core:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><div><span><span>I</span></span></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">type of the actual expression state</p></div></div></div></div></div><div class="table-row" data-filterable-current=":kmath-core:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex"><div><span><span>A</span></span></div></span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">type of expression algebra</p></div></div></div></div></div></div></div></div> </div>
|
|
</div>
|
|
<h2 class="">Functions</h2>
|
|
<div class="table" data-togglable="Functions"><a data-name="892056140%2FFunctions%2F244675578" anchor-label="differentiate" id="892056140%2FFunctions%2F244675578" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain"></a>
|
|
<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><a href="differentiate.html"><span><span>differentiate</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="892056140%2FFunctions%2F244675578"></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 with-platform-tabs" data-platform-hinted="data-platform-hinted">
|
|
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark common-like" data-filterable-current=":kmath-core:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain" data-active="" data-toggle=":kmath-core:dokkaHtmlPartial/commonMain">common</button></div>
|
|
<div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-core:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">fun </span><a href="differentiate.html"><span class="token function">differentiate</span></a><span class="token punctuation">(</span>function<span class="token operator">: </span><span class="token keyword"></span><a href="index.html">A</a><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="index.html">I</a><span class="token punctuation">)</span><span class="token operator">: </span><a href="../-differentiable-expression/index.html">DifferentiableExpression</a><span class="token operator"><</span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator">></span><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>
|
|
<h2 class="tabbedcontent">Extensions</h2>
|
|
<div class="table" data-togglable="Extensions"><a data-name="848144846%2FExtensions%2F244675578" anchor-label="chiSquaredExpression" id="848144846%2FExtensions%2F244675578" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain"></a>
|
|
<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><a href="../chi-squared-expression.html"><span>chi</span><wbr><span>Squared</span><wbr><span><span>Expression</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="848144846%2FExtensions%2F244675578"></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 with-platform-tabs" data-platform-hinted="data-platform-hinted">
|
|
<div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark common-like" data-filterable-current=":kmath-core:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain" data-active="" data-toggle=":kmath-core:dokkaHtmlPartial/commonMain">common</button></div>
|
|
<div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-core:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-name/index.html"><span class="token annotation">JvmName</span></a><span class="token punctuation">(</span><span>name<span class="token operator"> = </span><span class="breakable-word"><span class="token string">"genericChiSquaredExpression"</span></span></span><wbr><span class="token punctuation">)</span></div></div><span class="token keyword"></span><span class="token keyword">fun </span><span class="token operator"><</span><span class="token keyword"></span><a href="../chi-squared-expression.html">T</a><span class="token operator"> : </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-comparable/index.html">Comparable</a><span class="token operator"><</span><span class="token keyword"></span><a href="../chi-squared-expression.html">T</a><span class="token operator">></span><span class="token punctuation">, </span><span class="token keyword"></span><a href="../chi-squared-expression.html">I</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="../chi-squared-expression.html">A</a><span class="token operator"> : </span><a href="../../space.kscience.kmath.operations/-extended-field/index.html">ExtendedField</a><span class="token operator"><</span><span class="token keyword"></span><a href="../chi-squared-expression.html">I</a><span class="token operator">></span>, <a href="../-expression-algebra/index.html">ExpressionAlgebra</a><span class="token operator"><</span><span class="token keyword"></span><a href="../chi-squared-expression.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../chi-squared-expression.html">I</a><span class="token operator">></span><span class="token operator">> </span><a href="index.html">AutoDiffProcessor</a><span class="token operator"><</span><span class="token keyword"></span><a href="../chi-squared-expression.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../chi-squared-expression.html">I</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../chi-squared-expression.html">A</a><span class="token operator">></span><span class="token punctuation">.</span><a href="../chi-squared-expression.html"><span class="token function">chiSquaredExpression</span></a><span class="token punctuation">(</span>x<span class="token operator">: </span><a href="../../space.kscience.kmath.structures/-buffer/index.html">Buffer</a><span class="token operator"><</span><span class="token keyword"></span><a href="../chi-squared-expression.html">T</a><span class="token operator">></span><span class="token punctuation">, </span>y<span class="token operator">: </span><a href="../../space.kscience.kmath.structures/-buffer/index.html">Buffer</a><span class="token operator"><</span><span class="token keyword"></span><a href="../chi-squared-expression.html">T</a><span class="token operator">></span><span class="token punctuation">, </span>yErr<span class="token operator">: </span><a href="../../space.kscience.kmath.structures/-buffer/index.html">Buffer</a><span class="token operator"><</span><span class="token keyword"></span><a href="../chi-squared-expression.html">T</a><span class="token operator">></span><span class="token punctuation">, </span>model<span class="token operator">: </span><span class="token keyword"></span><a href="../chi-squared-expression.html">A</a><span class="token punctuation">.</span><span class="token punctuation">(</span><span class="token keyword"></span><a href="../chi-squared-expression.html">I</a><span class="token punctuation">)</span><span class="token operator"> -> </span><span class="token keyword"></span><a href="../chi-squared-expression.html">I</a><span class="token punctuation">)</span><span class="token operator">: </span><a href="../-differentiable-expression/index.html">DifferentiableExpression</a><span class="token operator"><</span><span class="token keyword"></span><a href="../chi-squared-expression.html">T</a><span class="token operator">></span><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 "><p class="paragraph">Generate a chi squared expression from given x-y-sigma data and inline model. Provides automatic differentiation.</p></div><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="../chi-squared-expression.html">I</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="../chi-squared-expression.html">A</a><span class="token operator"> : </span><a href="../../space.kscience.kmath.operations/-extended-field/index.html">ExtendedField</a><span class="token operator"><</span><span class="token keyword"></span><a href="../chi-squared-expression.html">I</a><span class="token operator">></span>, <a href="../-expression-algebra/index.html">ExpressionAlgebra</a><span class="token operator"><</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../chi-squared-expression.html">I</a><span class="token operator">></span><span class="token operator">> </span><a href="index.html">AutoDiffProcessor</a><span class="token operator"><</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../chi-squared-expression.html">I</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../chi-squared-expression.html">A</a><span class="token operator">></span><span class="token punctuation">.</span><a href="../chi-squared-expression.html"><span class="token function">chiSquaredExpression</span></a><span class="token punctuation">(</span>x<span class="token operator">: </span><a href="../../space.kscience.kmath.structures/-buffer/index.html">Buffer</a><span class="token operator"><</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a><span class="token operator">></span><span class="token punctuation">, </span>y<span class="token operator">: </span><a href="../../space.kscience.kmath.structures/-buffer/index.html">Buffer</a><span class="token operator"><</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a><span class="token operator">></span><span class="token punctuation">, </span>yErr<span class="token operator">: </span><a href="../../space.kscience.kmath.structures/-buffer/index.html">Buffer</a><span class="token operator"><</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a><span class="token operator">></span><span class="token punctuation">, </span>model<span class="token operator">: </span><span class="token keyword"></span><a href="../chi-squared-expression.html">A</a><span class="token punctuation">.</span><span class="token punctuation">(</span><span class="token keyword"></span><a href="../chi-squared-expression.html">I</a><span class="token punctuation">)</span><span class="token operator"> -> </span><span class="token keyword"></span><a href="../chi-squared-expression.html">I</a><span class="token punctuation">)</span><span class="token operator">: </span><a href="../-differentiable-expression/index.html">DifferentiableExpression</a><span class="token operator"><</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a><span class="token operator">></span><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>
|
|
<h2 class="">Sources</h2>
|
|
<div class="table" data-togglable="Sources"><a data-name="-838094129%2FSource%2F244675578" anchor-label="https://github.com/mipt-npm/kmath/tree/master/kmath-core/src/commonMain/kotlin/space/kscience/kmath/expressions/DifferentiableExpression.kt#L67" id="-838094129%2FSource%2F244675578" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain"></a>
|
|
<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><a href="https://github.com/mipt-npm/kmath/tree/master/kmath-core/src/commonMain/kotlin/space/kscience/kmath/expressions/DifferentiableExpression.kt#L67">common source</a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-838094129%2FSource%2F244675578"></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" id="go-to-top-link"></a></span><span>© 2022 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>
|
|
|
|
|