You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
37 lines
239 KiB
37 lines
239 KiB
5 years ago
|
<!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 `SubsetOf` trait in crate `alga`."><meta name="keywords" content="rust, rustlang, rust-lang, SubsetOf"><title>alga::general::SubsetOf - 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 SubsetOf</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_superset_unchecked">from_superset_unchecked</a><a href="#tymethod.is_in_subset">is_in_subset</a><a href="#tymethod.to_superset">to_superset</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.from_superset">from_superset</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-SubsetOf%3CComplex%3CN2%3E%3E-for-Complex%3CN1%3E">Complex<N1></a><a href="#impl-SubsetOf%3CComplex%3CN2%3E%3E-for-f32">f32</a><a href="#impl-SubsetOf%3CComplex%3CN2%3E%3E-for-f64">f64</a><a href="#impl-SubsetOf%3CComplex%3CN2%3E%3E-for-i16">i16</a><a href="#impl-SubsetOf%3CComplex%3CN2%3E%3E-for-i32">i32</a><a href="#impl-SubsetOf%3CComplex%3CN2%3E%3E-for-i64">i64</a><a href="#impl-SubsetOf%3CComplex%3CN2%3E%3E-for-i8">i8</a><a href="#impl-SubsetOf%3CComplex%3CN2%3E%3E-for-isize">isize</a><a href="#impl-SubsetOf%3CComplex%3CN2%3E%3E-for-u16">u16</a><a href="#impl-SubsetOf%3CComplex%3CN2%3E%3E-for-u32">u32</a><a href="#impl-SubsetOf%3CComplex%3CN2%3E%3E-for-u64">u64</a><a href="#impl-SubsetOf%3CComplex%3CN2%3E%3E-for-u8">u8</a><a href="#impl-SubsetOf%3CComplex%3CN2%3E%3E-for-usize">usize</a><a href="#impl-SubsetOf%3Cf32%3E-for-f32">f32</a><a href="#impl-SubsetOf%3Cf32%3E-for-f64">f64</a><a href="#impl-SubsetOf%3Cf32%3E-for-i16">i16</a><a href="#impl-SubsetOf%3Cf32%3E-for-i32">i32</a><a href="#impl-SubsetOf%3Cf32%3E-for-i64">i64</a><a href="#impl-SubsetOf%3Cf32%3E-for-i8">i8</a><a href="#impl-SubsetOf%3Cf32%3E-for-isize">isize</a><a href="#impl-SubsetOf%3Cf32%3E-for-u16">u16</a><a href="#impl-SubsetOf%3Cf32%3E-for-u32">u32</a><a href="#impl-SubsetOf%3Cf32%3E-for-u64">u64</a><a href="#impl-SubsetOf%3Cf32%3E-for-u8">u8</a><a href="#impl-SubsetOf%3Cf32%3E-for-usize">usize</a><a href="#impl-SubsetOf%3Cf64%3E-for-f32">f32</a><a href="#impl-SubsetOf%3Cf64%3E-for-f64">f64</a><a href="#impl-SubsetOf%3Cf64%3E-for-i16">i16</a><a href="#impl-SubsetOf%3Cf64%3E-for-i32">i32</a><a href="#impl-SubsetOf%3Cf64%3E-for-i64">i64</a><a href="#impl-SubsetOf%3Cf64%3E-for-i8">i8</a><a href="#impl-SubsetOf%3Cf64%3E-for-isize">isize</a><a href="#impl-SubsetOf%3Cf64%3E-for-u16">u16</a><a href="#impl-SubsetOf%3Cf64%3E-for-u32">u32</a><a href="#impl-SubsetOf%3Cf64%3E-for-u64">u64</a><a href="#impl-SubsetOf%3Cf64%3E-for-u8">u8</a><a href="#impl-SubsetOf%3Cf64%3E-for-usize">usize</a><a href="#impl-SubsetOf%3Ci16%3E-for-i16">i16</a><a href="#impl-SubsetOf%3Ci16%3E-for-i32">i32</a><a href="#impl-SubsetOf%3Ci16%3E-for-i64">i64</a><a href="#impl-SubsetOf%3Ci16%3E-for-i8">i8</a><a href="#
|
||
|
|
fn <a href='#tymethod.to_superset' class='fnname'>to_superset</a>(&self) -> T;
|
||
|
|
<div class='item-spacer'></div> unsafe fn <a href='#tymethod.from_superset_unchecked' class='fnname'>from_superset_unchecked</a>(element: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T) -> Self;
|
||
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.is_in_subset' class='fnname'>is_in_subset</a>(element: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>;
|
||
|
|
|
||
|
|
fn <a href='#method.from_superset' class='fnname'>from_superset</a>(element: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self> { ... }
|
||
|
|
}</pre></div><div class='docblock'><p>Nested sets and conversions between them (using an injective mapping). Useful to work with
|
||
|
|
substructures. In generic code, it is preferable to use <code>SupersetOf</code> as trait bound whenever
|
||
|
|
possible instead of <code>SubsetOf</code> (because SupersetOf 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, u32 is
|
||
|
|
a subset of i8.</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.to_superset' class='method'><code id='to_superset.v'>fn <a href='#tymethod.to_superset' class='fnname'>to_superset</a>(&self) -> T</code></h3><div class='docblock'><p>The inclusion map: converts <code>self</code> to the equivalent element of its superset.</p>
|
||
|
|
</div><h3 id='tymethod.from_superset_unchecked' class='method'><code id='from_superset_unchecked.v'>unsafe fn <a href='#tymethod.from_superset_unchecked' class='fnname'>from_superset_unchecked</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>Use with care! Same as <code>self.to_superset</code> but without any property checks. Always succeeds.</p>
|
||
|
|
</div><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>(element: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T) -> <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>element</code> is actually part of the subset <code>Self</code> (and can be converted to it).</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.from_superset' class='method'><code id='from_superset.v'>fn <a href='#method.from_superset' class='fnname'>from_superset</a>(element: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><Self></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='foreign-impls' class='small-section-header'>Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a></h2><h3 id='impl-SubsetOf%3Cu8%3E-for-u8' class='impl'><code class='in-band'>impl <a class="trait" href="../../alga/general/trait.SubsetOf.html" title="trait alga::general::SubsetOf">SubsetOf</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a></code><a href='#impl-SubsetOf%3Cu8%3E-for-u8' class='anchor'></a><a class='srclink' href='../../src/alga/general/subset.rs.html#112-127' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.to_superset' class="method hidden"><code id='to_superset.v-1'>fn <a href='#method.to_superset' class='fnname'>to_superset</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a></code><a class='srclink' href='../../src/alga/general/subset.rs.html#114-116' title='goto source code'>[src]</a></h4><h4 id='method.from_superset_unchecked' class="method hidden"><code id='from_superset_unchecked.v-1'>unsafe fn <a href='#method.from_superset_unchecked' class='fnname'>from_superset_unchecked</a>(element: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a></code><a class='srclink' href='../../src/alga/general/subset.rs.html#119-121' 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>(_: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>) -> <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#124-126' title='goto source code'>[src]</a></h4></div><h3 id='impl-SubsetOf%3Cu16%3E-for-u8' class='impl'><code class='in-band'>impl <a class="trait" href="../../alga/general/trait.SubsetOf.html" title="trait alga::general::SubsetOf">SubsetOf</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a>> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a></code><a href='#impl-SubsetOf%3Cu16%3E-for-u8' class='anchor'></a><a class='srclink' href='../../src/alga/general/subset.rs.html#112-127' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.to_superset-1' class="method hidden"><code id='to_superset.v-2'>fn <a href='#method.to_superset' class='fnname'>to_superset</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a></code><a class='srclink' href='../../src/alga/general/subset.rs.html#114-116' title='goto source code'>[src]</a></h4><h4 id='method.from_superset_unchecked-1' class="method hidden"><code id='from_superset_unchecked.v-2'>unsafe fn <a href='#method.from_superset_unchecked' class='fnname'>from_superset_unchecked</a>(element: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a></code><a class='srclink' href='../../src/alga/general/subset.rs.html#119-121' title='goto source code'>[src]</a></h4><h4 id='method.is_in_subset-1' class="method hidden"><code id='is_in_subset.v-2'>fn <a href='#method.is_in_subset' class='fnname'>is_in_subset</a>(_: &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a>) -> <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#124-126' title='goto source code'>[src]</a></h4></div><h3 id='impl-SubsetOf%3Cu32%3E-for-u8' class='impl'><code clas
|
||
|
|
<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-SubsetOf%3CT%3E' class='impl'><code class='in-band'>impl<O: <a class="trait" href="../../alga/general/trait.Operator.html" title="trait alga::general::Operator">Operator</a>, T: <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="../../alga/general/trait.Identity.html" title="trait alga::general::Identity">Identity</a><O>> SubsetOf<T> for <a class="struct" href="../../alga/general/struct.Id.html" title="struct alga::general::Id">Id</a><O></code><a href='#impl-SubsetOf%3CT%3E' class='anchor'></a><a class='srclink' href='../../src/alga/general/identity.rs.html#254-269' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.to_superset-112' class="method hidden"><code id='to_superset.v-113'>fn <a href='#method.to_superset-112' class='fnname'>to_superset</a>(&self) -> T</code><a class='srclink' href='../../src/alga/general/identity.rs.html#256-258' title='goto source code'>[src]</a></h4><h4 id='method.is_in_subset-112' class="method hidden"><code id='is_in_subset.v-113'>fn <a href='#method.is_in_subset-112' class='fnname'>is_in_subset</a>(t: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../src/alga/general/identity.rs.html#261-263' title='goto source code'>[src]</a></h4><h4 id='method.from_superset_unchecked-112' class="method hidden"><code id='from_superset_unchecked.v-113'>unsafe fn <a href='#method.from_superset_unchecked-112' class='fnname'>from_superset_unchecked</a>(_: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T) -> Self</code><a class='srclink' href='../../src/alga/general/identity.rs.html#266-268' 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.SubsetOf.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>
|