32 lines
20 KiB
HTML
32 lines
20 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="Lanewise generalization of `RealField` for SIMD reals."><title>SimdRealField in simba::simd - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.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" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="simba" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.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]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../simba/index.html">simba</a><span class="version">0.9.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Simd<wbr>Real<wbr>Field</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.simd_atan2" title="simd_atan2">simd_atan2</a></li><li><a href="#tymethod.simd_copysign" title="simd_copysign">simd_copysign</a></li><li><a href="#tymethod.simd_default_epsilon" title="simd_default_epsilon">simd_default_epsilon</a></li><li><a href="#tymethod.simd_e" title="simd_e">simd_e</a></li><li><a href="#tymethod.simd_frac_1_pi" title="simd_frac_1_pi">simd_frac_1_pi</a></li><li><a href="#tymethod.simd_frac_2_pi" title="simd_frac_2_pi">simd_frac_2_pi</a></li><li><a href="#tymethod.simd_frac_2_sqrt_pi" title="simd_frac_2_sqrt_pi">simd_frac_2_sqrt_pi</a></li><li><a href="#tymethod.simd_frac_pi_2" title="simd_frac_pi_2">simd_frac_pi_2</a></li><li><a href="#tymethod.simd_frac_pi_3" title="simd_frac_pi_3">simd_frac_pi_3</a></li><li><a href="#tymethod.simd_frac_pi_4" title="simd_frac_pi_4">simd_frac_pi_4</a></li><li><a href="#tymethod.simd_frac_pi_6" title="simd_frac_pi_6">simd_frac_pi_6</a></li><li><a href="#tymethod.simd_frac_pi_8" title="simd_frac_pi_8">simd_frac_pi_8</a></li><li><a href="#tymethod.simd_ln_10" title="simd_ln_10">simd_ln_10</a></li><li><a href="#tymethod.simd_ln_2" title="simd_ln_2">simd_ln_2</a></li><li><a href="#tymethod.simd_log10_e" title="simd_log10_e">simd_log10_e</a></li><li><a href="#tymethod.simd_log2_e" title="simd_log2_e">simd_log2_e</a></li><li><a href="#tymethod.simd_pi" title="simd_pi">simd_pi</a></li><li><a href="#tymethod.simd_two_pi" title="simd_two_pi">simd_two_pi</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In simba::<wbr>simd</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">simba</a>::<wbr><a href="index.html">simd</a></span><h1>Trait <span class="trait">SimdRealField</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/simba/simd/simd_real.rs.html#9-36">Source</a> </span></div><pre class="rust item-decl"><code>pub trait SimdRealField:
|
|
<a class="trait" href="trait.SimdPartialOrd.html" title="trait simba::simd::SimdPartialOrd">SimdPartialOrd</a>
|
|
+ <a class="trait" href="trait.SimdSigned.html" title="trait simba::simd::SimdSigned">SimdSigned</a>
|
|
+ <a class="trait" href="trait.SimdComplexField.html" title="trait simba::simd::SimdComplexField">SimdComplexField</a><SimdRealField = Self> {
|
|
<details class="toggle type-contents-toggle"><summary class="hideme"><span>Show 18 methods</span></summary> // Required methods
|
|
fn <a href="#tymethod.simd_copysign" class="fn">simd_copysign</a>(self, sign: Self) -> Self;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.simd_atan2" class="fn">simd_atan2</a>(self, other: Self) -> Self;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.simd_default_epsilon" class="fn">simd_default_epsilon</a>() -> Self;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.simd_pi" class="fn">simd_pi</a>() -> Self;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.simd_two_pi" class="fn">simd_two_pi</a>() -> Self;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.simd_frac_pi_2" class="fn">simd_frac_pi_2</a>() -> Self;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.simd_frac_pi_3" class="fn">simd_frac_pi_3</a>() -> Self;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.simd_frac_pi_4" class="fn">simd_frac_pi_4</a>() -> Self;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.simd_frac_pi_6" class="fn">simd_frac_pi_6</a>() -> Self;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.simd_frac_pi_8" class="fn">simd_frac_pi_8</a>() -> Self;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.simd_frac_1_pi" class="fn">simd_frac_1_pi</a>() -> Self;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.simd_frac_2_pi" class="fn">simd_frac_2_pi</a>() -> Self;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.simd_frac_2_sqrt_pi" class="fn">simd_frac_2_sqrt_pi</a>() -> Self;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.simd_e" class="fn">simd_e</a>() -> Self;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.simd_log2_e" class="fn">simd_log2_e</a>() -> Self;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.simd_log10_e" class="fn">simd_log10_e</a>() -> Self;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.simd_ln_2" class="fn">simd_ln_2</a>() -> Self;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.simd_ln_10" class="fn">simd_ln_10</a>() -> Self;
|
|
</details>}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Lanewise generalization of <code>RealField</code> for SIMD reals.</p>
|
|
<p>Each lane of an SIMD real field should contain one real field.
|
|
This is implemented by scalar reals like <code>f32</code> and <code>f64</code> as well as SIMD reals like <code>portable_simd::f32x4</code>.</p>
|
|
</div></details><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.simd_copysign" class="method"><a class="src rightside" href="../../src/simba/simd/simd_real.rs.html#16">Source</a><h4 class="code-header">fn <a href="#tymethod.simd_copysign" class="fn">simd_copysign</a>(self, sign: Self) -> Self</h4></section></summary><div class="docblock"><p>Copies the sign of <code>sign</code> to <code>self</code>.</p>
|
|
<ul>
|
|
<li>Returns <code>self.simd_abs()</code> if <code>sign</code> is positive or positive-zero.</li>
|
|
<li>Returns <code>-self.simd_abs()</code> if <code>sign</code> is negative or negative-zero.</li>
|
|
</ul>
|
|
</div></details><section id="tymethod.simd_atan2" class="method"><a class="src rightside" href="../../src/simba/simd/simd_real.rs.html#17">Source</a><h4 class="code-header">fn <a href="#tymethod.simd_atan2" class="fn">simd_atan2</a>(self, other: Self) -> Self</h4></section><section id="tymethod.simd_default_epsilon" class="method"><a class="src rightside" href="../../src/simba/simd/simd_real.rs.html#19">Source</a><h4 class="code-header">fn <a href="#tymethod.simd_default_epsilon" class="fn">simd_default_epsilon</a>() -> Self</h4></section><section id="tymethod.simd_pi" class="method"><a class="src rightside" href="../../src/simba/simd/simd_real.rs.html#20">Source</a><h4 class="code-header">fn <a href="#tymethod.simd_pi" class="fn">simd_pi</a>() -> Self</h4></section><section id="tymethod.simd_two_pi" class="method"><a class="src rightside" href="../../src/simba/simd/simd_real.rs.html#21">Source</a><h4 class="code-header">fn <a href="#tymethod.simd_two_pi" class="fn">simd_two_pi</a>() -> Self</h4></section><section id="tymethod.simd_frac_pi_2" class="method"><a class="src rightside" href="../../src/simba/simd/simd_real.rs.html#22">Source</a><h4 class="code-header">fn <a href="#tymethod.simd_frac_pi_2" class="fn">simd_frac_pi_2</a>() -> Self</h4></section><section id="tymethod.simd_frac_pi_3" class="method"><a class="src rightside" href="../../src/simba/simd/simd_real.rs.html#23">Source</a><h4 class="code-header">fn <a href="#tymethod.simd_frac_pi_3" class="fn">simd_frac_pi_3</a>() -> Self</h4></section><section id="tymethod.simd_frac_pi_4" class="method"><a class="src rightside" href="../../src/simba/simd/simd_real.rs.html#24">Source</a><h4 class="code-header">fn <a href="#tymethod.simd_frac_pi_4" class="fn">simd_frac_pi_4</a>() -> Self</h4></section><section id="tymethod.simd_frac_pi_6" class="method"><a class="src rightside" href="../../src/simba/simd/simd_real.rs.html#25">Source</a><h4 class="code-header">fn <a href="#tymethod.simd_frac_pi_6" class="fn">simd_frac_pi_6</a>() -> Self</h4></section><section id="tymethod.simd_frac_pi_8" class="method"><a class="src rightside" href="../../src/simba/simd/simd_real.rs.html#26">Source</a><h4 class="code-header">fn <a href="#tymethod.simd_frac_pi_8" class="fn">simd_frac_pi_8</a>() -> Self</h4></section><section id="tymethod.simd_frac_1_pi" class="method"><a class="src rightside" href="../../src/simba/simd/simd_real.rs.html#27">Source</a><h4 class="code-header">fn <a href="#tymethod.simd_frac_1_pi" class="fn">simd_frac_1_pi</a>() -> Self</h4></section><section id="tymethod.simd_frac_2_pi" class="method"><a class="src rightside" href="../../src/simba/simd/simd_real.rs.html#28">Source</a><h4 class="code-header">fn <a href="#tymethod.simd_frac_2_pi" class="fn">simd_frac_2_pi</a>() -> Self</h4></section><section id="tymethod.simd_frac_2_sqrt_pi" class="method"><a class="src rightside" href="../../src/simba/simd/simd_real.rs.html#29">Source</a><h4 class="code-header">fn <a href="#tymethod.simd_frac_2_sqrt_pi" class="fn">simd_frac_2_sqrt_pi</a>() -> Self</h4></section><section id="tymethod.simd_e" class="method"><a class="src rightside" href="../../src/simba/simd/simd_real.rs.html#31">Source</a><h4 class="code-header">fn <a href="#tymethod.simd_e" class="fn">simd_e</a>() -> Self</h4></section><section id="tymethod.simd_log2_e" class="method"><a class="src rightside" href="../../src/simba/simd/simd_real.rs.html#32">Source</a><h4 class="code-header">fn <a href="#tymethod.simd_log2_e" class="fn">simd_log2_e</a>() -> Self</h4></section><section id="tymethod.simd_log10_e" class="method"><a class="src rightside" href="../../src/simba/simd/simd_real.rs.html#33">Source</a><h4 class="code-header">fn <a href="#tymethod.simd_log10_e" class="fn">simd_log10_e</a>() -> Self</h4></section><section id="tymethod.simd_ln_2" class="method"><a class="src rightside" href="../../src/simba/simd/simd_real.rs.html#34">Source</a><h4 class="code-header">fn <a href="#tymethod.simd_ln_2" class="fn">simd_ln_2</a>() -> Self</h4></section><section id="tymethod.simd_ln_10" class="method"><a class="src rightside" href="../../src/simba/simd/simd_real.rs.html#35">Source</a><h4 class="code-header">fn <a href="#tymethod.simd_ln_10" class="fn">simd_ln_10</a>() -> Self</h4></section></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.84.0/reference/items/traits.html#object-safety">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-SimdRealField-for-AutoSimd%3C%5Bf32;+2%5D%3E" class="impl"><a class="src rightside" href="../../src/simba/simd/auto_simd_impl.rs.html#1478-1486">Source</a><a href="#impl-SimdRealField-for-AutoSimd%3C%5Bf32;+2%5D%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.SimdRealField.html" title="trait simba::simd::SimdRealField">SimdRealField</a> for <a class="struct" href="struct.AutoSimd.html" title="struct simba::simd::AutoSimd">AutoSimd</a><[<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.f32.html">f32</a>; <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.array.html">2</a>]></h3></section><section id="impl-SimdRealField-for-AutoSimd%3C%5Bf32;+4%5D%3E" class="impl"><a class="src rightside" href="../../src/simba/simd/auto_simd_impl.rs.html#1478-1486">Source</a><a href="#impl-SimdRealField-for-AutoSimd%3C%5Bf32;+4%5D%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.SimdRealField.html" title="trait simba::simd::SimdRealField">SimdRealField</a> for <a class="struct" href="struct.AutoSimd.html" title="struct simba::simd::AutoSimd">AutoSimd</a><[<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.f32.html">f32</a>; <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.array.html">4</a>]></h3></section><section id="impl-SimdRealField-for-AutoSimd%3C%5Bf32;+8%5D%3E" class="impl"><a class="src rightside" href="../../src/simba/simd/auto_simd_impl.rs.html#1478-1486">Source</a><a href="#impl-SimdRealField-for-AutoSimd%3C%5Bf32;+8%5D%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.SimdRealField.html" title="trait simba::simd::SimdRealField">SimdRealField</a> for <a class="struct" href="struct.AutoSimd.html" title="struct simba::simd::AutoSimd">AutoSimd</a><[<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.f32.html">f32</a>; <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.array.html">8</a>]></h3></section><section id="impl-SimdRealField-for-AutoSimd%3C%5Bf32;+16%5D%3E" class="impl"><a class="src rightside" href="../../src/simba/simd/auto_simd_impl.rs.html#1478-1486">Source</a><a href="#impl-SimdRealField-for-AutoSimd%3C%5Bf32;+16%5D%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.SimdRealField.html" title="trait simba::simd::SimdRealField">SimdRealField</a> for <a class="struct" href="struct.AutoSimd.html" title="struct simba::simd::AutoSimd">AutoSimd</a><[<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.f32.html">f32</a>; <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.array.html">16</a>]></h3></section><section id="impl-SimdRealField-for-AutoSimd%3C%5Bf64;+2%5D%3E" class="impl"><a class="src rightside" href="../../src/simba/simd/auto_simd_impl.rs.html#1478-1486">Source</a><a href="#impl-SimdRealField-for-AutoSimd%3C%5Bf64;+2%5D%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.SimdRealField.html" title="trait simba::simd::SimdRealField">SimdRealField</a> for <a class="struct" href="struct.AutoSimd.html" title="struct simba::simd::AutoSimd">AutoSimd</a><[<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.f64.html">f64</a>; <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.array.html">2</a>]></h3></section><section id="impl-SimdRealField-for-AutoSimd%3C%5Bf64;+4%5D%3E" class="impl"><a class="src rightside" href="../../src/simba/simd/auto_simd_impl.rs.html#1478-1486">Source</a><a href="#impl-SimdRealField-for-AutoSimd%3C%5Bf64;+4%5D%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.SimdRealField.html" title="trait simba::simd::SimdRealField">SimdRealField</a> for <a class="struct" href="struct.AutoSimd.html" title="struct simba::simd::AutoSimd">AutoSimd</a><[<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.f64.html">f64</a>; <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.array.html">4</a>]></h3></section><section id="impl-SimdRealField-for-AutoSimd%3C%5Bf64;+8%5D%3E" class="impl"><a class="src rightside" href="../../src/simba/simd/auto_simd_impl.rs.html#1478-1486">Source</a><a href="#impl-SimdRealField-for-AutoSimd%3C%5Bf64;+8%5D%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.SimdRealField.html" title="trait simba::simd::SimdRealField">SimdRealField</a> for <a class="struct" href="struct.AutoSimd.html" title="struct simba::simd::AutoSimd">AutoSimd</a><[<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.f64.html">f64</a>; <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.array.html">8</a>]></h3></section><section id="impl-SimdRealField-for-WideF32x4" class="impl"><a class="src rightside" href="../../src/simba/simd/wide_simd_impl.rs.html#1545">Source</a><a href="#impl-SimdRealField-for-WideF32x4" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.SimdRealField.html" title="trait simba::simd::SimdRealField">SimdRealField</a> for <a class="struct" href="struct.WideF32x4.html" title="struct simba::simd::WideF32x4">WideF32x4</a></h3></section><section id="impl-SimdRealField-for-WideF32x8" class="impl"><a class="src rightside" href="../../src/simba/simd/wide_simd_impl.rs.html#1547">Source</a><a href="#impl-SimdRealField-for-WideF32x8" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.SimdRealField.html" title="trait simba::simd::SimdRealField">SimdRealField</a> for <a class="struct" href="struct.WideF32x8.html" title="struct simba::simd::WideF32x8">WideF32x8</a></h3></section><section id="impl-SimdRealField-for-WideF64x4" class="impl"><a class="src rightside" href="../../src/simba/simd/wide_simd_impl.rs.html#1546">Source</a><a href="#impl-SimdRealField-for-WideF64x4" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.SimdRealField.html" title="trait simba::simd::SimdRealField">SimdRealField</a> for <a class="struct" href="struct.WideF64x4.html" title="struct simba::simd::WideF64x4">WideF64x4</a></h3></section><section id="impl-SimdRealField-for-T" class="impl"><a class="src rightside" href="../../src/simba/simd/simd_real.rs.html#39-114">Source</a><a href="#impl-SimdRealField-for-T" class="anchor">§</a><h3 class="code-header">impl<T: <a class="trait" href="../scalar/trait.RealField.html" title="trait simba::scalar::RealField">RealField</a>> <a class="trait" href="trait.SimdRealField.html" title="trait simba::simd::SimdRealField">SimdRealField</a> for T</h3></section></div><script src="../../trait.impl/simba/simd/simd_real/trait.SimdRealField.js" async></script></section></div></main></body></html> |