mitchellhansen/Trac3r-rust
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

add doc

Browse Source
This commit is contained in:
mitchellhansen
2020-01-23 23:13:36 -08:00
parent dcc0df955e
commit 2bc9ebdc6b
31829 changed files with 1229378 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/nalgebra/linalg/balancing/fn.balance_parlett_reinsch.html Normal file
View File

@@ -0,0 +1,4 @@
<!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 `balance_parlett_reinsch` fn in crate `nalgebra`."><meta name="keywords" content="rust, rustlang, rust-lang, balance_parlett_reinsch"><title>nalgebra::linalg::balancing::balance_parlett_reinsch - 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 fn"><!--[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">&#9776;</div><a href='../../../nalgebra/index.html'><div class='logo-container'><img src='../../../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><p class='location'><a href='../../index.html'>nalgebra</a>::<wbr><a href='../index.html'>linalg</a>::<wbr><a href='index.html'>balancing</a></p><script>window.sidebarCurrent = {name: 'balance_parlett_reinsch', ty: 'fn', 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'>&#x2212;</span>]</a></span><a class='srclink' href='../../../src/nalgebra/linalg/balancing.rs.html#15-64' title='goto source code'>[src]</a></span><span class='in-band'>Function <a href='../../index.html'>nalgebra</a>::<wbr><a href='../index.html'>linalg</a>::<wbr><a href='index.html'>balancing</a>::<wbr><a class="fn" href=''>balance_parlett_reinsch</a></span></h1><pre class='rust fn'>pub fn balance_parlett_reinsch&lt;N:&nbsp;<a class="trait" href="../../../nalgebra/trait.RealField.html" title="trait nalgebra::RealField">RealField</a>, D:&nbsp;<a class="trait" href="../../../nalgebra/base/dimension/trait.Dim.html" title="trait nalgebra::base::dimension::Dim">Dim</a>&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;m: &amp;mut <a class="type" href="../../../nalgebra/base/type.MatrixN.html" title="type nalgebra::base::MatrixN">MatrixN</a>&lt;N, D&gt;<br>) -&gt; <a class="type" href="../../../nalgebra/base/type.VectorN.html" title="type nalgebra::base::VectorN">VectorN</a>&lt;N, D&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="struct" href="../../../nalgebra/base/default_allocator/struct.DefaultAllocator.html" title="struct nalgebra::base::default_allocator::DefaultAllocator">DefaultAllocator</a>: <a class="trait" href="../../../nalgebra/base/allocator/trait.Allocator.html" title="trait nalgebra::base::allocator::Allocator">Allocator</a>&lt;N, D, D&gt; + <a class="trait" href="../../../nalgebra/base/allocator/trait.Allocator.html" title="trait nalgebra::base::allocator::Allocator">Allocator</a>&lt;N, D&gt;,&nbsp;</span></pre><div class='docblock'><p>Applies in-place a modified Parlett and Reinsch matrix balancing with 2-norm to the matrix <code>m</code> and returns
the corresponding diagonal transformation.</p>
<p>See https://arxiv.org/pdf/1401.5766.pdf</p>
</div></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>&#9166;</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>

2
doc/nalgebra/linalg/balancing/fn.unbalance.html Normal file
View File

@@ -0,0 +1,2 @@
<!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 `unbalance` fn in crate `nalgebra`."><meta name="keywords" content="rust, rustlang, rust-lang, unbalance"><title>nalgebra::linalg::balancing::unbalance - 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 fn"><!--[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">&#9776;</div><a href='../../../nalgebra/index.html'><div class='logo-container'><img src='../../../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><p class='location'><a href='../../index.html'>nalgebra</a>::<wbr><a href='../index.html'>linalg</a>::<wbr><a href='index.html'>balancing</a></p><script>window.sidebarCurrent = {name: 'unbalance', ty: 'fn', 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'>&#x2212;</span>]</a></span><a class='srclink' href='../../../src/nalgebra/linalg/balancing.rs.html#67-80' title='goto source code'>[src]</a></span><span class='in-band'>Function <a href='../../index.html'>nalgebra</a>::<wbr><a href='../index.html'>linalg</a>::<wbr><a href='index.html'>balancing</a>::<wbr><a class="fn" href=''>unbalance</a></span></h1><pre class='rust fn'>pub fn unbalance&lt;N:&nbsp;<a class="trait" href="../../../nalgebra/trait.RealField.html" title="trait nalgebra::RealField">RealField</a>, D:&nbsp;<a class="trait" href="../../../nalgebra/base/dimension/trait.Dim.html" title="trait nalgebra::base::dimension::Dim">Dim</a>&gt;(m: &amp;mut <a class="type" href="../../../nalgebra/base/type.MatrixN.html" title="type nalgebra::base::MatrixN">MatrixN</a>&lt;N, D&gt;, d: &amp;<a class="type" href="../../../nalgebra/base/type.VectorN.html" title="type nalgebra::base::VectorN">VectorN</a>&lt;N, D&gt;) <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="struct" href="../../../nalgebra/base/default_allocator/struct.DefaultAllocator.html" title="struct nalgebra::base::default_allocator::DefaultAllocator">DefaultAllocator</a>: <a class="trait" href="../../../nalgebra/base/allocator/trait.Allocator.html" title="trait nalgebra::base::allocator::Allocator">Allocator</a>&lt;N, D, D&gt; + <a class="trait" href="../../../nalgebra/base/allocator/trait.Allocator.html" title="trait nalgebra::base::allocator::Allocator">Allocator</a>&lt;N, D&gt;,&nbsp;</span></pre><div class='docblock'><p>Computes in-place <code>D * m * D.inverse()</code>, where <code>D</code> is the matrix with diagonal <code>d</code>.</p>
</div></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>&#9166;</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>

6
doc/nalgebra/linalg/balancing/index.html Normal file
View File

@@ -0,0 +1,6 @@
<!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 `balancing` mod in crate `nalgebra`."><meta name="keywords" content="rust, rustlang, rust-lang, balancing"><title>nalgebra::linalg::balancing - 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">&#9776;</div><a href='../../../nalgebra/index.html'><div class='logo-container'><img src='../../../rust-logo.png' alt='logo'></div></a><p class='location'>Module balancing</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../../index.html'>nalgebra</a>::<wbr><a href='../index.html'>linalg</a></p><script>window.sidebarCurrent = {name: 'balancing', 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'>&#x2212;</span>]</a></span><a class='srclink' href='../../../src/nalgebra/linalg/balancing.rs.html#1-80' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../../index.html'>nalgebra</a>::<wbr><a href='../index.html'>linalg</a>::<wbr><a class="mod" href=''>balancing</a></span></h1><div class='docblock'><p>Functions for balancing a matrix.</p>
</div><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
<table><tr class='module-item'><td><a class="fn" href="fn.balance_parlett_reinsch.html" title='nalgebra::linalg::balancing::balance_parlett_reinsch fn'>balance_parlett_reinsch</a></td><td class='docblock-short'><p>Applies in-place a modified Parlett and Reinsch matrix balancing with 2-norm to the matrix <code>m</code> and returns
the corresponding diagonal transformation.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.unbalance.html" title='nalgebra::linalg::balancing::unbalance fn'>unbalance</a></td><td class='docblock-short'><p>Computes in-place <code>D * m * D.inverse()</code>, where <code>D</code> is the matrix with diagonal <code>d</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>&#9166;</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>

1
doc/nalgebra/linalg/balancing/sidebar-items.js Normal file
View File

@@ -0,0 +1 @@
initSidebarItems({"fn":[["balance_parlett_reinsch","Applies in-place a modified Parlett and Reinsch matrix balancing with 2-norm to the matrix `m` and returns the corresponding diagonal transformation."],["unbalance","Computes in-place `D * m * D.inverse()`, where `D` is the matrix with diagonal `d`."]]});

10
doc/nalgebra/linalg/bidiagonal/struct.Bidiagonal.html Normal file
View File

@@ -0,0 +1,10 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../nalgebra/linalg/struct.Bidiagonal.html">
</head>
<body>
<p>Redirecting to <a href="../../../nalgebra/linalg/struct.Bidiagonal.html">../../../nalgebra/linalg/struct.Bidiagonal.html</a>...</p>
<script>location.replace("../../../nalgebra/linalg/struct.Bidiagonal.html" + location.search + location.hash);</script>
</body>
</html>

10
doc/nalgebra/linalg/cholesky/struct.Cholesky.html Normal file
View File

@@ -0,0 +1,10 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../nalgebra/linalg/struct.Cholesky.html">
</head>
<body>
<p>Redirecting to <a href="../../../nalgebra/linalg/struct.Cholesky.html">../../../nalgebra/linalg/struct.Cholesky.html</a>...</p>
<script>location.replace("../../../nalgebra/linalg/struct.Cholesky.html" + location.search + location.hash);</script>
</body>
</html>

3
doc/nalgebra/linalg/fn.try_invert_to.html Normal file
View File

@@ -0,0 +1,3 @@
<!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 `try_invert_to` fn in crate `nalgebra`."><meta name="keywords" content="rust, rustlang, rust-lang, try_invert_to"><title>nalgebra::linalg::try_invert_to - 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 fn"><!--[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">&#9776;</div><a href='../../nalgebra/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><p class='location'><a href='../index.html'>nalgebra</a>::<wbr><a href='index.html'>linalg</a></p><script>window.sidebarCurrent = {name: 'try_invert_to', ty: 'fn', 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'>&#x2212;</span>]</a></span><a class='srclink' href='../../src/nalgebra/linalg/lu.rs.html#52-87' title='goto source code'>[src]</a></span><span class='in-band'>Function <a href='../index.html'>nalgebra</a>::<wbr><a href='index.html'>linalg</a>::<wbr><a class="fn" href=''>try_invert_to</a></span></h1><pre class='rust fn'>pub fn try_invert_to&lt;N:&nbsp;<a class="trait" href="../../nalgebra/trait.ComplexField.html" title="trait nalgebra::ComplexField">ComplexField</a>, D:&nbsp;<a class="trait" href="../../nalgebra/base/dimension/trait.Dim.html" title="trait nalgebra::base::dimension::Dim">Dim</a>, S&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;matrix: <a class="type" href="../../nalgebra/base/type.MatrixN.html" title="type nalgebra::base::MatrixN">MatrixN</a>&lt;N, D&gt;, <br>&nbsp;&nbsp;&nbsp;&nbsp;out: &amp;mut <a class="struct" href="../../nalgebra/base/struct.Matrix.html" title="struct nalgebra::base::Matrix">Matrix</a>&lt;N, D, D, S&gt;<br>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;S: <a class="trait" href="../../nalgebra/base/storage/trait.StorageMut.html" title="trait nalgebra::base::storage::StorageMut">StorageMut</a>&lt;N, D, D&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a class="struct" href="../../nalgebra/base/default_allocator/struct.DefaultAllocator.html" title="struct nalgebra::base::default_allocator::DefaultAllocator">DefaultAllocator</a>: <a class="trait" href="../../nalgebra/base/allocator/trait.Allocator.html" title="trait nalgebra::base::allocator::Allocator">Allocator</a>&lt;N, D, D&gt;,&nbsp;</span></pre><div class='docblock'><p>Performs a LU decomposition to overwrite <code>out</code> with the inverse of <code>matrix</code>.</p>
<p>If <code>matrix</code> is not invertible, <code>false</code> is returned and <code>out</code> may contain invalid data.</p>
</div></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>&#9166;</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>

6
doc/nalgebra/linalg/fn.wilkinson_shift.html Normal file
View File

@@ -0,0 +1,6 @@
<!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 `wilkinson_shift` fn in crate `nalgebra`."><meta name="keywords" content="rust, rustlang, rust-lang, wilkinson_shift"><title>nalgebra::linalg::wilkinson_shift - 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 fn"><!--[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">&#9776;</div><a href='../../nalgebra/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><p class='location'><a href='../index.html'>nalgebra</a>::<wbr><a href='index.html'>linalg</a></p><script>window.sidebarCurrent = {name: 'wilkinson_shift', ty: 'fn', 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'>&#x2212;</span>]</a></span><a class='srclink' href='../../src/nalgebra/linalg/symmetric_eigen.rs.html#291-300' title='goto source code'>[src]</a></span><span class='in-band'>Function <a href='../index.html'>nalgebra</a>::<wbr><a href='index.html'>linalg</a>::<wbr><a class="fn" href=''>wilkinson_shift</a></span></h1><pre class='rust fn'>pub fn wilkinson_shift&lt;N:&nbsp;<a class="trait" href="../../nalgebra/trait.ComplexField.html" title="trait nalgebra::ComplexField">ComplexField</a>&gt;(tmm: N, tnn: N, tmn: N) -&gt; N</pre><div class='docblock'><p>Computes the wilkinson shift, i.e., the 2x2 symmetric matrix eigenvalue to its tailing
component <code>tnn</code>.</p>
<p>The inputs are interpreted as the 2x2 matrix:
tmm tmn
tmn tnn</p>
</div></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>&#9166;</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>

10
doc/nalgebra/linalg/full_piv_lu/struct.FullPivLU.html Normal file
View File

@@ -0,0 +1,10 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../nalgebra/linalg/struct.FullPivLU.html">
</head>
<body>
<p>Redirecting to <a href="../../../nalgebra/linalg/struct.FullPivLU.html">../../../nalgebra/linalg/struct.FullPivLU.html</a>...</p>
<script>location.replace("../../../nalgebra/linalg/struct.FullPivLU.html" + location.search + location.hash);</script>
</body>
</html>

4
doc/nalgebra/linalg/givens/index.html Normal file
View File

@@ -0,0 +1,4 @@
<!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 `givens` mod in crate `nalgebra`."><meta name="keywords" content="rust, rustlang, rust-lang, givens"><title>nalgebra::linalg::givens - 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">&#9776;</div><a href='../../../nalgebra/index.html'><div class='logo-container'><img src='../../../rust-logo.png' alt='logo'></div></a><p class='location'>Module givens</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li></ul></div><p class='location'><a href='../../index.html'>nalgebra</a>::<wbr><a href='../index.html'>linalg</a></p><script>window.sidebarCurrent = {name: 'givens', 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'>&#x2212;</span>]</a></span><a class='srclink' href='../../../src/nalgebra/linalg/givens.rs.html#1-160' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../../index.html'>nalgebra</a>::<wbr><a href='../index.html'>linalg</a>::<wbr><a class="mod" href=''>givens</a></span></h1><div class='docblock'><p>Construction of givens rotations.</p>
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table><tr class='module-item'><td><a class="struct" href="struct.GivensRotation.html" title='nalgebra::linalg::givens::GivensRotation struct'>GivensRotation</a></td><td class='docblock-short'><p>A Givens rotation.</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>&#9166;</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>

1
doc/nalgebra/linalg/givens/sidebar-items.js Normal file
View File

@@ -0,0 +1 @@
initSidebarItems({"struct":[["GivensRotation","A Givens rotation."]]});

40
doc/nalgebra/linalg/givens/struct.GivensRotation.html Normal file
View File

File diff suppressed because one or more lines are too long

10
doc/nalgebra/linalg/hessenberg/struct.Hessenberg.html Normal file
View File

@@ -0,0 +1,10 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../nalgebra/linalg/struct.Hessenberg.html">
</head>
<body>
<p>Redirecting to <a href="../../../nalgebra/linalg/struct.Hessenberg.html">../../../nalgebra/linalg/struct.Hessenberg.html</a>...</p>
<script>location.replace("../../../nalgebra/linalg/struct.Hessenberg.html" + location.search + location.hash);</script>
</body>
</html>

2
doc/nalgebra/linalg/householder/index.html Normal file
View File

@@ -0,0 +1,2 @@
<!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 `householder` mod in crate `nalgebra`."><meta name="keywords" content="rust, rustlang, rust-lang, householder"><title>nalgebra::linalg::householder - 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">&#9776;</div><a href='../../../nalgebra/index.html'><div class='logo-container'><img src='../../../rust-logo.png' alt='logo'></div></a><p class='location'>Module householder</p><div class="sidebar-elems"><p class='location'><a href='../../index.html'>nalgebra</a>::<wbr><a href='../index.html'>linalg</a></p><script>window.sidebarCurrent = {name: 'householder', 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'>&#x2212;</span>]</a></span><a class='srclink' href='../../../src/nalgebra/linalg/householder.rs.html#1-129' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../../index.html'>nalgebra</a>::<wbr><a href='../index.html'>linalg</a>::<wbr><a class="mod" href=''>householder</a></span></h1><div class='docblock'><p>Construction of householder elementary reflections.</p>
</div></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>&#9166;</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>

1
doc/nalgebra/linalg/householder/sidebar-items.js Normal file
View File

@@ -0,0 +1 @@
initSidebarItems({});

22
doc/nalgebra/linalg/index.html Normal file
View File

@@ -0,0 +1,22 @@
<!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">&#9776;</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'>&#x2212;</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>&#9166;</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>

10
doc/nalgebra/linalg/lu/fn.try_invert_to.html Normal file
View File

@@ -0,0 +1,10 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../nalgebra/linalg/fn.try_invert_to.html">
</head>
<body>
<p>Redirecting to <a href="../../../nalgebra/linalg/fn.try_invert_to.html">../../../nalgebra/linalg/fn.try_invert_to.html</a>...</p>
<script>location.replace("../../../nalgebra/linalg/fn.try_invert_to.html" + location.search + location.hash);</script>
</body>
</html>

10
doc/nalgebra/linalg/lu/struct.LU.html Normal file
View File

@@ -0,0 +1,10 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../nalgebra/linalg/struct.LU.html">
</head>
<body>
<p>Redirecting to <a href="../../../nalgebra/linalg/struct.LU.html">../../../nalgebra/linalg/struct.LU.html</a>...</p>
<script>location.replace("../../../nalgebra/linalg/struct.LU.html" + location.search + location.hash);</script>
</body>
</html>

10
doc/nalgebra/linalg/permutation_sequence/struct.PermutationSequence.html Normal file
View File

@@ -0,0 +1,10 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../nalgebra/linalg/struct.PermutationSequence.html">
</head>
<body>
<p>Redirecting to <a href="../../../nalgebra/linalg/struct.PermutationSequence.html">../../../nalgebra/linalg/struct.PermutationSequence.html</a>...</p>
<script>location.replace("../../../nalgebra/linalg/struct.PermutationSequence.html" + location.search + location.hash);</script>
</body>
</html>

10
doc/nalgebra/linalg/qr/struct.QR.html Normal file
View File

@@ -0,0 +1,10 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../nalgebra/linalg/struct.QR.html">
</head>
<body>
<p>Redirecting to <a href="../../../nalgebra/linalg/struct.QR.html">../../../nalgebra/linalg/struct.QR.html</a>...</p>
<script>location.replace("../../../nalgebra/linalg/struct.QR.html" + location.search + location.hash);</script>
</body>
</html>

10
doc/nalgebra/linalg/schur/struct.Schur.html Normal file
View File

@@ -0,0 +1,10 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../nalgebra/linalg/struct.Schur.html">
</head>
<body>
<p>Redirecting to <a href="../../../nalgebra/linalg/struct.Schur.html">../../../nalgebra/linalg/struct.Schur.html</a>...</p>
<script>location.replace("../../../nalgebra/linalg/struct.Schur.html" + location.search + location.hash);</script>
</body>
</html>

1
doc/nalgebra/linalg/sidebar-items.js Normal file
View File

@@ -0,0 +1 @@
initSidebarItems({"fn":[["try_invert_to","Performs a LU decomposition to overwrite `out` with the inverse of `matrix`."],["wilkinson_shift","Computes the wilkinson shift, i.e., the 2x2 symmetric matrix eigenvalue to its tailing component `tnn`."]],"mod":[["balancing","Functions for balancing a matrix."],["givens","Construction of givens rotations."],["householder","Construction of householder elementary reflections."]],"struct":[["Bidiagonal","The bidiagonalization of a general matrix."],["Cholesky","The Cholesky decomposition of a symmetric-definite-positive matrix."],["FullPivLU","LU decomposition with full row and column pivoting."],["Hessenberg","Hessenberg decomposition of a general matrix."],["LU","LU decomposition with partial (row) pivoting."],["PermutationSequence","A sequence of row or column permutations."],["QR","The QR decomposition of a general matrix."],["SVD","Singular Value Decomposition of a general matrix."],["Schur","Schur decomposition of a square matrix."],["SymmetricEigen","Eigendecomposition of a symmetric matrix."],["SymmetricTridiagonal","Tridiagonalization of a symmetric matrix."]]});

32
doc/nalgebra/linalg/struct.Bidiagonal.html Normal file
View File

File diff suppressed because one or more lines are too long

43
doc/nalgebra/linalg/struct.Cholesky.html Normal file
View File

File diff suppressed because one or more lines are too long

39
doc/nalgebra/linalg/struct.FullPivLU.html Normal file
View File

File diff suppressed because one or more lines are too long

33
doc/nalgebra/linalg/struct.Hessenberg.html Normal file
View File

File diff suppressed because one or more lines are too long

41
doc/nalgebra/linalg/struct.LU.html Normal file
View File

File diff suppressed because one or more lines are too long

34
doc/nalgebra/linalg/struct.PermutationSequence.html Normal file
View File

File diff suppressed because one or more lines are too long

38
doc/nalgebra/linalg/struct.QR.html Normal file
View File

File diff suppressed because one or more lines are too long

55
doc/nalgebra/linalg/struct.SVD.html Normal file
View File

File diff suppressed because one or more lines are too long

40
doc/nalgebra/linalg/struct.Schur.html Normal file
View File

File diff suppressed because one or more lines are too long

43
doc/nalgebra/linalg/struct.SymmetricEigen.html Normal file
View File

File diff suppressed because one or more lines are too long

32
doc/nalgebra/linalg/struct.SymmetricTridiagonal.html Normal file
View File

File diff suppressed because one or more lines are too long

10
doc/nalgebra/linalg/svd/struct.SVD.html Normal file
View File

@@ -0,0 +1,10 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../nalgebra/linalg/struct.SVD.html">
</head>
<body>
<p>Redirecting to <a href="../../../nalgebra/linalg/struct.SVD.html">../../../nalgebra/linalg/struct.SVD.html</a>...</p>
<script>location.replace("../../../nalgebra/linalg/struct.SVD.html" + location.search + location.hash);</script>
</body>
</html>

10
doc/nalgebra/linalg/symmetric_eigen/fn.wilkinson_shift.html Normal file
View File

@@ -0,0 +1,10 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../nalgebra/linalg/fn.wilkinson_shift.html">
</head>
<body>
<p>Redirecting to <a href="../../../nalgebra/linalg/fn.wilkinson_shift.html">../../../nalgebra/linalg/fn.wilkinson_shift.html</a>...</p>
<script>location.replace("../../../nalgebra/linalg/fn.wilkinson_shift.html" + location.search + location.hash);</script>
</body>
</html>

10
doc/nalgebra/linalg/symmetric_eigen/struct.SymmetricEigen.html Normal file
View File

@@ -0,0 +1,10 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../nalgebra/linalg/struct.SymmetricEigen.html">
</head>
<body>
<p>Redirecting to <a href="../../../nalgebra/linalg/struct.SymmetricEigen.html">../../../nalgebra/linalg/struct.SymmetricEigen.html</a>...</p>
<script>location.replace("../../../nalgebra/linalg/struct.SymmetricEigen.html" + location.search + location.hash);</script>
</body>
</html>

10
doc/nalgebra/linalg/symmetric_tridiagonal/struct.SymmetricTridiagonal.html Normal file
View File

@@ -0,0 +1,10 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../nalgebra/linalg/struct.SymmetricTridiagonal.html">
</head>
<body>
<p>Redirecting to <a href="../../../nalgebra/linalg/struct.SymmetricTridiagonal.html">../../../nalgebra/linalg/struct.SymmetricTridiagonal.html</a>...</p>
<script>location.replace("../../../nalgebra/linalg/struct.SymmetricTridiagonal.html" + location.search + location.hash);</script>
</body>
</html>