kmath/kmath-core/space.kscience.kmath.expressions/-d-s-compiler/get-partial-derivative-index.html

67 lines
7.0 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!doctype html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>getPartialDerivativeIndex</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/DSCompiler/getPartialDerivativeIndex/#kotlin.IntArray/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">DSCompiler</a><span class="delimiter">/</span><span class="current">getPartialDerivativeIndex</span></div>
<div class="cover ">
<h1 class="cover"><span>get</span><wbr><span>Partial</span><wbr><span>Derivative</span><wbr><span><span>Index</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><a href="get-partial-derivative-index.html"><span class="token function">getPartialDerivativeIndex</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">vararg </span>orders<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><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/DSCompiler.kt#L148">source</a>)</span></span></div><p class="paragraph">Get the index of a partial derivative in the array.</p><p class="paragraph">If all orders are set to 0, then the 0<sup>th</sup> order derivative is returned, which is the value of the function.</p><p class="paragraph">The indices of derivatives are between 0 and <a href="size.html">size</a> 1. Their specific order is fixed for a given compiler, but otherwise not publicly specified. There are however some simple cases which have guaranteed indices:</p><ul><li><p class="paragraph">the index of 0<sup>th</sup> order derivative is always 0</p></li><li><p class="paragraph">if there is only 1 <a href="free-parameters.html">freeParameters</a>, then the derivatives are sorted in increasing derivation order (i.e., f at index 0, df/dp at index 1, d<sup>2</sup>f/dp<sup>2</sup> at index 2 … d<sup>k</sup>f/dp<sup>k</sup> at index k),</p></li><li><p class="paragraph">if the <a href="order.html">order</a> is 1, then the derivatives are sorted in increasing free parameter order (i.e., f at index 0, df/dx<sub>1</sub> at index 1, df/dx<sub>2</sub> at index 2 … df/dx<sub>k</sub> at index k),</p></li><li><p class="paragraph">all other cases are not publicly specified.</p></li></ul><p class="paragraph">This method is the inverse of method <a href="get-partial-derivative-orders.html">getPartialDerivativeOrders</a>.</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">index of the partial derivative.</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>orders</span></span></u></div></span></div><div><div class="title"><p class="paragraph">derivation orders with respect to each parameter.</p></div></div></div></div></div><h4 class="">See also</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><a href="get-partial-derivative-orders.html"><span>DSCompiler.</span><wbr><span>get</span><wbr><span>Partial</span><wbr><span>Derivative</span><wbr><span><span>Orders</span></span></a></div></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>© 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>