| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Base trait for decompositions."><meta name="keywords" content="rust, rustlang, rust-lang, Decomposition"><title>Decomposition in rusty_machine::linalg - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../rusty_machine/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../rusty_machine/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Decomposition</a></h2><div class="sidebar-elems"><section><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Factors">Factors</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.unpack">unpack</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In rusty_machine::linalg</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Trait <a href="../index.html">rusty_machine</a>::<wbr><a href="index.html">linalg</a>::<wbr><a class="trait" href="#">Decomposition</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/rulinalg/matrix/decomposition/mod.rs.html#159">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust trait"><code>pub trait Decomposition { |
| type <a href="#associatedtype.Factors" class="associatedtype">Factors</a>; |
| |
| fn <a href="#tymethod.unpack" class="fnname">unpack</a>(self) -> Self::<a class="associatedtype" href="trait.Decomposition.html#associatedtype.Factors" title="type rusty_machine::linalg::Decomposition::Factors">Factors</a>; |
| }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Base trait for decompositions.</p> |
| <p>A matrix decomposition, or factorization, |
| is a procedure which takes a matrix <code>X</code> and returns |
| a set of <code>k</code> factors <code>X_1, X_2, ..., X_k</code> such that |
| <code>X = X_1 * X_2 * ... * X_k</code>.</p> |
| </div></details><h2 id="required-associated-types" class="small-section-header">Required Associated Types<a href="#required-associated-types" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="associatedtype.Factors" class="method has-srclink"><a class="srclink rightside" href="../../src/rulinalg/matrix/decomposition/mod.rs.html#162">source</a><h4 class="code-header">type <a href="#associatedtype.Factors" class="associatedtype">Factors</a></h4></section></summary><div class="docblock"><p>The type representing the ordered set of factors |
| that when multiplied yields the decomposed matrix.</p> |
| </div></details></div><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.unpack" class="method has-srclink"><a class="srclink rightside" href="../../src/rulinalg/matrix/decomposition/mod.rs.html#165">source</a><h4 class="code-header">fn <a href="#tymethod.unpack" class="fnname">unpack</a>(self) -> Self::<a class="associatedtype" href="trait.Decomposition.html#associatedtype.Factors" title="type rusty_machine::linalg::Decomposition::Factors">Factors</a></h4></section></summary><div class="docblock"><p>Extract the individual factors from this decomposition.</p> |
| </div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Decomposition-for-Cholesky%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/rulinalg/matrix/decomposition/cholesky.rs.html#237">source</a><a href="#impl-Decomposition-for-Cholesky%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="trait.Decomposition.html" title="trait rusty_machine::linalg::Decomposition">Decomposition</a> for <a class="struct" href="struct.Cholesky.html" title="struct rusty_machine::linalg::Cholesky">Cholesky</a><T><span class="where fmt-newline">where<br> T: <a class="trait" href="../../num_traits/identities/trait.Zero.html" title="trait num_traits::identities::Zero">Zero</a>,</span></h3></section></summary><div class="impl-items"><section id="associatedtype.Factors-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Factors-1" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Factors" class="associatedtype">Factors</a> = <a class="struct" href="struct.Matrix.html" title="struct rusty_machine::linalg::Matrix">Matrix</a><T></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Decomposition-for-FullPivLu%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/rulinalg/matrix/decomposition/lu.rs.html#345">source</a><a href="#impl-Decomposition-for-FullPivLu%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="trait.Decomposition.html" title="trait rusty_machine::linalg::Decomposition">Decomposition</a> for <a class="struct" href="struct.FullPivLu.html" title="struct rusty_machine::linalg::FullPivLu">FullPivLu</a><T><span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> + <a class="trait" href="../../num_traits/identities/trait.One.html" title="trait num_traits::identities::One">One</a> + <a class="trait" href="../../num_traits/identities/trait.Zero.html" title="trait num_traits::identities::Zero">Zero</a>,</span></h3></section></summary><div class="impl-items"><section id="associatedtype.Factors-2" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Factors-2" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Factors" class="associatedtype">Factors</a> = <a class="struct" href="struct.LUPQ.html" title="struct rusty_machine::linalg::LUPQ">LUPQ</a><T></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Decomposition-for-HouseholderQr%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/rulinalg/matrix/decomposition/qr.rs.html#278">source</a><a href="#impl-Decomposition-for-HouseholderQr%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="trait.Decomposition.html" title="trait rusty_machine::linalg::Decomposition">Decomposition</a> for <a class="struct" href="struct.HouseholderQr.html" title="struct rusty_machine::linalg::HouseholderQr">HouseholderQr</a><T><span class="where fmt-newline">where<br> T: <a class="trait" href="../../num_traits/float/trait.Float.html" title="trait num_traits::float::Float">Float</a>,</span></h3></section></summary><div class="impl-items"><section id="associatedtype.Factors-3" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Factors-3" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Factors" class="associatedtype">Factors</a> = <a class="struct" href="struct.QR.html" title="struct rusty_machine::linalg::QR">QR</a><T></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Decomposition-for-PartialPivLu%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/rulinalg/matrix/decomposition/lu.rs.html#135">source</a><a href="#impl-Decomposition-for-PartialPivLu%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="trait.Decomposition.html" title="trait rusty_machine::linalg::Decomposition">Decomposition</a> for <a class="struct" href="struct.PartialPivLu.html" title="struct rusty_machine::linalg::PartialPivLu">PartialPivLu</a><T><span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> + <a class="trait" href="../../num_traits/identities/trait.One.html" title="trait num_traits::identities::One">One</a> + <a class="trait" href="../../num_traits/identities/trait.Zero.html" title="trait num_traits::identities::Zero">Zero</a>,</span></h3></section></summary><div class="impl-items"><section id="associatedtype.Factors-4" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Factors-4" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Factors" class="associatedtype">Factors</a> = <a class="struct" href="struct.LUP.html" title="struct rusty_machine::linalg::LUP">LUP</a><T></h4></section></div></details></div><script src="../../implementors/rulinalg/matrix/decomposition/trait.Decomposition.js" data-ignore-extern-crates="rulinalg" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rusty_machine" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
