|
|
<!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` trait in crate `nalgebra`."><meta name="keywords" content="rust, rustlang, rust-lang, Allocator"><title>nalgebra::base::allocator::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 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 Allocator</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.Buffer">Buffer</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.allocate_from_iterator">allocate_from_iterator</a><a href="#tymethod.allocate_uninitialized">allocate_uninitialized</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'>allocator</a></p><script>window.sidebarCurrent = {name: 'Allocator', 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/allocator.rs.html#19-32' 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'>allocator</a>::<wbr><a class="trait" href=''>Allocator</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait Allocator<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> = <a class="struct" href="../../../nalgebra/base/dimension/struct.U1.html" title="struct nalgebra::base::dimension::U1">U1</a>>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
|
|
|
type <a href='#associatedtype.Buffer' class="type">Buffer</a>: <a class="trait" href="../../../nalgebra/base/storage/trait.ContiguousStorageMut.html" title="trait nalgebra::base::storage::ContiguousStorageMut">ContiguousStorageMut</a><N, R, C> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>;
|
|
|
unsafe fn <a href='#tymethod.allocate_uninitialized' class='fnname'>allocate_uninitialized</a>(nrows: R, ncols: C) -> Self::<a class="type" href="../../../nalgebra/base/allocator/trait.Allocator.html#associatedtype.Buffer" title="type nalgebra::base::allocator::Allocator::Buffer">Buffer</a>;
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.allocate_from_iterator' class='fnname'>allocate_from_iterator</a><I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = N>>(<br> nrows: R, <br> ncols: C, <br> iter: I<br> ) -> Self::<a class="type" href="../../../nalgebra/base/allocator/trait.Allocator.html#associatedtype.Buffer" title="type nalgebra::base::allocator::Allocator::Buffer">Buffer</a>;
|
|
|
}</pre></div><div class='docblock'><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>
|
|
|
<p>An allocator is said to be:
|
|
|
− static: if <code>R</code> and <code>C</code> both implement <code>DimName</code>.
|
|
|
− dynamic: if either one (or both) of <code>R</code> or <code>C</code> is equal to <code>Dynamic</code>.</p>
|
|
|
<p>Every allocator must be both static and dynamic. Though not all implementations may share the
|
|
|
same <code>Buffer</code> type.</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.Buffer' class='method'><code id='Buffer.t'>type <a href='#associatedtype.Buffer' class="type">Buffer</a>: <a class="trait" href="../../../nalgebra/base/storage/trait.ContiguousStorageMut.html" title="trait nalgebra::base::storage::ContiguousStorageMut">ContiguousStorageMut</a><N, R, C> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a></code></h3><div class='docblock'><p>The type of buffer this allocator can instanciate.</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.allocate_uninitialized' class='method'><code id='allocate_uninitialized.v'>unsafe fn <a href='#tymethod.allocate_uninitialized' class='fnname'>allocate_uninitialized</a>(nrows: R, ncols: C) -> Self::<a class="type" href="../../../nalgebra/base/allocator/trait.Allocator.html#associatedtype.Buffer" title="type nalgebra::base::allocator::Allocator::Buffer">Buffer</a></code></h3><div class='docblock'><p>Allocates a buffer with the given number of rows and columns without initializing its content.</p>
|
|
|
</div><h3 id='tymethod.allocate_from_iterator' class='method'><code id='allocate_from_iterator.v'>fn <a href='#tymethod.allocate_from_iterator' class='fnname'>allocate_from_iterator</a><I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = N>>(<br> nrows: R, <br> ncols: C, <br> iter: I<br>) -> Self::<a class="type" href="../../../nalgebra/base/allocator/trait.Allocator.html#associatedtype.Buffer" title="type nalgebra::base::allocator::Allocator::Buffer">Buffer</a></code></h3><div class='docblock'><p>Allocates a buffer initialized with the content of the given iterator.</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-Allocator%3CN%2C%20R%2C%20C%3E' class='impl'><code class='in-band'>impl<N, R, C> Allocator<N, R, C> for <a class="struct" href="../../../nalgebra/base/default_allocator/struct.DefaultAllocator.html" title="struct nalgebra::base::default_allocator::DefaultAllocator">DefaultAllocator</a> <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>, </span></code><a href='#impl-Allocator%3CN%2C%20R%2C%20C%3E' class='anchor'></a><a class='srclink' href='../../../src/nalgebra/base/default_allocator.rs.html#37-74' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Buffer-1' class="type"><code id='Buffer.t-1'>type <a href='#associatedtype.Buffer-1' class="type">Buffer</a> = <a class="struct" href="../../../nalgebra/base/struct.ArrayStorage.html" title="struct nalgebra::base::ArrayStorage">ArrayStorage</a><N, R, C></code></h4><h4 id='method.allocate_uninitialized' class="method hidden"><code id='allocate_uninitialized.v-1'>unsafe fn <a href='#method.allocate_uninitialized' class='fnname'>allocate_uninitialized</a>(_: R, _: C) -> Self::<a class="type" href="../../../nalgebra/base/allocator/trait.Allocator.html#associatedtype.Buffer" title="type nalgebra::base::allocator::Allocator::Buffer">Buffer</a></code><a class='srclink' href='../../../src/nalgebra/base/default_allocator.rs.html#48-50' title='goto source code'>[src]</a></h4><h4 id='method.allocate_from_iterator' class="method hidden"><code id='allocate_from_iterator.v-1'>fn <a href='#method.allocate_from_iterator' class='fnname'>allocate_from_iterator</a><I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = N>>(<br> nrows: R, <br> ncols: C, <br> iter: I<br>) -> Self::<a class="type" href="../../../nalgebra/base/allocator/trait.Allocator.html#associatedtype.Buffer" title="type nalgebra::base::allocator::Allocator::Buffer">Buffer</a></code><a class='srclink' href='../../../src/nalgebra/base/default_allocator.rs.html#53-73' title='goto source code'>[src]</a></h4></div><h3 id='impl-Allocator%3CN%2C%20Dynamic%2C%20C%3E' class='impl'><code class='in-band'>impl<N: <a class="trait" href="../../../nalgebra/base/trait.Scalar.html" title="trait nalgebra::base::Scalar">Scalar</a>, C: <a class="trait" href="../../../nalgebra/base/dimension/trait.Dim.html" title="trait nalgebra::base::dimension::Dim">Dim</a>> Allocator<N, <a class="struct" href="../../../nalgebra/base/dimension/struct.Dynamic.html" title="struct nalgebra::base::dimension::Dynamic">Dynamic</a>, C> for <a class="struct" href="../../../nalgebra/base/default_allocator/struct.DefaultAllocator.html" title="struct nalgebra::base::default_allocator::DefaultAllocator">DefaultAllocator</a></code><a href='#impl-Allocator%3CN%2C%20Dynamic%2C%20C%3E' class='anchor'></a><a class='srclink' href='../../../src/nalgebra/base/default_allocator.rs.html#79-106' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Buffer-2' class="type"><code id='Buffer.t-2'>type <a href='#associatedtype.Buffer-2' class="type">Buffer</a> = <a class="struct" href="../../../nalgebra/base/struct.VecStorage.html" title="struct nalgebra::base::VecStorage">VecStorage</a><N, <a class="struct" href="../../../nalgebra/base/dimension/struct.Dynamic.html" title="struct nalgebra::base::dimension::Dynamic">Dynamic</a>, C></code></h4><h4 id='method.allocate_uninitialized-1' class="method hidden"><code id='allocate_uninitialized.v-2'>unsafe fn <a href='#method.allocate_uninitialized-1' class='fnname'>allocate_uninitialized</a>(nrows: <a class="struct" href="../../../nalgebra/base/dimension/struct.Dynamic.html" title="struct nalgebra::base::dimension::Dynamic">Dynamic</a>, ncols: C) -> Self::<a class="type" href="../../../nalgebra/base/allocator/trait.Allocator.html#associatedtype.Buffer" title="type nalgebra::base::allocator::Allocator::Buffer">Buffer</a></code><a class='srclink' href='../../../src/nalgebra/base/default_allocator.rs.html#83-90' title='goto source code'>[src]</a></h4><h4 id='method.allocate_from_iterator-1' class="method hidden"><code id='allocate_from_iterator.v-2'>fn <a href='#method.allocate_from_iterator-1' class='fnname'>allocate_from_iterator</a><I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = N>>(<br> nrows: <a class="struct" href="../../../nalgebra/base/dimension/struct.Dynamic.html" title="struct nalgebra::base::dimension::Dynamic">Dynamic</a>, <br> ncols: C, <br> iter: I<br>) -> Self::<a class="type" href="../../../nalgebra/base/allocator/trait.Allocator.html#associatedtype.Buffer" title="type nalgebra::base::allocator::Allocator::Buffer">Buffer</a></code><a class='srclink' href='../../../src/nalgebra/base/default_allocator.rs.html#93-105' title='goto source code'>[src]</a></h4></div><h3 id='impl-Allocator%3CN%2C%20R%2C%20Dynamic%3E' class='impl'><code class='in-band'>impl<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.DimName.html" title="trait nalgebra::base::dimension::DimName">DimName</a>> Allocator<N, R, <a class="struct" href="../../../nalgebra/base/dimension/struct.Dynamic.html" title="struct nalgebra::base::dimension::Dynamic">Dynamic</a>> for <a class="struct" href="../../../nalgebra/base/default_allocator/struct.DefaultAllocator.html" title="struct nalgebra::base::default_allocator::DefaultAllocator">DefaultAllocator</a></code><a href='#impl-Allocator%3CN%2C%20R%2C%20Dynamic%3E' class='anchor'></a><a class='srclink' href='../../../src/nalgebra/base/default_allocator.rs.html#110-137' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Buffer-3' class="type"><code id='Buffer.t-3'>type <a href='#associatedtype.Buffer-3' class="type">Buffer</a> = <a class="struct" href="../../../nalgebra/base/struct.VecStorage.html" title="struct nalgebra::base::VecStorage">VecStorage</a><N, R, <a class="struct" href="../../../nalgebra/base/dimension/struct.Dynamic.html" title="struct nalgebra::base::dimension::Dynamic">Dynamic</a>></code></h4><h4 id='method.allocate_uninitialized-2' class="method hidden"><code id='allocate_uninitialized.v-3'>unsafe fn <a href='#method.allocate_uninitialized-2' class='fnname'>allocate_uninitialized</a>(nrows: R, ncols: <a class="struct" href="../../../nalgebra/base/dimension/struct.Dynamic.html" title="struct nalgebra::base::dimension::Dynamic">Dynamic</a>) -> Self::<a class="type" href="../../../nalgebra/base/allocator/trait.Allocator.html#associatedtype.Buffer" title="type nalgebra::base::allocator::Allocator::Buffer">Buffer</a></code><a class='srclink' href='../../../src/nalgebra/base/default_allocator.rs.html#114-121' title='goto source code'>[src]</a></h4><h4 id='method.allocate_from_iterator-2' class="method hidden"><code id='allocate_from_iterator.v-3'>fn <a href='#method.allocate_from_iterator-2' class='fnname'>allocate_from_iterator</a><I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = N>>(<br> nrows: R, <br> ncols: <a class="struct" href="../../../nalgebra/base/dimension/struct.Dynamic.html" title="struct nalgebra::base::dimension::Dynamic">Dynamic</a>, <br> iter: I<br>) -> Self::<a class="type" href="../../../nalgebra/base/allocator/trait.Allocator.html#associatedtype.Buffer" title="type nalgebra::base::allocator::Allocator::Buffer">Buffer</a></code><a class='srclink' href='../../../src/nalgebra/base/default_allocator.rs.html#124-136' title='goto source code'>[src]</a></h4></div></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/nalgebra/base/allocator/trait.Allocator.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> |
