| <!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="Unary operator for retrieving the multiplicative inverse, or reciprocal, of a value."><meta name="keywords" content="rust, rustlang, rust-lang, Inv"><title>Inv in num::traits - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../num/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../num/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Inv</a></h2><div class="sidebar-elems"><section><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Output">Output</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.inv">inv</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-Inv-for-%26%27a%20f32">&'a f32</a></li><li><a href="#impl-Inv-for-%26%27a%20f64">&'a f64</a></li><li><a href="#impl-Inv-for-f32">f32</a></li><li><a href="#impl-Inv-for-f64">f64</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In num::traits</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Trait <a href="../index.html">num</a>::<wbr><a href="index.html">traits</a>::<wbr><a class="trait" href="#">Inv</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/num_traits/ops/inv.rs.html#2">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust trait"><code>pub trait Inv { |
| type <a href="#associatedtype.Output" class="associatedtype">Output</a>; |
| |
| fn <a href="#tymethod.inv" class="fnname">inv</a>(self) -> Self::<a class="associatedtype" href="trait.Inv.html#associatedtype.Output" title="type num::traits::Inv::Output">Output</a>; |
| }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Unary operator for retrieving the multiplicative inverse, or reciprocal, of a value.</p> |
| </div></details><h2 id="required-associated-types" class="small-section-header">Required Associated Types<a href="#required-associated-types" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="associatedtype.Output" class="method has-srclink"><a class="srclink rightside" href="../../src/num_traits/ops/inv.rs.html#4">source</a><h4 class="code-header">type <a href="#associatedtype.Output" class="associatedtype">Output</a></h4></section></summary><div class="docblock"><p>The result after applying the operator.</p> |
| </div></details></div><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.inv" class="method has-srclink"><a class="srclink rightside" href="../../src/num_traits/ops/inv.rs.html#17">source</a><h4 class="code-header">fn <a href="#tymethod.inv" class="fnname">inv</a>(self) -> Self::<a class="associatedtype" href="trait.Inv.html#associatedtype.Output" title="type num::traits::Inv::Output">Output</a></h4></section></summary><div class="docblock"><p>Returns the multiplicative inverse of <code>self</code>.</p> |
| <h5 id="examples"><a href="#examples">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::f64::INFINITY; |
| <span class="kw">use </span>num_traits::Inv; |
| |
| <span class="macro">assert_eq!</span>(<span class="number">7.0</span>.inv() * <span class="number">7.0</span>, <span class="number">1.0</span>); |
| <span class="macro">assert_eq!</span>((-<span class="number">0.0</span>).inv(), -INFINITY);</code></pre></div> |
| </div></details></div><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Inv-for-%26%27a%20f32" class="impl has-srclink"><a class="srclink rightside" href="../../src/num_traits/ops/inv.rs.html#34">source</a><a href="#impl-Inv-for-%26%27a%20f32" class="anchor"></a><h3 class="code-header">impl<'a> <a class="trait" href="trait.Inv.html" title="trait num::traits::Inv">Inv</a> for &'a f32</h3></section></summary><div class="impl-items"><section id="associatedtype.Output-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Output-1" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Output" class="associatedtype">Output</a> = f32</h4></section><section id="method.inv" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/num_traits/ops/inv.rs.html#37">source</a><a href="#method.inv" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.inv" class="fnname">inv</a>(self) -> f32</h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Inv-for-%26%27a%20f64" class="impl has-srclink"><a class="srclink rightside" href="../../src/num_traits/ops/inv.rs.html#41">source</a><a href="#impl-Inv-for-%26%27a%20f64" class="anchor"></a><h3 class="code-header">impl<'a> <a class="trait" href="trait.Inv.html" title="trait num::traits::Inv">Inv</a> for &'a f64</h3></section></summary><div class="impl-items"><section id="associatedtype.Output-2" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Output-2" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Output" class="associatedtype">Output</a> = f64</h4></section><section id="method.inv-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/num_traits/ops/inv.rs.html#44">source</a><a href="#method.inv-1" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.inv" class="fnname">inv</a>(self) -> f64</h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Inv-for-f32" class="impl has-srclink"><a class="srclink rightside" href="../../src/num_traits/ops/inv.rs.html#20">source</a><a href="#impl-Inv-for-f32" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.Inv.html" title="trait num::traits::Inv">Inv</a> for f32</h3></section></summary><div class="impl-items"><section id="associatedtype.Output-3" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Output-3" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Output" class="associatedtype">Output</a> = f32</h4></section><section id="method.inv-2" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/num_traits/ops/inv.rs.html#23">source</a><a href="#method.inv-2" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.inv" class="fnname">inv</a>(self) -> f32</h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Inv-for-f64" class="impl has-srclink"><a class="srclink rightside" href="../../src/num_traits/ops/inv.rs.html#27">source</a><a href="#impl-Inv-for-f64" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.Inv.html" title="trait num::traits::Inv">Inv</a> for f64</h3></section></summary><div class="impl-items"><section id="associatedtype.Output-4" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Output-4" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Output" class="associatedtype">Output</a> = f64</h4></section><section id="method.inv-3" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/num_traits/ops/inv.rs.html#30">source</a><a href="#method.inv-3" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.inv" class="fnname">inv</a>(self) -> f64</h4></section></div></details><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Inv-for-%26%27a%20Ratio%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/num_rational/lib.rs.html#893">source</a><a href="#impl-Inv-for-%26%27a%20Ratio%3CT%3E" class="anchor"></a><h3 class="code-header">impl<'a, T> <a class="trait" href="trait.Inv.html" title="trait num::traits::Inv">Inv</a> for &'a <a class="struct" href="../rational/struct.Ratio.html" title="struct num::rational::Ratio">Ratio</a><T><span class="where fmt-newline">where<br> T: Clone + <a class="trait" href="../trait.Integer.html" title="trait num::Integer">Integer</a>,</span></h3></section></summary><div class="impl-items"><section id="associatedtype.Output-5" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Output-5" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Output" class="associatedtype">Output</a> = <a class="struct" href="../rational/struct.Ratio.html" title="struct num::rational::Ratio">Ratio</a><T></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Inv-for-%26%27a%20Complex%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/num_complex/lib.rs.html#918">source</a><a href="#impl-Inv-for-%26%27a%20Complex%3CT%3E" class="anchor"></a><h3 class="code-header">impl<'a, T> <a class="trait" href="trait.Inv.html" title="trait num::traits::Inv">Inv</a> for &'a <a class="struct" href="../struct.Complex.html" title="struct num::Complex">Complex</a><T><span class="where fmt-newline">where<br> T: Clone + <a class="trait" href="../trait.Num.html" title="trait num::Num">Num</a> + Neg<Output = T>,</span></h3></section></summary><div class="impl-items"><section id="associatedtype.Output-6" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Output-6" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Output" class="associatedtype">Output</a> = <a class="struct" href="../struct.Complex.html" title="struct num::Complex">Complex</a><T></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Inv-for-Ratio%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/num_rational/lib.rs.html#881">source</a><a href="#impl-Inv-for-Ratio%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="trait.Inv.html" title="trait num::traits::Inv">Inv</a> for <a class="struct" href="../rational/struct.Ratio.html" title="struct num::rational::Ratio">Ratio</a><T><span class="where fmt-newline">where<br> T: Clone + <a class="trait" href="../trait.Integer.html" title="trait num::Integer">Integer</a>,</span></h3></section></summary><div class="impl-items"><section id="associatedtype.Output-7" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Output-7" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Output" class="associatedtype">Output</a> = <a class="struct" href="../rational/struct.Ratio.html" title="struct num::rational::Ratio">Ratio</a><T></h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Inv-for-Complex%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/num_complex/lib.rs.html#909">source</a><a href="#impl-Inv-for-Complex%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="trait.Inv.html" title="trait num::traits::Inv">Inv</a> for <a class="struct" href="../struct.Complex.html" title="struct num::Complex">Complex</a><T><span class="where fmt-newline">where<br> T: Clone + <a class="trait" href="../trait.Num.html" title="trait num::Num">Num</a> + Neg<Output = T>,</span></h3></section></summary><div class="impl-items"><section id="associatedtype.Output-8" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Output-8" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Output" class="associatedtype">Output</a> = <a class="struct" href="../struct.Complex.html" title="struct num::Complex">Complex</a><T></h4></section></div></details></div><script src="../../implementors/num_traits/ops/inv/trait.Inv.js" data-ignore-extern-crates="core,num_complex,num_rational" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="num" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
