Struct std::simd::Mask

#[repr(transparent)]
pub struct Mask<T, const LANES: usize>(_) 
where
    T: MaskElement,
    LaneCount<LANES>: SupportedLaneCount;

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

A SIMD vector mask for LANES elements of width specified by Element.

The layout of this type is unspecified.

Implementations

impl<T, const LANES: usize> Mask<T, LANES> where
    T: MaskElement,
    LaneCount<LANES>: SupportedLaneCount, 

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

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

Construct a mask by setting all lanes to the given value.

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

🔬 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; LANES]

🔬 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, LANES>) -> Mask<T, LANES>

🔬 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 lanes must be either 0 or -1.

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

🔬 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 lane is not 0 or -1.

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

🔬 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 unsafe fn test_unchecked(&self, lane: usize) -> bool

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

Tests the value of the specified lane.

Safety

lane must be less than LANES.

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

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

Tests the value of the specified lane.

Panics

Panics if lane is greater than or equal to the number of lanes in the vector.

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

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

Sets the value of the specified lane.

Safety

lane must be less than LANES.

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

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

Sets the value of the specified lane.

Panics

Panics if lane is greater than or equal to the number of lanes in the vector.

pub fn any(self) -> bool

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

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

pub fn all(self) -> bool

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

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

impl<T, const LANES: usize> Mask<T, LANES> where
    T: MaskElement,
    LaneCount<LANES>: SupportedLaneCount, 

pub fn select<U>(
    self,
    true_values: Simd<U, LANES>,
    false_values: Simd<U, LANES>
) -> Simd<U, LANES> where
    U: SimdElement<Mask = T>, 

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

Choose lanes from two vectors.

For each lane in the mask, choose the corresponding lane from true_values if that lane mask is true, and false_values if that lane 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, LANES>,
    false_values: Mask<T, LANES>
) -> Mask<T, LANES>

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

Choose lanes from two masks.

For each lane in the mask, choose the corresponding lane from true_values if that lane mask is true, and false_values if that lane 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 LANES: usize> BitAnd<Mask<T, LANES>> for Mask<T, LANES> where
    T: MaskElement,
    LaneCount<LANES>: SupportedLaneCount, 

type Output = Mask<T, LANES>

The resulting type after applying the & operator.

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

Performs the & operation.

impl<T, const LANES: usize> BitAnd<Mask<T, LANES>> for bool where
    T: MaskElement,
    LaneCount<LANES>: SupportedLaneCount, 

type Output = Mask<T, LANES>

The resulting type after applying the & operator.

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

Performs the & operation.

impl<T, const LANES: usize> BitAnd<bool> for Mask<T, LANES> where
    T: MaskElement,
    LaneCount<LANES>: SupportedLaneCount, 

type Output = Mask<T, LANES>

The resulting type after applying the & operator.

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

Performs the & operation.

impl<T, const LANES: usize> BitAndAssign<Mask<T, LANES>> for Mask<T, LANES> where
    T: MaskElement,
    LaneCount<LANES>: SupportedLaneCount, 

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

Performs the &= operation.

impl<T, const LANES: usize> BitAndAssign<bool> for Mask<T, LANES> where
    T: MaskElement,
    LaneCount<LANES>: SupportedLaneCount, 

fn bitand_assign(&mut self, rhs: bool)

Performs the &= operation.

impl<T, const LANES: usize> BitOr<Mask<T, LANES>> for bool where
    T: MaskElement,
    LaneCount<LANES>: SupportedLaneCount, 

type Output = Mask<T, LANES>

The resulting type after applying the | operator.

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

Performs the | operation.

impl<T, const LANES: usize> BitOr<Mask<T, LANES>> for Mask<T, LANES> where
    T: MaskElement,
    LaneCount<LANES>: SupportedLaneCount, 

type Output = Mask<T, LANES>

The resulting type after applying the | operator.

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

Performs the | operation.

impl<T, const LANES: usize> BitOr<bool> for Mask<T, LANES> where
    T: MaskElement,
    LaneCount<LANES>: SupportedLaneCount, 

type Output = Mask<T, LANES>

The resulting type after applying the | operator.

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

Performs the | operation.

impl<T, const LANES: usize> BitOrAssign<Mask<T, LANES>> for Mask<T, LANES> where
    T: MaskElement,
    LaneCount<LANES>: SupportedLaneCount, 

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

Performs the |= operation.

impl<T, const LANES: usize> BitOrAssign<bool> for Mask<T, LANES> where
    T: MaskElement,
    LaneCount<LANES>: SupportedLaneCount, 

fn bitor_assign(&mut self, rhs: bool)

Performs the |= operation.

impl<T, const LANES: usize> BitXor<Mask<T, LANES>> for Mask<T, LANES> where
    T: MaskElement,
    LaneCount<LANES>: SupportedLaneCount, 

type Output = Mask<T, LANES>

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl<T, const LANES: usize> BitXor<Mask<T, LANES>> for bool where
    T: MaskElement,
    LaneCount<LANES>: SupportedLaneCount, 

