forked from kscience/kmath
106 lines
18 KiB
HTML
106 lines
18 KiB
HTML
<!doctype html>
|
|
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>Integrator</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="classlike" id="content" pageids="kmath-functions::space.kscience.kmath.integration/Integrator///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">Integrator</span></div>
|
|
<div class="cover ">
|
|
<h1 class="cover"><span><span>Integrator</span></span></h1>
|
|
<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"><span class="token keyword">interface </span><a href="index.html">Integrator</a><span class="token operator"><</span><span class="token keyword"></span><a href="index.html">I</a><span class="token operator"> : </span><a href="../-integrand/index.html">Integrand</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/Integrator.kt#L11">source</a>)</span></span></div><p class="paragraph">A general interface for all integrators.</p><h4 class="">Inheritors</h4><div class="table"><div class="table-row" data-filterable-current=":kmath-functions:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-functions:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-gauss-integrator/index.html">GaussIntegrator</a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":kmath-functions:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-functions:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-simpson-integrator/index.html">SimpsonIntegrator</a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":kmath-functions:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-functions:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-double-simpson-integrator/index.html">DoubleSimpsonIntegrator</a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":kmath-functions:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-functions:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-spline-integrator/index.html">SplineIntegrator</a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":kmath-functions:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-functions:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-double-spline-integrator/index.html">DoubleSplineIntegrator</a></div></span></div><div></div></div></div></div></div></div>
|
|
</div>
|
|
<div class="tabbedcontent">
|
|
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,FUNCTION,PROPERTY">Members</button><button class="section-tab" data-togglable="CONSTRUCTOR,TYPE,FUNCTION,PROPERTY,EXTENSION_PROPERTY,EXTENSION_FUNCTION">Members & Extensions</button></div>
|
|
<div class="tabs-section-body">
|
|
<div data-togglable="FUNCTION">
|
|
<h2 class="">Functions</h2>
|
|
<div class="table"><a data-name="1038648357%2FFunctions%2F-597741372" anchor-label="integrate" id="1038648357%2FFunctions%2F-597741372" data-filterable-set=":kmath-functions:dokkaHtmlPartial/commonMain"></a>
|
|
<div class="table-row" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":kmath-functions:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-functions:dokkaHtmlPartial/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="../integrate.html"><span><span>integrate</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1038648357%2FFunctions%2F-597741372"></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 " 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="../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></div><div class="brief "><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></div><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></div><div class="brief "><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></div><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></div><div class="brief "><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>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="1176423867%2FFunctions%2F-597741372" anchor-label="process" id="1176423867%2FFunctions%2F-597741372" data-filterable-set=":kmath-functions:dokkaHtmlPartial/commonMain"></a>
|
|
<div class="table-row" data-filterable-current=":kmath-functions:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-functions:dokkaHtmlPartial/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="process.html"><span><span>process</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1176423867%2FFunctions%2F-597741372"></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 " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-functions: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="process.html"><span class="token function">process</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">integrand<span class="token operator">: </span><a href="index.html">I</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">I</a></div><div class="brief "><p class="paragraph">Runs one integration pass and return a new <a href="../-integrand/index.html">Integrand</a> with a new set of features.</p></div></div></div>
|
|
</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>
|
|
|