|
|
|
|
|
<!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 `Dim` trait in crate `nalgebra`."><meta name="keywords" content="rust, rustlang, rust-lang, Dim"><title>nalgebra::base::dimension::Dim - 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 Dim</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.from_usize">from_usize</a><a href="#tymethod.try_to_usize">try_to_usize</a><a href="#tymethod.value">value</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.is">is</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-Dim-for-UInt%3CU%2C%20B%3E">UInt<U, B></a><a href="#impl-Dim-for-UInt%3CUInt%3CUInt%3CUInt%3CUInt%3CUInt%3CUInt%3CUInt%3CUTerm%2C%20B1%3E%2C%20A%3E%2C%20B%3E%2C%20C%3E%2C%20D%3E%2C%20E%3E%2C%20F%3E%2C%20G%3E">UInt<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, A>, B>, C>, D>, E>, F>, G></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'>dimension</a></p><script>window.sidebarCurrent = {name: 'Dim', 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/dimension.rs.html#56-73' 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'>dimension</a>::<wbr><a class="trait" href=''>Dim</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait Dim: <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.
|
|
|
|
|
|
fn <a href='#tymethod.try_to_usize' class='fnname'>try_to_usize</a>() -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<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.value' class='fnname'>value</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.from_usize' class='fnname'>from_usize</a>(dim: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> Self;
|
|
|
|
|
|
|
|
|
|
|
|
fn <a href='#method.is' class='fnname'>is</a><D: <a class="trait" href="../../../nalgebra/base/dimension/trait.Dim.html" title="trait nalgebra::base::dimension::Dim">Dim</a>>() -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> { ... }
|
|
|
|
|
|
}</pre></div><div class='docblock'><p>Trait implemented by any type that can be used as a dimension. This includes type-level
|
|
|
|
|
|
integers and <code>Dynamic</code> (for dimensions not known at compile-time).</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.try_to_usize' class='method'><code id='try_to_usize.v'>fn <a href='#tymethod.try_to_usize' class='fnname'>try_to_usize</a>() -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>></code></h3><div class='docblock'><p>Gets the compile-time value of <code>Self</code>. Returns <code>None</code> if it is not known, i.e., if <code>Self = Dynamic</code>.</p>
|
|
|
|
|
|
</div><h3 id='tymethod.value' class='method'><code id='value.v'>fn <a href='#tymethod.value' class='fnname'>value</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></h3><div class='docblock'><p>Gets the run-time value of <code>self</code>. For type-level integers, this is the same as
|
|
|
|
|
|
<code>Self::try_to_usize().unwrap()</code>.</p>
|
|
|
|
|
|
</div><h3 id='tymethod.from_usize' class='method'><code id='from_usize.v'>fn <a href='#tymethod.from_usize' class='fnname'>from_usize</a>(dim: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> Self</code></h3><div class='docblock'><p>Builds an instance of <code>Self</code> from a run-time value. Panics if <code>Self</code> is a type-level
|
|
|
|
|
|
integer and <code>dim != Self::try_to_usize().unwrap()</code>.</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.is' class='method'><code id='is.v'>fn <a href='#method.is' class='fnname'>is</a><D: <a class="trait" href="../../../nalgebra/base/dimension/trait.Dim.html" title="trait nalgebra::base::dimension::Dim">Dim</a>>() -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></h3></div><span class='loading-content'>Loading content...</span>
|
|
|
|
|
|
<h2 id='foreign-impls' class='small-section-header'>Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a></h2><h3 id='impl-Dim-for-UInt%3CUInt%3CUInt%3CUInt%3CUInt%3CUInt%3CUInt%3CUInt%3CUTerm%2C%20B1%3E%2C%20A%3E%2C%20B%3E%2C%20C%3E%2C%20D%3E%2C%20E%3E%2C%20F%3E%2C%20G%3E' class='impl'><code class='in-band'>impl<A: <a class="trait" href="../../../typenum/marker_traits/trait.Bit.html" title="trait typenum::marker_traits::Bit">Bit</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/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>, B: <a class="trait" href="../../../typenum/marker_traits/trait.Bit.html" title="trait typenum::marker_traits::Bit">Bit</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/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>, C: <a class="trait" href="../../../typenum/marker_traits/trait.Bit.html" title="trait typenum::marker_traits::Bit">Bit</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/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>, D: <a class="trait" href="../../../typenum/marker_traits/trait.Bit.html" title="trait typenum::marker_traits::Bit">Bit</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/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>, E: <a class="trait" href="../../../typenum/marker_traits/trait.Bit.html" title="trait typenum::marker_traits::Bit
|
|
|
|
|
|
<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-Dim' class='impl'><code class='in-band'>impl Dim for <a class="struct" href="../../../nalgebra/base/dimension/struct.Dynamic.html" title="struct nalgebra::base::dimension::Dynamic">Dynamic</a></code><a href='#impl-Dim' class='anchor'></a><a class='srclink' href='../../../src/nalgebra/base/dimension.rs.html#75-90' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.try_to_usize-2' class="method hidden"><code id='try_to_usize.v-3'>fn <a href='#method.try_to_usize-2' class='fnname'>try_to_usize</a>() -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>></code><a class='srclink' href='../../../src/nalgebra/base/dimension.rs.html#77-79' title='goto source code'>[src]</a></h4><h4 id='method.from_usize-2' class="method hidden"><code id='from_usize.v-3'>fn <a href='#method.from_usize-2' class='fnname'>from_usize</a>(dim: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> Self</code><a class='srclink' href='../../../src/nalgebra/base/dimension.rs.html#82-84' title='goto source code'>[src]</a></h4><h4 id='method.value-2' class="method hidden"><code id='value.v-3'>fn <a href='#method.value-2' class='fnname'>value</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class='srclink' href='../../../src/nalgebra/base/dimension.rs.html#87-89' title='goto source code'>[src]</a></h4></div><h3 id='impl-Dim-1' class='impl'><code class='in-band'>impl Dim for <a class="struct" href="../../../nalgebra/base/dimension/struct.U0.html" title="struct nalgebra::base::dimension::U0">U0</a></code><a href='#impl-Dim-1' class='anchor'></a><a class='srclink' href='../../../src/nalgebra/base/dimension.rs.html#251-267' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.try_to_usize-3' class="method hidden"><code id='try_to_usize.v-4'>fn <a href='#method.try_to_usize-3' class='fnname'>try_to_usize</a>() -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>></code><a class='srclink' href='../../../src/nalgebra/base/dimension.rs.html#253-255' title='goto source code'>[src]</a></h4><h4 id='method.from_usize-3' class="method hidden"><code id='from_usize.v-4'>fn <a href='#method.from_usize-3' class='fnname'>from_usize</a>(dim: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> Self</code><a class='srclink' href='../../../src/nalgebra/base/dimension.rs.html#258-261' title='goto source code'>[src]</a></h4><h4 id='method.value-3' class="method hidden"><code id='value.v-4'>fn <a href='#method.value-3' class='fnname'>value</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class='srclink' href='../../../src/nalgebra/base/dimension.rs.html#264-266' title='goto source code'>[src]</a></h4></div><h3 id='impl-Dim-2' class='impl'><code class='in-band'>impl Dim for <a class="struct" href="../../../nalgebra/base/dimension/struct.U1.html" title="struct nalgebra::base::dimension::U1">U1</a></code><a href='#impl-Dim-2' class='anchor'></a><a class='srclink' href='../../../src/nalgebra/base/dimension.rs.html#213-229' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.try_to_usize-4' class="method hidden"><code id='try_to_usize.v-5'>fn <a href='#method.try_to_usize-4' class='fnname'>try_to_usize</a>() -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum co
|
|
|
|
|
|
src="../../../implementors/nalgebra/base/dimension/trait.Dim.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>
|
