Struct M128 

pub struct M128(/* private fields */);

128-bit underlier for the portable build — a transparent wrapper over u128.

On x86_64/aarch64 M128 is a SIMD register and on wasm32 (with simd128) a v128; here it is a plain u128 newtype. Wrapping rather than aliasing u128 keeps M128 a distinct type on every target, so the M128 <-> u128 conversions never collide with u128’s own reflexive impls and the architecture-gated BinaryField128bGhash conversions need no cfg gate.

Implementations

impl M128

pub const fn from_u128(value: u128) -> Self

Trait Implementations

impl BitAnd for M128

type Output = M128

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitAndAssign for M128

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitOr for M128

type Output = M128

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl BitOrAssign for M128

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitXor for M128

type Output = M128

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl BitXorAssign for M128

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl Clone for M128

fn clone(&self) -> M128

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for M128

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

Formats the value using the given formatter.

impl Default for M128

fn default() -> M128

Returns the “default value” for a type.

impl DeserializeBytes for M128

fn deserialize(read_buf: impl Buf) -> Result<Self, SerializationError>

where Self: Sized,

impl Display for M128

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

Formats the value using the given formatter.

impl Distribution<M128> for StandardUniform

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> M128

Generate a random value of T, using rng as the source of randomness.

fn sample_iter<R>(self, rng: R) -> Iter<Self, R, T>

where R: Rng, Self: Sized,

Create an iterator that generates random values of T, using rng as the source of randomness.

fn map<F, S>(self, func: F) -> Map<Self, F, T, S>

where F: Fn(T) -> S, Self: Sized,

Map sampled values to type S

impl Divisible<M128> for M128

const LOG_N: usize = 0

The log2 of the number of T elements that fit in Self.

fn value_iter(value: Self) -> impl ExactSizeIterator<Item = M128> + Send + Clone

Returns an iterator over subdivisions of this underlier value, ordered from LSB to MSB.

fn ref_iter( value: &Self, ) -> impl ExactSizeIterator<Item = M128> + Send + Clone + '_

Returns an iterator over subdivisions of this underlier reference, ordered from LSB to MSB.

fn slice_iter( slice: &[Self], ) -> impl ExactSizeIterator<Item = M128> + Send + Clone + '_

Returns an iterator over subdivisions of a slice of underliers, ordered from LSB to MSB.

unsafe fn get_unchecked(&self, _index: usize) -> M128

Get element at index (LSB-first ordering) without bounds checking.

unsafe fn set_unchecked(&mut self, _index: usize, val: M128)

Set element at index (LSB-first ordering) in place, without bounds checking.

fn broadcast(val: M128) -> Self

Create a value with val broadcast to all N positions.

fn from_iter(iter: impl Iterator<Item = M128>) -> Self

Construct a value from an iterator of elements.

const N: usize = _

The number of T elements that fit in Self.

fn get(&self, index: usize) -> T

Get element at index (LSB-first ordering).

fn set(&mut self, index: usize, val: T)

Set element at index (LSB-first ordering), in place.

impl Divisible<u128> for M128

const LOG_N: usize

The log2 of the number of T elements that fit in Self.

fn value_iter(value: Self) -> impl ExactSizeIterator<Item = u128> + Send + Clone

Returns an iterator over subdivisions of this underlier value, ordered from LSB to MSB.

fn ref_iter( value: &Self, ) -> impl ExactSizeIterator<Item = u128> + Send + Clone + '_

Returns an iterator over subdivisions of this underlier reference, ordered from LSB to MSB.

fn slice_iter( slice: &[Self], ) -> impl ExactSizeIterator<Item = u128> + Send + Clone + '_

Returns an iterator over subdivisions of a slice of underliers, ordered from LSB to MSB.

unsafe fn get_unchecked(&self, index: usize) -> u128

Get element at index (LSB-first ordering) without bounds checking.

unsafe fn set_unchecked(&mut self, index: usize, val: u128)

Set element at index (LSB-first ordering) in place, without bounds checking.

fn broadcast(val: u128) -> Self

Create a value with val broadcast to all N positions.

fn from_iter(iter: impl Iterator<Item = u128>) -> Self

Construct a value from an iterator of elements.

const N: usize = _

The number of T elements that fit in Self.

