Trait UnderlierWithBitOps

pub trait UnderlierWithBitOps:
    UnderlierType
    + BitAnd<Self, Output = Self>
    + BitAndAssign<Self>
    + BitOr<Self, Output = Self>
    + BitOrAssign<Self>
    + BitXor<Self, Output = Self>
    + BitXorAssign<Self>
    + Shr<usize, Output = Self>
    + Shl<usize, Output = Self>
    + Not<Output = Self> {
    const ZERO: Self;
    const ONE: Self;
    const ONES: Self;

    // Required methods
    fn fill_with_bit(val: u8) -> Self;
    fn shl_128b_lanes(self, shift: usize) -> Self;
    fn shr_128b_lanes(self, shift: usize) -> Self;

    // Provided methods
    fn from_fn<T>(f: impl FnMut(usize) -> T) -> Self
       where T: UnderlierType,
             Self: From<T> { ... }
    fn broadcast_subvalue<T>(value: T) -> Self
       where T: UnderlierType,
             Self: From<T> { ... }
    unsafe fn get_subvalue<T>(&self, i: usize) -> T
       where T: UnderlierType + NumCast<Self> { ... }
    unsafe fn set_subvalue<T>(&mut self, i: usize, val: T)
       where T: UnderlierWithBitOps,
             Self: From<T> { ... }
    unsafe fn spread<T>(self, log_block_len: usize, block_idx: usize) -> Self
       where T: UnderlierWithBitOps + NumCast<Self>,
             Self: From<T> { ... }
    fn unpack_lo_128b_lanes(self, other: Self, log_block_len: usize) -> Self { ... }
    fn unpack_hi_128b_lanes(self, other: Self, log_block_len: usize) -> Self { ... }
}

Underlier type that supports bit arithmetic.

Required Associated Constants

const ZERO: Self

const ONE: Self

const ONES: Self

Required Methods

fn fill_with_bit(val: u8) -> Self

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

fn shl_128b_lanes(self, shift: usize) -> Self

Left shift within 128-bit lanes. This can be more efficient than the full Shl implementation.

fn shr_128b_lanes(self, shift: usize) -> Self

Right shift within 128-bit lanes. This can be more efficient than the full Shr implementation.

Provided Methods

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

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

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

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

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

unsafe fn get_subvalue<T>(&self, i: usize) -> T

where T: UnderlierType + NumCast<Self>,

Gets the subvalue from the given position. Function panics in case when index is out of range.

Safety

i must be less than Self::BITS/T::BITS.

unsafe fn set_subvalue<T>(&mut self, i: usize, val: T)

where T: UnderlierWithBitOps, Self: From<T>,

Sets the subvalue in the given position. Function panics in case when index is out of range.

Safety

i must be less than Self::BITS/T::BITS.

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

where T: UnderlierWithBitOps + NumCast<Self>, Self: From<T>,

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

Safety

log_block_len + T::LOG_BITS must be less than or equal to Self::LOG_BITS. block_idx must be less than 1 << (Self::LOG_BITS - log_block_len).

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

Unpacks 1 << log_block_len-bit values from low parts of self and other within 128-bit lanes.

Example: self: [a_0, a_1, a_2, a_3, a_4, a_5, a_6, a_7] other: [b_0, b_1, b_2, b_3, b_4, b_5, b_6, b_7] log_block_len: 1

result: [a_0, a_0, b_0, b_1, a_2, a_3, b_2, b_3]

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

Unpacks 1 << log_block_len-bit values from high parts of self and other within 128-bit lanes.

Example: self: [a_0, a_1, a_2, a_3, a_4, a_5, a_6, a_7] other: [b_0, b_1, b_2, b_3, b_4, b_5, b_6, b_7] log_block_len: 1

result: [a_4, a_5, b_4, b_5, a_6, a_7, b_6, b_7]

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl UnderlierWithBitOps for u8

const ZERO: Self = 0u8

const ONE: Self = 1u8

const ONES: Self = 255u8

fn fill_with_bit(val: u8) -> Self

fn shl_128b_lanes(self, rhs: usize) -> Self

fn shr_128b_lanes(self, rhs: usize) -> Self

impl UnderlierWithBitOps for u16

const ZERO: Self = 0u16

const ONE: Self = 1u16

const ONES: Self = 65_535u16

fn fill_with_bit(val: u8) -> Self

fn shl_128b_lanes(self, rhs: usize) -> Self

fn shr_128b_lanes(self, rhs: usize) -> Self

impl UnderlierWithBitOps for u32

const ZERO: Self = 0u32

const ONE: Self = 1u32

const ONES: Self = 4_294_967_295u32

fn fill_with_bit(val: u8) -> Self

fn shl_128b_lanes(self, rhs: usize) -> Self

fn shr_128b_lanes(self, rhs: usize) -> Self

impl UnderlierWithBitOps for u64

const ZERO: Self = 0u64

const ONE: Self = 1u64

const ONES: Self = 18_446_744_073_709_551_615u64

fn fill_with_bit(val: u8) -> Self

fn shl_128b_lanes(self, rhs: usize) -> Self

fn shr_128b_lanes(self, rhs: usize) -> Self

impl UnderlierWithBitOps for u128

const ZERO: Self = 0u128

const ONE: Self = 1u128

const ONES: Self = 340_282_366_920_938_463_463_374_607_431_768_211_455u128

fn fill_with_bit(val: u8) -> Self

fn shl_128b_lanes(self, rhs: usize) -> Self

fn shr_128b_lanes(self, rhs: usize) -> Self

Implementors

impl<U: UnderlierWithBitOps + Pod, const N: usize> UnderlierWithBitOps for ScaledUnderlier<U, N>

const ZERO: Self

const ONE: Self

const ONES: Self

impl<const N: usize> UnderlierWithBitOps for SmallU<N>

const ZERO: Self

const ONE: Self

const ONES: Self