Files
phy/simba/simd/trait.SimdSigned.html
Orion Kindel 0ce894e6b0 doc
2025-03-18 10:30:23 -05:00

16 lines
15 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="A lane-wise generalization of `num::Signed` for SIMD values."><title>SimdSigned 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>Signed</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.is_simd_negative" title="is_simd_negative">is_simd_negative</a></li><li><a href="#tymethod.is_simd_positive" title="is_simd_positive">is_simd_positive</a></li><li><a href="#tymethod.simd_abs" title="simd_abs">simd_abs</a></li><li><a href="#tymethod.simd_abs_sub" title="simd_abs_sub">simd_abs_sub</a></li><li><a href="#tymethod.simd_signum" title="simd_signum">simd_signum</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">SimdSigned</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_signed.rs.html#5-19">Source</a> </span></div><pre class="rust item-decl"><code>pub trait SimdSigned: <a class="trait" href="trait.SimdValue.html" title="trait simba::simd::SimdValue">SimdValue</a> {
// Required methods
fn <a href="#tymethod.simd_abs" class="fn">simd_abs</a>(&amp;self) -&gt; Self;
<span class="item-spacer"></span> fn <a href="#tymethod.simd_abs_sub" class="fn">simd_abs_sub</a>(&amp;self, other: &amp;Self) -&gt; Self;
<span class="item-spacer"></span> fn <a href="#tymethod.simd_signum" class="fn">simd_signum</a>(&amp;self) -&gt; Self;
<span class="item-spacer"></span> fn <a href="#tymethod.is_simd_positive" class="fn">is_simd_positive</a>(&amp;self) -&gt; Self::<a class="associatedtype" href="trait.SimdValue.html#associatedtype.SimdBool" title="type simba::simd::SimdValue::SimdBool">SimdBool</a>;
<span class="item-spacer"></span> fn <a href="#tymethod.is_simd_negative" class="fn">is_simd_negative</a>(&amp;self) -&gt; Self::<a class="associatedtype" href="trait.SimdValue.html#associatedtype.SimdBool" title="type simba::simd::SimdValue::SimdBool">SimdBool</a>;
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A lane-wise generalization of <a href="https://rust-num.github.io/num/num/trait.Signed.html"><code>num::Signed</code></a> for SIMD values.</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_abs" class="method"><a class="src rightside" href="../../src/simba/simd/simd_signed.rs.html#7">Source</a><h4 class="code-header">fn <a href="#tymethod.simd_abs" class="fn">simd_abs</a>(&amp;self) -&gt; Self</h4></section></summary><div class="docblock"><p>The absolute value of each lane of <code>self</code>.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.simd_abs_sub" class="method"><a class="src rightside" href="../../src/simba/simd/simd_signed.rs.html#12">Source</a><h4 class="code-header">fn <a href="#tymethod.simd_abs_sub" class="fn">simd_abs_sub</a>(&amp;self, other: &amp;Self) -&gt; Self</h4></section></summary><div class="docblock"><p>The absolute difference of each lane of <code>self</code>.</p>
<p>For each lane, this zero if the lane of self is less than or equal to the corresponding lane of other
otherwise the difference between the lane of self and the lane of other is returned.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.simd_signum" class="method"><a class="src rightside" href="../../src/simba/simd/simd_signed.rs.html#14">Source</a><h4 class="code-header">fn <a href="#tymethod.simd_signum" class="fn">simd_signum</a>(&amp;self) -&gt; Self</h4></section></summary><div class="docblock"><p>The signum of each lane of <code>Self</code>.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.is_simd_positive" class="method"><a class="src rightside" href="../../src/simba/simd/simd_signed.rs.html#16">Source</a><h4 class="code-header">fn <a href="#tymethod.is_simd_positive" class="fn">is_simd_positive</a>(&amp;self) -&gt; Self::<a class="associatedtype" href="trait.SimdValue.html#associatedtype.SimdBool" title="type simba::simd::SimdValue::SimdBool">SimdBool</a></h4></section></summary><div class="docblock"><p>Tests which lane is positive.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.is_simd_negative" class="method"><a class="src rightside" href="../../src/simba/simd/simd_signed.rs.html#18">Source</a><h4 class="code-header">fn <a href="#tymethod.is_simd_negative" class="fn">is_simd_negative</a>(&amp;self) -&gt; Self::<a class="associatedtype" href="trait.SimdValue.html#associatedtype.SimdBool" title="type simba::simd::SimdValue::SimdBool">SimdBool</a></h4></section></summary><div class="docblock"><p>Tests which lane is negative.</p>
</div></details></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-SimdSigned-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-SimdSigned-for-AutoSimd%3C%5Bf32;+2%5D%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.SimdSigned.html" title="trait simba::simd::SimdSigned">SimdSigned</a> for <a class="struct" href="struct.AutoSimd.html" title="struct simba::simd::AutoSimd">AutoSimd</a>&lt;[<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>]&gt;</h3></section><section id="impl-SimdSigned-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-SimdSigned-for-AutoSimd%3C%5Bf32;+4%5D%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.SimdSigned.html" title="trait simba::simd::SimdSigned">SimdSigned</a> for <a class="struct" href="struct.AutoSimd.html" title="struct simba::simd::AutoSimd">AutoSimd</a>&lt;[<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>]&gt;</h3></section><section id="impl-SimdSigned-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-SimdSigned-for-AutoSimd%3C%5Bf32;+8%5D%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.SimdSigned.html" title="trait simba::simd::SimdSigned">SimdSigned</a> for <a class="struct" href="struct.AutoSimd.html" title="struct simba::simd::AutoSimd">AutoSimd</a>&lt;[<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>]&gt;</h3></section><section id="impl-SimdSigned-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-SimdSigned-for-AutoSimd%3C%5Bf32;+16%5D%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.SimdSigned.html" title="trait simba::simd::SimdSigned">SimdSigned</a> for <a class="struct" href="struct.AutoSimd.html" title="struct simba::simd::AutoSimd">AutoSimd</a>&lt;[<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>]&gt;</h3></section><section id="impl-SimdSigned-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-SimdSigned-for-AutoSimd%3C%5Bf64;+2%5D%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.SimdSigned.html" title="trait simba::simd::SimdSigned">SimdSigned</a> for <a class="struct" href="struct.AutoSimd.html" title="struct simba::simd::AutoSimd">AutoSimd</a>&lt;[<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>]&gt;</h3></section><section id="impl-SimdSigned-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-SimdSigned-for-AutoSimd%3C%5Bf64;+4%5D%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.SimdSigned.html" title="trait simba::simd::SimdSigned">SimdSigned</a> for <a class="struct" href="struct.AutoSimd.html" title="struct simba::simd::AutoSimd">AutoSimd</a>&lt;[<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>]&gt;</h3></section><section id="impl-SimdSigned-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-SimdSigned-for-AutoSimd%3C%5Bf64;+8%5D%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.SimdSigned.html" title="trait simba::simd::SimdSigned">SimdSigned</a> for <a class="struct" href="struct.AutoSimd.html" title="struct simba::simd::AutoSimd">AutoSimd</a>&lt;[<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>]&gt;</h3></section><section id="impl-SimdSigned-for-WideF32x4" class="impl"><a class="src rightside" href="../../src/simba/simd/wide_simd_impl.rs.html#1545">Source</a><a href="#impl-SimdSigned-for-WideF32x4" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.SimdSigned.html" title="trait simba::simd::SimdSigned">SimdSigned</a> for <a class="struct" href="struct.WideF32x4.html" title="struct simba::simd::WideF32x4">WideF32x4</a></h3></section><section id="impl-SimdSigned-for-WideF32x8" class="impl"><a class="src rightside" href="../../src/simba/simd/wide_simd_impl.rs.html#1547">Source</a><a href="#impl-SimdSigned-for-WideF32x8" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.SimdSigned.html" title="trait simba::simd::SimdSigned">SimdSigned</a> for <a class="struct" href="struct.WideF32x8.html" title="struct simba::simd::WideF32x8">WideF32x8</a></h3></section><section id="impl-SimdSigned-for-WideF64x4" class="impl"><a class="src rightside" href="../../src/simba/simd/wide_simd_impl.rs.html#1546">Source</a><a href="#impl-SimdSigned-for-WideF64x4" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.SimdSigned.html" title="trait simba::simd::SimdSigned">SimdSigned</a> for <a class="struct" href="struct.WideF64x4.html" title="struct simba::simd::WideF64x4">WideF64x4</a></h3></section><section id="impl-SimdSigned-for-T" class="impl"><a class="src rightside" href="../../src/simba/simd/simd_signed.rs.html#21-46">Source</a><a href="#impl-SimdSigned-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T: <a class="trait" href="../../num_traits/sign/trait.Signed.html" title="trait num_traits::sign::Signed">Signed</a> + <a class="trait" href="trait.SimdValue.html" title="trait simba::simd::SimdValue">SimdValue</a>&lt;SimdBool = <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.bool.html">bool</a>&gt;&gt; <a class="trait" href="trait.SimdSigned.html" title="trait simba::simd::SimdSigned">SimdSigned</a> for T</h3></section></div><script src="../../trait.impl/simba/simd/simd_signed/trait.SimdSigned.js" async></script></section></div></main></body></html>