fn get(&self, index: usize) -> T

Get element at index (LSB-first ordering).

fn set(&mut self, index: usize, val: T)

Set element at index (LSB-first ordering), in place.

impl Divisible<u16> for M128

const LOG_N: usize

The log2 of the number of T elements that fit in Self.

fn value_iter(value: Self) -> impl ExactSizeIterator<Item = u16> + Send + Clone

Returns an iterator over subdivisions of this underlier value, ordered from LSB to MSB.

fn ref_iter( value: &Self, ) -> impl ExactSizeIterator<Item = u16> + Send + Clone + '_

Returns an iterator over subdivisions of this underlier reference, ordered from LSB to MSB.

fn slice_iter( slice: &[Self], ) -> impl ExactSizeIterator<Item = u16> + Send + Clone + '_

Returns an iterator over subdivisions of a slice of underliers, ordered from LSB to MSB.

unsafe fn get_unchecked(&self, index: usize) -> u16

Get element at index (LSB-first ordering) without bounds checking.

unsafe fn set_unchecked(&mut self, index: usize, val: u16)

Set element at index (LSB-first ordering) in place, without bounds checking.

fn broadcast(val: u16) -> Self

Create a value with val broadcast to all N positions.

fn from_iter(iter: impl Iterator<Item = u16>) -> Self

Construct a value from an iterator of elements.

const N: usize = _

The number of T elements that fit in Self.

fn get(&self, index: usize) -> T

Get element at index (LSB-first ordering).

fn set(&mut self, index: usize, val: T)

Set element at index (LSB-first ordering), in place.

impl Divisible<u32> for M128

const LOG_N: usize

The log2 of the number of T elements that fit in Self.

fn value_iter(value: Self) -> impl ExactSizeIterator<Item = u32> + Send + Clone

Returns an iterator over subdivisions of this underlier value, ordered from LSB to MSB.

fn ref_iter( value: &Self, ) -> impl ExactSizeIterator<Item = u32> + Send + Clone + '_

Returns an iterator over subdivisions of this underlier reference, ordered from LSB to MSB.

fn slice_iter( slice: &[Self], ) -> impl ExactSizeIterator<Item = u32> + Send + Clone + '_

Returns an iterator over subdivisions of a slice of underliers, ordered from LSB to MSB.

unsafe fn get_unchecked(&self, index: usize) -> u32

Get element at index (LSB-first ordering) without bounds checking.

unsafe fn set_unchecked(&mut self, index: usize, val: u32)

Set element at index (LSB-first ordering) in place, without bounds checking.

fn broadcast(val: u32) -> Self

Create a value with val broadcast to all N positions.

fn from_iter(iter: impl Iterator<Item = u32>) -> Self

Construct a value from an iterator of elements.

const N: usize = _

The number of T elements that fit in Self.

fn get(&self, index: usize) -> T

Get element at index (LSB-first ordering).

fn set(&mut self, index: usize, val: T)

Set element at index (LSB-first ordering), in place.

impl Divisible<u64> for M128

const LOG_N: usize

The log2 of the number of T elements that fit in Self.

fn value_iter(value: Self) -> impl ExactSizeIterator<Item = u64> + Send + Clone

Returns an iterator over subdivisions of this underlier value, ordered from LSB to MSB.

fn ref_iter( value: &Self, ) -> impl ExactSizeIterator<Item = u64> + Send + Clone + '_

Returns an iterator over subdivisions of this underlier reference, ordered from LSB to MSB.

fn slice_iter( slice: &[Self], ) -> impl ExactSizeIterator<Item = u64> + Send + Clone + '_

Returns an iterator over subdivisions of a slice of underliers, ordered from LSB to MSB.

unsafe fn get_unchecked(&self, index: usize) -> u64

Get element at index (LSB-first ordering) without bounds checking.

unsafe fn set_unchecked(&mut self, index: usize, val: u64)

Set element at index (LSB-first ordering) in place, without bounds checking.

fn broadcast(val: u64) -> Self

Create a value with val broadcast to all N positions.

fn from_iter(iter: impl Iterator<Item = u64>) -> Self

Construct a value from an iterator of elements.

const N: usize = _

The number of T elements that fit in Self.

fn get(&self, index: usize) -> T

