|
|
|
|
|
<!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 `One` trait in crate `num`."><meta name="keywords" content="rust, rustlang, rust-lang, One"><title>num::One - 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='../num/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Trait One</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.one">one</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.is_one">is_one</a><a href="#method.set_one">set_one</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-One-for-Wrapping%3CT%3E">Wrapping<T></a><a href="#impl-One-for-f32">f32</a><a href="#impl-One-for-f64">f64</a><a href="#impl-One-for-i128">i128</a><a href="#impl-One-for-i16">i16</a><a href="#impl-One-for-i32">i32</a><a href="#impl-One-for-i64">i64</a><a href="#impl-One-for-i8">i8</a><a href="#impl-One-for-isize">isize</a><a href="#impl-One-for-u128">u128</a><a href="#impl-One-for-u16">u16</a><a href="#impl-One-for-u32">u32</a><a href="#impl-One-for-u64">u64</a><a href="#impl-One-for-u8">u8</a><a href="#impl-One-for-usize">usize</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>num</a></p><script>window.sidebarCurrent = {name: 'One', 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/num_traits/identities.rs.html#91-119' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='index.html'>num</a>::<wbr><a class="trait" href=''>One</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait One: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.Mul.html" title="trait core::ops::arith::Mul">Mul</a><Self, Output = Self> {
|
|
|
|
|
|
fn <a href='#tymethod.one' class='fnname'>one</a>() -> Self;
|
|
|
|
|
|
|
|
|
|
|
|
fn <a href='#method.set_one' class='fnname'>set_one</a>(&mut self) { ... }
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#method.is_one' class='fnname'>is_one</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a><br> <span class="where">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a><Self></span>,
|
|
|
|
|
|
{ ... }
|
|
|
|
|
|
}</pre></div><div class='docblock'><p>Defines a multiplicative identity element for <code>Self</code>.</p>
|
|
|
|
|
|
<h1 id="laws" class="section-header"><a href="#laws">Laws</a></h1>
|
|
|
|
|
|
<pre><code class="language-{.text}">a * 1 = a ∀ a ∈ Self
|
|
|
|
|
|
1 * a = a ∀ a ∈ Self
|
|
|
|
|
|
</code></pre>
|
|
|
|
|
|
</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.one' class='method'><code id='one.v'>fn <a href='#tymethod.one' class='fnname'>one</a>() -> Self</code></h3><div class='docblock'><p>Returns the multiplicative identity element of <code>Self</code>, <code>1</code>.</p>
|
|
|
|
|
|
<h1 id="purity" class="section-header"><a href="#purity">Purity</a></h1>
|
|
|
|
|
|
<p>This function should return the same result at all times regardless of
|
|
|
|
|
|
external mutable state, for example values stored in TLS or in
|
|
|
|
|
|
<code>static mut</code>s.</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.set_one' class='method'><code id='set_one.v'>fn <a href='#method.set_one' class='fnname'>set_one</a>(&mut self)</code></h3><div class='docblock'><p>Sets <code>self</code> to the multiplicative identity element of <code>Self</code>, <code>1</code>.</p>
|
|
|
|
|
|
</div><h3 id='method.is_one' class='method'><code id='is_one.v'>fn <a href='#method.is_one' class='fnname'>is_one</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a><Self>, </span></code></h3><div class='docblock'><p>Returns <code>true</code> if <code>self</code> is equal to the multiplicative identity.</p>
|
|
|
|
|
|
<p>For performance reasons, it's best to implement this manually.
|
|
|
|
|
|
After a semver bump, this method will be required, and the
|
|
|
|
|
|
<code>where Self: PartialEq</code> bound will be removed.</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-One-for-u8' class='impl'><code class='in-band'>impl <a class="trait" href="../num/traits/identities/trait.One.html" title="trait num::traits::identities::One">One</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a></code><a href='#impl-One-for-u8' class='anchor'></a><a class='srclink' href='../src/num_traits/identities.rs.html#123-132' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.one' class="method hidden"><code id='one.v-1'>fn <a href='#method.one' class='fnname'>one</a>() -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a></code><a class='srclink' href='../src/num_traits/identities.rs.html#125-127' title='goto source code'>[src]</a></h4><h4 id='method.is_one-1' class="method hidden"><code id='is_one.v-1'>fn <a href='#method.is_one' class='fnname'>is_one</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../src/num_traits/identities.rs.html#129-131' title='goto source code'>[src]</a></h4></div><h3 id='impl-One-for-u16' class='impl'><code class='in-band'>impl <a class="trait" href="../num/traits/identities/trait.One.html" title="trait num::traits::identities::One">One</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a></code><a href='#impl-One-for-u16' class='anchor'></a><a class='srclink' href='../src/num_traits/identities.rs.html#123-132' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.one-1' class="method hidden"><code id='one.v-2'>fn <a href='#method.one' class='fnname'>one</a>() -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a></code><a class='srclink' href='../src/num_traits/identities.rs.html#125-127' title='goto source code'>[src]</a></h4><h4 id='method.is_one-2' class="method hidden"><code id='is_one.v-2'>fn <a href='#method.is_one' class='fnname'>is_one</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../src/num_traits/identities.rs.html#129-131' title='goto source code'>[src]</a></h4></div><h3 id='impl-One-for-Wrapping%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="../num/traits/identities/trait.One.html" title="trait num::traits::identities::One">One</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.Wrapping.html" title="struct core::num::Wrapping">Wrapping</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="../num/traits/identities/trait.One.html" title="trait num::traits::identities::One">One</a>,<br> <a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.Wrapping.html" title="struct core::num::Wrapping">Wrapping</a><T>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.Mul.html" title="trait core::ops::arith::Mul">Mul</a><<a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.Wrapping.html" title="struct core::num::Wrapping">Wrapping</a><T>>,<br> <<a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.Wrapping.html" title="struct core::num::Wrapping">Wrapping</a><T> as <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.Mul.html" title="trait core::ops::arith::Mul">Mul</a><<a class="struct" href="https://doc.rust-lang.org/nightly/core/num/struct.Wrapping.html" title="struct core::num::Wrapping">Wrapping</a><T>>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/arith/trait.Mul.html#associatedtype.Output" title="type core::ops::arith::Mul::Output">Output</a> == <a class="struct" href="ht
|
|
|
|
|
|
<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-One' class='impl'><code class='in-band'>impl One for <a class="struct" href="../num/bigint/struct.BigInt.html" title="struct num::bigint::BigInt">BigInt</a></code><a href='#impl-One' class='anchor'></a><a class='srclink' href='../src/num_bigint/bigint.rs.html#261-266' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.one-15' class="method hidden"><code id='one.v-16'>fn <a href='#method.one-15' class='fnname'>one</a>() -> <a class="struct" href="../num/bigint/struct.BigInt.html" title="struct num::bigint::BigInt">BigInt</a></code><a class='srclink' href='../src/num_bigint/bigint.rs.html#263-265' title='goto source code'>[src]</a></h4></div><h3 id='impl-One-1' class='impl'><code class='in-band'>impl One for <a class="struct" href="../num/bigint/struct.BigUint.html" title="struct num::bigint::BigUint">BigUint</a></code><a href='#impl-One-1' class='anchor'></a><a class='srclink' href='../src/num_bigint/biguint.rs.html#418-423' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.one-16' class="method hidden"><code id='one.v-17'>fn <a href='#method.one-16' class='fnname'>one</a>() -> <a class="struct" href="../num/bigint/struct.BigUint.html" title="struct num::bigint::BigUint">BigUint</a></code><a class='srclink' href='../src/num_bigint/biguint.rs.html#420-422' title='goto source code'>[src]</a></h4></div><h3 id='impl-One-2' class='impl'><code class='in-band'>impl<T> One for <a class="struct" href="../num/complex/struct.Complex.html" title="struct num::complex::Complex">Complex</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> + <a class="trait" href="../num/traits/trait.Num.html" title="trait num::traits::Num">Num</a>, </span></code><a href='#impl-One-2' class='anchor'></a><a class='srclink' href='../src/num_complex/lib.rs.html#839-844' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.one-17' class="method hidden"><code id='one.v-18'>fn <a href='#method.one-17' class='fnname'>one</a>() -> <a class="struct" href="../num/complex/struct.Complex.html" title="struct num::complex::Complex">Complex</a><T></code><a class='srclink' href='../src/num_complex/lib.rs.html#841-843' title='goto source code'>[src]</a></h4></div><h3 id='impl-One-3' class='impl'><code class='in-band'>impl<T> One for <a class="struct" href="../num/rational/struct.Ratio.html" title="struct num::rational::Ratio">Ratio</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> + <a class="trait" href="../num/integer/trait.Integer.html" title="trait num::integer::Integer">Integer</a>, </span></code><a href='#impl-One-3' class='anchor'></a><a class='srclink' href='../src/num_rational/lib.rs.html#731-736' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.one-18' class="method hidden"><code id='one.v-19'>fn <a href='#method.one-18' class='fnname'>one</a>() -> <a class="struct" href="../num/rational/struct.Ratio.html" title="struct num::rational::Ratio">Ratio</a><T></code><a class='srclink' href='../src/num_rational/lib.rs.html#733-735' 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/num_traits/identities/trait.One.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 = "num";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
|
