Struct Mask Copy item path

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

pub fn reverse(self) -> Mask<T, N>

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

Available on crate feature std only.

Reverse the order of the elements in the mask.

pub fn rotate_elements_left<const OFFSET: usize>(self) -> Mask<T, N>

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

Available on crate feature std only.

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.

pub fn rotate_elements_right<const OFFSET: usize>(self) -> Mask<T, N>

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

Available on crate feature std only.

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.

pub fn shift_elements_left<const OFFSET: usize>( self, padding: bool, ) -> Mask<T, N>

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

Available on crate feature std only.

Shifts the mask elements to the left by OFFSET, filling in with padding from the right.

pub fn shift_elements_right<const OFFSET: usize>( self, padding: bool, ) -> Mask<T, N>

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

Available on crate feature std only.

Shifts the mask elements to the right by OFFSET, filling in with padding from the left.

pub fn interleave(self, other: Mask<T, N>) -> (Mask<T, N>, Mask<T, N>) ⓘ

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

Available on crate feature std only.

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

pub fn deinterleave(self, other: Mask<T, N>) -> (Mask<T, N>, Mask<T, N>) ⓘ

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

Available on crate feature std only.

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

pub fn resize<const M: usize>(self, value: bool) -> Mask<T, M>
where LaneCount<M>: SupportedLaneCount,

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

Available on crate feature std only.

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

pub fn extract<const START: usize, const LEN: usize>(self) -> Mask<T, LEN>
where LaneCount<LEN>: SupportedLaneCount,

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

Available on crate feature std only.

Extract a vector from another vector.

let x = mask32x4::from_array([false, true, true, false]);
assert_eq!(x.extract::<1, 2>().to_array(), [true, true]);

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)

Available on crate feature std only.

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)

Available on crate feature std only.

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)

Available on crate feature std only.

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)

Available on crate feature std only.

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)

Available on crate feature std only.

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)

Available on crate feature std only.

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

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

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

Available on crate feature std only.

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)

Available on crate feature std only.

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)

Available on crate feature std only.

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)

Available on crate feature std only.

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)

Available on crate feature std only.

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)

Available on crate feature std only.

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

pub fn all(self) -> bool

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

Available on crate feature std only.

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)

Available on crate feature std only.

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)

Available on crate feature std only.

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 first_set(self) -> Option<usize> ⓘ

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

Available on crate feature std only.

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

Available on crate feature std only.

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)

Available on crate feature std only.

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<Mask<T, N>> for bool
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. Read more

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. Read more

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. Read more

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. Read more

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. Read more

impl<T, const N: usize> BitOr<Mask<T, N>> for bool
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. Read more

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. Read more

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. Read more

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. Read more

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. Read more

impl<T, const N: usize> BitXor<Mask<T, N>> for bool
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>) -> <bool as BitXor<Mask<T, N>>>::Output

Performs the ^ operation. Read more

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. Read more

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. Read more

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. Read more

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. Read more

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

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

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

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. Read more

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. Read more

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<T, const N: usize> From<Mask<T, N>> for [bool; N]
where T: MaskElement, LaneCount<N>: SupportedLaneCount,

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

fn from(value: Mask<i16, N>) -> Mask<i64, 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<i16, N>> for Mask<isize, N>
where LaneCount<N>: SupportedLaneCount,

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

fn from(value: Mask<i32, N>) -> Mask<i64, 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<i32, N>> for Mask<isize, N>
where LaneCount<N>: SupportedLaneCount,

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

fn from(value: Mask<i64, N>) -> Mask<i32, 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<i64, N>> for Mask<isize, N>
where LaneCount<N>: SupportedLaneCount,

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

fn from(value: Mask<isize, N>) -> Mask<i64, 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. Read more

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 ==.

1.0.0 · Source§

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. Read more

1.0.0 · Source§

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

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

1.0.0 · Source§

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

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

1.0.0 · Source§

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

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

1.0.0 · Source§

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

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

impl<const N: usize> SimdOrd for Mask<i16, N>
where LaneCount<N>: SupportedLaneCount,

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

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

Returns the element-wise maximum with other.

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

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