type Output = Mask<T, LANES>

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl<T, const LANES: usize> BitXor<bool> for Mask<T, LANES> where
    T: MaskElement,
    LaneCount<LANES>: SupportedLaneCount, 

type Output = Mask<T, LANES>

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl<T, const LANES: usize> BitXorAssign<Mask<T, LANES>> for Mask<T, LANES> where
    T: MaskElement,
    LaneCount<LANES>: SupportedLaneCount, 

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

Performs the ^= operation.

impl<T, const LANES: usize> BitXorAssign<bool> for Mask<T, LANES> where
    T: MaskElement,
    LaneCount<LANES>: SupportedLaneCount, 

fn bitxor_assign(&mut self, rhs: bool)

Performs the ^= operation.

impl<T, const LANES: usize> Clone for Mask<T, LANES> where
    T: MaskElement,
    LaneCount<LANES>: SupportedLaneCount, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, const LANES: usize> Debug for Mask<T, LANES> where
    T: MaskElement + Debug,
    LaneCount<LANES>: SupportedLaneCount, 

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

Formats the value using the given formatter.

impl<T, const LANES: usize> Default for Mask<T, LANES> where
    T: MaskElement,
    LaneCount<LANES>: SupportedLaneCount, 

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

Returns the “default value” for a type.

impl<T, const LANES: usize> From<[bool; LANES]> for Mask<T, LANES> where
    T: MaskElement,
    LaneCount<LANES>: SupportedLaneCount, 

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

Converts to this type from the input type.

impl<T, const LANES: usize> From<Mask<T, LANES>> for [bool; LANES] where
    T: MaskElement,
    LaneCount<LANES>: SupportedLaneCount, 

fn from(vector: Mask<T, LANES>) -> [bool; LANES]

Converts to this type from the input type.

impl<const LANES: usize> From<Mask<i16, LANES>> for Mask<i32, LANES> where
    LaneCount<LANES>: SupportedLaneCount, 

fn from(value: Mask<i16, LANES>) -> Mask<i32, LANES>

Converts to this type from the input type.

impl<const LANES: usize> From<Mask<i16, LANES>> for Mask<isize, LANES> where
    LaneCount<LANES>: SupportedLaneCount, 

fn from(value: Mask<i16, LANES>) -> Mask<isize, LANES>

Converts to this type from the input type.

impl<const LANES: usize> From<Mask<i16, LANES>> for Mask<i64, LANES> where
    LaneCount<LANES>: SupportedLaneCount, 

fn from(value: Mask<i16, LANES>) -> Mask<i64, LANES>

Converts to this type from the input type.

impl<const LANES: usize> From<Mask<i16, LANES>> for Mask<i8, LANES> where
    LaneCount<LANES>: SupportedLaneCount, 

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

Converts to this type from the input type.

impl<const LANES: usize> From<Mask<i32, LANES>> for Mask<i16, LANES> where
    LaneCount<LANES>: SupportedLaneCount, 

fn from(value: Mask<i32, LANES>) -> Mask<i16, LANES>

Converts to this type from the input type.

impl<const LANES: usize> From<Mask<i32, LANES>> for Mask<i64, LANES> where
    LaneCount<LANES>: SupportedLaneCount, 

fn from(value: Mask<i32, LANES>) -> Mask<i64, LANES>

Converts to this type from the input type.

impl<const LANES: usize> From<Mask<i32, LANES>> for Mask<isize, LANES> where
    LaneCount<LANES>: SupportedLaneCount, 

fn from(value: Mask<i32, LANES>) -> Mask<isize, LANES>

Converts to this type from the input type.

impl<const LANES: usize> From<Mask<i32, LANES>> for Mask<i8, LANES> where
    LaneCount<LANES>: SupportedLaneCount, 

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

Converts to this type from the input type.

impl<const LANES: usize> From<Mask<i64, LANES>> for Mask<i8, LANES> where
    LaneCount<LANES>: SupportedLaneCount, 

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

Converts to this type from the input type.

impl<const LANES: usize> From<Mask<i64, LANES>> for Mask<isize, LANES> where
    LaneCount<LANES>: SupportedLaneCount, 

fn from(value: Mask<i64, LANES>) -> Mask<isize, LANES>

Converts to this type from the input type.

impl<const LANES: usize> From<Mask<i64, LANES>> for Mask<i32, LANES> where
    LaneCount<LANES>: SupportedLaneCount, 

fn from(value: Mask<i64, LANES>) -> Mask<i32, LANES>

Converts to this type from the input type.

impl<const LANES: usize> From<Mask<i64, LANES>> for Mask<i16, LANES> where
    LaneCount<LANES>: SupportedLaneCount, 

fn from(value: Mask<i64, LANES>) -> Mask<i16, LANES>

Converts to this type from the input type.

impl<const LANES: usize> From<Mask<i8, LANES>> for Mask<i16, LANES> where
    LaneCount<LANES>: SupportedLaneCount, 

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

