kscience/kmath
9
0
Fork 1
Code Issues Pull Requests 6 Packages Projects Releases 16 Wiki Activity
de9d50d466
kmath/kmath-core/space.kscience.kmath.linear/-singular-value-decomposition-feature/index.html

151 lines
14 KiB
HTML
Raw Normal View History

Deploying to gh-pages from @ SciProgCentre/kmath@e1d5409c0d1148b2ba9e8221d09cb514c22e7fb9 🚀
2023-04-09 11:31:42 +03:00
<!doctype html>
Deploying to gh-pages from @ mipt-npm/kmath@2216e232736439b46c9bdb2cf98144c119d2d697 🚀
2021-03-12 21:24:01 +03:00
<html>
Deploying to gh-pages from @ SciProgCentre/kmath@e1d5409c0d1148b2ba9e8221d09cb514c22e7fb9 🚀
2023-04-09 11:31:42 +03:00
<head>
Deploying to gh-pages from @ mipt-npm/kmath@2216e232736439b46c9bdb2cf98144c119d2d697 🚀
2021-03-12 21:24:01 +03:00
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>SingularValueDecompositionFeature</title>
Deploying to gh-pages from @ SciProgCentre/kmath@e1d5409c0d1148b2ba9e8221d09cb514c22e7fb9 🚀
2023-04-09 11:31:42 +03:00
<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>
Deploying to gh-pages from @ mipt-npm/kmath@b698f2d613cdf20cdfb03cb7185ca7c04318b786 🚀
2022-04-12 11:30:54 +03:00
<div id="searchBar"></div>
</div>
Deploying to gh-pages from @ SciProgCentre/kmath@e1d5409c0d1148b2ba9e8221d09cb514c22e7fb9 🚀
2023-04-09 11:31:42 +03:00
</div>
<div id="container">
<div id="leftColumn">
Deploying to gh-pages from @ mipt-npm/kmath@2216e232736439b46c9bdb2cf98144c119d2d697 🚀
2021-03-12 21:24:01 +03:00
<div id="sideMenu"></div>
Deploying to gh-pages from @ SciProgCentre/kmath@e1d5409c0d1148b2ba9e8221d09cb514c22e7fb9 🚀
2023-04-09 11:31:42 +03:00
</div>
<div id="main">
<div class="main-content" data-page-type="classlike" id="content" pageids="kmath-core::space.kscience.kmath.linear/SingularValueDecompositionFeature///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">SingularValueDecompositionFeature</span></div>
<div class="cover ">
<h1 class="cover"><span>Singular</span><wbr><span>Value</span><wbr><span>Decomposition</span><wbr><span><span>Feature</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">interface </span><a href="index.html">SingularValueDecompositionFeature</a><span class="token operator">&lt;</span><span class="token keyword">out </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">&gt;</span> : <a href="../-matrix-feature/index.html">MatrixFeature</a><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/MatrixFeatures.kt#L160">source</a>)</span></span></div><p class="paragraph">Matrices with this feature support SVD: <i>a = </i><a href="u.html"><i>u</i></a><i> · </i><a href="s.html"><i>s</i></a><i> · </i><a href="v.html"><i>v</i></a><sup><i>H</i></sup> where <i>a</i> is the owning matrix.</p><h4 class="">Parameters</h4><div class="table"><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><u><span><span>T</span></span></u></div></span></div><div><div class="title"><p class="paragraph">the type of matrices' items.</p></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></div>
<div class="tabs-section-body">
<div data-togglable="PROPERTY">
<h2 class="">Properties</h2>
<div class="table"><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>
Deploying to gh-pages from @ mipt-npm/kmath@b698f2d613cdf20cdfb03cb7185ca7c04318b786 🚀
2022-04-12 11:30:54 +03:00
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="833282930%2FProperties%2F244675578"></span>
Deploying to gh-pages from @ SciProgCentre/kmath@e1d5409c0d1148b2ba9e8221d09cb514c22e7fb9 🚀
2023-04-09 11:31:42 +03:00
<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">&lt;</span><span class="token keyword"></span><a href="../../space.kscience.kmath.nd/-structure-feature/index.html">StructureFeature</a><span class="token operator">&gt;</span></div><div class="brief "><p class="paragraph">A key used for extraction</p></div></div></div>
Deploying to gh-pages from @ mipt-npm/kmath@6a9f4d462658c13e12b05b7a00989c473b5b7bbe 🚀
2021-10-13 15:08:46 +03:00
</div>
Deploying to gh-pages from @ SciProgCentre/kmath@e1d5409c0d1148b2ba9e8221d09cb514c22e7fb9 🚀
2023-04-09 11:31:42 +03:00
</div>
</div>
</div>
Deploying to gh-pages from @ mipt-npm/kmath@6a9f4d462658c13e12b05b7a00989c473b5b7bbe 🚀
2021-10-13 15:08:46 +03:00
<a data-name="-701767436%2FProperties%2F244675578" anchor-label="s" id="-701767436%2FProperties%2F244675578" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain"></a>
Deploying to gh-pages from @ SciProgCentre/kmath@e1d5409c0d1148b2ba9e8221d09cb514c22e7fb9 🚀
2023-04-09 11:31:42 +03:00
<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="s.html"><span><span>s</span></span></a></div>
Deploying to gh-pages from @ mipt-npm/kmath@b698f2d613cdf20cdfb03cb7185ca7c04318b786 🚀
2022-04-12 11:30:54 +03:00
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-701767436%2FProperties%2F244675578"></span>
Deploying to gh-pages from @ SciProgCentre/kmath@e1d5409c0d1148b2ba9e8221d09cb514c22e7fb9 🚀
2023-04-09 11:31:42 +03:00
<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">abstract </span><span class="token keyword"></span><span class="token keyword">val </span><a href="s.html">s</a><span class="token operator">: </span><a href="../index.html#-828842962%2FClasslikes%2F244675578">Matrix</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator">&gt;</span></div><div class="brief "><p class="paragraph">The matrix in this decomposition. Its main diagonal elements are singular values.</p></div></div></div>
Deploying to gh-pages from @ mipt-npm/kmath@2216e232736439b46c9bdb2cf98144c119d2d697 🚀
2021-03-12 21:24:01 +03:00
</div>
Deploying to gh-pages from @ SciProgCentre/kmath@e1d5409c0d1148b2ba9e8221d09cb514c22e7fb9 🚀
2023-04-09 11:31:42 +03:00
</div>
</div>
</div>
Deploying to gh-pages from @ mipt-npm/kmath@ca02f5406d06d18d07909f3d48508e1a99701fa5 🚀
2021-05-08 18:18:11 +03:00
<a data-name="1833809850%2FProperties%2F244675578" anchor-label="singularValues" id="1833809850%2FProperties%2F244675578" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain"></a>
Deploying to gh-pages from @ SciProgCentre/kmath@e1d5409c0d1148b2ba9e8221d09cb514c22e7fb9 🚀
2023-04-09 11:31:42 +03:00
<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="singular-values.html"><span>singular</span><wbr><span><span>Values</span></span></a></div>
Deploying to gh-pages from @ mipt-npm/kmath@b698f2d613cdf20cdfb03cb7185ca7c04318b786 🚀
2022-04-12 11:30:54 +03:00
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1833809850%2FProperties%2F244675578"></span>
Deploying to gh-pages from @ SciProgCentre/kmath@e1d5409c0d1148b2ba9e8221d09cb514c22e7fb9 🚀
2023-04-09 11:31:42 +03:00
<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">abstract </span><span class="token keyword"></span><span class="token keyword">val </span><a href="singular-values.html">singularValues</a><span class="token operator">: </span><a href="../index.html#-1940126653%2FClasslikes%2F244675578">Point</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator">&gt;</span></div><div class="brief "><p class="paragraph">The buffer of singular values of this SVD.</p></div></div></div>
Deploying to gh-pages from @ mipt-npm/kmath@2216e232736439b46c9bdb2cf98144c119d2d697 🚀
2021-03-12 21:24:01 +03:00
</div>
Deploying to gh-pages from @ SciProgCentre/kmath@e1d5409c0d1148b2ba9e8221d09cb514c22e7fb9 🚀
2023-04-09 11:31:42 +03:00
</div>
</div>
</div>
Deploying to gh-pages from @ mipt-npm/kmath@ca02f5406d06d18d07909f3d48508e1a99701fa5 🚀
2021-05-08 18:18:11 +03:00
<a data-name="-639727822%2FProperties%2F244675578" anchor-label="u" id="-639727822%2FProperties%2F244675578" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain"></a>
Deploying to gh-pages from @ SciProgCentre/kmath@e1d5409c0d1148b2ba9e8221d09cb514c22e7fb9 🚀
2023-04-09 11:31:42 +03:00
<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>
Deploying to gh-pages from @ mipt-npm/kmath@b698f2d613cdf20cdfb03cb7185ca7c04318b786 🚀
2022-04-12 11:30:54 +03:00
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-639727822%2FProperties%2F244675578"></span>
Deploying to gh-pages from @ SciProgCentre/kmath@e1d5409c0d1148b2ba9e8221d09cb514c22e7fb9 🚀
2023-04-09 11:31:42 +03:00
<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">abstract </span><span class="token keyword"></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">&lt;</span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator">&gt;</span></div><div class="brief "><p class="paragraph">The matrix in this decomposition. It is unitary, and it consists from left singular vectors.</p></div></div></div>
Deploying to gh-pages from @ mipt-npm/kmath@2216e232736439b46c9bdb2cf98144c119d2d697 🚀
2021-03-12 21:24:01 +03:00
</div>
Deploying to gh-pages from @ SciProgCentre/kmath@e1d5409c0d1148b2ba9e8221d09cb514c22e7fb9 🚀
2023-04-09 11:31:42 +03:00
</div>
</div>
</div>
Deploying to gh-pages from @ mipt-npm/kmath@ca02f5406d06d18d07909f3d48508e1a99701fa5 🚀
2021-05-08 18:18:11 +03:00
<a data-name="-608708015%2FProperties%2F244675578" anchor-label="v" id="-608708015%2FProperties%2F244675578" data-filterable-set=":kmath-core:dokkaHtmlPartial/commonMain"></a>
Deploying to gh-pages from @ SciProgCentre/kmath@e1d5409c0d1148b2ba9e8221d09cb514c22e7fb9 🚀
2023-04-09 11:31:42 +03:00
<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="v.html"><span><span>v</span></span></a></div>
Deploying to gh-pages from @ mipt-npm/kmath@b698f2d613cdf20cdfb03cb7185ca7c04318b786 🚀
2022-04-12 11:30:54 +03:00
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-608708015%2FProperties%2F244675578"></span>
Deploying to gh-pages from @ SciProgCentre/kmath@e1d5409c0d1148b2ba9e8221d09cb514c22e7fb9 🚀
2023-04-09 11:31:42 +03:00
<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">abstract </span><span class="token keyword"></span><span class="token keyword">val </span><a href="v.html">v</a><span class="token operator">: </span><a href="../index.html#-828842962%2FClasslikes%2F244675578">Matrix</a><span class="token operator">&lt;</span><span class="token keyword"></span><a href="index.html">T</a><span class="token operator">&gt;</span></div><div class="brief "><p class="paragraph">The matrix in this decomposition. It is unitary, and it consists from right singular vectors.</p></div></div></div>
Deploying to gh-pages from @ mipt-npm/kmath@6a9f4d462658c13e12b05b7a00989c473b5b7bbe 🚀
2021-10-13 15:08:46 +03:00
</div>
</div>
Deploying to gh-pages from @ mipt-npm/kmath@2216e232736439b46c9bdb2cf98144c119d2d697 🚀
2021-03-12 21:24:01 +03:00
</div>
</div>
</div>
</div>
</div>
Deploying to gh-pages from @ SciProgCentre/kmath@e1d5409c0d1148b2ba9e8221d09cb514c22e7fb9 🚀
2023-04-09 11:31:42 +03:00
</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>
Deploying to gh-pages from @ mipt-npm/kmath@2216e232736439b46c9bdb2cf98144c119d2d697 🚀
2021-03-12 21:24:01 +03:00
Copy Permalink