kmath/kmath-functions/space.kscience.kmath.functions/index.html

243 lines
52 KiB
HTML

<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>space.kscience.kmath.functions</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.functions////PointingToDeclaration//-597741372">
<div class="breadcrumbs"><a href="../index.html">kmath-functions</a>/<a href="index.html">space.kscience.kmath.functions</a></div>
<div class="cover ">
<h1 class="cover"><span><span>Package</span></span> <span>space.</span><wbr><span>kscience.</span><wbr><span>kmath.</span><wbr><span>functions</span></h1>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="Types">Types</button><button class="section-tab" data-togglable="Functions">Functions</button></div>
<div class="tabs-section-body">
<h2 class="">Types</h2>
<div class="table" data-togglable="Types"><a data-name="1926244682%2FClasslikes%2F-597741372" anchor-label="Function1D" id="1926244682%2FClasslikes%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="index.html#1926244682%2FClasslikes%2F-597741372"><span><span>Function1D</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1926244682%2FClasslikes%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-depenent-content" data-active="" data-togglable=":kmath-functions:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">typealias </span><a href="index.html#1926244682%2FClasslikes%2F-597741372">Function1D</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html#1926244682%2FClasslikes%2F-597741372">T</a><span class="token operator">&gt;</span><span class="token operator"> = </span><span class="token punctuation">(</span><span class="token keyword"></span><a href="index.html#1926244682%2FClasslikes%2F-597741372">T</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="index.html#1926244682%2FClasslikes%2F-597741372">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>
</div>
</div>
</div>
<a data-name="-251719897%2FClasslikes%2F-597741372" anchor-label="FunctionND" id="-251719897%2FClasslikes%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="index.html#-251719897%2FClasslikes%2F-597741372"><span>Function</span><wbr><span><span>ND</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-251719897%2FClasslikes%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-depenent-content" data-active="" data-togglable=":kmath-functions:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">typealias </span><a href="index.html#-251719897%2FClasslikes%2F-597741372">FunctionND</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html#-251719897%2FClasslikes%2F-597741372">T</a><span class="token operator">&gt;</span><span class="token operator"> = </span><span class="token punctuation">(</span><span class="token keyword"></span><a href="../../kmath-core/space.kscience.kmath.structures/-buffer/index.html">Buffer</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html#-251719897%2FClasslikes%2F-597741372">T</a><span class="token operator">&gt;</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="index.html#-251719897%2FClasslikes%2F-597741372">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>
</div>
</div>
</div>
<a data-name="1485823131%2FClasslikes%2F-597741372" anchor-label="Piecewise" id="1485823131%2FClasslikes%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="-piecewise/index.html"><span><span>Piecewise</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1485823131%2FClasslikes%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-depenent-content" data-active="" data-togglable=":kmath-functions:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">fun </span><span class="token keyword">interface </span><a href="-piecewise/index.html">Piecewise</a><span class="token operator">&lt;</span><span class="token keyword">in </span><a href="-piecewise/index.html">T</a><span class="token punctuation">, </span><span class="token keyword">out </span><a href="-piecewise/index.html">R</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><div class="brief "><p class="paragraph">Represents piecewise-defined function.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-115151508%2FClasslikes%2F-597741372" anchor-label="PiecewiseBuilder" id="-115151508%2FClasslikes%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="-piecewise-builder/index.html"><span>Piecewise</span><wbr><span><span>Builder</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-115151508%2FClasslikes%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-depenent-content" data-active="" data-togglable=":kmath-functions:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">class </span><a href="-piecewise-builder/index.html">PiecewiseBuilder</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-piecewise-builder/index.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="-piecewise-builder/index.html">T</a><span class="token operator">&gt;</span><span class="token operator">&gt;</span><span class="token punctuation">(</span>delimiter<span class="token operator">: </span><a href="-piecewise-builder/index.html">T</a><span class="token punctuation">)</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><div class="brief "><p class="paragraph">A <a href="-piecewise/index.html">Piecewise</a> builder where all the pieces are ordered by the <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-comparable/index.html">Comparable</a> type instances.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1477376089%2FClasslikes%2F-597741372" anchor-label="PiecewisePolynomial" id="-1477376089%2FClasslikes%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="-piecewise-polynomial/index.html"><span>Piecewise</span><wbr><span><span>Polynomial</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1477376089%2FClasslikes%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-depenent-content" data-active="" data-togglable=":kmath-functions:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">interface </span><a href="-piecewise-polynomial/index.html">PiecewisePolynomial</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-piecewise-polynomial/index.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="-piecewise-polynomial/index.html">T</a><span class="token operator">&gt;</span><span class="token operator">&gt;</span> : <a href="-piecewise/index.html">Piecewise</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-piecewise-polynomial/index.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="-polynomial/index.html">Polynomial</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-piecewise-polynomial/index.html">T</a><span class="token operator">&gt;</span><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><div class="brief "><p class="paragraph">Represents piecewise-defined function where all the sub-functions are polynomials.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1242143393%2FClasslikes%2F-597741372" anchor-label="Polynomial" id="1242143393%2FClasslikes%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="-polynomial/index.html"><span><span>Polynomial</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1242143393%2FClasslikes%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-depenent-content" data-active="" data-togglable=":kmath-functions:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">class </span><a href="-polynomial/index.html">Polynomial</a><span class="token operator">&lt;</span><span class="token keyword">out </span><a href="-polynomial/index.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">(</span>coefficients<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-polynomial/index.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">)</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><div class="brief "><p class="paragraph">Polynomial coefficients model without fixation on specific context they are applied to.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1928395365%2FClasslikes%2F-597741372" anchor-label="PolynomialSpace" id="-1928395365%2FClasslikes%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="-polynomial-space/index.html"><span>Polynomial</span><wbr><span><span>Space</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1928395365%2FClasslikes%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-depenent-content" data-active="" data-togglable=":kmath-functions:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">class </span><a href="-polynomial-space/index.html">PolynomialSpace</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-polynomial-space/index.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="-polynomial-space/index.html">C</a><span class="token operator"> : </span><a href="../../kmath-core/space.kscience.kmath.operations/-ring/index.html">Ring</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-polynomial-space/index.html">T</a><span class="token operator">&gt;</span>, <a href="../../kmath-core/space.kscience.kmath.operations/-scale-operations/index.html">ScaleOperations</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-polynomial-space/index.html">T</a><span class="token operator">&gt;</span><span class="token operator">&gt;</span><span class="token punctuation">(</span>ring<span class="token operator">: </span><a href="-polynomial-space/index.html">C</a><span class="token punctuation">)</span> : <a href="../../kmath-core/space.kscience.kmath.operations/-group/index.html">Group</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-polynomial/index.html">Polynomial</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-polynomial-space/index.html">T</a><span class="token operator">&gt;</span><span class="token operator">&gt; </span>, <a href="../../kmath-core/space.kscience.kmath.operations/-scale-operations/index.html">ScaleOperations</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-polynomial/index.html">Polynomial</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-polynomial-space/index.html">T</a><span class="token operator">&gt;</span><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><div class="brief "><p class="paragraph">Space of polynomials.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
<h2 class="">Functions</h2>
<div class="table" data-togglable="Functions"><a data-name="1645577743%2FFunctions%2F-597741372" anchor-label="asFunction" id="1645577743%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="as-function.html"><span>as</span><wbr><span><span>Function</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1645577743%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-depenent-content" data-active="" data-togglable=":kmath-functions:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="as-function.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="as-function.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">, </span><span class="token keyword"></span><a href="as-function.html">C</a><span class="token operator"> : </span><a href="../../kmath-core/space.kscience.kmath.operations/-ring/index.html">Ring</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="as-function.html">T</a><span class="token operator">&gt;</span><span class="token operator">&gt; </span><a href="-piecewise-polynomial/index.html">PiecewisePolynomial</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="as-function.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="as-function.html"><span class="token function">asFunction</span></a><span class="token punctuation">(</span>ring<span class="token operator">: </span><a href="as-function.html">C</a><span class="token punctuation">)</span><span class="token operator">: </span><span class="token punctuation">(</span><span class="token keyword"></span><a href="as-function.html">T</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><a href="as-function.html">T</a><span class="token operator">?</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><div class="brief "><p class="paragraph">Convert this polynomial to a function returning nullable value (null if argument is outside piecewise range).</p></div><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="as-function.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="as-function.html">C</a><span class="token operator"> : </span><a href="../../kmath-core/space.kscience.kmath.operations/-ring/index.html">Ring</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="as-function.html">T</a><span class="token operator">&gt;</span><span class="token operator">&gt; </span><a href="-polynomial/index.html">Polynomial</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="as-function.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="as-function.html"><span class="token function">asFunction</span></a><span class="token punctuation">(</span>ring<span class="token operator">: </span><a href="as-function.html">C</a><span class="token punctuation">)</span><span class="token operator">: </span><span class="token punctuation">(</span><span class="token keyword"></span><a href="as-function.html">T</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><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 class="brief "><p class="paragraph">Represent the polynomial as a regular context-less function.</p></div><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="as-function.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="as-function.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">, </span><span class="token keyword"></span><a href="as-function.html">C</a><span class="token operator"> : </span><a href="../../kmath-core/space.kscience.kmath.operations/-ring/index.html">Ring</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="as-function.html">T</a><span class="token operator">&gt;</span><span class="token operator">&gt; </span><a href="-piecewise-polynomial/index.html">PiecewisePolynomial</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="as-function.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="as-function.html"><span class="token function">asFunction</span></a><span class="token punctuation">(</span>ring<span class="token operator">: </span><a href="as-function.html">C</a><span class="token punctuation">, </span>defaultValue<span class="token operator">: </span><a href="as-function.html">T</a><span class="token punctuation">)</span><span class="token operator">: </span><span class="token punctuation">(</span><span class="token keyword"></span><a href="as-function.html">T</a><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><span class="token keyword"></span><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 class="brief "><p class="paragraph">Convert this polynomial to a function using <a href="as-function.html">defaultValue</a> for arguments outside the piecewise range.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-920703650%2FFunctions%2F-597741372" anchor-label="differentiate" id="-920703650%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="differentiate.html"><span><span>differentiate</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-920703650%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-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="differentiate.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="differentiate.html">A</a><span class="token operator"> : </span><a href="../../kmath-core/space.kscience.kmath.operations/-ring/index.html">Ring</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="differentiate.html">T</a><span class="token operator">&gt;</span>, <a href="../../kmath-core/space.kscience.kmath.operations/-numeric-algebra/index.html">NumericAlgebra</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="differentiate.html">T</a><span class="token operator">&gt;</span><span class="token operator">&gt; </span><a href="-polynomial/index.html">Polynomial</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="differentiate.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="differentiate.html"><span class="token function">differentiate</span></a><span class="token punctuation">(</span>algebra<span class="token operator">: </span><a href="differentiate.html">A</a><span class="token punctuation">)</span><span class="token operator">: </span><a href="-polynomial/index.html">Polynomial</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="differentiate.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><div class="brief "><p class="paragraph">Create a polynomial witch represents differentiated version of this polynomial</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="458363129%2FFunctions%2F-597741372" anchor-label="integrate" id="458363129%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="integrate.html"><span><span>integrate</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="458363129%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-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 punctuation">, </span><span class="token keyword"></span><a href="integrate.html">A</a><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>, <a href="../../kmath-core/space.kscience.kmath.operations/-numeric-algebra/index.html">NumericAlgebra</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="-polynomial/index.html">Polynomial</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="integrate.html">A</a><span class="token punctuation">)</span><span class="token operator">: </span><a href="-polynomial/index.html">Polynomial</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><div class="brief "><p class="paragraph">Create a polynomial witch represents indefinite integral version of this polynomial</p></div><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="-polynomial/index.html">Polynomial</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><div class="brief "><p class="paragraph">Compute a definite integral of a given polynomial in a <a href="integrate.html">range</a></p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="291607538%2FFunctions%2F-597741372" anchor-label="PiecewisePolynomial" id="291607538%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="-piecewise-polynomial.html"><span>Piecewise</span><wbr><span><span>Polynomial</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="291607538%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-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/-performance-pitfall/index.html"><span class="token annotation">PerformancePitfall</span></a><span class="token punctuation">(</span><span>message<span class="token operator"> = </span><span class="breakable-word"><span class="token string">"findPiece method of resulting piecewise is slow"</span></span></span><wbr><span class="token punctuation">)</span></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="-piecewise-polynomial.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="-piecewise-polynomial.html">T</a><span class="token operator">&gt;</span><span class="token operator">&gt; </span><a href="-piecewise-polynomial.html"><span class="token function">PiecewisePolynomial</span></a><span class="token punctuation">(</span>pieces<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-collection/index.html">Collection</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.html">Pair</a><span class="token operator">&lt;</span><span class="token keyword"></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="-piecewise-polynomial.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">, </span><span class="token keyword"></span><a href="-polynomial/index.html">Polynomial</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-piecewise-polynomial.html">T</a><span class="token operator">&gt;</span><span class="token operator">&gt;</span><span class="token operator">&gt;</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-piecewise-polynomial/index.html">PiecewisePolynomial</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-piecewise-polynomial.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><div class="brief "><p class="paragraph">A generic piecewise without constraints on how pieces are placed</p></div><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-piecewise-polynomial.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="-piecewise-polynomial.html">T</a><span class="token operator">&gt;</span><span class="token operator">&gt; </span><a href="-piecewise-polynomial.html"><span class="token function">PiecewisePolynomial</span></a><span class="token punctuation">(</span>startingPoint<span class="token operator">: </span><a href="-piecewise-polynomial.html">T</a><span class="token punctuation">, </span>builder<span class="token operator">: </span><span class="token keyword"></span><a href="-piecewise-builder/index.html">PiecewiseBuilder</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-piecewise-polynomial.html">T</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 punctuation">)</span><span class="token operator">: </span><a href="-piecewise-polynomial/index.html">PiecewisePolynomial</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="-piecewise-polynomial.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><div class="brief "><p class="paragraph">A builder for <a href="-piecewise-polynomial/index.html">PiecewisePolynomial</a></p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-809463075%2FFunctions%2F-597741372" anchor-label="Polynomial" id="-809463075%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="polynomial.html"><span><span>Polynomial</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-809463075%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-depenent-content" data-active="" data-togglable=":kmath-functions:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="polynomial.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="polynomial.html">C</a><span class="token operator"> : </span><a href="../../kmath-core/space.kscience.kmath.operations/-ring/index.html">Ring</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="polynomial.html">T</a><span class="token operator">&gt;</span>, <a href="../../kmath-core/space.kscience.kmath.operations/-scale-operations/index.html">ScaleOperations</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="polynomial.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">, </span><span class="token keyword"></span><a href="polynomial.html">R</a><span class="token operator">&gt; </span><a href="polynomial.html">C</a><span class="token punctuation">.</span><a href="polynomial.html"><span class="token function">polynomial</span></a><span class="token punctuation">(</span>block<span class="token operator">: </span><span class="token keyword"></span><a href="-polynomial-space/index.html">PolynomialSpace</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="polynomial.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="polynomial.html">C</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="polynomial.html">R</a><span class="token punctuation">)</span><span class="token operator">: </span><a href="polynomial.html">R</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>
</div>
</div>
</div>
<a data-name="1974867531%2FFunctions%2F-597741372" anchor-label="value" id="1974867531%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="value.html"><span><span>value</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1974867531%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-depenent-content" data-active="" data-togglable=":kmath-functions:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="-polynomial/index.html">Polynomial</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><a href="value.html"><span class="token function">value</span></a><span class="token punctuation">(</span>arg<span class="token operator">: </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><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</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 "><p class="paragraph">Evaluates the value of the given double polynomial for given double argument.</p></div><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="value.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="value.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">, </span><span class="token keyword"></span><a href="value.html">C</a><span class="token operator"> : </span><a href="../../kmath-core/space.kscience.kmath.operations/-ring/index.html">Ring</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="value.html">T</a><span class="token operator">&gt;</span><span class="token operator">&gt; </span><a href="-piecewise-polynomial/index.html">PiecewisePolynomial</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="value.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="value.html"><span class="token function">value</span></a><span class="token punctuation">(</span>ring<span class="token operator">: </span><a href="value.html">C</a><span class="token punctuation">, </span>arg<span class="token operator">: </span><a href="value.html">T</a><span class="token punctuation">)</span><span class="token operator">: </span><a href="value.html">T</a><span class="token operator">?</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><div class="brief "><p class="paragraph">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.</p></div><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="value.html">T</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="value.html">C</a><span class="token operator"> : </span><a href="../../kmath-core/space.kscience.kmath.operations/-ring/index.html">Ring</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="value.html">T</a><span class="token operator">&gt;</span><span class="token operator">&gt; </span><a href="-polynomial/index.html">Polynomial</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="value.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="value.html"><span class="token function">value</span></a><span class="token punctuation">(</span>ring<span class="token operator">: </span><a href="value.html">C</a><span class="token punctuation">, </span>arg<span class="token operator">: </span><a href="value.html">T</a><span class="token punctuation">)</span><span class="token operator">: </span><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 class="brief "><p class="paragraph">Evaluates the value of the given polynomial for given argument. https://en.wikipedia.org/wiki/Horner%27s_method</p></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>© 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>