kmath/kmath-commons/space.kscience.kmath.commons.optimization/-c-m-optimizer/index.html

155 lines
14 KiB
HTML

<!doctype html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>CMOptimizer</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 jvm-like" data-active="" data-filter=":kmath-commons:dokkaHtmlPartial/main">jvm</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-commons::space.kscience.kmath.commons.optimization/CMOptimizer///PointingToDeclaration//-755866740">
<div class="breadcrumbs"><a href="../../index.html">kmath-commons</a><span class="delimiter">/</span><a href="../index.html">space.kscience.kmath.commons.optimization</a><span class="delimiter">/</span><span class="current">CMOptimizer</span></div>
<div class="cover ">
<h1 class="cover"><span><span>CMOptimizer</span></span></h1>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-commons:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword">object </span><a href="index.html">CMOptimizer</a> : <a href="../../../kmath-optimization/space.kscience.kmath.optimization/-optimizer/index.html">Optimizer</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 punctuation">, </span><span class="token keyword"></span><a href="../../../kmath-optimization/space.kscience.kmath.optimization/-function-optimization/index.html">FunctionOptimization</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 operator">&gt; </span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/SciProgCentre/kmath/tree/master/kmath-commons/src/main/kotlin/space/kscience/kmath/commons/optimization/CMOptimizer.kt#L63">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></div>
<div class="tabs-section-body">
<div data-togglable="FUNCTION">
<h2 class="">Functions</h2>
<div class="table"><a data-name="567810846%2FFunctions%2F-755866740" anchor-label="optimize" id="567810846%2FFunctions%2F-755866740" data-filterable-set=":kmath-commons:dokkaHtmlPartial/main"></a>
<div class="table-row" data-filterable-current=":kmath-commons:dokkaHtmlPartial/main" data-filterable-set=":kmath-commons:dokkaHtmlPartial/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="optimize.html"><span><span>optimize</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="567810846%2FFunctions%2F-755866740"></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-commons:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">suspend override </span><span class="token keyword">fun </span><a href="optimize.html"><span class="token function">optimize</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">problem<span class="token operator">: </span><a href="../../../kmath-optimization/space.kscience.kmath.optimization/-function-optimization/index.html">FunctionOptimization</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></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../../kmath-optimization/space.kscience.kmath.optimization/-function-optimization/index.html">FunctionOptimization</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></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div data-togglable="PROPERTY">
<h2 class="">Properties</h2>
<div class="table"><a data-name="-1472207294%2FProperties%2F-755866740" anchor-label="DEFAULT_ABSOLUTE_TOLERANCE" id="-1472207294%2FProperties%2F-755866740" data-filterable-set=":kmath-commons:dokkaHtmlPartial/main"></a>
<div class="table-row" data-filterable-current=":kmath-commons:dokkaHtmlPartial/main" data-filterable-set=":kmath-commons:dokkaHtmlPartial/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-d-e-f-a-u-l-t_-a-b-s-o-l-u-t-e_-t-o-l-e-r-a-n-c-e.html"><span><span>DEFAULT_ABSOLUTE_TOLERANCE</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1472207294%2FProperties%2F-755866740"></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-commons:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-d-e-f-a-u-l-t_-a-b-s-o-l-u-t-e_-t-o-l-e-r-a-n-c-e.html">DEFAULT_ABSOLUTE_TOLERANCE</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a><span class="token operator"> = </span><span class="token constant">1.0E-4</span></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-719226764%2FProperties%2F-755866740" anchor-label="DEFAULT_MAX_ITER" id="-719226764%2FProperties%2F-755866740" data-filterable-set=":kmath-commons:dokkaHtmlPartial/main"></a>
<div class="table-row" data-filterable-current=":kmath-commons:dokkaHtmlPartial/main" data-filterable-set=":kmath-commons:dokkaHtmlPartial/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-d-e-f-a-u-l-t_-m-a-x_-i-t-e-r.html"><span><span>DEFAULT_MAX_ITER</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-719226764%2FProperties%2F-755866740"></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-commons:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-d-e-f-a-u-l-t_-m-a-x_-i-t-e-r.html">DEFAULT_MAX_ITER</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token operator"> = </span><span class="token constant">1000</span></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="993759437%2FProperties%2F-755866740" anchor-label="DEFAULT_RELATIVE_TOLERANCE" id="993759437%2FProperties%2F-755866740" data-filterable-set=":kmath-commons:dokkaHtmlPartial/main"></a>
<div class="table-row" data-filterable-current=":kmath-commons:dokkaHtmlPartial/main" data-filterable-set=":kmath-commons:dokkaHtmlPartial/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-d-e-f-a-u-l-t_-r-e-l-a-t-i-v-e_-t-o-l-e-r-a-n-c-e.html"><span><span>DEFAULT_RELATIVE_TOLERANCE</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="993759437%2FProperties%2F-755866740"></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-commons:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword">const </span><span class="token keyword">val </span><a href="-d-e-f-a-u-l-t_-r-e-l-a-t-i-v-e_-t-o-l-e-r-a-n-c-e.html">DEFAULT_RELATIVE_TOLERANCE</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html">Double</a><span class="token operator"> = </span><span class="token constant">1.0E-4</span></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="326538768%2FProperties%2F-755866740" anchor-label="defaultConvergenceChecker" id="326538768%2FProperties%2F-755866740" data-filterable-set=":kmath-commons:dokkaHtmlPartial/main"></a>
<div class="table-row" data-filterable-current=":kmath-commons:dokkaHtmlPartial/main" data-filterable-set=":kmath-commons:dokkaHtmlPartial/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="default-convergence-checker.html"><span>default</span><wbr><span>Convergence</span><wbr><span><span>Checker</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="326538768%2FProperties%2F-755866740"></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-commons:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="default-convergence-checker.html">defaultConvergenceChecker</a><span class="token operator">: </span><a href="https://commons.apache.org/proper/commons-math/javadocs/api-3.6.1/org/apache/commons/math3/optim/SimpleValueChecker.html">SimpleValueChecker</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>