Returns the element-wise minimum with other.

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

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

Restrict each element to a certain interval. Read more

impl<const N: usize> SimdOrd for Mask<i32, N>
where LaneCount<N>: SupportedLaneCount,

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

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

Returns the element-wise maximum with other.

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

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

Returns the element-wise minimum with other.

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

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

Restrict each element to a certain interval. Read more

impl<const N: usize> SimdOrd for Mask<i64, N>
where LaneCount<N>: SupportedLaneCount,

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

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

Returns the element-wise maximum with other.

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

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

Returns the element-wise minimum with other.

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

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

Restrict each element to a certain interval. Read more

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)

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)

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)

Restrict each element to a certain interval. Read more

impl<const N: usize> SimdOrd for Mask<isize, N>
where LaneCount<N>: SupportedLaneCount,

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

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

Returns the element-wise maximum with other.

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

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

Returns the element-wise minimum with other.

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

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

Restrict each element to a certain interval. Read more

impl<const N: usize> SimdPartialEq for Mask<i16, N>
where LaneCount<N>: SupportedLaneCount,

type Mask = Mask<i16, N>

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

The mask type returned by each comparison.

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

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

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

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

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

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

impl<const N: usize> SimdPartialEq for Mask<i32, N>
where LaneCount<N>: SupportedLaneCount,

type Mask = Mask<i32, N>

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

The mask type returned by each comparison.

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

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

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

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

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

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

impl<const N: usize> SimdPartialEq for Mask<i64, N>
where LaneCount<N>: SupportedLaneCount,

type Mask = Mask<i64, N>

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

The mask type returned by each comparison.

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

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

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

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

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

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

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)

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)

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)

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

impl<const N: usize> SimdPartialEq for Mask<isize, N>
where LaneCount<N>: SupportedLaneCount,

type Mask = Mask<isize, N>

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

The mask type returned by each comparison.

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

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

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

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

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

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

impl<const N: usize> SimdPartialOrd for Mask<i16, N>
where LaneCount<N>: SupportedLaneCount,

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

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

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

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

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

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

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

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

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

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

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

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

impl<const N: usize> SimdPartialOrd for Mask<i32, N>
where LaneCount<N>: SupportedLaneCount,

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

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

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

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

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

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

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

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

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

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

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

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

impl<const N: usize> SimdPartialOrd for Mask<i64, N>
where LaneCount<N>: SupportedLaneCount,

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

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

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

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

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

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

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

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

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

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

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

Test if each element is greater than or 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)

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)

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)

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)

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

impl<const N: usize> SimdPartialOrd for Mask<isize, N>
where LaneCount<N>: SupportedLaneCount,

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

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

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

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

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

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

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

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

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

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

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

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,

Auto Trait Implementations§

impl<T, const N: usize> UnwindSafe for Mask<T, N>
where T: UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> ByteSized for T

const BYTE_ALIGN: usize = _

The alignment of this type in bytes.

const BYTE_SIZE: usize = _

The size of this type in bytes.

fn byte_align(&self) -> usize

Returns the alignment of this type in bytes.

fn byte_size(&self) -> usize

Returns the size of this type in bytes. Read more

fn ptr_size_ratio(&self) -> [usize; 2]

Returns the size ratio between Ptr::BYTES and BYTE_SIZE. Read more

impl<T, R> Chain<R> for T
where T: ?Sized,

fn chain<F>(self, f: F) -> R
where F: FnOnce(Self) -> R, Self: Sized,

Chain a function which takes the parameter by value.

fn chain_ref<F>(&self, f: F) -> R
where F: FnOnce(&Self) -> R,

Chain a function which takes the parameter by shared reference.

fn chain_mut<F>(&mut self, f: F) -> R
where F: FnOnce(&mut Self) -> R,

Chain a function which takes the parameter by exclusive reference.

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

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

Performs copy-assignment from self to dest. Read more

impl<T> ExtAny for T
where T: Any + ?Sized,

fn type_id() -> TypeId

Returns the TypeId of Self. Read more

fn type_of(&self) -> TypeId

Returns the TypeId of self. Read more

