|
|
<!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 `SupersetOf` trait in crate `alga`."><meta name="keywords" content="rust, rustlang, rust-lang, SupersetOf"><title>alga::general::SupersetOf - 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 SupersetOf</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_subset">from_subset</a><a href="#tymethod.is_in_subset">is_in_subset</a><a href="#tymethod.to_subset_unchecked">to_subset_unchecked</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.to_subset">to_subset</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'>general</a></p><script>window.sidebarCurrent = {name: 'SupersetOf', 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/general/subset.rs.html#64-85' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='../index.html'>alga</a>::<wbr><a href='index.html'>general</a>::<wbr><a class="trait" href=''>SupersetOf</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait SupersetOf<T>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
|
|
|
fn <a href='#tymethod.is_in_subset' class='fnname'>is_in_subset</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>;
|
|
|
<div class='item-spacer'></div> unsafe fn <a href='#tymethod.to_subset_unchecked' class='fnname'>to_subset_unchecked</a>(&self) -> T;
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.from_subset' class='fnname'>from_subset</a>(element: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T) -> Self;
|
|
|
|
|
|
fn <a href='#method.to_subset' class='fnname'>to_subset</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><T> { ... }
|
|
|
}</pre></div><div class='docblock'><p>Nested sets and conversions between them. Useful to work with substructures. It is preferable
|
|
|
to implement the <code>SupersetOf</code> trait instead of <code>SubsetOf</code> whenever possible (because
|
|
|
<code>SupersetOf</code> is automatically implemented whenever <code>SubsetOf</code> is.</p>
|
|
|
<p>The notion of "nested sets" is very broad and applies to what the types are <em>supposed to
|
|
|
represent</em>, independently from their actual implementation details and limitations. For
|
|
|
example:</p>
|
|
|
<ul>
|
|
|
<li>f32 and f64 are both supposed to represent reals and are thus considered equal (even if in
|
|
|
practice f64 has more elements).</li>
|
|
|
<li>u32 and i8 are respectively supposed to represent natural and relative numbers. Thus, i8 is
|
|
|
a superset of u32.</li>
|
|
|
<li>A quaternion and a 3x3 orthogonal matrix with unit determinant are both sets of rotations.
|
|
|
They can thus be considered equal.</li>
|
|
|
</ul>
|
|
|
<p>In other words, implementation details due to machine limitations are ignored (otherwise we
|
|
|
could not even, e.g., convert a u64 to an i64). If considering those limitations are
|
|
|
important, other crates allowing you to query the limitations of given types should be used.</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.is_in_subset' class='method'><code id='is_in_subset.v'>fn <a href='#tymethod.is_in_subset' class='fnname'>is_in_subset</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></h3><div class='docblock'><p>Checks if <code>self</code> is actually part of its subset <code>T</code> (and can be converted to it).</p>
|
|
|
</div><h3 id='tymethod.to_subset_unchecked' class='method'><code id='to_subset_unchecked.v'>unsafe fn <a href='#tymethod.to_subset_unchecked' class='fnname'>to_subset_unchecked</a>(&self) -> T</code></h3><div class='docblock'><p>Use with care! Same as <code>self.to_subset</code> but without any property checks. Always succeeds.</p>
|
|
|
</div><h3 id='tymethod.from_subset' class='method'><code id='from_subset.v'>fn <a href='#tymethod.from_subset' class='fnname'>from_subset</a>(element: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T) -> Self</code></h3><div class='docblock'><p>The inclusion map: converts <code>self</code> to the equivalent element of its superset.</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.to_subset' class='method'><code id='to_subset.v'>fn <a href='#method.to_subset' class='fnname'>to_subset</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><T></code></h3><div class='docblock'><p>The inverse inclusion map: attempts to construct <code>self</code> from the equivalent element of its
|
|
|
superset.</p>
|
|
|
<p>Must return <code>None</code> if <code>element</code> has no equivalent in <code>Self</code>.</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-SupersetOf%3CSS%3E' class='impl'><code class='in-band'>impl<SS: <a class="trait" href="../../alga/general/trait.SubsetOf.html" title="trait alga::general::SubsetOf">SubsetOf</a><SP>, SP> SupersetOf<SS> for SP</code><a href='#impl-SupersetOf%3CSS%3E' class='anchor'></a><a class='srclink' href='../../src/alga/general/subset.rs.html#87-107' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.to_subset-1' class="method hidden"><code id='to_subset.v-1'>fn <a href='#method.to_subset-1' class='fnname'>to_subset</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><SS></code><a class='srclink' href='../../src/alga/general/subset.rs.html#89-91' title='goto source code'>[src]</a></h4><h4 id='method.is_in_subset' class="method hidden"><code id='is_in_subset.v-1'>fn <a href='#method.is_in_subset' class='fnname'>is_in_subset</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../src/alga/general/subset.rs.html#94-96' title='goto source code'>[src]</a></h4><h4 id='method.to_subset_unchecked' class="method hidden"><code id='to_subset_unchecked.v-1'>unsafe fn <a href='#method.to_subset_unchecked' class='fnname'>to_subset_unchecked</a>(&self) -> SS</code><a class='srclink' href='../../src/alga/general/subset.rs.html#99-101' title='goto source code'>[src]</a></h4><h4 id='method.from_subset' class="method hidden"><code id='from_subset.v-1'>fn <a href='#method.from_subset' class='fnname'>from_subset</a>(element: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>SS) -> Self</code><a class='srclink' href='../../src/alga/general/subset.rs.html#104-106' 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/alga/general/trait.SupersetOf.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> |
