14 lines
11 KiB
HTML
14 lines
11 KiB
HTML
<!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."><title>Inv in num_traits::ops::inv - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="num_traits" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-044be391.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]--><rustdoc-topbar><h2><a href="#">Inv</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../num_traits/index.html">num_<wbr>traits</a><span class="version">0.2.19</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Inv</a></h2><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Output" title="Output">Output</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.inv" title="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-%26f32" title="&'a f32">&'a f32</a></li><li><a href="#impl-Inv-for-%26f64" title="&'a f64">&'a f64</a></li><li><a href="#impl-Inv-for-f32" title="f32">f32</a></li><li><a href="#impl-Inv-for-f64" title="f64">f64</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In num_<wbr>traits::<wbr>ops::<wbr>inv</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../../index.html">num_traits</a>::<wbr><a href="../index.html">ops</a>::<wbr><a href="index.html">inv</a></div><h1>Trait <span class="trait">Inv</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../../src/num_traits/ops/inv.rs.html#2-18">Source</a> </span></div><pre class="rust item-decl"><code>pub trait Inv {
|
|
type <a href="#associatedtype.Output" class="associatedtype">Output</a>;
|
|
|
|
// Required method
|
|
fn <a href="#tymethod.inv" class="fn">inv</a>(self) -> Self::<a class="associatedtype" href="trait.Inv.html#associatedtype.Output" title="type num_traits::ops::inv::Inv::Output">Output</a>;
|
|
}</code></pre><details class="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="section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><details class="toggle" open><summary><section id="associatedtype.Output" class="method"><a class="src 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="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.inv" class="method"><a class="src rightside" href="../../../src/num_traits/ops/inv.rs.html#17">Source</a><h4 class="code-header">fn <a href="#tymethod.inv" class="fn">inv</a>(self) -> Self::<a class="associatedtype" href="trait.Inv.html#associatedtype.Output" title="type num_traits::ops::inv::Inv::Output">Output</a></h4></section></summary><div class="docblock"><p>Returns the multiplicative inverse of <code>self</code>.</p>
|
|
<h5 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</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="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-Inv-for-f32" class="impl"><a class="src rightside" href="../../../src/num_traits/ops/inv.rs.html#20-26">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::ops::inv::Inv">Inv</a> for <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.f32.html">f32</a></h3></section></summary><div class="impl-items"><section id="associatedtype.Output-1" class="associatedtype trait-impl"><a class="src rightside" href="../../../src/num_traits/ops/inv.rs.html#21">Source</a><a href="#associatedtype.Output-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Output" class="associatedtype">Output</a> = <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.f32.html">f32</a></h4></section><section id="method.inv" class="method trait-impl"><a class="src rightside" href="../../../src/num_traits/ops/inv.rs.html#23-25">Source</a><a href="#method.inv" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.inv" class="fn">inv</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.f32.html">f32</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Inv-for-f64" class="impl"><a class="src rightside" href="../../../src/num_traits/ops/inv.rs.html#27-33">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::ops::inv::Inv">Inv</a> for <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.f64.html">f64</a></h3></section></summary><div class="impl-items"><section id="associatedtype.Output-2" class="associatedtype trait-impl"><a class="src rightside" href="../../../src/num_traits/ops/inv.rs.html#28">Source</a><a href="#associatedtype.Output-2" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Output" class="associatedtype">Output</a> = <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.f64.html">f64</a></h4></section><section id="method.inv-1" class="method trait-impl"><a class="src rightside" href="../../../src/num_traits/ops/inv.rs.html#30-32">Source</a><a href="#method.inv-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.inv" class="fn">inv</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.f64.html">f64</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Inv-for-%26f32" class="impl"><a class="src rightside" href="../../../src/num_traits/ops/inv.rs.html#34-40">Source</a><a href="#impl-Inv-for-%26f32" class="anchor">§</a><h3 class="code-header">impl<'a> <a class="trait" href="trait.Inv.html" title="trait num_traits::ops::inv::Inv">Inv</a> for &'a <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.f32.html">f32</a></h3></section></summary><div class="impl-items"><section id="associatedtype.Output-3" class="associatedtype trait-impl"><a class="src rightside" href="../../../src/num_traits/ops/inv.rs.html#35">Source</a><a href="#associatedtype.Output-3" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Output" class="associatedtype">Output</a> = <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.f32.html">f32</a></h4></section><section id="method.inv-2" class="method trait-impl"><a class="src rightside" href="../../../src/num_traits/ops/inv.rs.html#37-39">Source</a><a href="#method.inv-2" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.inv" class="fn">inv</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.f32.html">f32</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Inv-for-%26f64" class="impl"><a class="src rightside" href="../../../src/num_traits/ops/inv.rs.html#41-47">Source</a><a href="#impl-Inv-for-%26f64" class="anchor">§</a><h3 class="code-header">impl<'a> <a class="trait" href="trait.Inv.html" title="trait num_traits::ops::inv::Inv">Inv</a> for &'a <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.f64.html">f64</a></h3></section></summary><div class="impl-items"><section id="associatedtype.Output-4" class="associatedtype trait-impl"><a class="src rightside" href="../../../src/num_traits/ops/inv.rs.html#42">Source</a><a href="#associatedtype.Output-4" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Output" class="associatedtype">Output</a> = <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.f64.html">f64</a></h4></section><section id="method.inv-3" class="method trait-impl"><a class="src rightside" href="../../../src/num_traits/ops/inv.rs.html#44-46">Source</a><a href="#method.inv-3" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.inv" class="fn">inv</a>(self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.f64.html">f64</a></h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../../../trait.impl/num_traits/ops/inv/trait.Inv.js" data-ignore-extern-crates="std" async></script></section></div></main></body></html> |