nordic-dev.net/rust
nordic-dev.net/rust
2
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2025-06-19 11:07:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Caleb Zulawski 2021-04-17 01:32:45 +00:00
parent e127586709
commit 01d78aa21a
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
crates/core_simd/src/reduction.rs
View File

@ -4,46 +4,46 @@ macro_rules! impl_integer_reductions {
where where
Self: crate::LanesAtMost32 Self: crate::LanesAtMost32
{ {
/// Horizontal wrapping add. Computes the sum of the lanes of the vector, with wrapping addition. /// Horizontal wrapping add. Returns the sum of the lanes of the vector, with wrapping addition.
#[inline] #[inline]
pub fn wrapping_sum(self) -> $scalar { pub fn wrapping_sum(self) -> $scalar {
unsafe { crate::intrinsics::simd_reduce_add_ordered(self, 0) } unsafe { crate::intrinsics::simd_reduce_add_ordered(self, 0) }
} }
/// Horizontal wrapping multiply. Computes the product of the lanes of the vector, with wrapping multiplication. /// Horizontal wrapping multiply. Returns the product of the lanes of the vector, with wrapping multiplication.
#[inline] #[inline]
pub fn wrapping_product(self) -> $scalar { pub fn wrapping_product(self) -> $scalar {
unsafe { crate::intrinsics::simd_reduce_mul_ordered(self, 1) } unsafe { crate::intrinsics::simd_reduce_mul_ordered(self, 1) }
} }
/// Horizontal bitwise "and". Computes the cumulative bitwise "and" across the lanes of /// Horizontal bitwise "and". Returns the cumulative bitwise "and" across the lanes of
/// the vector. /// the vector.
#[inline] #[inline]
pub fn horizontal_and(self) -> $scalar { pub fn horizontal_and(self) -> $scalar {
unsafe { crate::intrinsics::simd_reduce_and(self) } unsafe { crate::intrinsics::simd_reduce_and(self) }
} }
/// Horizontal bitwise "or". Computes the cumulative bitwise "or" across the lanes of /// Horizontal bitwise "or". Returns the cumulative bitwise "or" across the lanes of
/// the vector. /// the vector.
#[inline] #[inline]
pub fn horizontal_or(self) -> $scalar { pub fn horizontal_or(self) -> $scalar {
unsafe { crate::intrinsics::simd_reduce_or(self) } unsafe { crate::intrinsics::simd_reduce_or(self) }
} }
/// Horizontal bitwise "xor". Computes the cumulative bitwise "xor" across the lanes of /// Horizontal bitwise "xor". Returns the cumulative bitwise "xor" across the lanes of
/// the vector. /// the vector.
#[inline] #[inline]
pub fn horizontal_xor(self) -> $scalar { pub fn horizontal_xor(self) -> $scalar {
unsafe { crate::intrinsics::simd_reduce_xor(self) } unsafe { crate::intrinsics::simd_reduce_xor(self) }
} }
/// Horizontal maximum. Computes the maximum lane in the vector. /// Horizontal maximum. Returns the maximum lane in the vector.
#[inline] #[inline]
pub fn horizontal_max(self) -> $scalar { pub fn horizontal_max(self) -> $scalar {
unsafe { crate::intrinsics::simd_reduce_max(self) } unsafe { crate::intrinsics::simd_reduce_max(self) }
} }
/// Horizontal minimum. Computes the minimum lane in the vector. /// Horizontal minimum. Returns the minimum lane in the vector.
#[inline] #[inline]
pub fn horizontal_min(self) -> $scalar { pub fn horizontal_min(self) -> $scalar {
unsafe { crate::intrinsics::simd_reduce_min(self) } unsafe { crate::intrinsics::simd_reduce_min(self) }
@ -59,7 +59,7 @@ macro_rules! impl_float_reductions {
Self: crate::LanesAtMost32 Self: crate::LanesAtMost32
{ {
/// Horizontal add. Computes the sum of the lanes of the vector. /// Horizontal add. Returns the sum of the lanes of the vector.
#[inline] #[inline]
pub fn sum(self) -> $scalar { pub fn sum(self) -> $scalar {
// LLVM sum is inaccurate on i586 // LLVM sum is inaccurate on i586
@ -70,7 +70,7 @@ macro_rules! impl_float_reductions {
} }
} }
/// Horizontal multiply. Computes the sum of the lanes of the vector. /// Horizontal multiply. Returns the product of the lanes of the vector.
#[inline] #[inline]
pub fn product(self) -> $scalar { pub fn product(self) -> $scalar {
// LLVM product is inaccurate on i586 // LLVM product is inaccurate on i586
@ -81,7 +81,7 @@ macro_rules! impl_float_reductions {
} }
} }
/// Horizontal maximum. Computes the maximum lane in the vector. /// Horizontal maximum. Returns the maximum lane in the vector.
/// ///
/// Returns values based on equality, so a vector containing both `0.` and `-0.` may /// Returns values based on equality, so a vector containing both `0.` and `-0.` may
/// return either. This function will not return `NaN` unless all lanes are `NaN`. /// return either. This function will not return `NaN` unless all lanes are `NaN`.
@ -90,7 +90,7 @@ macro_rules! impl_float_reductions {
unsafe { crate::intrinsics::simd_reduce_max(self) } unsafe { crate::intrinsics::simd_reduce_max(self) }
} }
/// Horizontal minimum. Computes the minimum lane in the vector. /// Horizontal minimum. Returns the minimum lane in the vector.
/// ///
/// Returns values based on equality, so a vector containing both `0.` and `-0.` may /// Returns values based on equality, so a vector containing both `0.` and `-0.` may
/// return either. This function will not return `NaN` unless all lanes are `NaN`. /// return either. This function will not return `NaN` unless all lanes are `NaN`.