32 lines
16 KiB
HTML
32 lines
16 KiB
HTML
<!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 `Matrix` trait in crate `alga`."><meta name="keywords" content="rust, rustlang, rust-lang, Matrix"><title>alga::linear::Matrix - 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="../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[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='../../alga/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Trait Matrix</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-types">Associated Types</a><div class="sidebar-links"><a href="#associatedtype.Field">Field</a><a href="#associatedtype.Row">Row</a><a href="#associatedtype.Column">Column</a><a href="#associatedtype.Transpose">Transpose</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.column">column</a><a href="#tymethod.get_unchecked">get_unchecked</a><a href="#tymethod.ncolumns">ncolumns</a><a href="#tymethod.nrows">nrows</a><a href="#tymethod.row">row</a><a href="#tymethod.transpose">transpose</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.get">get</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../index.html'>alga</a>::<wbr><a href='index.html'>linear</a></p><script>window.sidebarCurrent = {name: 'Matrix', ty: 'trait', 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/alga/linear/matrix.rs.html#7-49' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='../index.html'>alga</a>::<wbr><a href='index.html'>linear</a>::<wbr><a class="trait" href=''>Matrix</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait Matrix: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <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="https://doc.rust-lang.org/nightly/core/ops/arith/trait.Mul.html" title="trait core::ops::arith::Mul">Mul</a><Self::<a class="type" href="../../alga/linear/trait.Matrix.html#associatedtype.Row" title="type alga::linear::Matrix::Row">Row</a>, Output = Self::<a class="type" href="../../alga/linear/trait.Matrix.html#associatedtype.Column" title="type alga::linear::Matrix::Column">Column</a>> {
|
||
type <a href='#associatedtype.Field' class="type">Field</a>: <a class="trait" href="../../alga/general/trait.Field.html" title="trait alga::general::Field">Field</a>;
|
||
type <a href='#associatedtype.Row' class="type">Row</a>: <a class="trait" href="../../alga/linear/trait.FiniteDimVectorSpace.html" title="trait alga::linear::FiniteDimVectorSpace">FiniteDimVectorSpace</a><Field = Self::<a class="type" href="../../alga/linear/trait.Matrix.html#associatedtype.Field" title="type alga::linear::Matrix::Field">Field</a>>;
|
||
type <a href='#associatedtype.Column' class="type">Column</a>: <a class="trait" href="../../alga/linear/trait.FiniteDimVectorSpace.html" title="trait alga::linear::FiniteDimVectorSpace">FiniteDimVectorSpace</a><Field = Self::<a class="type" href="../../alga/linear/trait.Matrix.html#associatedtype.Field" title="type alga::linear::Matrix::Field">Field</a>>;
|
||
type <a href='#associatedtype.Transpose' class="type">Transpose</a>: <a class="trait" href="../../alga/linear/trait.Matrix.html" title="trait alga::linear::Matrix">Matrix</a><Field = Self::<a class="type" href="../../alga/linear/trait.Matrix.html#associatedtype.Field" title="type alga::linear::Matrix::Field">Field</a>, Row = Self::<a class="type" href="../../alga/linear/trait.Matrix.html#associatedtype.Column" title="type alga::linear::Matrix::Column">Column</a>, Column = Self::<a class="type" href="../../alga/linear/trait.Matrix.html#associatedtype.Row" title="type alga::linear::Matrix::Row">Row</a>>;
|
||
fn <a href='#tymethod.nrows' class='fnname'>nrows</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>;
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.ncolumns' class='fnname'>ncolumns</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>;
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.row' class='fnname'>row</a>(&self, i: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> Self::<a class="type" href="../../alga/linear/trait.Matrix.html#associatedtype.Row" title="type alga::linear::Matrix::Row">Row</a>;
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.column' class='fnname'>column</a>(&self, i: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> Self::<a class="type" href="../../alga/linear/trait.Matrix.html#associatedtype.Column" title="type alga::linear::Matrix::Column">Column</a>;
|
||
<div class='item-spacer'></div> unsafe fn <a href='#tymethod.get_unchecked' class='fnname'>get_unchecked</a>(&self, i: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, j: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> Self::<a class="type" href="../../alga/linear/trait.Matrix.html#associatedtype.Field" title="type alga::linear::Matrix::Field">Field</a>;
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.transpose' class='fnname'>transpose</a>(&self) -> Self::<a class="type" href="../../alga/linear/trait.Matrix.html#associatedtype.Transpose" title="type alga::linear::Matrix::Transpose">Transpose</a>;
|
||
|
||
fn <a href='#method.get' class='fnname'>get</a>(&self, i: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, j: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> Self::<a class="type" href="../../alga/linear/trait.Matrix.html#associatedtype.Field" title="type alga::linear::Matrix::Field">Field</a> { ... }
|
||
}</pre></div><div class='docblock'><p>The space of all matrices.</p>
|
||
</div>
|
||
<h2 id='associated-types' class='small-section-header'>Associated Types<a href='#associated-types' class='anchor'></a></h2><div class='methods'><h3 id='associatedtype.Field' class='method'><code id='Field.t'>type <a href='#associatedtype.Field' class="type">Field</a>: <a class="trait" href="../../alga/general/trait.Field.html" title="trait alga::general::Field">Field</a></code></h3><div class='docblock'><p>The underlying field.</p>
|
||
</div><h3 id='associatedtype.Row' class='method'><code id='Row.t'>type <a href='#associatedtype.Row' class="type">Row</a>: <a class="trait" href="../../alga/linear/trait.FiniteDimVectorSpace.html" title="trait alga::linear::FiniteDimVectorSpace">FiniteDimVectorSpace</a><Field = Self::<a class="type" href="../../alga/linear/trait.Matrix.html#associatedtype.Field" title="type alga::linear::Matrix::Field">Field</a>></code></h3><div class='docblock'><p>The type of rows of this matrix.</p>
|
||
</div><h3 id='associatedtype.Column' class='method'><code id='Column.t'>type <a href='#associatedtype.Column' class="type">Column</a>: <a class="trait" href="../../alga/linear/trait.FiniteDimVectorSpace.html" title="trait alga::linear::FiniteDimVectorSpace">FiniteDimVectorSpace</a><Field = Self::<a class="type" href="../../alga/linear/trait.Matrix.html#associatedtype.Field" title="type alga::linear::Matrix::Field">Field</a>></code></h3><div class='docblock'><p>The type of columns of this matrix.</p>
|
||
</div><h3 id='associatedtype.Transpose' class='method'><code id='Transpose.t'>type <a href='#associatedtype.Transpose' class="type">Transpose</a>: <a class="trait" href="../../alga/linear/trait.Matrix.html" title="trait alga::linear::Matrix">Matrix</a><Field = Self::<a class="type" href="../../alga/linear/trait.Matrix.html#associatedtype.Field" title="type alga::linear::Matrix::Field">Field</a>, Row = Self::<a class="type" href="../../alga/linear/trait.Matrix.html#associatedtype.Column" title="type alga::linear::Matrix::Column">Column</a>, Column = Self::<a class="type" href="../../alga/linear/trait.Matrix.html#associatedtype.Row" title="type alga::linear::Matrix::Row">Row</a>></code></h3><div class='docblock'><p>The type of the transposed matrix.</p>
|
||
</div></div><span class='loading-content'>Loading content...</span>
|
||
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.nrows' class='method'><code id='nrows.v'>fn <a href='#tymethod.nrows' class='fnname'>nrows</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></h3><div class='docblock'><p>The number of rows of this matrix.</p>
|
||
</div><h3 id='tymethod.ncolumns' class='method'><code id='ncolumns.v'>fn <a href='#tymethod.ncolumns' class='fnname'>ncolumns</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></h3><div class='docblock'><p>The number of columns of this matrix.</p>
|
||
</div><h3 id='tymethod.row' class='method'><code id='row.v'>fn <a href='#tymethod.row' class='fnname'>row</a>(&self, i: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> Self::<a class="type" href="../../alga/linear/trait.Matrix.html#associatedtype.Row" title="type alga::linear::Matrix::Row">Row</a></code></h3><div class='docblock'><p>The i-th row of this matrix.</p>
|
||
</div><h3 id='tymethod.column' class='method'><code id='column.v'>fn <a href='#tymethod.column' class='fnname'>column</a>(&self, i: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> Self::<a class="type" href="../../alga/linear/trait.Matrix.html#associatedtype.Column" title="type alga::linear::Matrix::Column">Column</a></code></h3><div class='docblock'><p>The i-th column of this matrix.</p>
|
||
</div><h3 id='tymethod.get_unchecked' class='method'><code id='get_unchecked.v'>unsafe fn <a href='#tymethod.get_unchecked' class='fnname'>get_unchecked</a>(&self, i: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, j: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> Self::<a class="type" href="../../alga/linear/trait.Matrix.html#associatedtype.Field" title="type alga::linear::Matrix::Field">Field</a></code></h3><div class='docblock'><p>Gets the component at row <code>i</code> and column <code>j</code> of this matrix without bound checking.</p>
|
||
</div><h3 id='tymethod.transpose' class='method'><code id='transpose.v'>fn <a href='#tymethod.transpose' class='fnname'>transpose</a>(&self) -> Self::<a class="type" href="../../alga/linear/trait.Matrix.html#associatedtype.Transpose" title="type alga::linear::Matrix::Transpose">Transpose</a></code></h3><div class='docblock'><p>Transposes this matrix.</p>
|
||
</div></div><span class='loading-content'>Loading content...</span>
|
||
<h2 id='provided-methods' class='small-section-header'>Provided methods<a href='#provided-methods' class='anchor'></a></h2><div class='methods'><h3 id='method.get' class='method'><code id='get.v'>fn <a href='#method.get' class='fnname'>get</a>(&self, i: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, j: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> Self::<a class="type" href="../../alga/linear/trait.Matrix.html#associatedtype.Field" title="type alga::linear::Matrix::Field">Field</a></code></h3><div class='docblock'><p>Gets the component at row <code>i</code> and column <code>j</code> of this matrix.</p>
|
||
</div></div><span class='loading-content'>Loading content...</span>
|
||
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'></div><span class='loading-content'>Loading content...</span><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
|
||
src="../../implementors/alga/linear/trait.Matrix.js">
|
||
</script></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 = "alga";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |