mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-02-23 15:49:49 +01:00
27 lines
18 KiB
HTML
27 lines
18 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="API documentation for the Rust `MulAdd` trait in crate `num_traits`."><meta name="keywords" content="rust, rustlang, rust-lang, MulAdd"><title>num_traits::ops::mul_add::MulAdd - 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="../../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../../ayu.css" disabled ><script id="default-settings"></script><script src="../../../storage.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../../favicon.svg">
|
||
<link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png">
|
||
<link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><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_traits/index.html'><div class='logo-container rust-logo'><img src='../../../rust-logo.png' alt='logo'></div></a><p class="location">Trait MulAdd</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.mul_add">mul_add</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class="location"><a href="../../index.html">num_traits</a>::<wbr><a href="../index.html">ops</a>::<wbr><a href="index.html">mul_add</a></p><div id="sidebar-vars" data-name="MulAdd" data-ty="trait" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||
<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="in-band">Trait <a href="../../index.html">num_traits</a>::<wbr><a href="../index.html">ops</a>::<wbr><a href="index.html">mul_add</a>::<wbr><a class="trait" href="">MulAdd</a></span><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/mul_add.rs.html#23-29" title="goto source code">[src]</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class="rust trait">pub trait MulAdd<A = Self, B = Self> {
|
||
type <a href="#associatedtype.Output" class="type">Output</a>;
|
||
fn <a href="#tymethod.mul_add" class="fnname">mul_add</a>(self, a: A, b: B) -> Self::<a class="type" href="../../../num_traits/ops/mul_add/trait.MulAdd.html#associatedtype.Output" title="type num_traits::ops::mul_add::MulAdd::Output">Output</a>;
|
||
}</pre></div><div class="docblock"><p>Fused multiply-add. Computes <code>(self * a) + b</code> with only one rounding
|
||
error, yielding a more accurate result than an unfused multiply-add.</p>
|
||
<p>Using <code>mul_add</code> can be more performant than an unfused multiply-add if
|
||
the target architecture has a dedicated <code>fma</code> CPU instruction.</p>
|
||
<p>Note that <code>A</code> and <code>B</code> are <code>Self</code> by default, but this is not mandatory.</p>
|
||
<h1 id="example" class="section-header"><a href="#example">Example</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">f32</span>;
|
||
|
||
<span class="kw">let</span> <span class="ident">m</span> <span class="op">=</span> <span class="number">10.0_f32</span>;
|
||
<span class="kw">let</span> <span class="ident">x</span> <span class="op">=</span> <span class="number">4.0_f32</span>;
|
||
<span class="kw">let</span> <span class="ident">b</span> <span class="op">=</span> <span class="number">60.0_f32</span>;
|
||
|
||
<span class="comment">// 100.0</span>
|
||
<span class="kw">let</span> <span class="ident">abs_difference</span> <span class="op">=</span> (<span class="ident">m</span>.<span class="ident">mul_add</span>(<span class="ident">x</span>, <span class="ident">b</span>) <span class="op">-</span> (<span class="ident">m</span><span class="kw-2">*</span><span class="ident">x</span> <span class="op">+</span> <span class="ident">b</span>)).<span class="ident">abs</span>();
|
||
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">abs_difference</span> <span class="op"><</span><span class="op">=</span> <span class="number">100.0</span> <span class="op">*</span> <span class="ident">f32</span>::<span class="ident">EPSILON</span>);</pre></div>
|
||
</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>type <a href="#associatedtype.Output" class="type">Output</a></code><a class="srclink" href="../../../src/num_traits/ops/mul_add.rs.html#25" title="goto source code">[src]</a></h3><div class="docblock"><p>The resulting type after applying the fused multiply-add.</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.mul_add" class="method"><code>fn <a href="#tymethod.mul_add" class="fnname">mul_add</a>(self, a: A, b: B) -> Self::<a class="type" href="../../../num_traits/ops/mul_add/trait.MulAdd.html#associatedtype.Output" title="type num_traits::ops::mul_add::MulAdd::Output">Output</a></code><a class="srclink" href="../../../src/num_traits/ops/mul_add.rs.html#28" title="goto source code">[src]</a></h3><div class="docblock"><p>Performs the fused multiply-add operation.</p>
|
||
</div></div><span class="loading-content">Loading content...</span><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-MulAdd%3Ci8%2C%20i8%3E" class="impl"><code class="in-band">impl MulAdd<i8, i8> for i8</code><a href="#impl-MulAdd%3Ci8%2C%20i8%3E" class="anchor"></a><a class="srclink" href="../../../src/num_traits/ops/mul_add.rs.html#70" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Output-1" class="type"><code>type <a href="#associatedtype.Output-1" class="type">Output</a> = Self</code></h4><h4 id="method.mul_add" class="method hidden"><code>fn <a href="#method.mul_add" class="fnname">mul_add</a>(self, a: Self, b: Self) -> Self::<a class="type" href="../../../num_traits/ops/mul_add/trait.MulAdd.html#associatedtype.Output" title="type num_traits::ops::mul_add::MulAdd::Output">Output</a></code><a class="srclink" href="../../../src/num_traits/ops/mul_add.rs.html#70" title="goto source code">[src]</a></h4></div><h3 id="impl-MulAdd%3Ci16%2C%20i16%3E" class="impl"><code class="in-band">impl MulAdd<i16, i16> for i16</code><a href="#impl-MulAdd%3Ci16%2C%20i16%3E" class="anchor"></a><a class="srclink" href="../../../src/num_traits/ops/mul_add.rs.html#70" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Output-2" class="type"><code>type <a href="#associatedtype.Output-2" class="type">Output</a> = Self</code></h4><h4 id="method.mul_add-1" class="method hidden"><code>fn <a href="#method.mul_add-1" class="fnname">mul_add</a>(self, a: Self, b: Self) -> Self::<a class="type" href="../../../num_traits/ops/mul_add/trait.MulAdd.html#associatedtype.Output" title="type num_traits::ops::mul_add::MulAdd::Output">Output</a></code><a class="srclink" href="../../../src/num_traits/ops/mul_add.rs.html#70" title="goto source code">[src]</a></h4></div><h3 id="impl-MulAdd%3Ci32%2C%20i32%3E" class="impl"><code class="in-band">impl MulAdd<i32, i32> for i32</code><a href="#impl-MulAdd%3Ci32%2C%20i32%3E" class="anchor"></a><a class="srclink" href="../../../src/num_traits/ops/mul_add.rs.html#70" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Output-3" class="type"><code>type <a href="#associatedtype.Output-3" class="type">Output</a> = Self</code></h4><h4 id="method.mul_add-2" class="method hidden"><code>fn <a href="#method.mul_add-2" class="fnname">mul_add</a>(self, a: Self, b: Self) -> Self::<a class="type" href="../../../num_traits/ops/mul_add/trait.MulAdd.html#associatedtype.Output" title="type num_traits::ops::mul_add::MulAdd::Output">Output</a></code><a class="srclink" href="../../../src/num_traits/ops/mul_add.rs.html#70" title="goto source code">[src]</a></h4></div><h3 id="impl-MulAdd%3Ci64%2C%20i64%3E" class="impl"><code class="in-band">impl MulAdd<i64, i64> for i64</code><a href="#impl-MulAdd%3Ci64%2C%20i64%3E" class="anchor"></a><a class="srclink" href="../../../src/num_traits/ops/mul_add.rs.html#70" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Output-4" class="type"><code>type <a href="#associatedtype.Output-4" class="type">Output</a> = Self</code></h4><h4 id="method.mul_add-3" class="method hidden"><code>fn <a href="#method.mul_add-3" class="fnname">mul_add</a>(self, a: Self, b: Self) -> Self::<a class="type" href="../../../num_traits/ops/mul_add/trait.MulAdd.html#associatedtype.Output" title="type num_traits::ops::mul_add::MulAdd::Output">Output</a></code><a class="srclink" href="../../../src/num_traits/ops/mul_add.rs.html#70" title="goto source code">[src]</a></h4></div><h3 id="impl-MulAdd%3Ci128%2C%20i128%3E" class="impl"><code class="in-band">impl MulAdd<i128, i128> for i128</code><a href="#impl-MulAdd%3Ci128%2C%20i128%3E" class="anchor"></a><a class="srclink" href="../../../src/num_traits/ops/mul_add.rs.html#72" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Output-5" class="type"><code>type <a href="#associatedtype.Output-5" class="type">Output</a> = Self</code></h4><h4 id="method.mul_add-4" class="method hidden"><code>fn <a href="#method.mul_add-4" class="fnname">mul_add</a>(self, a: Self, b: Self) -> Self::<a class="type" href="../../../num_traits/ops/mul_add/trait.MulAdd.html#associatedtype.Output" title="type num_traits::ops::mul_add::MulAdd::Output">Output</a></code><a class="srclink" href="../../../src/num_traits/ops/mul_add.rs.html#72" title="goto source code">[src]</a></h4></div><h3 id="impl-MulAdd%3Cisize%2C%20isize%3E" class="impl"><code class="in-band">impl MulAdd<isize, isize> for isize</code><a href="#impl-MulAdd%3Cisize%2C%20isize%3E" class="anchor"></a><a class="srclink" href="../../../src/num_traits/ops/mul_add.rs.html#70" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Output-6" class="type"><code>type <a href="#associatedtype.Output-6" class="type">Output</a> = Self</code></h4><h4 id="method.mul_add-5" class="method hidden"><code>fn <a href="#method.mul_add-5" class="fnname">mul_add</a>(self, a: Self, b: Self) -> Self::<a class="type" href="../../../num_traits/ops/mul_add/trait.MulAdd.html#associatedtype.Output" title="type num_traits::ops::mul_add::MulAdd::Output">Output</a></code><a class="srclink" href="../../../src/num_traits/ops/mul_add.rs.html#70" title="goto source code">[src]</a></h4></div><h3 id="impl-MulAdd%3Cu8%2C%20u8%3E" class="impl"><code class="in-band">impl MulAdd<u8, u8> for u8</code><a href="#impl-MulAdd%3Cu8%2C%20u8%3E" class="anchor"></a><a class="srclink" href="../../../src/num_traits/ops/mul_add.rs.html#70" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Output-7" class="type"><code>type <a href="#associatedtype.Output-7" class="type">Output</a> = Self</code></h4><h4 id="method.mul_add-6" class="method hidden"><code>fn <a href="#method.mul_add-6" class="fnname">mul_add</a>(self, a: Self, b: Self) -> Self::<a class="type" href="../../../num_traits/ops/mul_add/trait.MulAdd.html#associatedtype.Output" title="type num_traits::ops::mul_add::MulAdd::Output">Output</a></code><a class="srclink" href="../../../src/num_traits/ops/mul_add.rs.html#70" title="goto source code">[src]</a></h4></div><h3 id="impl-MulAdd%3Cu16%2C%20u16%3E" class="impl"><code class="in-band">impl MulAdd<u16, u16> for u16</code><a href="#impl-MulAdd%3Cu16%2C%20u16%3E" class="anchor"></a><a class="srclink" href="../../../src/num_traits/ops/mul_add.rs.html#70" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Output-8" class="type"><code>type <a href="#associatedtype.Output-8" class="type">Output</a> = Self</code></h4><h4 id="method.mul_add-7" class="method hidden"><code>fn <a href="#method.mul_add-7" class="fnname">mul_add</a>(self, a: Self, b: Self) -> Self::<a class="type" href="../../../num_traits/ops/mul_add/trait.MulAdd.html#associatedtype.Output" title="type num_traits::ops::mul_add::MulAdd::Output">Output</a></code><a class="srclink" href="../../../src/num_traits/ops/mul_add.rs.html#70" title="goto source code">[src]</a></h4></div><h3 id="impl-MulAdd%3Cu32%2C%20u32%3E" class="impl"><code class="in-band">impl MulAdd<u32, u32> for u32</code><a href="#impl-MulAdd%3Cu32%2C%20u32%3E" class="anchor"></a><a class="srclink" href="../../../src/num_traits/ops/mul_add.rs.html#70" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Output-9" class="type"><code>type <a href="#associatedtype.Output-9" class="type">Output</a> = Self</code></h4><h4 id="method.mul_add-8" class="method hidden"><code>fn <a href="#method.mul_add-8" class="fnname">mul_add</a>(self, a: Self, b: Self) -> Self::<a class="type" href="../../../num_traits/ops/mul_add/trait.MulAdd.html#associatedtype.Output" title="type num_traits::ops::mul_add::MulAdd::Output">Output</a></code><a class="srclink" href="../../../src/num_traits/ops/mul_add.rs.html#70" title="goto source code">[src]</a></h4></div><h3 id="impl-MulAdd%3Cu64%2C%20u64%3E" class="impl"><code class="in-band">impl MulAdd<u64, u64> for u64</code><a href="#impl-MulAdd%3Cu64%2C%20u64%3E" class="anchor"></a><a class="srclink" href="../../../src/num_traits/ops/mul_add.rs.html#70" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Output-10" class="type"><code>type <a href="#associatedtype.Output-10" class="type">Output</a> = Self</code></h4><h4 id="method.mul_add-9" class="method hidden"><code>fn <a href="#method.mul_add-9" class="fnname">mul_add</a>(self, a: Self, b: Self) -> Self::<a class="type" href="../../../num_traits/ops/mul_add/trait.MulAdd.html#associatedtype.Output" title="type num_traits::ops::mul_add::MulAdd::Output">Output</a></code><a class="srclink" href="../../../src/num_traits/ops/mul_add.rs.html#70" title="goto source code">[src]</a></h4></div><h3 id="impl-MulAdd%3Cu128%2C%20u128%3E" class="impl"><code class="in-band">impl MulAdd<u128, u128> for u128</code><a href="#impl-MulAdd%3Cu128%2C%20u128%3E" class="anchor"></a><a class="srclink" href="../../../src/num_traits/ops/mul_add.rs.html#72" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Output-11" class="type"><code>type <a href="#associatedtype.Output-11" class="type">Output</a> = Self</code></h4><h4 id="method.mul_add-10" class="method hidden"><code>fn <a href="#method.mul_add-10" class="fnname">mul_add</a>(self, a: Self, b: Self) -> Self::<a class="type" href="../../../num_traits/ops/mul_add/trait.MulAdd.html#associatedtype.Output" title="type num_traits::ops::mul_add::MulAdd::Output">Output</a></code><a class="srclink" href="../../../src/num_traits/ops/mul_add.rs.html#72" title="goto source code">[src]</a></h4></div><h3 id="impl-MulAdd%3Cusize%2C%20usize%3E" class="impl"><code class="in-band">impl MulAdd<usize, usize> for usize</code><a href="#impl-MulAdd%3Cusize%2C%20usize%3E" class="anchor"></a><a class="srclink" href="../../../src/num_traits/ops/mul_add.rs.html#70" title="goto source code">[src]</a></h3><div class="impl-items"><h4 id="associatedtype.Output-12" class="type"><code>type <a href="#associatedtype.Output-12" class="type">Output</a> = Self</code></h4><h4 id="method.mul_add-11" class="method hidden"><code>fn <a href="#method.mul_add-11" class="fnname">mul_add</a>(self, a: Self, b: Self) -> Self::<a class="type" href="../../../num_traits/ops/mul_add/trait.MulAdd.html#associatedtype.Output" title="type num_traits::ops::mul_add::MulAdd::Output">Output</a></code><a class="srclink" href="../../../src/num_traits/ops/mul_add.rs.html#70" title="goto source code">[src]</a></h4></div></div><span class="loading-content">Loading content...</span><script type="text/javascript" src="../../../implementors/num_traits/ops/mul_add/trait.MulAdd.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="num_traits"></div>
|
||
<script src="../../../main.js"></script><script defer src="../../../search-index.js"></script></body></html> |