forked from kscience/kmath
67 lines
20 KiB
HTML
67 lines
20 KiB
HTML
<!doctype html>
|
|
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>integrate</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-functions: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-functions::space.kscience.kmath.integration//integrate/space.kscience.kmath.integration.GaussIntegrator[TypeParam(bounds=[kotlin.Any])]#kotlin.ranges.ClosedRange[kotlin.Double]#kotlin.Int#kotlin.Int#kotlin.Array[space.kscience.kmath.integration.IntegrandFeature]#kotlin.Function1[kotlin.Double,TypeParam(bounds=[kotlin.Any])]/PointingToDeclaration//-597741372">
|
|
<div class="breadcrumbs"><a href="../index.html">kmath-functions</a><span class="delimiter">/</span><a href="index.html">space.kscience.kmath.integration</a><span class="delimiter">/</span><span class="current">integrate</span></div>
|
|
<div class="cover ">
|
|
<h1 class="cover"><span><span>integrate</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-functions:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="../../kmath-memory/space.kscience.kmath/-unstable-k-math-a-p-i/index.html"><span class="token annotation builtin">UnstableKMathAPI</span></a></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="integrate.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 operator">> </span><a href="-gauss-integrator/index.html">GaussIntegrator</a><span class="token operator"><</span><span class="token keyword"></span><a href="integrate.html">T</a><span class="token operator">></span><span class="token punctuation">.</span><a href="integrate.html"><span class="token function">integrate</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">range<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.ranges/-closed-range/index.html">ClosedRange</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></span><span class="parameter ">order<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token operator"> = </span><span class="token constant">10</span><span class="token punctuation">, </span></span><span class="parameter ">intervals<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token operator"> = </span><span class="token constant">10</span><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">vararg </span>features<span class="token operator">: </span><a href="-integrand-feature/index.html">IntegrandFeature</a><span class="token punctuation">, </span></span><span class="parameter ">function<span class="token operator">: </span><span class="token punctuation">(</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 operator"> -> </span><span class="token keyword"></span><a href="integrate.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-univariate-integrand/index.html">UnivariateIntegrand</a><span class="token operator"><</span><span class="token keyword"></span><a href="integrate.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-functions/src/commonMain/kotlin/space/kscience/kmath/integration/GaussIntegrator.kt#L87">source</a>)</span></span></div><p class="paragraph">Integrate using <a href="integrate.html">intervals</a> segments with Gauss-Legendre rule of <a href="integrate.html">order</a> order.</p><hr><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="../../kmath-memory/space.kscience.kmath/-unstable-k-math-a-p-i/index.html"><span class="token annotation builtin">UnstableKMathAPI</span></a></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="integrate.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="integrate.html">T</a><span class="token operator">></span><span class="token operator">> </span><a href="../space.kscience.kmath.functions/-piecewise-polynomial/index.html">PiecewisePolynomial</a><span class="token operator"><</span><span class="token keyword"></span><a href="integrate.html">T</a><span class="token operator">></span><span class="token punctuation">.</span><a href="integrate.html"><span class="token function">integrate</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">algebra<span class="token operator">: </span><a href="../../kmath-core/space.kscience.kmath.operations/-field/index.html">Field</a><span class="token operator"><</span><span class="token keyword"></span><a href="integrate.html">T</a><span class="token operator">></span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../space.kscience.kmath.functions/-piecewise-polynomial/index.html">PiecewisePolynomial</a><span class="token operator"><</span><span class="token keyword"></span><a href="integrate.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-functions/src/commonMain/kotlin/space/kscience/kmath/integration/SplineIntegrator.kt#L25">source</a>)</span></span></div><p class="paragraph">Compute analytical indefinite integral of this <a href="../space.kscience.kmath.functions/-piecewise-polynomial/index.html">PiecewisePolynomial</a>, keeping all intervals intact</p><hr><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="../../kmath-memory/space.kscience.kmath/-unstable-k-math-a-p-i/index.html"><span class="token annotation builtin">UnstableKMathAPI</span></a></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="integrate.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="integrate.html">T</a><span class="token operator">></span><span class="token operator">> </span><a href="../space.kscience.kmath.functions/-piecewise-polynomial/index.html">PiecewisePolynomial</a><span class="token operator"><</span><span class="token keyword"></span><a href="integrate.html">T</a><span class="token operator">></span><span class="token punctuation">.</span><a href="integrate.html"><span class="token function">integrate</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">algebra<span class="token operator">: </span><a href="../../kmath-core/space.kscience.kmath.operations/-field/index.html">Field</a><span class="token operator"><</span><span class="token keyword"></span><a href="integrate.html">T</a><span class="token operator">></span><span class="token punctuation">, </span></span><span class="parameter ">range<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.ranges/-closed-range/index.html">ClosedRange</a><span class="token operator"><</span><span class="token keyword"></span><a href="integrate.html">T</a><span class="token operator">></span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="integrate.html">T</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/SciProgCentre/kmath/tree/master/kmath-functions/src/commonMain/kotlin/space/kscience/kmath/integration/SplineIntegrator.kt#L35">source</a>)</span></span></div><p class="paragraph">Compute definite integral of given <a href="../space.kscience.kmath.functions/-piecewise-polynomial/index.html">PiecewisePolynomial</a> piece by piece in a given <a href="integrate.html">range</a> Requires <a href="-univariate-integration-nodes/index.html">UnivariateIntegrationNodes</a> or <a href="-integration-range/index.html">IntegrationRange</a> and <a href="-integrand-max-calls/index.html">IntegrandMaxCalls</a></p><p class="paragraph">TODO use context receiver for algebra</p><hr><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="../../kmath-memory/space.kscience.kmath/-unstable-k-math-a-p-i/index.html"><span class="token annotation builtin">UnstableKMathAPI</span></a></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="integrate.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 operator">> </span><a href="index.html#1666897239%2FClasslikes%2F-597741372">UnivariateIntegrator</a><span class="token operator"><</span><span class="token keyword"></span><a href="integrate.html">T</a><span class="token operator">></span><span class="token punctuation">.</span><a href="integrate.html"><span class="token function">integrate</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">vararg </span>features<span class="token operator">: </span><a href="-integrand-feature/index.html">IntegrandFeature</a><span class="token punctuation">, </span></span><span class="parameter ">function<span class="token operator">: </span><span class="token punctuation">(</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 operator"> -> </span><span class="token keyword"></span><a href="integrate.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-univariate-integrand/index.html">UnivariateIntegrand</a><span class="token operator"><</span><span class="token keyword"></span><a href="integrate.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-functions/src/commonMain/kotlin/space/kscience/kmath/integration/UnivariateIntegrand.kt#L70">source</a>)</span></span></div><p class="paragraph">A shortcut method to integrate a <a href="integrate.html">function</a> with additional <a href="integrate.html">features</a>. Range must be provided in features. The <a href="integrate.html">function</a> is placed in the end position to allow passing a lambda.</p><hr><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="../../kmath-memory/space.kscience.kmath/-unstable-k-math-a-p-i/index.html"><span class="token annotation builtin">UnstableKMathAPI</span></a></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="integrate.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 operator">> </span><a href="index.html#1666897239%2FClasslikes%2F-597741372">UnivariateIntegrator</a><span class="token operator"><</span><span class="token keyword"></span><a href="integrate.html">T</a><span class="token operator">></span><span class="token punctuation">.</span><a href="integrate.html"><span class="token function">integrate</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">range<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.ranges/-closed-range/index.html">ClosedRange</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></span><span class="parameter "><span class="token keyword">vararg </span>features<span class="token operator">: </span><a href="-integrand-feature/index.html">IntegrandFeature</a><span class="token punctuation">, </span></span><span class="parameter ">function<span class="token operator">: </span><span class="token punctuation">(</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 operator"> -> </span><span class="token keyword"></span><a href="integrate.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-univariate-integrand/index.html">UnivariateIntegrand</a><span class="token operator"><</span><span class="token keyword"></span><a href="integrate.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-functions/src/commonMain/kotlin/space/kscience/kmath/integration/UnivariateIntegrand.kt#L80">source</a>)</span></span></div><p class="paragraph">A shortcut method to integrate a <a href="integrate.html">function</a> in <a href="integrate.html">range</a> with additional <a href="integrate.html">features</a>. The <a href="integrate.html">function</a> is placed in the end position to allow passing a lambda.</p><hr><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="../../kmath-memory/space.kscience.kmath/-unstable-k-math-a-p-i/index.html"><span class="token annotation builtin">UnstableKMathAPI</span></a></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="integrate.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 operator">> </span><a href="index.html#1666897239%2FClasslikes%2F-597741372">UnivariateIntegrator</a><span class="token operator"><</span><span class="token keyword"></span><a href="integrate.html">T</a><span class="token operator">></span><span class="token punctuation">.</span><a href="integrate.html"><span class="token function">integrate</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">range<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.ranges/-closed-range/index.html">ClosedRange</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></span><span class="parameter ">featureBuilder<span class="token operator">: </span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.html">MutableList</a><span class="token operator"><</span><span class="token keyword"></span><a href="-integrand-feature/index.html">IntegrandFeature</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="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html">Unit</a><span class="token operator"> = </span>{}<span class="token punctuation">, </span></span><span class="parameter ">function<span class="token operator">: </span><span class="token punctuation">(</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 operator"> -> </span><span class="token keyword"></span><a href="integrate.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-univariate-integrand/index.html">UnivariateIntegrand</a><span class="token operator"><</span><span class="token keyword"></span><a href="integrate.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-functions/src/commonMain/kotlin/space/kscience/kmath/integration/UnivariateIntegrand.kt#L91">source</a>)</span></span></div><p class="paragraph">A shortcut method to integrate a <a href="integrate.html">function</a> in <a href="integrate.html">range</a> with additional features. The <a href="integrate.html">function</a> is placed in the end position to allow passing a lambda.</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>
|
|
|