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

12
doc/nalgebra/base/allocator/index.html Normal file
View File

@@ -0,0 +1,12 @@
<!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 `allocator` mod in crate `nalgebra`."><meta name="keywords" content="rust, rustlang, rust-lang, allocator"><title>nalgebra::base::allocator - 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 allocator</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#traits">Traits</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'><a href='../../index.html'>nalgebra</a>::<wbr><a href='../index.html'>base</a></p><script>window.sidebarCurrent = {name: 'allocator', 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/base/allocator.rs.html#1-103' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../../index.html'>nalgebra</a>::<wbr><a href='../index.html'>base</a>::<wbr><a class="mod" href=''>allocator</a></span></h1><div class='docblock'><p>Abstract definition of a matrix data storage allocator.</p>
</div><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
<table><tr class='module-item'><td><a class="trait" href="trait.Allocator.html" title='nalgebra::base::allocator::Allocator trait'>Allocator</a></td><td class='docblock-short'><p>A matrix allocator of a memory buffer that may contain <code>R::to_usize() * C::to_usize()</code>
elements of type <code>N</code>.</p>
</td></tr><tr class='module-item'><td><a class="trait" href="trait.Reallocator.html" title='nalgebra::base::allocator::Reallocator trait'>Reallocator</a></td><td class='docblock-short'><p>A matrix reallocator. Changes the size of the memory buffer that initially contains (RFrom ×
CFrom) elements to a smaller or larger size (RTo, CTo).</p>
</td></tr><tr class='module-item'><td><a class="trait" href="trait.SameShapeAllocator.html" title='nalgebra::base::allocator::SameShapeAllocator trait'>SameShapeAllocator</a></td><td class='docblock-short'><p>Restricts the given number of rows and columns to be respectively the same.</p>
</td></tr><tr class='module-item'><td><a class="trait" href="trait.SameShapeVectorAllocator.html" title='nalgebra::base::allocator::SameShapeVectorAllocator trait'>SameShapeVectorAllocator</a></td><td class='docblock-short'><p>Restricts the given number of rows to be equal.</p>
</td></tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
<table><tr class='module-item'><td><a class="type" href="type.SameShapeC.html" title='nalgebra::base::allocator::SameShapeC type'>SameShapeC</a></td><td class='docblock-short'><p>The number of columns of the result of a componentwise operation on two matrices.</p>
</td></tr><tr class='module-item'><td><a class="type" href="type.SameShapeR.html" title='nalgebra::base::allocator::SameShapeR type'>SameShapeR</a></td><td class='docblock-short'><p>The number of rows of the result of a componentwise operation on two matrices.</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/base/allocator/sidebar-items.js Normal file
View File

@@ -0,0 +1 @@
initSidebarItems({"trait":[["Allocator","A matrix allocator of a memory buffer that may contain `R::to_usize() * C::to_usize()` elements of type `N`."],["Reallocator","A matrix reallocator. Changes the size of the memory buffer that initially contains (RFrom × CFrom) elements to a smaller or larger size (RTo, CTo)."],["SameShapeAllocator","Restricts the given number of rows and columns to be respectively the same."],["SameShapeVectorAllocator","Restricts the given number of rows to be equal."]],"type":[["SameShapeC","The number of columns of the result of a componentwise operation on two matrices."],["SameShapeR","The number of rows of the result of a componentwise operation on two matrices."]]});

20
doc/nalgebra/base/allocator/trait.Allocator.html Normal file
View File

File diff suppressed because one or more lines are too long

17
doc/nalgebra/base/allocator/trait.Reallocator.html Normal file
View File

File diff suppressed because one or more lines are too long

5
doc/nalgebra/base/allocator/trait.SameShapeAllocator.html Normal file
View File

File diff suppressed because one or more lines are too long

5
doc/nalgebra/base/allocator/trait.SameShapeVectorAllocator.html Normal file
View File

File diff suppressed because one or more lines are too long

2
doc/nalgebra/base/allocator/type.SameShapeC.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 `SameShapeC` type in crate `nalgebra`."><meta name="keywords" content="rust, rustlang, rust-lang, SameShapeC"><title>nalgebra::base::allocator::SameShapeC - 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 type"><!--[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'>Type Definition SameShapeC</p><div class="sidebar-elems"><p class='location'><a href='../../index.html'>nalgebra</a>::<wbr><a href='../index.html'>base</a>::<wbr><a href='index.html'>allocator</a></p><script>window.sidebarCurrent = {name: 'SameShapeC', ty: 'type', 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/base/allocator.rs.html#57' title='goto source code'>[src]</a></span><span class='in-band'>Type Definition <a href='../../index.html'>nalgebra</a>::<wbr><a href='../index.html'>base</a>::<wbr><a href='index.html'>allocator</a>::<wbr><a class="type" href=''>SameShapeC</a></span></h1><pre class='rust typedef'>type SameShapeC&lt;C1, C2&gt; = &lt;<a class="struct" href="../../../nalgebra/base/constraint/struct.ShapeConstraint.html" title="struct nalgebra::base::constraint::ShapeConstraint">ShapeConstraint</a> as <a class="trait" href="../../../nalgebra/base/constraint/trait.SameNumberOfColumns.html" title="trait nalgebra::base::constraint::SameNumberOfColumns">SameNumberOfColumns</a>&lt;C1, C2&gt;&gt;::<a class="type" href="../../../nalgebra/base/constraint/trait.SameNumberOfColumns.html#associatedtype.Representative" title="type nalgebra::base::constraint::SameNumberOfColumns::Representative">Representative</a>;</pre><div class='docblock'><p>The number of columns of the result of a componentwise operation on two matrices.</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/base/allocator/type.SameShapeR.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 `SameShapeR` type in crate `nalgebra`."><meta name="keywords" content="rust, rustlang, rust-lang, SameShapeR"><title>nalgebra::base::allocator::SameShapeR - 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 type"><!--[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'>Type Definition SameShapeR</p><div class="sidebar-elems"><p class='location'><a href='../../index.html'>nalgebra</a>::<wbr><a href='../index.html'>base</a>::<wbr><a href='index.html'>allocator</a></p><script>window.sidebarCurrent = {name: 'SameShapeR', ty: 'type', 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/base/allocator.rs.html#54' title='goto source code'>[src]</a></span><span class='in-band'>Type Definition <a href='../../index.html'>nalgebra</a>::<wbr><a href='../index.html'>base</a>::<wbr><a href='index.html'>allocator</a>::<wbr><a class="type" href=''>SameShapeR</a></span></h1><pre class='rust typedef'>type SameShapeR&lt;R1, R2&gt; = &lt;<a class="struct" href="../../../nalgebra/base/constraint/struct.ShapeConstraint.html" title="struct nalgebra::base::constraint::ShapeConstraint">ShapeConstraint</a> as <a class="trait" href="../../../nalgebra/base/constraint/trait.SameNumberOfRows.html" title="trait nalgebra::base::constraint::SameNumberOfRows">SameNumberOfRows</a>&lt;R1, R2&gt;&gt;::<a class="type" href="../../../nalgebra/base/constraint/trait.SameNumberOfRows.html#associatedtype.Representative" title="type nalgebra::base::constraint::SameNumberOfRows::Representative">Representative</a>;</pre><div class='docblock'><p>The number of rows of the result of a componentwise operation on two matrices.</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>