kmath/kmath-ejml/space.kscience.kmath.ejml/-ejml-linear-space-f-s-c-c/solve.html

67 lines
8.9 KiB
HTML

<!doctype html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>solve</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-ejml: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="member" id="content" pageids="kmath-ejml::space.kscience.kmath.ejml/EjmlLinearSpaceFSCC/solve/#space.kscience.kmath.nd.Structure2D[kotlin.Float]#space.kscience.kmath.nd.Structure2D[kotlin.Float]/PointingToDeclaration//426819818">
<div class="breadcrumbs"><a href="../../index.html">kmath-ejml</a><span class="delimiter">/</span><a href="../index.html">space.kscience.kmath.ejml</a><span class="delimiter">/</span><a href="index.html">EjmlLinearSpaceFSCC</a><span class="delimiter">/</span><span class="current">solve</span></div>
<div class="cover ">
<h1 class="cover"><span><span>solve</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-ejml:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="solve.html"><span class="token function">solve</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">a<span class="token operator">: </span><a href="../../../kmath-core/space.kscience.kmath.linear/-matrix/index.html">Matrix</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a><span class="token operator">&gt;</span><span class="token punctuation">, </span></span><span class="parameter ">b<span class="token operator">: </span><a href="../../../kmath-core/space.kscience.kmath.linear/-matrix/index.html">Matrix</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../-ejml-float-matrix/index.html">EjmlFloatMatrix</a><span class="token operator">&lt;</span><span class="token keyword"></span><span data-unresolved-link="org.ejml.data/FMatrixSparseCSC///PointingToDeclaration/">FMatrixSparseCSC</span><span class="token operator">&gt;</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/SciProgCentre/kmath/tree/master/kmath-ejml/src/main/kotlin/space/kscience/kmath/ejml/_generated.kt#L984">source</a>)</span></span></div><p class="paragraph">Solves for <i>x</i> in the following equation: <i>x = </i><a href="solve.html"><i>a</i></a><i> </i><sup><i>-1</i></sup><i> · </i><a href="solve.html"><i>b</i></a>.</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">the solution for <i>x</i> that is n by p.</p></span><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":kmath-ejml:dokkaHtmlPartial/main" data-filterable-set=":kmath-ejml:dokkaHtmlPartial/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>a</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the base matrix.</p></div></div></div></div><div class="table-row" data-filterable-current=":kmath-ejml:dokkaHtmlPartial/main" data-filterable-set=":kmath-ejml:dokkaHtmlPartial/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>b</span></span></u></div></span></div><div><div class="title"><p class="paragraph">n by p matrix.</p></div></div></div></div></div><hr><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="solve.html"><span class="token function">solve</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">a<span class="token operator">: </span><a href="../../../kmath-core/space.kscience.kmath.linear/-matrix/index.html">Matrix</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a><span class="token operator">&gt;</span><span class="token punctuation">, </span></span><span class="parameter ">b<span class="token operator">: </span><a href="../../../kmath-core/space.kscience.kmath.linear/-point/index.html">Point</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html">Float</a><span class="token operator">&gt;</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../-ejml-float-vector/index.html">EjmlFloatVector</a><span class="token operator">&lt;</span><span class="token keyword"></span><span data-unresolved-link="org.ejml.data/FMatrixSparseCSC///PointingToDeclaration/">FMatrixSparseCSC</span><span class="token operator">&gt;</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/SciProgCentre/kmath/tree/master/kmath-ejml/src/main/kotlin/space/kscience/kmath/ejml/_generated.kt#L997">source</a>)</span></span></div><p class="paragraph">Solves for <i>x</i> in the following equation: <i>x = </i><a href="solve.html"><i>a</i></a><i> </i><sup><i>-1</i></sup><i> · </i><a href="solve.html"><i>b</i></a>.</p><span class="kdoc-tag"><h4 class="">Return</h4><p class="paragraph">the solution for <i>x</i> that is n by p.</p></span><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":kmath-ejml:dokkaHtmlPartial/main" data-filterable-set=":kmath-ejml:dokkaHtmlPartial/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>a</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the base matrix.</p></div></div></div></div><div class="table-row" data-filterable-current=":kmath-ejml:dokkaHtmlPartial/main" data-filterable-set=":kmath-ejml:dokkaHtmlPartial/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>b</span></span></u></div></span></div><div><div class="title"><p class="paragraph">n by p vector.</p></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>