Get element at index (LSB-first ordering).

fn set(&mut self, index: usize, val: T)

Set element at index (LSB-first ordering), in place.

impl Divisible<u8> for M128

const LOG_N: usize

The log2 of the number of T elements that fit in Self.

fn value_iter(value: Self) -> impl ExactSizeIterator<Item = u8> + Send + Clone

Returns an iterator over subdivisions of this underlier value, ordered from LSB to MSB.

fn ref_iter( value: &Self, ) -> impl ExactSizeIterator<Item = u8> + Send + Clone + '_

Returns an iterator over subdivisions of this underlier reference, ordered from LSB to MSB.

fn slice_iter( slice: &[Self], ) -> impl ExactSizeIterator<Item = u8> + Send + Clone + '_

Returns an iterator over subdivisions of a slice of underliers, ordered from LSB to MSB.

unsafe fn get_unchecked(&self, index: usize) -> u8

Get element at index (LSB-first ordering) without bounds checking.

unsafe fn set_unchecked(&mut self, index: usize, val: u8)

Set element at index (LSB-first ordering) in place, without bounds checking.

fn broadcast(val: u8) -> Self

Create a value with val broadcast to all N positions.

fn from_iter(iter: impl Iterator<Item = u8>) -> Self

Construct a value from an iterator of elements.

const N: usize = _

The number of T elements that fit in Self.

fn get(&self, index: usize) -> T

Get element at index (LSB-first ordering).

fn set(&mut self, index: usize, val: T)

Set element at index (LSB-first ordering), in place.

impl From<M128> for u128

fn from(value: M128) -> Self

Converts to this type from the input type.

impl From<u128> for M128

fn from(value: u128) -> Self

Converts to this type from the input type.

impl From<u16> for M128

fn from(value: u16) -> Self

Converts to this type from the input type.

impl From<u32> for M128

fn from(value: u32) -> Self

Converts to this type from the input type.

impl From<u64> for M128

fn from(value: u64) -> Self

Converts to this type from the input type.

impl From<u8> for M128

fn from(value: u8) -> Self

Converts to this type from the input type.

impl Hash for M128

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LowerHex for M128

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

Formats the value using the given formatter.

impl Not for M128

type Output = M128

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl Ord for M128

fn cmp(&self, other: &M128) -> 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 PartialEq for M128

fn eq(&self, other: &M128) -> 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 PartialOrd for M128

fn partial_cmp(&self, other: &M128) -> 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 SerializeBytes for M128

fn serialize(&self, write_buf: impl BufMut) -> Result<(), SerializationError>

impl Shl<usize> for M128

type Output = M128

The resulting type after applying the << operator.

fn shl(self, rhs: usize) -> Self::Output

Performs the << operation.

impl Shr<usize> for M128

type Output = M128

The resulting type after applying the >> operator.

fn shr(self, rhs: usize) -> Self::Output

Performs the >> operation.

impl UnderlierType for M128

const LOG_BITS: usize = 7

Number of bits in value

const ZERO: Self

const ONE: Self

const ONES: Self

fn interleave(self, other: Self, log_block_len: usize) -> (Self, Self)

Interleave with the given bit size

const BITS: usize = _

Number of bits used to represent a value. This may not be equal to the number of bits in a type instance.

fn fill_with_bit(val: u8) -> Self

Fill value with the given bit val must be 0 or 1.

fn transpose(self, other: Self, log_block_len: usize) -> (Self, Self)

Transpose with the given bit size

fn from_fn<T>(f: impl FnMut(usize) -> T) -> Self

where T: UnderlierType, Self: Divisible<T>,

fn broadcast_subvalue<T>(value: T) -> Self

where T: UnderlierType, Self: Divisible<T>,

Broadcast subvalue to fill Self. Self::BITS/T::BITS is supposed to be a power of 2.

unsafe fn spread<T>(self, log_block_len: usize, block_idx: usize) -> Self

where T: UnderlierType, Self: Divisible<T>,

Spread takes a block of sub_elements of T type within the current value and repeats them to the full underlier width.

impl Zeroable for M128

fn zeroed() -> Self

Calls zeroed.

impl Copy for M128

impl Eq for M128

impl Pod for M128

impl StructuralPartialEq for M128