kmath/kmath-functions/space.kscience.kmath.integration/integrate.html

40 lines
19 KiB
HTML

<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>integrate</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"><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-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>/<a href="index.html">space.kscience.kmath.integration</a>/<a href="integrate.html">integrate</a></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-depenent-content" data-active="" data-togglable=":kmath-functions:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation">@</span><a href="../../kmath-core/space.kscience.kmath.misc/-unstable-k-math-a-p-i/index.html"><span class="token annotation">UnstableKMathAPI</span></a></div></div><span class="token keyword"></span><span class="token keyword">fun </span><span class="token operator">&lt;</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">&gt; </span><a href="-gauss-integrator/index.html">GaussIntegrator</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="integrate.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="integrate.html"><span class="token function">integrate</span></a><span class="token punctuation">(</span>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">&lt;</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">&gt;</span><span class="token punctuation">, </span>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>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 class="token keyword">vararg </span>features<span class="token operator">: </span><a href="-integrand-feature/index.html">IntegrandFeature</a><span class="token punctuation">, </span>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"> -&gt; </span><span class="token keyword"></span><a href="integrate.html">T</a><span class="token punctuation">)</span><span class="token operator">: </span><a href="-univariate-integrand/index.html">UnivariateIntegrand</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="integrate.html">T</a><span class="token operator">&gt;</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">Integrate using <a href="integrate.html">intervals</a> segments with Gauss-Legendre rule of <a href="integrate.html">order</a> order.</p><br><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation">@</span><a href="../../kmath-core/space.kscience.kmath.misc/-unstable-k-math-a-p-i/index.html"><span class="token annotation">UnstableKMathAPI</span></a></div></div><span class="token keyword"></span><span class="token keyword">fun </span><span class="token operator">&lt;</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">&lt;</span><span class="token keyword"></span><a href="integrate.html">T</a><span class="token operator">&gt;</span><span class="token operator">&gt; </span><a href="../space.kscience.kmath.functions/-piecewise-polynomial/index.html">PiecewisePolynomial</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="integrate.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="integrate.html"><span class="token function">integrate</span></a><span class="token punctuation">(</span>algebra<span class="token operator">: </span><a href="../../kmath-core/space.kscience.kmath.operations/-field/index.html">Field</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="integrate.html">T</a><span class="token operator">&gt;</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">&lt;</span><span class="token keyword"></span><a href="integrate.html">T</a><span class="token operator">&gt;</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">Compute analytical indefinite integral of this <a href="../space.kscience.kmath.functions/-piecewise-polynomial/index.html">PiecewisePolynomial</a>, keeping all intervals intact</p><br><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation">@</span><a href="../../kmath-core/space.kscience.kmath.misc/-unstable-k-math-a-p-i/index.html"><span class="token annotation">UnstableKMathAPI</span></a></div></div><span class="token keyword"></span><span class="token keyword">fun </span><span class="token operator">&lt;</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">&lt;</span><span class="token keyword"></span><a href="integrate.html">T</a><span class="token operator">&gt;</span><span class="token operator">&gt; </span><a href="../space.kscience.kmath.functions/-piecewise-polynomial/index.html">PiecewisePolynomial</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="integrate.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="integrate.html"><span class="token function">integrate</span></a><span class="token punctuation">(</span>algebra<span class="token operator">: </span><a href="../../kmath-core/space.kscience.kmath.operations/-field/index.html">Field</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="integrate.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">, </span>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">&lt;</span><span class="token keyword"></span><a href="integrate.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="integrate.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><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><br><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation">@</span><a href="../../kmath-core/space.kscience.kmath.misc/-unstable-k-math-a-p-i/index.html"><span class="token annotation">UnstableKMathAPI</span></a></div></div><span class="token keyword"></span><span class="token keyword">fun </span><span class="token operator">&lt;</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">&gt; </span><a href="index.html#1666897239%2FClasslikes%2F-597741372">UnivariateIntegrator</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="integrate.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="integrate.html"><span class="token function">integrate</span></a><span class="token punctuation">(</span><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>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"> -&gt; </span><span class="token keyword"></span><a href="integrate.html">T</a><span class="token punctuation">)</span><span class="token operator">: </span><a href="-univariate-integrand/index.html">UnivariateIntegrand</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="integrate.html">T</a><span class="token operator">&gt;</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 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><br><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation">@</span><a href="../../kmath-core/space.kscience.kmath.misc/-unstable-k-math-a-p-i/index.html"><span class="token annotation">UnstableKMathAPI</span></a></div></div><span class="token keyword"></span><span class="token keyword">fun </span><span class="token operator">&lt;</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">&gt; </span><a href="index.html#1666897239%2FClasslikes%2F-597741372">UnivariateIntegrator</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="integrate.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="integrate.html"><span class="token function">integrate</span></a><span class="token punctuation">(</span>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">&lt;</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">&gt;</span><span class="token punctuation">, </span><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>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"> -&gt; </span><span class="token keyword"></span><a href="integrate.html">T</a><span class="token punctuation">)</span><span class="token operator">: </span><a href="-univariate-integrand/index.html">UnivariateIntegrand</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="integrate.html">T</a><span class="token operator">&gt;</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 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><br><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation">@</span><a href="../../kmath-core/space.kscience.kmath.misc/-unstable-k-math-a-p-i/index.html"><span class="token annotation">UnstableKMathAPI</span></a></div></div><span class="token keyword"></span><span class="token keyword">fun </span><span class="token operator">&lt;</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">&gt; </span><a href="index.html#1666897239%2FClasslikes%2F-597741372">UnivariateIntegrator</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="integrate.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="integrate.html"><span class="token function">integrate</span></a><span class="token punctuation">(</span>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">&lt;</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">&gt;</span><span class="token punctuation">, </span>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">&lt;</span><span class="token keyword"></span><a href="-integrand-feature/index.html">IntegrandFeature</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </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>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"> -&gt; </span><span class="token keyword"></span><a href="integrate.html">T</a><span class="token punctuation">)</span><span class="token operator">: </span><a href="-univariate-integrand/index.html">UnivariateIntegrand</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="integrate.html">T</a><span class="token operator">&gt;</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 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>© 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>