forked from kscience/kmath
170 lines
19 KiB
HTML
170 lines
19 KiB
HTML
<!doctype html>
|
|
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>OptimizationProblem</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/OptimizationProblem///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">OptimizationProblem</span></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-dependent-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"><</span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator">></span> : <a href="../../../kmath-core/space.kscience.kmath.misc/-featured/index.html">Featured</a><span class="token operator"><</span><span class="token keyword"></span><a href="../-optimization-feature/index.html">OptimizationFeature</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/OptimizationProblem.kt#L19">source</a>)</span></span></div><h4 class="">Inheritors</h4><div class="table"><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></div><div></div></div></div><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></div><div></div></div></div></div></div></div>
|
|
</div>
|
|
<div class="tabbedcontent">
|
|
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,FUNCTION,PROPERTY">Members</button><button class="section-tab" data-togglable="CONSTRUCTOR,TYPE,FUNCTION,PROPERTY,EXTENSION_PROPERTY,EXTENSION_FUNCTION">Members & Extensions</button></div>
|
|
<div class="tabs-section-body">
|
|
<div data-togglable="FUNCTION">
|
|
<h2 class="">Functions</h2>
|
|
<div class="table"><a data-name="-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-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><span class="token operator"><</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">> </span><a href="get-feature.html"><span class="token function">getFeature</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">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"><</span><span class="token keyword">out </span><a href="get-feature.html">F</a><span class="token operator">></span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="get-feature.html">F</a><span class="token operator">?</span></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="1644170397%2FFunctions%2F959727596" anchor-label="getFeature" id="1644170397%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="../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%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="../get-feature.html">F</a><span class="token operator"> : </span><a href="../-optimization-feature/index.html">OptimizationFeature</a><span class="token operator">> </span><a href="index.html">OptimizationProblem</a><span class="token operator"><</span><span class="token operator">*</span><span class="token operator">></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></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div data-togglable="PROPERTY">
|
|
<h2 class="">Properties</h2>
|
|
<div class="table"><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"><span><span>features</span></span></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"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-optimization:dokkaHtmlPartial/commonMain"><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"><</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="-1617573446%2FProperties%2F959727596" anchor-label="resultPoint" id="-1617573446%2FProperties%2F959727596" data-filterable-set=":kmath-optimization:dokkaHtmlPartial/commonMain"></a>
|
|
<div class="table-row" data-togglable="EXTENSION_PROPERTY" 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%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><span class="token operator"><</span><span class="token keyword"></span><a href="../result-point.html">T</a><span class="token operator">> </span><a href="index.html">OptimizationProblem</a><span class="token operator"><</span><span class="token keyword"></span><a href="../result-point.html">T</a><span class="token operator">></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"><</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">></span></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="160799952%2FProperties%2F959727596" anchor-label="resultPointOrNull" id="160799952%2FProperties%2F959727596" data-filterable-set=":kmath-optimization:dokkaHtmlPartial/commonMain"></a>
|
|
<div class="table-row" data-togglable="EXTENSION_PROPERTY" 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%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><span class="token operator"><</span><span class="token keyword"></span><a href="../result-point-or-null.html">T</a><span class="token operator">> </span><a href="index.html">OptimizationProblem</a><span class="token operator"><</span><span class="token keyword"></span><a href="../result-point-or-null.html">T</a><span class="token operator">></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"><</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">></span><span class="token operator">?</span></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="1180606453%2FProperties%2F959727596" anchor-label="startPoint" id="1180606453%2FProperties%2F959727596" data-filterable-set=":kmath-optimization:dokkaHtmlPartial/commonMain"></a>
|
|
<div class="table-row" data-togglable="EXTENSION_PROPERTY" 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%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><span class="token operator"><</span><span class="token keyword"></span><a href="../start-point.html">T</a><span class="token operator">> </span><a href="index.html">OptimizationProblem</a><span class="token operator"><</span><span class="token keyword"></span><a href="../start-point.html">T</a><span class="token operator">></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"><</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">></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>
|
|
</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>
|
|
|