Struct simba::simd::SimdOption

pub struct SimdOption<V: SimdValue> { /* fields omitted */ }

Generalization of Option for SIMD computation.

Implementations

impl<V: SimdValue> SimdOption<V>

pub fn new(val: V, mask: V::SimdBool) -> Self

Creates a new SIMD option by combining a value and a mask indicating what lane of the value is valid.

pub fn mask(&self) -> V::SimdBool

Return the underlying SIMD boolean mask.

pub fn value(&self) -> &V

Return the underlying unfiltered value.

pub fn option(self) -> Option<V>

Converts this SIMD option to a strandard Option.

If all the bits of self.mask are 1, then this returns Some(self.value()). If any bit of self.mask is 0, then this returns None.

pub fn simd_unwrap(self) -> V

Retrieve the underlying value if all the bits of self.mask are 1.

Panics if any of the bits of self.mask is 0.

pub fn simd_unwrap_or(self, other: impl FnOnce() -> V) -> V

Merges the value of self with the value of other.

Each lane of the result with a corresponding bit mask set to 1 will be filled with the corresponding lanes of self.value(). The lanes of the result with a corresponding bit mask set to 0 will be filled with the corresponding lanes of other().

The function in other should not do any side-effect. Indeed, implementors of this trait are free to decide in what cases other is called or not.