pub struct Mask<T, const N: usize>(/* private fields */)
where
T: MaskElement;portable_simd)Expand description
A SIMD vector mask for N elements of width specified by Element.
Masks represent boolean inclusion/exclusion on a per-element basis.
The layout of this type is unspecified, and may change between platforms
and/or Rust versions, and code should not assume that it is equivalent to
[T; N].
N cannot be 0 and may be at most 64. This limit may be increased in
the future.
Implementations§
Source§impl<T, const N: usize> Mask<T, N>where
T: MaskElement,
impl<T, const N: usize> Mask<T, N>where
T: MaskElement,
Sourcepub fn reverse(self) -> Self
🔬This is a nightly-only experimental API. (portable_simd)
pub fn reverse(self) -> Self
portable_simd)Reverse the order of the elements in the mask.
Sourcepub fn rotate_elements_left<const OFFSET: usize>(self) -> Self
🔬This is a nightly-only experimental API. (portable_simd)
pub fn rotate_elements_left<const OFFSET: usize>(self) -> Self
portable_simd)Rotates the mask such that the first OFFSET elements of the slice move to the end
while the last self.len() - OFFSET elements move to the front. After calling rotate_elements_left,
the element previously at index OFFSET will become the first element in the slice.
Sourcepub fn rotate_elements_right<const OFFSET: usize>(self) -> Self
🔬This is a nightly-only experimental API. (portable_simd)
pub fn rotate_elements_right<const OFFSET: usize>(self) -> Self
portable_simd)Rotates the mask such that the first self.len() - OFFSET elements of the mask move to
the end while the last OFFSET elements move to the front. After calling rotate_elements_right,
the element previously at index self.len() - OFFSET will become the first element in the slice.
Sourcepub fn shift_elements_left<const OFFSET: usize>(self, padding: bool) -> Self
🔬This is a nightly-only experimental API. (portable_simd)
pub fn shift_elements_left<const OFFSET: usize>(self, padding: bool) -> Self
portable_simd)Shifts the mask elements to the left by OFFSET, filling in with
padding from the right.
Sourcepub fn shift_elements_right<const OFFSET: usize>(self, padding: bool) -> Self
🔬This is a nightly-only experimental API. (portable_simd)
pub fn shift_elements_right<const OFFSET: usize>(self, padding: bool) -> Self
portable_simd)Shifts the mask elements to the right by OFFSET, filling in with
padding from the left.
Sourcepub fn interleave(self, other: Self) -> (Self, Self)
🔬This is a nightly-only experimental API. (portable_simd)
pub fn interleave(self, other: Self) -> (Self, Self)
portable_simd)Interleave two masks.
The resulting masks contain elements taken alternatively from self and other, first
filling the first result, and then the second.
The reverse of this operation is Mask::deinterleave.
let a = mask32x4::from_array([false, true, false, true]);
let b = mask32x4::from_array([false, false, true, true]);
let (x, y) = a.interleave(b);
assert_eq!(x.to_array(), [false, false, true, false]);
assert_eq!(y.to_array(), [false, true, true, true]);Sourcepub fn deinterleave(self, other: Self) -> (Self, Self)
🔬This is a nightly-only experimental API. (portable_simd)
pub fn deinterleave(self, other: Self) -> (Self, Self)
portable_simd)Deinterleave two masks.
The first result takes every other element of self and then other, starting with
the first element.
The second result takes every other element of self and then other, starting with
the second element.
The reverse of this operation is Mask::interleave.
let a = mask32x4::from_array([false, true, false, true]);
let b = mask32x4::from_array([false, false, true, true]);
let (x, y) = a.deinterleave(b);
assert_eq!(x.to_array(), [false, false, false, true]);
assert_eq!(y.to_array(), [true, true, false, true]);Sourcepub fn resize<const M: usize>(self, value: bool) -> Mask<T, M>
🔬This is a nightly-only experimental API. (portable_simd)
pub fn resize<const M: usize>(self, value: bool) -> Mask<T, M>
portable_simd)Resize a mask.
If M > N, extends the length of a mask, setting the new elements to value.
If M < N, truncates the mask to the first M elements.
let x = mask32x4::from_array([false, true, true, false]);
assert_eq!(x.resize::<8>(true).to_array(), [false, true, true, false, true, true, true, true]);
assert_eq!(x.resize::<2>(true).to_array(), [false, true]);Source§impl<T, const N: usize> Mask<T, N>where
T: MaskElement,
impl<T, const N: usize> Mask<T, N>where
T: MaskElement,
Sourcepub const fn splat(value: bool) -> Self
🔬This is a nightly-only experimental API. (portable_simd)
pub const fn splat(value: bool) -> Self
portable_simd)Constructs a mask by setting all elements to the given value.
Sourcepub fn from_array(array: [bool; N]) -> Self
🔬This is a nightly-only experimental API. (portable_simd)
pub fn from_array(array: [bool; N]) -> Self
portable_simd)Converts an array of bools to a SIMD mask.
Sourcepub fn to_array(self) -> [bool; N]
🔬This is a nightly-only experimental API. (portable_simd)
pub fn to_array(self) -> [bool; N]
portable_simd)Converts a SIMD mask to an array of bools.
Sourcepub unsafe fn from_simd_unchecked(value: Simd<T, N>) -> Self
🔬This is a nightly-only experimental API. (portable_simd)
pub unsafe fn from_simd_unchecked(value: Simd<T, N>) -> Self
portable_simd)Converts a vector of integers to a mask, where 0 represents false and -1
represents true.
§Safety
All elements must be either 0 or -1.
Sourcepub fn from_simd(value: Simd<T, N>) -> Self
🔬This is a nightly-only experimental API. (portable_simd)
pub fn from_simd(value: Simd<T, N>) -> Self
portable_simd)Converts a vector of integers to a mask, where 0 represents false and -1
represents true.
§Panics
Panics if any element is not 0 or -1.
Sourcepub fn to_simd(self) -> Simd<T, N>
🔬This is a nightly-only experimental API. (portable_simd)
pub fn to_simd(self) -> Simd<T, N>
portable_simd)Converts the mask to a vector of integers, where 0 represents false and -1
represents true.
Sourcepub fn cast<U: MaskElement>(self) -> Mask<U, N>
🔬This is a nightly-only experimental API. (portable_simd)
pub fn cast<U: MaskElement>(self) -> Mask<U, N>
portable_simd)Converts the mask to a mask of any other element size.
Sourcepub unsafe fn test_unchecked(&self, index: usize) -> bool
🔬This is a nightly-only experimental API. (portable_simd)
pub unsafe fn test_unchecked(&self, index: usize) -> bool
portable_simd)Sourcepub fn test(&self, index: usize) -> bool
🔬This is a nightly-only experimental API. (portable_simd)
pub fn test(&self, index: usize) -> bool
portable_simd)Tests the value of the specified element.
§Panics
Panics if index is greater than or equal to the number of elements in the vector.
Sourcepub unsafe fn set_unchecked(&mut self, index: usize, value: bool)
🔬This is a nightly-only experimental API. (portable_simd)
pub unsafe fn set_unchecked(&mut self, index: usize, value: bool)
portable_simd)Sourcepub fn set(&mut self, index: usize, value: bool)
🔬This is a nightly-only experimental API. (portable_simd)
pub fn set(&mut self, index: usize, value: bool)
portable_simd)Sets the value of the specified element.
§Panics
Panics if index is greater than or equal to the number of elements in the vector.
Sourcepub fn any(self) -> bool
🔬This is a nightly-only experimental API. (portable_simd)
pub fn any(self) -> bool
portable_simd)Returns true if any element is set, or false otherwise.
Sourcepub fn all(self) -> bool
🔬This is a nightly-only experimental API. (portable_simd)
pub fn all(self) -> bool
portable_simd)Returns true if all elements are set, or false otherwise.
Sourcepub fn to_bitmask(self) -> u64
🔬This is a nightly-only experimental API. (portable_simd)
pub fn to_bitmask(self) -> u64
portable_simd)Creates a bitmask from a mask.
Each bit is set if the corresponding element in the mask is true.
Sourcepub fn from_bitmask(bitmask: u64) -> Self
🔬This is a nightly-only experimental API. (portable_simd)
pub fn from_bitmask(bitmask: u64) -> Self
portable_simd)Creates a mask from a bitmask.
For each bit, if it is set, the corresponding element in the mask is set to true.
If the mask contains more than 64 elements, the remainder are set to false.
Sourcepub fn first_set(self) -> Option<usize>
🔬This is a nightly-only experimental API. (portable_simd)
pub fn first_set(self) -> Option<usize>
portable_simd)Finds the index of the first set element.
assert_eq!(mask32x8::splat(false).first_set(), None);
assert_eq!(mask32x8::splat(true).first_set(), Some(0));
let mask = mask32x8::from_array([false, true, false, false, true, false, false, true]);
assert_eq!(mask.first_set(), Some(1));Trait Implementations§
Source§impl<T, const N: usize> BitAndAssign<bool> for Mask<T, N>where
T: MaskElement,
impl<T, const N: usize> BitAndAssign<bool> for Mask<T, N>where
T: MaskElement,
Source§fn bitand_assign(&mut self, rhs: bool)
fn bitand_assign(&mut self, rhs: bool)
&= operation. Read moreSource§impl<T, const N: usize> BitAndAssign for Mask<T, N>where
T: MaskElement,
impl<T, const N: usize> BitAndAssign for Mask<T, N>where
T: MaskElement,
Source§fn bitand_assign(&mut self, rhs: Self)
fn bitand_assign(&mut self, rhs: Self)
&= operation. Read moreSource§impl<T, const N: usize> BitOrAssign<bool> for Mask<T, N>where
T: MaskElement,
impl<T, const N: usize> BitOrAssign<bool> for Mask<T, N>where
T: MaskElement,
Source§fn bitor_assign(&mut self, rhs: bool)
fn bitor_assign(&mut self, rhs: bool)
|= operation. Read moreSource§impl<T, const N: usize> BitOrAssign for Mask<T, N>where
T: MaskElement,
impl<T, const N: usize> BitOrAssign for Mask<T, N>where
T: MaskElement,
Source§fn bitor_assign(&mut self, rhs: Self)
fn bitor_assign(&mut self, rhs: Self)
|= operation. Read moreSource§impl<T, const N: usize> BitXorAssign<bool> for Mask<T, N>where
T: MaskElement,
impl<T, const N: usize> BitXorAssign<bool> for Mask<T, N>where
T: MaskElement,
Source§fn bitxor_assign(&mut self, rhs: bool)
fn bitxor_assign(&mut self, rhs: bool)
^= operation. Read moreSource§impl<T, const N: usize> BitXorAssign for Mask<T, N>where
T: MaskElement,
impl<T, const N: usize> BitXorAssign for Mask<T, N>where
T: MaskElement,
Source§fn bitxor_assign(&mut self, rhs: Self)
fn bitxor_assign(&mut self, rhs: Self)
^= operation. Read moreSource§impl<T, const N: usize> PartialOrd for Mask<T, N>where
T: MaskElement + PartialOrd,
impl<T, const N: usize> PartialOrd for Mask<T, N>where
T: MaskElement + PartialOrd,
Source§impl<T, U, const N: usize> Select<Mask<T, N>> for Mask<U, N>where
T: MaskElement,
U: MaskElement,
impl<T, U, const N: usize> Select<Mask<T, N>> for Mask<U, N>where
T: MaskElement,
U: MaskElement,
Source§impl<T, U, const N: usize> Select<Simd<T, N>> for Mask<U, N>where
T: SimdElement,
U: MaskElement,
impl<T, U, const N: usize> Select<Simd<T, N>> for Mask<U, N>where
T: SimdElement,
U: MaskElement,
Source§impl<const N: usize> SimdOrd for Mask<i16, N>
impl<const N: usize> SimdOrd for Mask<i16, N>
Source§fn simd_max(self, other: Self) -> Self
fn simd_max(self, other: Self) -> Self
portable_simd)other.Source§fn simd_min(self, other: Self) -> Self
fn simd_min(self, other: Self) -> Self
portable_simd)other.Source§fn simd_clamp(self, min: Self, max: Self) -> Self
fn simd_clamp(self, min: Self, max: Self) -> Self
portable_simd)Source§impl<const N: usize> SimdOrd for Mask<i32, N>
impl<const N: usize> SimdOrd for Mask<i32, N>
Source§fn simd_max(self, other: Self) -> Self
fn simd_max(self, other: Self) -> Self
portable_simd)other.Source§fn simd_min(self, other: Self) -> Self
fn simd_min(self, other: Self) -> Self
portable_simd)other.Source§fn simd_clamp(self, min: Self, max: Self) -> Self
fn simd_clamp(self, min: Self, max: Self) -> Self
portable_simd)Source§impl<const N: usize> SimdOrd for Mask<i64, N>
impl<const N: usize> SimdOrd for Mask<i64, N>
Source§fn simd_max(self, other: Self) -> Self
fn simd_max(self, other: Self) -> Self
portable_simd)other.Source§fn simd_min(self, other: Self) -> Self
fn simd_min(self, other: Self) -> Self
portable_simd)other.Source§fn simd_clamp(self, min: Self, max: Self) -> Self
fn simd_clamp(self, min: Self, max: Self) -> Self
portable_simd)Source§impl<const N: usize> SimdOrd for Mask<i8, N>
impl<const N: usize> SimdOrd for Mask<i8, N>
Source§fn simd_max(self, other: Self) -> Self
fn simd_max(self, other: Self) -> Self
portable_simd)other.Source§fn simd_min(self, other: Self) -> Self
fn simd_min(self, other: Self) -> Self
portable_simd)other.Source§fn simd_clamp(self, min: Self, max: Self) -> Self
fn simd_clamp(self, min: Self, max: Self) -> Self
portable_simd)Source§impl<const N: usize> SimdOrd for Mask<isize, N>
impl<const N: usize> SimdOrd for Mask<isize, N>
Source§fn simd_max(self, other: Self) -> Self
fn simd_max(self, other: Self) -> Self
portable_simd)other.Source§fn simd_min(self, other: Self) -> Self
fn simd_min(self, other: Self) -> Self
portable_simd)other.Source§fn simd_clamp(self, min: Self, max: Self) -> Self
fn simd_clamp(self, min: Self, max: Self) -> Self
portable_simd)Source§impl<const N: usize> SimdPartialEq for Mask<i16, N>
impl<const N: usize> SimdPartialEq for Mask<i16, N>
Source§type Mask = Mask<i16, N>
type Mask = Mask<i16, N>
portable_simd)Source§impl<const N: usize> SimdPartialEq for Mask<i32, N>
impl<const N: usize> SimdPartialEq for Mask<i32, N>
Source§type Mask = Mask<i32, N>
type Mask = Mask<i32, N>
portable_simd)Source§impl<const N: usize> SimdPartialEq for Mask<i64, N>
impl<const N: usize> SimdPartialEq for Mask<i64, N>
Source§type Mask = Mask<i64, N>
type Mask = Mask<i64, N>
portable_simd)Source§impl<const N: usize> SimdPartialEq for Mask<i8, N>
impl<const N: usize> SimdPartialEq for Mask<i8, N>
Source§type Mask = Mask<i8, N>
type Mask = Mask<i8, N>
portable_simd)Source§impl<const N: usize> SimdPartialEq for Mask<isize, N>
impl<const N: usize> SimdPartialEq for Mask<isize, N>
Source§type Mask = Mask<isize, N>
type Mask = Mask<isize, N>
portable_simd)Source§impl<const N: usize> SimdPartialOrd for Mask<i16, N>
impl<const N: usize> SimdPartialOrd for Mask<i16, N>
Source§fn simd_lt(self, other: Self) -> Self::Mask
fn simd_lt(self, other: Self) -> Self::Mask
portable_simd)other.Source§fn simd_le(self, other: Self) -> Self::Mask
fn simd_le(self, other: Self) -> Self::Mask
portable_simd)other.Source§impl<const N: usize> SimdPartialOrd for Mask<i32, N>
impl<const N: usize> SimdPartialOrd for Mask<i32, N>
Source§fn simd_lt(self, other: Self) -> Self::Mask
fn simd_lt(self, other: Self) -> Self::Mask
portable_simd)other.Source§fn simd_le(self, other: Self) -> Self::Mask
fn simd_le(self, other: Self) -> Self::Mask
portable_simd)other.Source§impl<const N: usize> SimdPartialOrd for Mask<i64, N>
impl<const N: usize> SimdPartialOrd for Mask<i64, N>
Source§fn simd_lt(self, other: Self) -> Self::Mask
fn simd_lt(self, other: Self) -> Self::Mask
portable_simd)other.Source§fn simd_le(self, other: Self) -> Self::Mask
fn simd_le(self, other: Self) -> Self::Mask
portable_simd)other.Source§impl<const N: usize> SimdPartialOrd for Mask<i8, N>
impl<const N: usize> SimdPartialOrd for Mask<i8, N>
Source§fn simd_lt(self, other: Self) -> Self::Mask
fn simd_lt(self, other: Self) -> Self::Mask
portable_simd)other.Source§fn simd_le(self, other: Self) -> Self::Mask
fn simd_le(self, other: Self) -> Self::Mask
portable_simd)other.Source§impl<const N: usize> SimdPartialOrd for Mask<isize, N>
impl<const N: usize> SimdPartialOrd for Mask<isize, N>
Source§fn simd_lt(self, other: Self) -> Self::Mask
fn simd_lt(self, other: Self) -> Self::Mask
portable_simd)other.Source§fn simd_le(self, other: Self) -> Self::Mask
fn simd_le(self, other: Self) -> Self::Mask
portable_simd)other.