29 lines
28 KiB
HTML
29 lines
28 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="../../../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_traits/index.html'><div class='logo-container'><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="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-MulAdd%3Cf32%2C%20f32%3E-for-f32">f32</a><a href="#impl-MulAdd%3Cf64%2C%20f64%3E-for-f64">f64</a><a href="#impl-MulAdd%3Ci128%2C%20i128%3E-for-i128">i128</a><a href="#impl-MulAdd%3Ci16%2C%20i16%3E-for-i16">i16</a><a href="#impl-MulAdd%3Ci32%2C%20i32%3E-for-i32">i32</a><a href="#impl-MulAdd%3Ci64%2C%20i64%3E-for-i64">i64</a><a href="#impl-MulAdd%3Ci8%2C%20i8%3E-for-i8">i8</a><a href="#impl-MulAdd%3Cisize%2C%20isize%3E-for-isize">isize</a><a href="#impl-MulAdd%3Cu128%2C%20u128%3E-for-u128">u128</a><a href="#impl-MulAdd%3Cu16%2C%20u16%3E-for-u16">u16</a><a href="#impl-MulAdd%3Cu32%2C%20u32%3E-for-u32">u32</a><a href="#impl-MulAdd%3Cu64%2C%20u64%3E-for-u64">u64</a><a href="#impl-MulAdd%3Cu8%2C%20u8%3E-for-u8">u8</a><a href="#impl-MulAdd%3Cusize%2C%20usize%3E-for-usize">usize</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><script>window.sidebarCurrent = {name: 'MulAdd', 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/mul_add.rs.html#23-29' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='../../index.html'>num_traits</a>::<wbr><a h
|
|||
|
|
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="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 id='Output.t'>type <a href='#associatedtype.Output' class="type">Output</a></code></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 id='mul_add.v'>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></h3><div class='docblock'><p>Performs the fused multiply-add operation.</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-MulAdd%3Cf32%2C%20f32%3E-for-f32' class='impl'><code class='in-band'>impl <a class="trait" href="../../../num_traits/ops/mul_add/trait.MulAdd.html" title="trait num_traits::ops::mul_add::MulAdd">MulAdd</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a>> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a></code><a href='#impl-MulAdd%3Cf32%2C%20f32%3E-for-f32' class='anchor'></a><a class='srclink' href='../../../src/num_traits/ops/mul_add.rs.html#38-45' 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> = Self</code></h4><h4 id='method.mul_add' class="method hidden"><code id='mul_add.v-1'>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#42-44' title='goto source code'>[src]</a></h4></div><h3 id='impl-MulAdd%3Cf64%2C%20f64%3E-for-f64' class='impl'><code class='in-band'>impl <a class="trait" href="../../../num_traits/ops/mul_add/trait.MulAdd.html" title="trait num_traits::ops::mul_add::MulAdd">MulAdd</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a>> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a></code><a href='#impl-MulAdd%3Cf64%2C%20f64%3E-for-f64' class='anchor'></a><a class='srclink' href='../../../src/num_traits/ops/mul_add.rs.html#48-55' 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> = Self</code></h4><h4 id='method.mul_add-1' class="method hidden"><code id='mul_add.v-2'>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#52-54' title='goto source code'>[src]</a></h4></div><h3 id='impl-MulAdd%3Cisize%2C%20isize%3E-for-isize' class='impl'><code class='in-band'>impl <a class="trait" href="../../../num_traits/ops/mul_add/trait.MulAdd.html" title="trait num_traits::ops::mul_add::MulAdd">MulAdd</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.isize.html">isize</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.isize.html">isize</a>> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.isize.html">isize</a></code><a href='#impl-MulAdd%3Cisize%2C%20isize%3E-for-isize' class='anchor'></a><a class='srclink' href='../../../src/num_traits/ops/mul_add.rs.html#59-66' 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> = Self</code></h4><h4 id='method.mul_add-2' class="method hidden"><code id='mul_add.v-3'>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#63-65' title='got
|
|||
|
|
<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/mul_add/trait.MulAdd.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_traits";</script><script src="../../../aliases.js"></script><script src="../../../main.js"></script><script defer src="../../../search-index.js"></script></body></html>
|