|
|
|
|
|
<!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 `Inv` trait in crate `num`."><meta name="keywords" content="rust, rustlang, rust-lang, Inv"><title>num::traits::ops::inv::Inv - 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 Inv</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.Output">Output</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.inv">inv</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-Inv-for-%26%27a%20f32">&'a f32</a><a href="#impl-Inv-for-%26%27a%20f64">&'a f64</a><a href="#impl-Inv-for-f32">f32</a><a href="#impl-Inv-for-f64">f64</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../../../index.html'>num</a>::<wbr><a href='../../index.html'>traits</a>::<wbr><a href='../index.html'>ops</a>::<wbr><a href='index.html'>inv</a></p><script>window.sidebarCurrent = {name: 'Inv', 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/ops/inv.rs.html#2-18' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='../../../index.html'>num</a>::<wbr><a href='../../index.html'>traits</a>::<wbr><a href='../index.html'>ops</a>::<wbr><a href='index.html'>inv</a>::<wbr><a class="trait" href=''>Inv</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait Inv {
|
|
|
|
|
|
type <a href='#associatedtype.Output' class="type">Output</a>;
|
|
|
|
|
|
fn <a href='#tymethod.inv' class='fnname'>inv</a>(self) -> Self::<a class="type" href="../../../../num/traits/ops/inv/trait.Inv.html#associatedtype.Output" title="type num::traits::ops::inv::Inv::Output">Output</a>;
|
|
|
|
|
|
}</pre></div><div class='docblock'><p>Unary operator for retrieving the multiplicative inverse, or reciprocal, of a value.</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.Output' class='method'><code id='Output.t'>type <a href='#associatedtype.Output' class="type">Output</a></code></h3><div class='docblock'><p>The result after applying the operator.</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.inv' class='method'><code id='inv.v'>fn <a href='#tymethod.inv' class='fnname'>inv</a>(self) -> Self::<a class="type" href="../../../../num/traits/ops/inv/trait.Inv.html#associatedtype.Output" title="type num::traits::ops::inv::Inv::Output">Output</a></code></h3><div class='docblock'><p>Returns the multiplicative inverse of <code>self</code>.</p>
|
|
|
|
|
|
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
|
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
|
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">f64</span>::<span class="ident">INFINITY</span>;
|
|
|
|
|
|
<span class="kw">use</span> <span class="ident">num_traits</span>::<span class="ident">Inv</span>;
|
|
|
|
|
|
|
|
|
|
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">7.0</span>.<span class="ident">inv</span>() <span class="op">*</span> <span class="number">7.0</span>, <span class="number">1.0</span>);
|
|
|
|
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>((<span class="op">-</span><span class="number">0.0</span>).<span class="ident">inv</span>(), <span class="op">-</span><span class="ident">INFINITY</span>);</pre></div>
|
|
|
|
|
|
</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-Inv-for-f64' class='impl'><code class='in-band'>impl <a class="trait" href="../../../../num/traits/ops/inv/trait.Inv.html" title="trait num::traits::ops::inv::Inv">Inv</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a></code><a href='#impl-Inv-for-f64' class='anchor'></a><a class='srclink' href='../../../../src/num_traits/ops/inv.rs.html#27-33' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Output-1' class="type"><code id='Output.t-1'>type <a href='#associatedtype.Output' class="type">Output</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a></code></h4><h4 id='method.inv' class="method hidden"><code id='inv.v-1'>fn <a href='#method.inv' class='fnname'>inv</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a></code><a class='srclink' href='../../../../src/num_traits/ops/inv.rs.html#30-32' title='goto source code'>[src]</a></h4></div><h3 id='impl-Inv-for-%26%27a%20f64' class='impl'><code class='in-band'>impl<'a> <a class="trait" href="../../../../num/traits/ops/inv/trait.Inv.html" title="trait num::traits::ops::inv::Inv">Inv</a> for &'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a></code><a href='#impl-Inv-for-%26%27a%20f64' class='anchor'></a><a class='srclink' href='../../../../src/num_traits/ops/inv.rs.html#41-47' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Output-2' class="type"><code id='Output.t-2'>type <a href='#associatedtype.Output' class="type">Output</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a></code></h4><h4 id='method.inv-1' class="method hidden"><code id='inv.v-2'>fn <a href='#method.inv' class='fnname'>inv</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a></code><a class='srclink' href='../../../../src/num_traits/ops/inv.rs.html#44-46' title='goto source code'>[src]</a></h4></div><h3 id='impl-Inv-for-%26%27a%20f32' class='impl'><code class='in-band'>impl<'a> <a class="trait" href="../../../../num/traits/ops/inv/trait.Inv.html" title="trait num::traits::ops::inv::Inv">Inv</a> for &'a <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a></code><a href='#impl-Inv-for-%26%27a%20f32' class='anchor'></a><a class='srclink' href='../../../../src/num_traits/ops/inv.rs.html#34-40' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Output-3' class="type"><code id='Output.t-3'>type <a href='#associatedtype.Output' class="type">Output</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a></code></h4><h4 id='method.inv-2' class="method hidden"><code id='inv.v-3'>fn <a href='#method.inv' class='fnname'>inv</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a></code><a class='srclink' href='../../../../src/num_traits/ops/inv.rs.html#37-39' title='goto source code'>[src]</a></h4></div><h3 id='impl-Inv-for-f32' class='impl'><code class='in-band'>impl <a class="trait" href="../../../../num/traits/ops/inv/trait.Inv.html" title="trait num::traits::ops::inv::Inv">Inv</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a></code><a href='#impl-Inv-for-f32' class='anchor'></a><a class='srclink' href='../../../../src/num_traits/ops/inv.rs.html#20-26' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Output-4' class="type"><code id='Output.t-4'>type <a href='#associatedtype.Output' class="type">Output</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a></code></h4><h4 id='method
|
|
|
|
|
|
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'></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/ops/inv/trait.Inv.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>
|
