kmath/kmath-optimization/space.kscience.kmath.optimization/-optimization-problem/index.html

178 lines
22 KiB
HTML

<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>OptimizationProblem</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-optimization::space.kscience.kmath.optimization/OptimizationProblem///PointingToDeclaration//959727596">
<div class="breadcrumbs"><a href="../../index.html">kmath-optimization</a>/<a href="../index.html">space.kscience.kmath.optimization</a>/<a href="index.html">OptimizationProblem</a></div>
<div class="cover ">
<h1 class="cover"><span>Optimization</span><wbr><span><span>Problem</span></span></h1>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-optimization:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">interface </span><a href="index.html">OptimizationProblem</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator">&gt;</span> : <a href="../../../kmath-core/space.kscience.kmath.misc/-featured/index.html">Featured</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../-optimization-feature/index.html">OptimizationFeature</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></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><button class="section-tab" data-togglable="Inheritors">Inheritors</button></div>
<div class="tabs-section-body">
<h2 class="">Functions</h2>
<div class="table" data-togglable="Functions"><a data-name="-1687457235%2FFunctions%2F959727596" anchor-label="getFeature" id="-1687457235%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="get-feature.html"><span>get</span><wbr><span><span>Feature</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1687457235%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-depenent-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><span class="token operator">&lt;</span><span class="token keyword"></span><a href="get-feature.html">F</a><span class="token operator"> : </span><a href="../-optimization-feature/index.html">OptimizationFeature</a><span class="token operator">&gt; </span><a href="get-feature.html"><span class="token function">getFeature</span></a><span class="token punctuation">(</span>type<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.html">KClass</a><span class="token operator">&lt;</span><span class="token keyword">out </span><a href="get-feature.html">F</a><span class="token operator">&gt;</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="get-feature.html">F</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></div>
</div>
</div>
</div>
</div>
</div>
<h2 class="">Properties</h2>
<div class="table" data-togglable="Properties"><a data-name="592641577%2FProperties%2F959727596" anchor-label="features" id="592641577%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="features.html">features</a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="592641577%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" data-togglable="Properties"><div class="content sourceset-depenent-content" data-active="" data-togglable=":kmath-optimization:dokkaHtmlPartial/commonMain"><a data-name="592641577%2FProperties%2F959727596" anchor-label="features" id="592641577%2FProperties%2F959727596" data-filterable-set=":kmath-optimization:dokkaHtmlPartial/commonMain"></a><div class="symbol monospace"><span class="token keyword">abstract </span><span class="token keyword"></span><span class="token keyword">val </span><a href="features.html">features</a><span class="token operator">: </span><a href="../../../kmath-core/space.kscience.kmath.misc/-feature-set/index.html">FeatureSet</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../-optimization-feature/index.html">OptimizationFeature</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></div>
</div>
</div>
</div>
</div>
</div>
<h2 class="">Inheritors</h2>
<div class="table" data-togglable="Inheritors"><a data-name="638777554%2FInheritors%2F959727596" anchor-label="FunctionOptimization" id="638777554%2FInheritors%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="../-function-optimization/index.html">FunctionOptimization</a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="638777554%2FInheritors%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>
</div>
</div>
<a data-name="1577499419%2FInheritors%2F959727596" anchor-label="XYFit" id="1577499419%2FInheritors%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="../-x-y-fit/index.html">XYFit</a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1577499419%2FInheritors%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>
</div>
</div>
</div>
<h2 class="tabbedcontent">Extensions</h2>
<div class="table" data-togglable="Extensions"><a data-name="1644170397%2FExtensions%2F959727596" anchor-label="getFeature" id="1644170397%2FExtensions%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="../get-feature.html"><span>get</span><wbr><span><span>Feature</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1644170397%2FExtensions%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-depenent-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">&lt;</span><span class="token keyword"></span><a href="../get-feature.html">F</a><span class="token operator"> : </span><a href="../-optimization-feature/index.html">OptimizationFeature</a><span class="token operator">&gt; </span><a href="index.html">OptimizationProblem</a><span class="token operator">&lt;</span><span class="token operator">*</span><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="../get-feature.html"><span class="token function">getFeature</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../get-feature.html">F</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></div>
</div>
</div>
</div>
</div>
<a data-name="-1617573446%2FExtensions%2F959727596" anchor-label="resultPoint" id="-1617573446%2FExtensions%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="../result-point.html"><span>result</span><wbr><span><span>Point</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1617573446%2FExtensions%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-depenent-content" data-active="" data-togglable=":kmath-optimization:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../result-point.html">T</a><span class="token operator">&gt; </span><a href="index.html">OptimizationProblem</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../result-point.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="../result-point.html">resultPoint</a><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">&lt;</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="../result-point.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></div>
</div>
</div>
</div>
</div>
<a data-name="160799952%2FExtensions%2F959727596" anchor-label="resultPointOrNull" id="160799952%2FExtensions%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="../result-point-or-null.html"><span>result</span><wbr><span>Point</span><wbr><span>Or</span><wbr><span><span>Null</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="160799952%2FExtensions%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-depenent-content" data-active="" data-togglable=":kmath-optimization:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../result-point-or-null.html">T</a><span class="token operator">&gt; </span><a href="index.html">OptimizationProblem</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../result-point-or-null.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="../result-point-or-null.html">resultPointOrNull</a><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">&lt;</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="../result-point-or-null.html">T</a><span class="token operator">&gt;</span><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></div>
</div>
</div>
</div>
</div>
<a data-name="1180606453%2FExtensions%2F959727596" anchor-label="startPoint" id="1180606453%2FExtensions%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="../start-point.html"><span>start</span><wbr><span><span>Point</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1180606453%2FExtensions%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-depenent-content" data-active="" data-togglable=":kmath-optimization:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../start-point.html">T</a><span class="token operator">&gt; </span><a href="index.html">OptimizationProblem</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="../start-point.html">T</a><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="../start-point.html">startPoint</a><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">&lt;</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-point.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">Get the starting point for optimization. Throws error if not defined.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
<h2 class="">Sources</h2>
<div class="table" data-togglable="Sources"><a data-name="860513497%2FSource%2F959727596" anchor-label="https://github.com/mipt-npm/kmath/tree/master/kmath-optimization/src/commonMain/kotlin/space/kscience/kmath/optimization/OptimizationProblem.kt#L19" id="860513497%2FSource%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="https://github.com/mipt-npm/kmath/tree/master/kmath-optimization/src/commonMain/kotlin/space/kscience/kmath/optimization/OptimizationProblem.kt#L19">common source</a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="860513497%2FSource%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>
</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>