Struct Mask

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

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

Tuple Fields

0: Simd<T, N>

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

Implementations

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

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

pub(crate) fn splat(value: bool) -> Self

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

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

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

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

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

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

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

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

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

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

where U: MaskElement,

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

unsafe fn to_bitmask_impl<U: ReverseBits, const M: usize>(self) -> U

where LaneCount<M>: SupportedLaneCount,

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

unsafe fn from_bitmask_impl<U: ReverseBits, const M: usize>(bitmask: U) -> Self

where LaneCount<M>: SupportedLaneCount,

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

pub(crate) fn to_bitmask_integer(self) -> u64

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

pub(crate) fn from_bitmask_integer(bitmask: u64) -> Self

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

pub(crate) fn any(self) -> bool

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

pub(crate) fn all(self) -> bool

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

Trait Implementations

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: Self) -> Self

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: Self) -> Self

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: Self) -> Self

Performs the ^ operation.

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

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

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

#[doc(hidden)] fn assert_receiver_is_total_eq(&self)

impl<T, const N: usize> From<Mask<T, N>> for Simd<T, N>

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

fn from(value: Mask<T, N>) -> Self

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) -> Self::Output

Performs the unary ! operation.

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

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

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

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

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

fn eq(&self, other: &Self) -> 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: &Self) -> 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.

#[doc(hidden)] fn __chaining_lt(&self, other: &Rhs) -> ControlFlow<bool>

🔬This is a nightly-only experimental API. (partial_ord_chaining_methods)

If self == other, returns ControlFlow::Continue(()). Otherwise, returns ControlFlow::Break(self < other).

#[doc(hidden)] fn __chaining_le(&self, other: &Rhs) -> ControlFlow<bool>

🔬This is a nightly-only experimental API. (partial_ord_chaining_methods)

Same as __chaining_lt, but for <= instead of <.

#[doc(hidden)] fn __chaining_gt(&self, other: &Rhs) -> ControlFlow<bool>

🔬This is a nightly-only experimental API. (partial_ord_chaining_methods)

Same as __chaining_lt, but for > instead of <.

#[doc(hidden)] fn __chaining_ge(&self, other: &Rhs) -> ControlFlow<bool>

🔬This is a nightly-only experimental API. (partial_ord_chaining_methods)

Same as __chaining_lt, but for >= instead of <.

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

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