Type Alias mask8x16 

pub type mask8x16 = Mask<i8, 16>;

🔬This is a nightly-only experimental API. (portable_simd #86656)

A SIMD mask with 16 elements for vectors with 8-bit element types.

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 [i8; 16].

Aliased Type

struct mask8x16(/* private fields */);

Implementations

impl<T, const N: usize> Mask<T, N>

where T: MaskElement, LaneCount<N>: SupportedLaneCount,

pub fn splat(value: bool) -> Mask<T, N>

🔬This is a nightly-only experimental API. (portable_simd #86656)

Constructs a mask by setting all elements to the given value.

pub fn from_array(array: [bool; N]) -> Mask<T, N>

🔬This is a nightly-only experimental API. (portable_simd #86656)

Converts an array of bools to a SIMD mask.

pub fn to_array(self) -> [bool; N]

🔬This is a nightly-only experimental API. (portable_simd #86656)

Converts a SIMD mask to an array of bools.

pub unsafe fn from_int_unchecked(value: Simd<T, N>) -> Mask<T, N>

🔬This is a nightly-only experimental API. (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.

pub fn from_int(value: Simd<T, N>) -> Mask<T, N>

🔬This is a nightly-only experimental API. (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.

pub fn to_int(self) -> Simd<T, N>

🔬This is a nightly-only experimental API. (portable_simd #86656)

Converts the mask to a vector of integers, where 0 represents false and -1 represents true.

pub fn cast<U>(self) -> Mask<U, N>

where U: MaskElement,

🔬This is a nightly-only experimental API. (portable_simd #86656)

Converts the mask to a mask of any other element size.

pub unsafe fn test_unchecked(&self, index: usize) -> bool

🔬This is a nightly-only experimental API. (portable_simd #86656)

Tests the value of the specified element.

Safety

index must be less than self.len().

pub fn test(&self, index: usize) -> bool

🔬This is a nightly-only experimental API. (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.

pub unsafe fn set_unchecked(&mut self, index: usize, value: bool)

🔬This is a nightly-only experimental API. (portable_simd #86656)

Sets the value of the specified element.

Safety

index must be less than self.len().

pub fn set(&mut self, index: usize, value: bool)

🔬This is a nightly-only experimental API. (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.

pub fn any(self) -> bool

🔬This is a nightly-only experimental API. (portable_simd #86656)

Returns true if any element is set, or false otherwise.

pub fn all(self) -> bool

🔬This is a nightly-only experimental API. (portable_simd #86656)

Returns true if all elements are set, or false otherwise.

pub fn to_bitmask(self) -> u64

🔬This is a nightly-only experimental API. (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.

pub fn from_bitmask(bitmask: u64) -> Mask<T, N>

🔬This is a nightly-only experimental API. (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.

pub fn to_bitmask_vector(self) -> Simd<u8, N>

🔬This is a nightly-only experimental API. (portable_simd #86656)

Creates a bitmask vector from a mask.

Each bit is set if the corresponding element in the mask is true. The remaining bits are unset.

The bits are packed into the first N bits of the vector:

let mask = mask32x8::from_array([true, false, true, false, false, false, true, false]);
assert_eq!(mask.to_bitmask_vector()[0], 0b01000101);

pub fn from_bitmask_vector(bitmask: Simd<u8, N>) -> Mask<T, N>

🔬This is a nightly-only experimental API. (portable_simd #86656)

Creates a mask from a bitmask vector.

For each bit, if it is set, the corresponding element in the mask is set to true.

The bits are packed into the first N bits of the vector:

let bitmask = u8x8::from_array([0b01000101, 0, 0, 0, 0, 0, 0, 0]);
assert_eq!(
    mask32x8::from_bitmask_vector(bitmask),
    mask32x8::from_array([true, false, true, false, false, false, true, false]),
);

pub fn first_set(self) -> Option<usize>

🔬This is a nightly-only experimental API. (portable_simd #86656)

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));

impl<T, const N: usize> Mask<T, N>

where T: MaskElement, LaneCount<N>: SupportedLaneCount,

pub 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)

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

let a = Simd::from_array([0, 1, 2, 3]);
let b = Simd::from_array([4, 5, 6, 7]);
let mask = Mask::from_array([true, false, false, true]);
let c = mask.select(a, b);
assert_eq!(c.to_array(), [0, 5, 6, 3]);

pub fn select_mask( self, true_values: Mask<T, N>, false_values: Mask<T, N>, ) -> Mask<T, N>

🔬This is a nightly-only experimental API. (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

let a = Mask::<i32, 4>::from_array([true, true, false, false]);
let b = Mask::<i32, 4>::from_array([false, false, true, true]);
let mask = Mask::<i32, 4>::from_array([true, false, false, true]);
let c = mask.select_mask(a, b);
assert_eq!(c.to_array(), [true, false, true, false]);

Trait Implementations

impl<T, const N: usize> BitAnd<bool> for Mask<T, N>

where T: MaskElement, LaneCount<N>: SupportedLaneCount,

type Output = Mask<T, N>

The resulting type after applying the & operator.

fn bitand(self, rhs: bool) -> Mask<T, N>

Performs the & operation.

impl<T, const N: usize> BitAnd for Mask<T, N>

where T: MaskElement, LaneCount<N>: SupportedLaneCount,

type Output = Mask<T, N>

The resulting type after applying the & operator.

fn bitand(self, rhs: Mask<T, N>) -> Mask<T, N>

Performs the & operation.

impl<T, const N: usize> BitAndAssign<bool> for Mask<T, N>

where T: MaskElement, LaneCount<N>: SupportedLaneCount,

fn bitand_assign(&mut self, rhs: bool)

Performs the &= operation.

impl<T, const N: usize> BitAndAssign for Mask<T, N>

where T: MaskElement, LaneCount<N>: SupportedLaneCount,

fn bitand_assign(&mut self, rhs: Mask<T, N>)

Performs the &= operation.

impl<T, const N: usize> BitOr<bool> for Mask<T, N>

where T: MaskElement, LaneCount<N>: SupportedLaneCount,

type Output = Mask<T, N>

The resulting type after applying the | operator.

fn bitor(self, rhs: bool) -> Mask<T, N>

Performs the | operation.

impl<T, const N: usize> BitOr for Mask<T, N>

where T: MaskElement, LaneCount<N>: SupportedLaneCount,

type Output = Mask<T, N>

The resulting type after applying the | operator.

fn bitor(self, rhs: Mask<T, N>) -> Mask<T, N>

Performs the | operation.

impl<T, const N: usize> BitOrAssign<bool> for Mask<T, N>

where T: MaskElement, LaneCount<N>: SupportedLaneCount,

fn bitor_assign(&mut self, rhs: bool)

Performs the |= operation.

impl<T, const N: usize> BitOrAssign for Mask<T, N>

where T: MaskElement, LaneCount<N>: SupportedLaneCount,

fn bitor_assign(&mut self, rhs: Mask<T, N>)

Performs the |= operation.

impl<T, const N: usize> BitXor<bool> for Mask<T, N>

where T: MaskElement, LaneCount<N>: SupportedLaneCount,

type Output = Mask<T, N>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: bool) -> <Mask<T, N> as BitXor<bool>>::Output

Performs the ^ operation.

impl<T, const N: usize> BitXor for Mask<T, N>

where T: MaskElement, LaneCount<N>: SupportedLaneCount,

type Output = Mask<T, N>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Mask<T, N>) -> <Mask<T, N> as BitXor>::Output

Performs the ^ operation.

impl<T, const N: usize> BitXorAssign<bool> for Mask<T, N>

where T: MaskElement, LaneCount<N>: SupportedLaneCount,

fn bitxor_assign(&mut self, rhs: bool)

Performs the ^= operation.

impl<T, const N: usize> BitXorAssign for Mask<T, N>

where T: MaskElement, LaneCount<N>: SupportedLaneCount,

fn bitxor_assign(&mut self, rhs: Mask<T, N>)

Performs the ^= operation.

impl<T, const N: usize> Clone for Mask<T, N>

where T: MaskElement, LaneCount<N>: SupportedLaneCount,

fn clone(&self) -> Mask<T, N>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T, const N: usize> Debug for Mask<T, N>

where T: MaskElement + Debug, LaneCount<N>: SupportedLaneCount,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<T, const N: usize> Default for Mask<T, N>

where T: MaskElement, LaneCount<N>: SupportedLaneCount,

fn default() -> Mask<T, N>

Returns the “default value” for a type.

impl<T, const N: usize> From<[bool; N]> for Mask<T, N>

where T: MaskElement, LaneCount<N>: SupportedLaneCount,

fn from(array: [bool; N]) -> Mask<T, N>

Converts to this type from the input type.

impl<const N: usize> From<Mask<i16, N>> for Mask<i8, N>

where LaneCount<N>: SupportedLaneCount,

fn from(value: Mask<i16, N>) -> Mask<i8, N>

Converts to this type from the input type.

impl<const N: usize> From<Mask<i32, N>> for Mask<i8, N>

where LaneCount<N>: SupportedLaneCount,

fn from(value: Mask<i32, N>) -> Mask<i8, N>

Converts to this type from the input type.

impl<const N: usize> From<Mask<i64, N>> for Mask<i8, N>

where LaneCount<N>: SupportedLaneCount,

fn from(value: Mask<i64, N>) -> Mask<i8, N>

Converts to this type from the input type.

impl<const N: usize> From<Mask<isize, N>> for Mask<i8, N>

where LaneCount<N>: SupportedLaneCount,

fn from(value: Mask<isize, N>) -> Mask<i8, N>

Converts to this type from the input type.

impl<T, const N: usize> Not for Mask<T, N>

where T: MaskElement, LaneCount<N>: SupportedLaneCount,

type Output = Mask<T, N>

The resulting type after applying the ! operator.

fn not(self) -> <Mask<T, N> as Not>::Output

Performs the unary ! operation.

impl<T, const N: usize> PartialEq for Mask<T, N>

where T: MaskElement + PartialEq, LaneCount<N>: SupportedLaneCount,

fn eq(&self, other: &Mask<T, N>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T, const N: usize> PartialOrd for Mask<T, N>

where T: MaskElement + PartialOrd, LaneCount<N>: SupportedLaneCount,

fn partial_cmp(&self, other: &Mask<T, N>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<const N: usize> SimdOrd for Mask<i8, N>

where LaneCount<N>: SupportedLaneCount,

fn simd_max(self, other: Mask<i8, N>) -> Mask<i8, N>

🔬This is a nightly-only experimental API. (portable_simd #86656)

Returns the element-wise maximum with other.

fn simd_min(self, other: Mask<i8, N>) -> Mask<i8, N>

🔬This is a nightly-only experimental API. (portable_simd #86656)

Returns the element-wise minimum with other.

fn simd_clamp(self, min: Mask<i8, N>, max: Mask<i8, N>) -> Mask<i8, N>

🔬This is a nightly-only experimental API. (portable_simd #86656)

Restrict each element to a certain interval.

impl<const N: usize> SimdPartialEq for Mask<i8, N>

where LaneCount<N>: SupportedLaneCount,

type Mask = Mask<i8, N>

🔬This is a nightly-only experimental API. (portable_simd #86656)

The mask type returned by each comparison.

fn simd_eq(self, other: Mask<i8, N>) -> <Mask<i8, N> as SimdPartialEq>::Mask

🔬This is a nightly-only experimental API. (portable_simd #86656)

Test if each element is equal to the corresponding element in other.

fn simd_ne(self, other: Mask<i8, N>) -> <Mask<i8, N> as SimdPartialEq>::Mask

🔬This is a nightly-only experimental API. (portable_simd #86656)

Test if each element is equal to the corresponding element in other.

impl<const N: usize> SimdPartialOrd for Mask<i8, N>

where LaneCount<N>: SupportedLaneCount,

fn simd_lt(self, other: Mask<i8, N>) -> <Mask<i8, N> as SimdPartialEq>::Mask

🔬This is a nightly-only experimental API. (portable_simd #86656)

Test if each element is less than the corresponding element in other.

fn simd_le(self, other: Mask<i8, N>) -> <Mask<i8, N> as SimdPartialEq>::Mask

🔬This is a nightly-only experimental API. (portable_simd #86656)

Test if each element is less than or equal to the corresponding element in other.

fn simd_gt(self, other: Mask<i8, N>) -> <Mask<i8, N> as SimdPartialEq>::Mask

🔬This is a nightly-only experimental API. (portable_simd #86656)

Test if each element is greater than the corresponding element in other.

fn simd_ge(self, other: Mask<i8, N>) -> <Mask<i8, N> as SimdPartialEq>::Mask

🔬This is a nightly-only experimental API. (portable_simd #86656)

Test if each element is greater than or equal to the corresponding element in other.

impl<T, const N: usize> Copy for Mask<T, N>

where T: MaskElement, LaneCount<N>: SupportedLaneCount,