|
|
|
|
|
<!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 `StorageMut` trait in crate `nalgebra`."><meta name="keywords" content="rust, rustlang, rust-lang, StorageMut"><title>nalgebra::base::storage::StorageMut - 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 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='../../../nalgebra/index.html'><div class='logo-container'><img src='../../../rust-logo.png' alt='logo'></div></a><p class='location'>Trait StorageMut</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.as_mut_slice">as_mut_slice</a><a href="#tymethod.ptr_mut">ptr_mut</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.get_address_unchecked_linear_mut">get_address_unchecked_linear_mut</a><a href="#method.get_address_unchecked_mut">get_address_unchecked_mut</a><a href="#method.get_unchecked_linear_mut">get_unchecked_linear_mut</a><a href="#method.get_unchecked_mut">get_unchecked_mut</a><a href="#method.swap_unchecked">swap_unchecked</a><a href="#method.swap_unchecked_linear">swap_unchecked_linear</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../../index.html'>nalgebra</a>::<wbr><a href='../index.html'>base</a>::<wbr><a href='index.html'>storage</a></p><script>window.sidebarCurrent = {name: 'StorageMut', 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/nalgebra/base/storage.rs.html#120-171' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='../../index.html'>nalgebra</a>::<wbr><a href='../index.html'>base</a>::<wbr><a href='index.html'>storage</a>::<wbr><a class="trait" href=''>StorageMut</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub unsafe trait StorageMut<N: <a class="trait" href="../../../nalgebra/base/trait.Scalar.html" title="trait nalgebra::base::Scalar">Scalar</a>, R: <a class="trait" href="../../../nalgebra/base/dimension/trait.Dim.html" title="trait nalgebra::base::dimension::Di
|
|
|
|
|
|
fn <a href='#tymethod.ptr_mut' class='fnname'>ptr_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut N</a>;
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.as_mut_slice' class='fnname'>as_mut_slice</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [N]</a>;
|
|
|
|
|
|
|
|
|
|
|
|
unsafe fn <a href='#method.get_address_unchecked_linear_mut' class='fnname'>get_address_unchecked_linear_mut</a>(&mut self, i: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut N</a> { ... }
|
|
|
|
|
|
<div class='item-spacer'></div> unsafe fn <a href='#method.get_address_unchecked_mut' class='fnname'>get_address_unchecked_mut</a>(<br> &mut self, <br> irow: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br> icol: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><br> ) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut N</a> { ... }
|
|
|
|
|
|
<div class='item-spacer'></div> unsafe fn <a href='#method.get_unchecked_linear_mut' class='fnname'>get_unchecked_linear_mut</a>(&mut self, i: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>N { ... }
|
|
|
|
|
|
<div class='item-spacer'></div> unsafe fn <a href='#method.get_unchecked_mut' class='fnname'>get_unchecked_mut</a>(&mut self, irow: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, icol: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>N { ... }
|
|
|
|
|
|
<div class='item-spacer'></div> unsafe fn <a href='#method.swap_unchecked_linear' class='fnname'>swap_unchecked_linear</a>(&mut self, i1: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, i2: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) { ... }
|
|
|
|
|
|
<div class='item-spacer'></div> unsafe fn <a href='#method.swap_unchecked' class='fnname'>swap_unchecked</a>(<br> &mut self, <br> row_col1: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>, <br> row_col2: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a><br> ) { ... }
|
|
|
|
|
|
}</pre></div><div class='docblock'><p>Trait implemented by matrix data storage that can provide a mutable access to its elements.</p>
|
|
|
|
|
|
<p>Note that a mutable access does not mean that the matrix owns its data. For example, a mutable
|
|
|
|
|
|
matrix slice can provide mutable access to its elements even if it does not own its data (it
|
|
|
|
|
|
contains only an internal reference to them).</p>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.ptr_mut' class='method'><code id='ptr_mut.v'>fn <a href='#tymethod.ptr_mut' class='fnname'>ptr_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut N</a></code></h3><div class='docblock'><p>The matrix mutable data pointer.</p>
|
|
|
|
|
|
</div><h3 id='tymethod.as_mut_slice' class='method'><code id='as_mut_slice.v'>fn <a href='#tymethod.as_mut_slice' class='fnname'>as_mut_slice</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [N]</a></code></h3><div class='docblock'><p>Retrieves the mutable data buffer as a contiguous slice.</p>
|
|
|
|
|
|
<p>Matrix components may not be contiguous, depending on its strides.</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_address_unchecked_linear_mut' class='method'><code id='get_address_unchecked_linear_mut.v'>unsafe fn <a href='#method.get_address_unchecked_linear_mut' class='fnname'>get_address_unchecked_linear_mut</a>(&mut self, i: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut N</a></code></h3><div class='docblock'><p>Gets the mutable address of the i-th matrix component without performing bound-checking.</p>
|
|
|
|
|
|
</div><h3 id='method.get_address_unchecked_mut' class='method'><code id='get_address_unchecked_mut.v'>unsafe fn <a href='#method.get_address_unchecked_mut' class='fnname'>get_address_unchecked_mut</a>(<br> &mut self, <br> irow: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br> icol: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><br>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut N</a></code></h3><div class='docblock'><p>Gets the mutable address of the i-th matrix component without performing bound-checking.</p>
|
|
|
|
|
|
</div><h3 id='method.get_unchecked_linear_mut' class='method'><code id='get_unchecked_linear_mut.v'>unsafe fn <a href='#method.get_unchecked_linear_mut' class='fnname'>get_unchecked_linear_mut</a>(&mut self, i: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>N</code></h3><div class='docblock'><p>Retrieves a mutable reference to the i-th element without bound-checking.</p>
|
|
|
|
|
|
</div><h3 id='method.get_unchecked_mut' class='method'><code id='get_unchecked_mut.v'>unsafe fn <a href='#method.get_unchecked_mut' class='fnname'>get_unchecked_mut</a>(&mut self, irow: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, icol: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>N</code></h3><div class='docblock'><p>Retrieves a mutable reference to the element at <code>(irow, icol)</code> without bound-checking.</p>
|
|
|
|
|
|
</div><h3 id='method.swap_unchecked_linear' class='method'><code id='swap_unchecked_linear.v'>unsafe fn <a href='#method.swap_unchecked_linear' class='fnname'>swap_unchecked_linear</a>(&mut self, i1: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, i2: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>)</code></h3><div class='docblock'><p>Swaps two elements using their linear index without bound-checking.</p>
|
|
|
|
|
|
</div><h3 id='method.swap_unchecked' class='method'><code id='swap_unchecked.v'>unsafe fn <a href='#method.swap_unchecked' class='fnname'>swap_unchecked</a>(<br> &mut self, <br> row_col1: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>, <br> row_col2: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a><br>)</code></h3><div class='docblock'><p>Swaps two elements without bound-checking.</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'><h3 id='impl-StorageMut%3CN%2C%20R%2C%20C%3E' class='impl'><code class='in-band'>impl<'a, N: <a class="trait" href="../../../nalgebra/base/trait.Scalar.html" title="trait nalgebra::base::Scalar">Scalar</a>, R: <a class="trait" href="../../../nalgebra/base/dimension/trait.Dim.html" title="trait nalgebra::base::dimension::Dim">Dim</a>, C: <a class="trait" href="../../../nalgebra/base/dimension/trait.Dim.html" title="trait nalgebra::base::dimension::Dim">Dim</a>, RStride: <a class="trait" href="../../../nalgebra/base/dimension/trait.Dim.html" title="trait nalgebra::base::dimension::Dim">Dim</a>, CStride: <a class="trait" href="../../../nalgebra/base/dimension/trait.Dim.html" title="trait nalgebra::base::dimension::Dim">Dim</a>> StorageMut<N, R, C> for <a class="struct" href="../../../nalgebra/base/struct.SliceStorageMut.html" title="struct nalgebra::base::SliceStorageMut">SliceStorageMut</a><'a, N, R, C, RStride, CStride></code><a href='#impl-StorageMut%3CN%2C%20R%2C%20C%3E' class='anchor'></a><a class='srclink' href='../../../src/nalgebra/base/matrix_slice.rs.html#181-199' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.ptr_mut' class="method hidden"><code id='ptr_mut.v-1'>fn <a href='#method.ptr_mut' class='fnname'>ptr_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut N</a></code><a class='srclink' href='../../../src/nalgebra/base/matrix_slice.rs.html#185-187' title='goto source code'>[src]</a></h4><h4 id='method.as_mut_slice' class="method hidden"><code id='as_mut_slice.v-1'>fn <a href='#method.as_mut_slice' class='fnname'>as_mut_slice</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [N]</a></code><a class='srclink' href='../../../src/nalgebra/base/matrix_slice.rs.html#190-198' title='goto source code'>[src]</a></h4></div><h3 id='impl-StorageMut%3CN%2C%20R%2C%20C%3E-1' class='impl'><code class='in-band'>impl<N, R, C> StorageMut<N, R, C> for <a class="struct" href="../../../nalgebra/base/struct.ArrayStorage.html" title="struct nalgebra::base::ArrayStorage">ArrayStorage</a><N, R, C> <span class="where fmt-newline">where<br> N: <a class="trait" href="../../../nalgebra/base/trait.Scalar.html" title="trait nalgebra::base::Scalar">Scalar</a>,<br> R: <a class="trait" href="../../../nalgebra/base/dimension/trait.DimName.html" title="trait nalgebra::base::dimension::DimName">DimName</a>,<br> C: <a class="trait" href="../../../nalgebra/base/dimension/trait.DimName.html" title="trait nalgebra::base::dimension::DimName">DimName</a>,<br> R::<a class="type" href="../../../nalgebra/base/dimension/trait.DimName.html#associatedtype.Value" title="type nalgebra::base::dimension::DimName::Value">Value</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><C::<a class="type" href="../../../nalgebra/base/dimension/trait.DimName.html#associatedtype.Value" title="type nalgebra::base::dimension::DimName::Value">Value</a>>,<br> <a class="type" href="../../../typenum/operator_aliases/type.Prod.html" title="type typenum::operator_aliases::Prod">Prod</a><R::<a class="type" href="../../../nalgebra/base/dimension/trait.DimName.html#associatedtype.Value" title="type nalgebra::base::dimension::DimName::Value">Value</a>, C::<a class="type" href="../../../nalgebra/base/dimension/trait.DimName.html#associatedtype.Value" title="type nalgebra::base::dimension::DimName::Value">Value</a>>: <a class="trait" href="../../../generic_array/trait.ArrayLength.html" title="trait generic_array::ArrayLength">ArrayLength</a><N>,<br> <a cla
|
|
|
|
|
|
src="../../../implementors/nalgebra/base/storage/trait.StorageMut.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 = "nalgebra";</script><script src="../../../aliases.js"></script><script src="../../../main.js"></script><script defer src="../../../search-index.js"></script></body></html>
|
