Trait binius_field::underlier::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 method
    fn fill_with_bit(val: u8) -> 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> { ... }
}

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.

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.

Object Safety

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

impl UnderlierWithBitOps for u16

const ZERO: Self = 0u16

const ONE: Self = 1u16

const ONES: Self = 65_535u16

fn fill_with_bit(val: u8) -> 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

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

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

Implementors

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

const ZERO: Self = _

const ONE: Self = _

const ONES: Self = _