fn type_name(&self) -> &'static str ⓘ

Returns the type name of self. Read more

fn type_is<T: 'static>(&self) -> bool

Returns true if Self is of type T. Read more

fn type_hash(&self) -> u64

Returns a deterministic hash of the TypeId of Self.

fn type_hash_with<H: Hasher>(&self, hasher: H) -> u64

Returns a deterministic hash of the TypeId of Self using a custom hasher.

fn as_any_ref(&self) -> &dyn Any
where Self: Sized,

Upcasts &self as &dyn Any. Read more

fn as_any_mut(&mut self) -> &mut dyn Any
where Self: Sized,

Upcasts &mut self as &mut dyn Any. Read more

fn as_any_box(self: Box<Self>) -> Box<dyn Any>
where Self: Sized,

Upcasts Box<self> as Box<dyn Any>. Read more

fn downcast_ref<T: 'static>(&self) -> Option<&T> ⓘ

Available on crate feature unsafe_layout only.

Returns some shared reference to the inner value if it is of type T. Read more

fn downcast_mut<T: 'static>(&mut self) -> Option<&mut T> ⓘ

Available on crate feature unsafe_layout only.

Returns some exclusive reference to the inner value if it is of type T. Read more

impl<T> ExtMem for T
where T: ?Sized,

const NEEDS_DROP: bool = _

Know whether dropping values of this type matters, in compile-time.

fn mem_align_of<T>() -> usize

Returns the minimum alignment of the type in bytes. Read more

fn mem_align_of_val(&self) -> usize

Returns the alignment of the pointed-to value in bytes. Read more

fn mem_size_of<T>() -> usize

Returns the size of a type in bytes. Read more

fn mem_size_of_val(&self) -> usize

Returns the size of the pointed-to value in bytes. Read more

fn mem_copy(&self) -> Self
where Self: Copy,

Bitwise-copies a value. Read more

fn mem_needs_drop(&self) -> bool

Returns true if dropping values of this type matters. Read more

fn mem_drop(self)
where Self: Sized,

Drops self by running its destructor. Read more

fn mem_forget(self)
where Self: Sized,

Forgets about self without running its destructor. Read more

fn mem_replace(&mut self, other: Self) -> Self
where Self: Sized,

Replaces self with other, returning the previous value of self. Read more

fn mem_take(&mut self) -> Self
where Self: Default,

Replaces self with its default value, returning the previous value of self. Read more

fn mem_swap(&mut self, other: &mut Self)
where Self: Sized,

Swaps the value of self and other without deinitializing either one. Read more

unsafe fn mem_zeroed<T>() -> T

Available on crate feature unsafe_layout only.

Returns the value of type T represented by the all-zero byte-pattern. Read more

unsafe fn mem_transmute_copy<Src, Dst>(src: &Src) -> Dst

Available on crate feature unsafe_layout only.

Returns the value of type T represented by the all-zero byte-pattern. Read more

fn mem_as_bytes(&self) -> &[u8] ⓘ
where Self: Sync + Unpin,

Available on crate feature unsafe_slice only.

View a Sync + Unpin self as &[u8]. Read more

fn mem_as_bytes_mut(&mut self) -> &mut [u8] ⓘ
where Self: Sync + Unpin,

Available on crate feature unsafe_slice only.

View a Sync + Unpin self as &mut [u8]. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<S> FromSample<S> for S

fn from_sample_(s: S) -> S

impl<T> Hook for T

fn hook_ref<F>(self, f: F) -> Self
where F: FnOnce(&Self),

Applies a function which takes the parameter by shared reference, and then returns the (possibly) modified owned value. Read more

fn hook_mut<F>(self, f: F) -> Self
where F: FnOnce(&mut Self),

Applies a function which takes the parameter by exclusive reference, and then returns the (possibly) modified owned value. Read more

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

fn into_sample(self) -> T

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> ToSample for T
where U: FromSample<T>,

fn to_sample_(self) -> U

impl<T, U> TryFrom for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error> ⓘ

Performs the conversion.

impl<T, U> TryInto for T
where U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, >::Error> ⓘ

Performs the conversion.

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,