|
|
<!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="API documentation for the Rust `linalg` mod in crate `nalgebra`."><meta name="keywords" content="rust, rustlang, rust-lang, linalg"><title>nalgebra::linalg - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="shortcut icon" href="http://nalgebra.org/img/favicon.ico"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../nalgebra/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Module linalg</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../index.html'>nalgebra</a></p><script>window.sidebarCurrent = {name: 'linalg', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../../src/nalgebra/linalg/mod.rs.html#1-37' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../index.html'>nalgebra</a>::<wbr><a class="mod" href=''>linalg</a></span></h1><div class='docblock'><p>[Reexported at the root of this crate.] Factorization of real matrices.</p>
|
|
|
</div><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="mod" href="balancing/index.html" title='nalgebra::linalg::balancing mod'>balancing</a></td><td class='docblock-short'><p>Functions for balancing a matrix.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="mod" href="givens/index.html" title='nalgebra::linalg::givens mod'>givens</a></td><td class='docblock-short'><p>Construction of givens rotations.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="mod" href="householder/index.html" title='nalgebra::linalg::householder mod'>householder</a></td><td class='docblock-short'><p>Construction of householder elementary reflections.</p>
|
|
|
</td></tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="struct" href="struct.Bidiagonal.html" title='nalgebra::linalg::Bidiagonal struct'>Bidiagonal</a></td><td class='docblock-short'><p>The bidiagonalization of a general matrix.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Cholesky.html" title='nalgebra::linalg::Cholesky struct'>Cholesky</a></td><td class='docblock-short'><p>The Cholesky decomposition of a symmetric-definite-positive matrix.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.FullPivLU.html" title='nalgebra::linalg::FullPivLU struct'>FullPivLU</a></td><td class='docblock-short'><p>LU decomposition with full row and column pivoting.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Hessenberg.html" title='nalgebra::linalg::Hessenberg struct'>Hessenberg</a></td><td class='docblock-short'><p>Hessenberg decomposition of a general matrix.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.LU.html" title='nalgebra::linalg::LU struct'>LU</a></td><td class='docblock-short'><p>LU decomposition with partial (row) pivoting.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.PermutationSequence.html" title='nalgebra::linalg::PermutationSequence struct'>PermutationSequence</a></td><td class='docblock-short'><p>A sequence of row or column permutations.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.QR.html" title='nalgebra::linalg::QR struct'>QR</a></td><td class='docblock-short'><p>The QR decomposition of a general matrix.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.SVD.html" title='nalgebra::linalg::SVD struct'>SVD</a></td><td class='docblock-short'><p>Singular Value Decomposition of a general matrix.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Schur.html" title='nalgebra::linalg::Schur struct'>Schur</a></td><td class='docblock-short'><p>Schur decomposition of a square matrix.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.SymmetricEigen.html" title='nalgebra::linalg::SymmetricEigen struct'>SymmetricEigen</a></td><td class='docblock-short'><p>Eigendecomposition of a symmetric matrix.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.SymmetricTridiagonal.html" title='nalgebra::linalg::SymmetricTridiagonal struct'>SymmetricTridiagonal</a></td><td class='docblock-short'><p>Tridiagonalization of a symmetric matrix.</p>
|
|
|
</td></tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="fn" href="fn.try_invert_to.html" title='nalgebra::linalg::try_invert_to fn'>try_invert_to</a></td><td class='docblock-short'><p>Performs a LU decomposition to overwrite <code>out</code> with the inverse of <code>matrix</code>.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.wilkinson_shift.html" title='nalgebra::linalg::wilkinson_shift fn'>wilkinson_shift</a></td><td class='docblock-short'><p>Computes the wilkinson shift, i.e., the 2x2 symmetric matrix eigenvalue to its tailing
|
|
|
component <code>tnn</code>.</p>
|
|
|
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "nalgebra";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |
