forked from kscience/kmath
230 lines
24 KiB
HTML
230 lines
24 KiB
HTML
<!doctype html>
|
|
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>LupDecomposition</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-core: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-core::space.kscience.kmath.linear/LupDecomposition///PointingToDeclaration//244675578">
|
|
<div class="breadcrumbs"><a href="../../index.html">kmath-core</a><span class="delimiter">/</span><a href="../index.html">space.kscience.kmath.linear</a><span class="delimiter">/</span><span class="current">LupDecomposition</span></div>
|
|
<div class="cover ">
|
|
<h1 class="cover"><span>Lup</span><wbr><span><span>Decomposition</span></span></h1>
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":kmath-core:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">class </span><a href="index.html">LupDecomposition</a><span class="token operator"><</span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator"> : </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html">Any</a><span class="token operator">></span><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>context<span class="token operator">: </span><a href="../-linear-space/index.html">LinearSpace</a><span class="token operator"><</span><span class="token keyword"></span><a href="index.html">T</a><span class="token punctuation">, </span><span class="token operator">*</span><span class="token operator">></span><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>elementContext<span class="token operator">: </span><a href="../../space.kscience.kmath.operations/-field/index.html">Field</a><span class="token operator"><</span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator">></span><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>lu<span class="token operator">: </span><a href="../index.html#-828842962%2FClasslikes%2F244675578">Matrix</a><span class="token operator"><</span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator">></span><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>pivot<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int-array/index.html">IntArray</a><span class="token punctuation">, </span></span><span class="parameter ">even<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></span></span><span class="token punctuation">)</span> : <a href="../-lup-decomposition-feature/index.html">LupDecompositionFeature</a><span class="token operator"><</span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator">> </span>, <a href="../-determinant-feature/index.html">DeterminantFeature</a><span class="token operator"><</span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator">> </span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/SciProgCentre/kmath/tree/master/kmath-core/src/commonMain/kotlin/space/kscience/kmath/linear/LupDecomposition.kt#L18">source</a>)</span></span></div><p class="paragraph">Common implementation of <a href="../-lup-decomposition-feature/index.html">LupDecompositionFeature</a>.</p></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="CONSTRUCTOR">
|
|
<h2 class="">Constructors</h2>
|
|
<div class="table"><a data-name="2078587044%2FConstructors%2F244675578" anchor-label="LupDecomposition" id="2078587044%2FConstructors%2F244675578" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain"></a>
|
|
<div class="table-row" data-togglable="CONSTRUCTOR" data-filterable-current=":kmath-core:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="-lup-decomposition.html"><span>Lup</span><wbr><span><span>Decomposition</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2078587044%2FConstructors%2F244675578"></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-core:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">context<span class="token operator">: </span><a href="../-linear-space/index.html">LinearSpace</a><span class="token operator"><</span><span class="token keyword"></span><a href="index.html">T</a><span class="token punctuation">, </span><span class="token operator">*</span><span class="token operator">></span><span class="token punctuation">, </span></span><span class="parameter ">elementContext<span class="token operator">: </span><a href="../../space.kscience.kmath.operations/-field/index.html">Field</a><span class="token operator"><</span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator">></span><span class="token punctuation">, </span></span><span class="parameter ">lu<span class="token operator">: </span><a href="../index.html#-828842962%2FClasslikes%2F244675578">Matrix</a><span class="token operator"><</span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator">></span><span class="token punctuation">, </span></span><span class="parameter ">pivot<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int-array/index.html">IntArray</a><span class="token punctuation">, </span></span><span class="parameter ">even<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</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="959195833%2FProperties%2F244675578" anchor-label="context" id="959195833%2FProperties%2F244675578" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain"></a>
|
|
<div class="table-row" data-filterable-current=":kmath-core:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="context.html"><span><span>context</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="959195833%2FProperties%2F244675578"></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-core:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="context.html">context</a><span class="token operator">: </span><a href="../-linear-space/index.html">LinearSpace</a><span class="token operator"><</span><span class="token keyword"></span><a href="index.html">T</a><span class="token punctuation">, </span><span class="token operator">*</span><span class="token operator">></span></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-803686573%2FProperties%2F244675578" anchor-label="determinant" id="-803686573%2FProperties%2F244675578" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain"></a>
|
|
<div class="table-row" data-filterable-current=":kmath-core:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="determinant.html"><span><span>determinant</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-803686573%2FProperties%2F244675578"></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-core:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">val </span><a href="determinant.html">determinant</a><span class="token operator">: </span><a href="index.html">T</a></div><div class="brief "><p class="paragraph">Return the determinant of the matrix</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="507133919%2FProperties%2F244675578" anchor-label="elementContext" id="507133919%2FProperties%2F244675578" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain"></a>
|
|
<div class="table-row" data-filterable-current=":kmath-core:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="element-context.html"><span>element</span><wbr><span><span>Context</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="507133919%2FProperties%2F244675578"></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-core:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="element-context.html">elementContext</a><span class="token operator">: </span><a href="../../space.kscience.kmath.operations/-field/index.html">Field</a><span class="token operator"><</span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator">></span></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="833282930%2FProperties%2F244675578" anchor-label="key" id="833282930%2FProperties%2F244675578" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain"></a>
|
|
<div class="table-row" data-filterable-current=":kmath-core:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="../../space.kscience.kmath.misc/-feature/key.html"><span><span>key</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="833282930%2FProperties%2F244675578"></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-core:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword"></span><span class="token keyword">val </span><a href="../../space.kscience.kmath.misc/-feature/key.html">key</a><span class="token operator">: </span><a href="../../space.kscience.kmath.misc/index.html#2124566189%2FClasslikes%2F244675578">FeatureKey</a><span class="token operator"><</span><span class="token keyword"></span><a href="../../space.kscience.kmath.nd/-structure-feature/index.html">StructureFeature</a><span class="token operator">></span></div><div class="brief "><p class="paragraph">A key used for extraction</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="1101984476%2FProperties%2F244675578" anchor-label="l" id="1101984476%2FProperties%2F244675578" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain"></a>
|
|
<div class="table-row" data-filterable-current=":kmath-core:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="l.html"><span><span>l</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1101984476%2FProperties%2F244675578"></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-core:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">val </span><a href="l.html">l</a><span class="token operator">: </span><a href="../index.html#-828842962%2FClasslikes%2F244675578">Matrix</a><span class="token operator"><</span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator">></span></div><div class="brief "><p class="paragraph">Returns the matrix L of the decomposition.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="1430074793%2FProperties%2F244675578" anchor-label="lu" id="1430074793%2FProperties%2F244675578" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain"></a>
|
|
<div class="table-row" data-filterable-current=":kmath-core:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="lu.html"><span><span>lu</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1430074793%2FProperties%2F244675578"></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-core:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="lu.html">lu</a><span class="token operator">: </span><a href="../index.html#-828842962%2FClasslikes%2F244675578">Matrix</a><span class="token operator"><</span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator">></span></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="1226063704%2FProperties%2F244675578" anchor-label="p" id="1226063704%2FProperties%2F244675578" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain"></a>
|
|
<div class="table-row" data-filterable-current=":kmath-core:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="p.html"><span><span>p</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1226063704%2FProperties%2F244675578"></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-core:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">val </span><a href="p.html">p</a><span class="token operator">: </span><a href="../index.html#-828842962%2FClasslikes%2F244675578">Matrix</a><span class="token operator"><</span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator">></span></div><div class="brief "><p class="paragraph">Returns the P rows permutation matrix.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="2123695686%2FProperties%2F244675578" anchor-label="pivot" id="2123695686%2FProperties%2F244675578" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain"></a>
|
|
<div class="table-row" data-filterable-current=":kmath-core:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="pivot.html"><span><span>pivot</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2123695686%2FProperties%2F244675578"></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-core:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="pivot.html">pivot</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int-array/index.html">IntArray</a></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="1381162739%2FProperties%2F244675578" anchor-label="u" id="1381162739%2FProperties%2F244675578" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain"></a>
|
|
<div class="table-row" data-filterable-current=":kmath-core:dokkaHtmlPartial/commonMain" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex">
|
|
<div><a href="u.html"><span><span>u</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1381162739%2FProperties%2F244675578"></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-core:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">val </span><a href="u.html">u</a><span class="token operator">: </span><a href="../index.html#-828842962%2FClasslikes%2F244675578">Matrix</a><span class="token operator"><</span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator">></span></div><div class="brief "><p class="paragraph">Returns the matrix U of the decomposition.</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>
|
|
|