pub struct Mask<T, const N: usize>(/* private fields */)
where
T: MaskElement,
LaneCount<N>: SupportedLaneCount;portable_simd #86656)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].
Implementations§
Source§impl<T, const N: usize> Mask<T, N>
impl<T, const N: usize> Mask<T, N>
Sourcepub fn reverse(self) -> Self
🔬This is a nightly-only experimental API. (portable_simd #86656)
pub fn reverse(self) -> Self
portable_simd #86656)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 #86656)
pub fn rotate_elements_left<const OFFSET: usize>(self) -> Self
portable_simd #86656)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 #86656)
pub fn rotate_elements_right<const OFFSET: usize>(self) -> Self
portable_simd #86656)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 #86656)
pub fn shift_elements_left<const OFFSET: usize>(self, padding: bool) -> Self
portable_simd #86656)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 #86656)
pub fn shift_elements_right<const OFFSET: usize>(self, padding: bool) -> Self
portable_simd #86656)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 #86656)
pub fn interleave(self, other: Self) -> (Self, Self)
portable_simd #86656)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.
Sourcepub fn deinterleave(self, other: Self) -> (Self, Self)
🔬This is a nightly-only experimental API. (portable_simd #86656)
pub fn deinterleave(self, other: Self) -> (Self, Self)
portable_simd #86656)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.
Sourcepub fn resize<const M: usize>(self, value: bool) -> Mask<T, M>where
LaneCount<M>: SupportedLaneCount,
🔬This is a nightly-only experimental API. (portable_simd #86656)
pub fn resize<const M: usize>(self, value: bool) -> Mask<T, M>where
LaneCount<M>: SupportedLaneCount,
portable_simd #86656)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.
Source§impl<T, const N: usize> Mask<T, N>
impl<T, const N: usize> Mask<T, N>
Sourcepub fn splat(value: bool) -> Self
🔬This is a nightly-only experimental API. (portable_simd #86656)
pub fn splat(value: bool) -> Self
portable_simd #86656)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 #86656)
pub fn from_array(array: [bool; N]) -> Self
portable_simd #86656)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 #86656)
pub fn to_array(self) -> [bool; N]
portable_simd #86656)Converts a SIMD mask to an array of bools.
Sourcepub unsafe fn from_int_unchecked(value: Simd<T, N>) -> Self
🔬This is a nightly-only experimental API. (portable_simd #86656)
pub unsafe fn from_int_unchecked(value: Simd<T, N>) -> Self
portable_simd #86656)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_int(value: Simd<T, N>) -> Self
🔬This is a nightly-only experimental API. (portable_simd #86656)
pub fn from_int(value: Simd<T, N>) -> Self
portable_simd #86656)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_int(self) -> Simd<T, N>
🔬This is a nightly-only experimental API. (portable_simd #86656)
pub fn to_int(self) -> Simd<T, N>
portable_simd #86656)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 #86656)
pub fn cast<U: MaskElement>(self) -> Mask<U, N>
portable_simd #86656)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 #86656)
pub unsafe fn test_unchecked(&self, index: usize) -> bool
portable_simd #86656)Sourcepub fn test(&self, index: usize) -> bool
🔬This is a nightly-only experimental API. (portable_simd #86656)
pub fn test(&self, index: usize) -> bool
portable_simd #86656)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 #86656)
pub unsafe fn set_unchecked(&mut self, index: usize, value: bool)
portable_simd #86656)Sourcepub fn set(&mut self, index: usize, value: bool)
🔬This is a nightly-only experimental API. (portable_simd #86656)
pub fn set(&mut self, index: usize, value: bool)
portable_simd #86656)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 #86656)
pub fn any(self) -> bool
portable_simd #86656)Returns true if any element is set, or false otherwise.
Sourcepub fn all(self) -> bool
🔬This is a nightly-only experimental API. (portable_simd #86656)
pub fn all(self) -> bool
portable_simd #86656)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 #86656)
pub fn to_bitmask(self) -> u64
portable_simd #86656)Creates a bitmask from a mask.
Each bit is set if the corresponding element in the mask is true.
If the mask contains more than 64 elements, the bitmask is truncated to the first 64.
Sourcepub fn from_bitmask(bitmask: u64) -> Self
🔬This is a nightly-only experimental API. (portable_simd #86656)
pub fn from_bitmask(bitmask: u64) -> Self
portable_simd #86656)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.
Source§impl<T, const N: usize> Mask<T, N>
impl<T, const N: usize> Mask<T, N>
Sourcepub fn select<U>(
self,
true_values: Simd<U, N>,
false_values: Simd<U, N>,
) -> Simd<U, N>where
U: SimdElement<Mask = T>,
🔬This is a nightly-only experimental API. (portable_simd #86656)
pub fn select<U>(
self,
true_values: Simd<U, N>,
false_values: Simd<U, N>,
) -> Simd<U, N>where
U: SimdElement<Mask = T>,
portable_simd #86656)Choose elements from two vectors.
For each element in the mask, choose the corresponding element from true_values if
that element mask is true, and false_values if that element mask is false.
§Examples
Sourcepub fn select_mask(self, true_values: Self, false_values: Self) -> Self
🔬This is a nightly-only experimental API. (portable_simd #86656)
pub fn select_mask(self, true_values: Self, false_values: Self) -> Self
portable_simd #86656)Choose elements from two masks.
For each element in the mask, choose the corresponding element from true_values if
that element mask is true, and false_values if that element mask is false.
§Examples
Trait Implementations§
Source§impl<T, const N: usize> BitAndAssign<bool> for Mask<T, N>
impl<T, const N: usize> BitAndAssign<bool> for Mask<T, N>
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>
impl<T, const N: usize> BitAndAssign for Mask<T, N>
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>
impl<T, const N: usize> BitOrAssign<bool> for Mask<T, N>
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>
impl<T, const N: usize> BitOrAssign for Mask<T, N>
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>
impl<T, const N: usize> BitXorAssign<bool> for Mask<T, N>
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>
impl<T, const N: usize> BitXorAssign for Mask<T, N>
Source§fn bitxor_assign(&mut self, rhs: Self)
fn bitxor_assign(&mut self, rhs: Self)
^= operation. Read moreSource§impl<const N: usize> From<Mask<i16, N>> for Mask<i32, N>where
LaneCount<N>: SupportedLaneCount,
impl<const N: usize> From<Mask<i16, N>> for Mask<i32, N>where
LaneCount<N>: SupportedLaneCount,
Source§impl<const N: usize> From<Mask<i16, N>> for Mask<i64, N>where
LaneCount<N>: SupportedLaneCount,
impl<const N: usize> From<Mask<i16, N>> for Mask<i64, N>where
LaneCount<N>: SupportedLaneCount,
Source§impl<const N: usize> From<Mask<i16, N>> for Mask<i8, N>where
LaneCount<N>: SupportedLaneCount,
impl<const N: usize> From<Mask<i16, N>> for Mask<i8, N>where
LaneCount<N>: SupportedLaneCount,
Source§impl<const N: usize> From<Mask<i16, N>> for Mask<isize, N>where
LaneCount<N>: SupportedLaneCount,
impl<const N: usize> From<Mask<i16, N>> for Mask<isize, N>where
LaneCount<N>: SupportedLaneCount,
Source§impl<const N: usize> From<Mask<i32, N>> for Mask<i16, N>where
LaneCount<N>: SupportedLaneCount,
impl<const N: usize> From<Mask<i32, N>> for Mask<i16, N>where
LaneCount<N>: SupportedLaneCount,
Source§impl<const N: usize> From<Mask<i32, N>> for Mask<i64, N>where
LaneCount<N>: SupportedLaneCount,
impl<const N: usize> From<Mask<i32, N>> for Mask<i64, N>where
LaneCount<N>: SupportedLaneCount,
Source§impl<const N: usize> From<Mask<i32, N>> for Mask<i8, N>where
LaneCount<N>: SupportedLaneCount,
impl<const N: usize> From<Mask<i32, N>> for Mask<i8, N>where
LaneCount<N>: SupportedLaneCount,
Source§impl<const N: usize> From<Mask<i32, N>> for Mask<isize, N>where
LaneCount<N>: SupportedLaneCount,
impl<const N: usize> From<Mask<i32, N>> for Mask<isize, N>where
LaneCount<N>: SupportedLaneCount,
Source§impl<const N: usize> From<Mask<i64, N>> for Mask<i16, N>where
LaneCount<N>: SupportedLaneCount,
impl<const N: usize> From<Mask<i64, N>> for Mask<i16, N>where
LaneCount<N>: SupportedLaneCount,
Source§impl<const N: usize> From<Mask<i64, N>> for Mask<i32, N>where
LaneCount<N>: SupportedLaneCount,
impl<const N: usize> From<Mask<i64, N>> for Mask<i32, N>where
LaneCount<N>: SupportedLaneCount,
Source§impl<const N: usize> From<Mask<i64, N>> for Mask<i8, N>where
LaneCount<N>: SupportedLaneCount,
impl<const N: usize> From<Mask<i64, N>> for Mask<i8, N>where
LaneCount<N>: SupportedLaneCount,
Source§impl<const N: usize> From<Mask<i64, N>> for Mask<isize, N>where
LaneCount<N>: SupportedLaneCount,
impl<const N: usize> From<Mask<i64, N>> for Mask<isize, N>where
LaneCount<N>: SupportedLaneCount,
Source§impl<const N: usize> From<Mask<i8, N>> for Mask<i16, N>where
LaneCount<N>: SupportedLaneCount,
impl<const N: usize> From<Mask<i8, N>> for Mask<i16, N>where
LaneCount<N>: SupportedLaneCount,
Source§impl<const N: usize> From<Mask<i8, N>> for Mask<i32, N>where
LaneCount<N>: SupportedLaneCount,
impl<const N: usize> From<Mask<i8, N>> for Mask<i32, N>where
LaneCount<N>: SupportedLaneCount,
Source§impl<const N: usize> From<Mask<i8, N>> for Mask<i64, N>where
LaneCount<N>: SupportedLaneCount,
impl<const N: usize> From<Mask<i8, N>> for Mask<i64, N>where
LaneCount<N>: SupportedLaneCount,
Source§impl<const N: usize> From<Mask<i8, N>> for Mask<isize, N>where
LaneCount<N>: SupportedLaneCount,
impl<const N: usize> From<Mask<i8, N>> for Mask<isize, N>where
LaneCount<N>: SupportedLaneCount,
Source§impl<const N: usize> From<Mask<isize, N>> for Mask<i16, N>where
LaneCount<N>: SupportedLaneCount,
impl<const N: usize> From<Mask<isize, N>> for Mask<i16, N>where
LaneCount<N>: SupportedLaneCount,
Source§impl<const N: usize> From<Mask<isize, N>> for Mask<i32, N>where
LaneCount<N>: SupportedLaneCount,
impl<const N: usize> From<Mask<isize, N>> for Mask<i32, N>where
LaneCount<N>: SupportedLaneCount,
Source§impl<const N: usize> From<Mask<isize, N>> for Mask<i64, N>where
LaneCount<N>: SupportedLaneCount,
impl<const N: usize> From<Mask<isize, N>> for Mask<i64, N>where
LaneCount<N>: SupportedLaneCount,
Source§impl<const N: usize> From<Mask<isize, N>> for Mask<i8, N>where
LaneCount<N>: SupportedLaneCount,
impl<const N: usize> From<Mask<isize, N>> for Mask<i8, N>where
LaneCount<N>: SupportedLaneCount,
Source§impl<T, const N: usize> PartialOrd for Mask<T, N>
impl<T, const N: usize> PartialOrd for Mask<T, N>
Source§impl<const N: usize> SimdOrd for Mask<i16, N>where
LaneCount<N>: SupportedLaneCount,
impl<const N: usize> SimdOrd for Mask<i16, N>where
LaneCount<N>: SupportedLaneCount,
Source§fn simd_max(self, other: Self) -> Self
fn simd_max(self, other: Self) -> Self
portable_simd #86656)other.Source§fn simd_min(self, other: Self) -> Self
fn simd_min(self, other: Self) -> Self
portable_simd #86656)other.Source§fn simd_clamp(self, min: Self, max: Self) -> Self
fn simd_clamp(self, min: Self, max: Self) -> Self
portable_simd #86656)Source§impl<const N: usize> SimdOrd for Mask<i32, N>where
LaneCount<N>: SupportedLaneCount,
impl<const N: usize> SimdOrd for Mask<i32, N>where
LaneCount<N>: SupportedLaneCount,
Source§fn simd_max(self, other: Self) -> Self
fn simd_max(self, other: Self) -> Self
portable_simd #86656)other.Source§fn simd_min(self, other: Self) -> Self
fn simd_min(self, other: Self) -> Self
portable_simd #86656)other.Source§fn simd_clamp(self, min: Self, max: Self) -> Self
fn simd_clamp(self, min: Self, max: Self) -> Self
portable_simd #86656)Source§impl<const N: usize> SimdOrd for Mask<i64, N>where
LaneCount<N>: SupportedLaneCount,
impl<const N: usize> SimdOrd for Mask<i64, N>where
LaneCount<N>: SupportedLaneCount,
Source§fn simd_max(self, other: Self) -> Self
fn simd_max(self, other: Self) -> Self
portable_simd #86656)other.Source§fn simd_min(self, other: Self) -> Self
fn simd_min(self, other: Self) -> Self
portable_simd #86656)other.Source§fn simd_clamp(self, min: Self, max: Self) -> Self
fn simd_clamp(self, min: Self, max: Self) -> Self
portable_simd #86656)Source§impl<const N: usize> SimdOrd for Mask<i8, N>where
LaneCount<N>: SupportedLaneCount,
impl<const N: usize> SimdOrd for Mask<i8, N>where
LaneCount<N>: SupportedLaneCount,
Source§fn simd_max(self, other: Self) -> Self
fn simd_max(self, other: Self) -> Self
portable_simd #86656)other.Source§fn simd_min(self, other: Self) -> Self
fn simd_min(self, other: Self) -> Self
portable_simd #86656)other.Source§fn simd_clamp(self, min: Self, max: Self) -> Self
fn simd_clamp(self, min: Self, max: Self) -> Self
portable_simd #86656)Source§impl<const N: usize> SimdOrd for Mask<isize, N>where
LaneCount<N>: SupportedLaneCount,
impl<const N: usize> SimdOrd for Mask<isize, N>where
LaneCount<N>: SupportedLaneCount,
Source§fn simd_max(self, other: Self) -> Self
fn simd_max(self, other: Self) -> Self
portable_simd #86656)other.Source§fn simd_min(self, other: Self) -> Self
fn simd_min(self, other: Self) -> Self
portable_simd #86656)other.Source§fn simd_clamp(self, min: Self, max: Self) -> Self
fn simd_clamp(self, min: Self, max: Self) -> Self
portable_simd #86656)Source§impl<const N: usize> SimdPartialEq for Mask<i16, N>where
LaneCount<N>: SupportedLaneCount,
impl<const N: usize> SimdPartialEq for Mask<i16, N>where
LaneCount<N>: SupportedLaneCount,
Source§type Mask = Mask<i16, N>
type Mask = Mask<i16, N>
portable_simd #86656)Source§impl<const N: usize> SimdPartialEq for Mask<i32, N>where
LaneCount<N>: SupportedLaneCount,
impl<const N: usize> SimdPartialEq for Mask<i32, N>where
LaneCount<N>: SupportedLaneCount,
Source§type Mask = Mask<i32, N>
type Mask = Mask<i32, N>
portable_simd #86656)Source§impl<const N: usize> SimdPartialEq for Mask<i64, N>where
LaneCount<N>: SupportedLaneCount,
impl<const N: usize> SimdPartialEq for Mask<i64, N>where
LaneCount<N>: SupportedLaneCount,
Source§type Mask = Mask<i64, N>
type Mask = Mask<i64, N>
portable_simd #86656)Source§impl<const N: usize> SimdPartialEq for Mask<i8, N>where
LaneCount<N>: SupportedLaneCount,
impl<const N: usize> SimdPartialEq for Mask<i8, N>where
LaneCount<N>: SupportedLaneCount,
Source§type Mask = Mask<i8, N>
type Mask = Mask<i8, N>
portable_simd #86656)Source§impl<const N: usize> SimdPartialEq for Mask<isize, N>where
LaneCount<N>: SupportedLaneCount,
impl<const N: usize> SimdPartialEq for Mask<isize, N>where
LaneCount<N>: SupportedLaneCount,
Source§type Mask = Mask<isize, N>
type Mask = Mask<isize, N>
portable_simd #86656)Source§impl<const N: usize> SimdPartialOrd for Mask<i16, N>where
LaneCount<N>: SupportedLaneCount,
impl<const N: usize> SimdPartialOrd for Mask<i16, N>where
LaneCount<N>: SupportedLaneCount,
Source§fn simd_lt(self, other: Self) -> Self::Mask
fn simd_lt(self, other: Self) -> Self::Mask
portable_simd #86656)other.Source§fn simd_le(self, other: Self) -> Self::Mask
fn simd_le(self, other: Self) -> Self::Mask
portable_simd #86656)other.Source§impl<const N: usize> SimdPartialOrd for Mask<i32, N>where
LaneCount<N>: SupportedLaneCount,
impl<const N: usize> SimdPartialOrd for Mask<i32, N>where
LaneCount<N>: SupportedLaneCount,
Source§fn simd_lt(self, other: Self) -> Self::Mask
fn simd_lt(self, other: Self) -> Self::Mask
portable_simd #86656)other.Source§fn simd_le(self, other: Self) -> Self::Mask
fn simd_le(self, other: Self) -> Self::Mask
portable_simd #86656)other.Source§impl<const N: usize> SimdPartialOrd for Mask<i64, N>where
LaneCount<N>: SupportedLaneCount,
impl<const N: usize> SimdPartialOrd for Mask<i64, N>where
LaneCount<N>: SupportedLaneCount,
Source§fn simd_lt(self, other: Self) -> Self::Mask
fn simd_lt(self, other: Self) -> Self::Mask
portable_simd #86656)other.Source§fn simd_le(self, other: Self) -> Self::Mask
fn simd_le(self, other: Self) -> Self::Mask
portable_simd #86656)other.Source§impl<const N: usize> SimdPartialOrd for Mask<i8, N>where
LaneCount<N>: SupportedLaneCount,
impl<const N: usize> SimdPartialOrd for Mask<i8, N>where
LaneCount<N>: SupportedLaneCount,
Source§fn simd_lt(self, other: Self) -> Self::Mask
fn simd_lt(self, other: Self) -> Self::Mask
portable_simd #86656)other.Source§fn simd_le(self, other: Self) -> Self::Mask
fn simd_le(self, other: Self) -> Self::Mask
portable_simd #86656)other.Source§impl<const N: usize> SimdPartialOrd for Mask<isize, N>where
LaneCount<N>: SupportedLaneCount,
impl<const N: usize> SimdPartialOrd for Mask<isize, N>where
LaneCount<N>: SupportedLaneCount,
Source§fn simd_lt(self, other: Self) -> Self::Mask
fn simd_lt(self, other: Self) -> Self::Mask
portable_simd #86656)other.Source§fn simd_le(self, other: Self) -> Self::Mask
fn simd_le(self, other: Self) -> Self::Mask
portable_simd #86656)other.