forked from kscience/kmath
151 lines
23 KiB
HTML
151 lines
23 KiB
HTML
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>PiecewisePolynomial</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/logo-styles.css" rel="Stylesheet"><link href="../../../styles/jetbrains-mono.css" rel="Stylesheet"><link href="../../../styles/main.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" async></script>
|
|
|
|
<div id="container">
|
|
<div id="leftColumn"><a href="../../../index.html">
|
|
<div id="logo"></div>
|
|
</a>
|
|
<div id="paneSearch"></div>
|
|
<div id="sideMenu"></div>
|
|
</div>
|
|
<div id="main">
|
|
<script type="text/javascript" src="../../../scripts/main.js"></script><div id="leftToggler"><span class="icon-toggler"></span></div>
|
|
|
|
<div class="main-content" id="content" pageids="kmath-functions::space.kscience.kmath.functions/PiecewisePolynomial///PointingToDeclaration//-597741372">
|
|
<div class="navigation-wrapper" id="navigation-wrapper">
|
|
<div class="breadcrumbs"><a href="../../index.html">kmath-functions</a>/<a href="../index.html">space.kscience.kmath.functions</a>/<a href="index.html">PiecewisePolynomial</a></div>
|
|
<div class="pull-right d-flex">
|
|
<div id="searchBar"></div>
|
|
</div>
|
|
</div>
|
|
<div class="cover ">
|
|
<h1 class="cover"><span>Piecewise</span><wbr><span>Polynomial</span></h1>
|
|
<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">interface <a href="index.html">PiecewisePolynomial</a><<a href="index.html">T</a> : <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-comparable/index.html">Comparable</a><<a href="index.html">T</a>>> : <a href="../-piecewise/index.html">Piecewise</a><<a href="index.html">T</a>, <a href="../-polynomial/index.html">Polynomial</a><<a href="index.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">Represents piecewise-defined function where all the sub-functions are polynomials.</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="Properties">Properties</button><button class="section-tab" data-togglable="Extensions">Extensions</button><button class="section-tab" data-togglable="Sources">Sources</button></div>
|
|
<div class="tabs-section-body">
|
|
<h2 class="">Functions</h2>
|
|
<div class="table" data-togglable="Functions"><a data-name="-1480882906%2FFunctions%2F-597741372" anchor-label="findPiece" id="-1480882906%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"><a href="find-piece.html">findPiece</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1480882906%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="divergent-group" data-filterable-current=":kmath-functions:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-functions:dokkaHtmlPartial/commonMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
|
|
|
|
<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">abstract override fun <a href="find-piece.html">findPiece</a>(arg: <a href="index.html">T</a>): <a href="../-polynomial/index.html">Polynomial</a><<a href="index.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></div></div>
|
|
</div>
|
|
<a data-name="-1480882906%2FFunctions%2F-597741372" anchor-label="findPiece" id="-1480882906%2FFunctions%2F-597741372" data-filterable-set=":kmath-functions:dokkaHtmlPartial/commonMain"></a><div class="brief "><a data-name="-1480882906%2FFunctions%2F-597741372" anchor-label="findPiece" id="-1480882906%2FFunctions%2F-597741372" data-filterable-set=":kmath-functions:dokkaHtmlPartial/commonMain"></a>Returns the appropriate sub-function for given piece key.</div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h2 class="">Properties</h2>
|
|
<div class="table" data-togglable="Properties"><a data-name="392114131%2FProperties%2F-597741372" anchor-label="pieces" id="392114131%2FProperties%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"><a href="pieces.html">pieces</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="392114131%2FProperties%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" data-togglable="Properties"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-functions:dokkaHtmlPartial/commonMain"><a data-name="392114131%2FProperties%2F-597741372" anchor-label="pieces" id="392114131%2FProperties%2F-597741372" data-filterable-set=":kmath-functions:dokkaHtmlPartial/commonMain"></a><div class="symbol monospace">abstract val <a href="pieces.html">pieces</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-collection/index.html">Collection</a><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html">Pair</a><<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.ranges/-closed-range/index.html">ClosedRange</a><<a href="index.html">T</a>>, <a href="../-polynomial/index.html">Polynomial</a><<a href="index.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><div class="brief "><a data-name="392114131%2FProperties%2F-597741372" anchor-label="pieces" id="392114131%2FProperties%2F-597741372" data-filterable-set=":kmath-functions:dokkaHtmlPartial/commonMain"></a>An ordered list of range-polynomial pairs.</div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h2 class="tabbedcontent">Extensions</h2>
|
|
<div class="table" data-togglable="Extensions"><a data-name="-1600883604%2FExtensions%2F-597741372" anchor-label="asFunction" id="-1600883604%2FExtensions%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"><a href="../as-function.html">asFunction</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1600883604%2FExtensions%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="divergent-group" data-filterable-current=":kmath-functions:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-functions:dokkaHtmlPartial/commonMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
|
|
|
|
<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">fun <<a href="../as-function.html">T</a> : <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-comparable/index.html">Comparable</a><<a href="../as-function.html">T</a>>, <a href="../as-function.html">C</a> : <a href="../../../kmath-core/space.kscience.kmath.operations/-ring/index.html">Ring</a><<a href="../as-function.html">T</a>>> <a href="index.html">PiecewisePolynomial</a><<a href="../as-function.html">T</a>>.<a href="../as-function.html">asFunction</a>(ring: <a href="../as-function.html">C</a>): (<a href="../as-function.html">T</a>) -> <a href="../as-function.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></div></div>
|
|
</div>
|
|
<a data-name="1006097815%2FExtensions%2F-597741372" anchor-label="asFunction" id="1006097815%2FExtensions%2F-597741372" data-filterable-set=":kmath-functions:dokkaHtmlPartial/commonMain"></a><div class="brief "><a data-name="1006097815%2FExtensions%2F-597741372" anchor-label="asFunction" id="1006097815%2FExtensions%2F-597741372" data-filterable-set=":kmath-functions:dokkaHtmlPartial/commonMain"></a>Convert this polynomial to a function returning nullable value (null if argument is outside piecewise range).</div></div>
|
|
<div class="divergent-group" data-filterable-current=":kmath-functions:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-functions:dokkaHtmlPartial/commonMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
|
|
|
|
<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">fun <<a href="../as-function.html">T</a> : <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-comparable/index.html">Comparable</a><<a href="../as-function.html">T</a>>, <a href="../as-function.html">C</a> : <a href="../../../kmath-core/space.kscience.kmath.operations/-ring/index.html">Ring</a><<a href="../as-function.html">T</a>>> <a href="index.html">PiecewisePolynomial</a><<a href="../as-function.html">T</a>>.<a href="../as-function.html">asFunction</a>(ring: <a href="../as-function.html">C</a>, defaultValue: <a href="../as-function.html">T</a>): (<a href="../as-function.html">T</a>) -> <a href="../as-function.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></div></div>
|
|
</div>
|
|
<a data-name="-2132205855%2FExtensions%2F-597741372" anchor-label="asFunction" id="-2132205855%2FExtensions%2F-597741372" data-filterable-set=":kmath-functions:dokkaHtmlPartial/commonMain"></a><div class="brief "><a data-name="-2132205855%2FExtensions%2F-597741372" anchor-label="asFunction" id="-2132205855%2FExtensions%2F-597741372" data-filterable-set=":kmath-functions:dokkaHtmlPartial/commonMain"></a>Convert this polynomial to a function using <a href="../as-function.html">defaultValue</a> for arguments outside the piecewise range.</div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-752172566%2FExtensions%2F-597741372" anchor-label="integrate" id="-752172566%2FExtensions%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"><a href="../../space.kscience.kmath.integration/integrate.html">integrate</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-752172566%2FExtensions%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="divergent-group" data-filterable-current=":kmath-functions:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-functions:dokkaHtmlPartial/commonMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
|
|
|
|
<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">@<a href="../../../kmath-core/space.kscience.kmath.misc/-unstable-k-math-a-p-i/index.html">UnstableKMathAPI</a>()</div></div>fun <<a href="../../space.kscience.kmath.integration/integrate.html">T</a> : <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-comparable/index.html">Comparable</a><<a href="../../space.kscience.kmath.integration/integrate.html">T</a>>> <a href="index.html">PiecewisePolynomial</a><<a href="../../space.kscience.kmath.integration/integrate.html">T</a>>.<a href="../../space.kscience.kmath.integration/integrate.html">integrate</a>(algebra: <a href="../../../kmath-core/space.kscience.kmath.operations/-field/index.html">Field</a><<a href="../../space.kscience.kmath.integration/integrate.html">T</a>>): <a href="index.html">PiecewisePolynomial</a><<a href="../../space.kscience.kmath.integration/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></div></div>
|
|
</div>
|
|
<a data-name="-1309270455%2FExtensions%2F-597741372" anchor-label="integrate" id="-1309270455%2FExtensions%2F-597741372" data-filterable-set=":kmath-functions:dokkaHtmlPartial/commonMain"></a><div class="brief "><a data-name="-1309270455%2FExtensions%2F-597741372" anchor-label="integrate" id="-1309270455%2FExtensions%2F-597741372" data-filterable-set=":kmath-functions:dokkaHtmlPartial/commonMain"></a>Compute analytical indefinite integral of this <a href="index.html">PiecewisePolynomial</a>, keeping all intervals intact</div></div>
|
|
<div class="divergent-group" data-filterable-current=":kmath-functions:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-functions:dokkaHtmlPartial/commonMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
|
|
|
|
<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">@<a href="../../../kmath-core/space.kscience.kmath.misc/-unstable-k-math-a-p-i/index.html">UnstableKMathAPI</a>()</div></div>fun <<a href="../../space.kscience.kmath.integration/integrate.html">T</a> : <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-comparable/index.html">Comparable</a><<a href="../../space.kscience.kmath.integration/integrate.html">T</a>>> <a href="index.html">PiecewisePolynomial</a><<a href="../../space.kscience.kmath.integration/integrate.html">T</a>>.<a href="../../space.kscience.kmath.integration/integrate.html">integrate</a>(algebra: <a href="../../../kmath-core/space.kscience.kmath.operations/-field/index.html">Field</a><<a href="../../space.kscience.kmath.integration/integrate.html">T</a>>, range: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.ranges/-closed-range/index.html">ClosedRange</a><<a href="../../space.kscience.kmath.integration/integrate.html">T</a>>): <a href="../../space.kscience.kmath.integration/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></div></div>
|
|
</div>
|
|
<a data-name="1604883403%2FExtensions%2F-597741372" anchor-label="integrate" id="1604883403%2FExtensions%2F-597741372" data-filterable-set=":kmath-functions:dokkaHtmlPartial/commonMain"></a><div class="brief "><a data-name="1604883403%2FExtensions%2F-597741372" anchor-label="integrate" id="1604883403%2FExtensions%2F-597741372" data-filterable-set=":kmath-functions:dokkaHtmlPartial/commonMain"></a>Compute definite integral of given <a href="index.html">PiecewisePolynomial</a> piece by piece in a given <a href="../../space.kscience.kmath.integration/integrate.html">range</a> Requires <a href="../../space.kscience.kmath.integration/-univariate-integration-nodes/index.html">UnivariateIntegrationNodes</a> or <a href="../../space.kscience.kmath.integration/-integration-range/index.html">IntegrationRange</a> and <a href="../../space.kscience.kmath.integration/-integrand-max-calls/index.html">IntegrandMaxCalls</a></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="319599680%2FExtensions%2F-597741372" anchor-label="value" id="319599680%2FExtensions%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"><a href="../value.html">value</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="319599680%2FExtensions%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="divergent-group" data-filterable-current=":kmath-functions:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-functions:dokkaHtmlPartial/commonMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
|
|
|
|
<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">fun <<a href="../value.html">T</a> : <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-comparable/index.html">Comparable</a><<a href="../value.html">T</a>>, <a href="../value.html">C</a> : <a href="../../../kmath-core/space.kscience.kmath.operations/-ring/index.html">Ring</a><<a href="../value.html">T</a>>> <a href="index.html">PiecewisePolynomial</a><<a href="../value.html">T</a>>.<a href="../value.html">value</a>(ring: <a href="../value.html">C</a>, arg: <a href="../value.html">T</a>): <a href="../value.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></div></div>
|
|
</div>
|
|
<a data-name="319599680%2FExtensions%2F-597741372" anchor-label="value" id="319599680%2FExtensions%2F-597741372" data-filterable-set=":kmath-functions:dokkaHtmlPartial/commonMain"></a><div class="brief "><a data-name="319599680%2FExtensions%2F-597741372" anchor-label="value" id="319599680%2FExtensions%2F-597741372" data-filterable-set=":kmath-functions:dokkaHtmlPartial/commonMain"></a>Return a value of polynomial function with given <a href="../value.html">ring</a> a given <a href="../value.html">arg</a> or null if argument is outside piecewise definition.</div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h2 class="">Sources</h2>
|
|
<div class="table" data-togglable="Sources"><a data-name="-1477376089%2FSource%2F-597741372" anchor-label="https://github.com/mipt-npm/kmath/tree/master/kmath-functions/src/commonMain/kotlin/space/kscience/kmath/functions/Piecewise.kt#L24" id="-1477376089%2FSource%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"><a href="https://github.com/mipt-npm/kmath/tree/master/kmath-functions/src/commonMain/kotlin/space/kscience/kmath/functions/Piecewise.kt#L24">common source</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1477376089%2FSource%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>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="footer"><span class="go-to-top-icon"><a href="#content"></a></span><span>© 2021 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>
|
|
|
|
|