<!doctype html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>XYOptimizationBuilder</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-optimization: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-optimization::space.kscience.kmath.optimization/XYOptimizationBuilder///PointingToDeclaration//959727596">
<div class="breadcrumbs"><a href="../../index.html">kmath-optimization</a><span class="delimiter">/</span><a href="../index.html">space.kscience.kmath.optimization</a><span class="delimiter">/</span><span class="current">XYOptimizationBuilder</span></div>
<div class="cover ">
<h1 class="cover"><span>XYOptimization</span><wbr><span><span>Builder</span></span></h1>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-optimization:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">class </span><a href="index.html">XYOptimizationBuilder</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>data<span class="token operator">: </span><a href="../../../kmath-core/space.kscience.kmath.data/-x-y-columnar-data/index.html">XYColumnarData</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 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 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">val </span>model<span class="token operator">: </span><a href="../../../kmath-core/space.kscience.kmath.expressions/-differentiable-expression/index.html">DifferentiableExpression</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></span><span class="token punctuation">)</span> : <a href="../-optimization-builder/index.html">OptimizationBuilder</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 punctuation">, </span><span class="token keyword"></span><a href="../-x-y-fit/index.html">XYFit</a><span class="token operator">> </span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/SciProgCentre/kmath/tree/master/kmath-optimization/src/commonMain/kotlin/space/kscience/kmath/optimization/OptimizationBuilder.kt#L74">source</a>)</span></span></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="CONSTRUCTOR">
<h2 class="">Constructors</h2>
<div class="table"><a data-name="1434955380%2FConstructors%2F959727596" anchor-label="XYOptimizationBuilder" id="1434955380%2FConstructors%2F959727596" data-filterable-set=":kmath-optimization:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-togglable="CONSTRUCTOR" data-filterable-current=":kmath-optimization:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-optimization:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-x-y-optimization-builder.html"><span>XYOptimization</span><wbr><span><span>Builder</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1434955380%2FConstructors%2F959727596"></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-optimization:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">data<span class="token operator">: </span><a href="../../../kmath-core/space.kscience.kmath.data/-x-y-columnar-data/index.html">XYColumnarData</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 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 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 ">model<span class="token operator">: </span><a href="../../../kmath-core/space.kscience.kmath.expressions/-differentiable-expression/index.html">DifferentiableExpression</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></span><span class="token punctuation">)</span></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div data-togglable="FUNCTION">
<h2 class="">Functions</h2>
<div class="table"><a data-name="1858363973%2FFunctions%2F959727596" anchor-label="addFeature" id="1858363973%2FFunctions%2F959727596" data-filterable-set=":kmath-optimization:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-optimization:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-optimization:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="../-optimization-builder/add-feature.html"><span>add</span><wbr><span><span>Feature</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1858363973%2FFunctions%2F959727596"></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-optimization:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="../-optimization-builder/add-feature.html"><span class="token function">addFeature</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">feature<span class="token operator">: </span><a href="../-optimization-feature/index.html">OptimizationFeature</a></span></span><span class="token punctuation">)</span></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1992900459%2FFunctions%2F959727596" anchor-label="build" id="1992900459%2FFunctions%2F959727596" data-filterable-set=":kmath-optimization:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-optimization:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-optimization:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="build.html"><span><span>build</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1992900459%2FFunctions%2F959727596"></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-optimization:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="build.html"><span class="token function">build</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../-x-y-fit/index.html">XYFit</a></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="2110887789%2FFunctions%2F959727596" anchor-label="startAt" id="2110887789%2FFunctions%2F959727596" data-filterable-set=":kmath-optimization:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":kmath-optimization:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-optimization:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="../start-at.html"><span>start</span><wbr><span><span>At</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2110887789%2FFunctions%2F959727596"></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-optimization:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><span class="token operator"><</span><span class="token keyword"></span><a href="../start-at.html">T</a><span class="token operator">> </span><a href="../-optimization-builder/index.html">OptimizationBuilder</a><span class="token operator"><</span><span class="token keyword"></span><a href="../start-at.html">T</a><span class="token punctuation">, </span><span class="token operator">*</span><span class="token operator">></span><span class="token punctuation">.</span><a href="../start-at.html"><span class="token function">startAt</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">startingPoint<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.html">Map</a><span class="token operator"><</span><span class="token keyword"></span><a href="../../../kmath-core/space.kscience.kmath.expressions/-symbol/index.html">Symbol</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="../start-at.html">T</a><span class="token operator">></span></span></span><span class="token punctuation">)</span></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1137914576%2FFunctions%2F959727596" anchor-label="updateFeature" id="-1137914576%2FFunctions%2F959727596" data-filterable-set=":kmath-optimization:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-optimization:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-optimization:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="../-optimization-builder/update-feature.html"><span>update</span><wbr><span><span>Feature</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1137914576%2FFunctions%2F959727596"></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-optimization:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">inline </span><span class="token keyword">fun </span><span class="token operator"><</span><span class="token keyword"></span><a href="../-optimization-builder/update-feature.html">T</a><span class="token operator"> : </span><a href="../-optimization-feature/index.html">OptimizationFeature</a><span class="token operator">> </span><a href="../-optimization-builder/update-feature.html"><span class="token function">updateFeature</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">update<span class="token operator">: </span><span class="token punctuation">(</span><span class="token keyword"></span><a href="../-optimization-builder/update-feature.html">T</a><span class="token operator">?</span><span class="token punctuation">)</span><span class="token operator"> -> </span><span class="token keyword"></span><a href="../-optimization-builder/update-feature.html">T</a></span></span><span class="token punctuation">)</span></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div data-togglable="PROPERTY">
<h2 class="">Properties</h2>
<div class="table"><a data-name="-987815561%2FProperties%2F959727596" anchor-label="data" id="-987815561%2FProperties%2F959727596" data-filterable-set=":kmath-optimization:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-optimization:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-optimization:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="data.html"><span><span>data</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-987815561%2FProperties%2F959727596"></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-optimization:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="data.html">data</a><span class="token operator">: </span><a href="../../../kmath-core/space.kscience.kmath.data/-x-y-columnar-data/index.html">XYColumnarData</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 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 keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a><span class="token operator">></span></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-199496667%2FProperties%2F959727596" anchor-label="features" id="-199496667%2FProperties%2F959727596" data-filterable-set=":kmath-optimization:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-optimization:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-optimization:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="../-optimization-builder/features.html"><span><span>features</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-199496667%2FProperties%2F959727596"></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-optimization:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="../-optimization-builder/features.html">features</a><span class="token operator">: </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="../-optimization-feature/index.html">OptimizationFeature</a><span class="token operator">></span></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1339245328%2FProperties%2F959727596" anchor-label="model" id="1339245328%2FProperties%2F959727596" data-filterable-set=":kmath-optimization:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-optimization:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-optimization:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="model.html"><span><span>model</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1339245328%2FProperties%2F959727596"></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-optimization:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="model.html">model</a><span class="token operator">: </span><a href="../../../kmath-core/space.kscience.kmath.expressions/-differentiable-expression/index.html">DifferentiableExpression</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></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-2004000664%2FProperties%2F959727596" anchor-label="pointToCurveDistance" id="-2004000664%2FProperties%2F959727596" data-filterable-set=":kmath-optimization:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-optimization:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-optimization:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="point-to-curve-distance.html"><span>point</span><wbr><span>To</span><wbr><span>Curve</span><wbr><span><span>Distance</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-2004000664%2FProperties%2F959727596"></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-optimization:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="point-to-curve-distance.html">pointToCurveDistance</a><span class="token operator">: </span><a href="../-point-to-curve-distance/index.html">PointToCurveDistance</a></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1576812017%2FProperties%2F959727596" anchor-label="pointWeight" id="1576812017%2FProperties%2F959727596" data-filterable-set=":kmath-optimization:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":kmath-optimization:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-optimization:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="point-weight.html"><span>point</span><wbr><span><span>Weight</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1576812017%2FProperties%2F959727596"></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-optimization:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">var </span><a href="point-weight.html">pointWeight</a><span class="token operator">: </span><a href="../-point-weight/index.html">PointWeight</a></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>