Converts to this type from the input type.

impl<const LANES: usize> From<Mask<i8, LANES>> for Mask<i64, LANES> where
    LaneCount<LANES>: SupportedLaneCount, 

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

Converts to this type from the input type.

impl<const LANES: usize> From<Mask<i8, LANES>> for Mask<isize, LANES> where
    LaneCount<LANES>: SupportedLaneCount, 

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

Converts to this type from the input type.

impl<const LANES: usize> From<Mask<i8, LANES>> for Mask<i32, LANES> where
    LaneCount<LANES>: SupportedLaneCount, 

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

Converts to this type from the input type.

impl<const LANES: usize> From<Mask<isize, LANES>> for Mask<i32, LANES> where
    LaneCount<LANES>: SupportedLaneCount, 

fn from(value: Mask<isize, LANES>) -> Mask<i32, LANES>

Converts to this type from the input type.

impl<const LANES: usize> From<Mask<isize, LANES>> for Mask<i64, LANES> where
    LaneCount<LANES>: SupportedLaneCount, 

fn from(value: Mask<isize, LANES>) -> Mask<i64, LANES>

Converts to this type from the input type.

impl<const LANES: usize> From<Mask<isize, LANES>> for Mask<i16, LANES> where
    LaneCount<LANES>: SupportedLaneCount, 

fn from(value: Mask<isize, LANES>) -> Mask<i16, LANES>

Converts to this type from the input type.

impl<const LANES: usize> From<Mask<isize, LANES>> for Mask<i8, LANES> where
    LaneCount<LANES>: SupportedLaneCount, 

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

Converts to this type from the input type.

impl<T, const LANES: usize> Not for Mask<T, LANES> where
    T: MaskElement,
    LaneCount<LANES>: SupportedLaneCount, 

type Output = Mask<T, LANES>

The resulting type after applying the ! operator.

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

Performs the unary ! operation.

impl<T, const LANES: usize> PartialEq<Mask<T, LANES>> for Mask<T, LANES> where
    T: MaskElement + PartialEq<T>,
    LaneCount<LANES>: SupportedLaneCount, 

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl<T, const LANES: usize> PartialOrd<Mask<T, LANES>> for Mask<T, LANES> where
    T: MaskElement + PartialOrd<T>,
    LaneCount<LANES>: SupportedLaneCount, 

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<T> ToBitMask for Mask<T, 2_usize> where
    T: MaskElement, 

type BitMask = u8

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

The integer bitmask type.

fn to_bitmask(self) -> u8

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

Converts a mask to a bitmask.

fn from_bitmask(bitmask: u8) -> Mask<T, 2_usize>

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

Converts a bitmask to a mask.

impl<T> ToBitMask for Mask<T, 64_usize> where
    T: MaskElement, 

type BitMask = u64

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

The integer bitmask type.

fn to_bitmask(self) -> u64

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

Converts a mask to a bitmask.

fn from_bitmask(bitmask: u64) -> Mask<T, 64_usize>

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

Converts a bitmask to a mask.

impl<T> ToBitMask for Mask<T, 8_usize> where
    T: MaskElement, 

type BitMask = u8

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

The integer bitmask type.

fn to_bitmask(self) -> u8

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

Converts a mask to a bitmask.

fn from_bitmask(bitmask: u8) -> Mask<T, 8_usize>

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

Converts a bitmask to a mask.

impl<T> ToBitMask for Mask<T, 16_usize> where
    T: MaskElement, 

type BitMask = u16

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

The integer bitmask type.

fn to_bitmask(self) -> u16

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

Converts a mask to a bitmask.

fn from_bitmask(bitmask: u16) -> Mask<T, 16_usize>

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

Converts a bitmask to a mask.

impl<T> ToBitMask for Mask<T, 4_usize> where
    T: MaskElement, 

type BitMask = u8

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

The integer bitmask type.

fn to_bitmask(self) -> u8

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

Converts a mask to a bitmask.

fn from_bitmask(bitmask: u8) -> Mask<T, 4_usize>

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

Converts a bitmask to a mask.

impl<T> ToBitMask for Mask<T, 1_usize> where
    T: MaskElement, 

type BitMask = u8

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

The integer bitmask type.

fn to_bitmask(self) -> u8

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

Converts a mask to a bitmask.

fn from_bitmask(bitmask: u8) -> Mask<T, 1_usize>

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

Converts a bitmask to a mask.

impl<T> ToBitMask for Mask<T, 32_usize> where
    T: MaskElement, 

type BitMask = u32

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

The integer bitmask type.

fn to_bitmask(self) -> u32

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

Converts a mask to a bitmask.

fn from_bitmask(bitmask: u32) -> Mask<T, 32_usize>

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

Converts a bitmask to a mask.

impl<T, const LANES: usize> Copy for Mask<T, LANES> where
    T: MaskElement,
    LaneCount<LANES>: SupportedLaneCount,