Type Alias U4

pub type U4 = SmallU<4>;

Aliased Type

struct U4(/* private fields */);

Implementations

impl<const N: usize> SmallU<N>

pub const fn new(val: u8) -> Self

pub const fn new_unchecked(val: u8) -> Self

pub const fn val(&self) -> u8

pub fn checked_add(self, rhs: Self) -> Option<Self>

pub fn checked_sub(self, rhs: Self) -> Option<Self>

Trait Implementations

impl From<BinaryField4b> for U4

fn from(val: BinaryField4b) -> Self

Converts to this type from the input type.

impl NumCast<SmallU<1>> for U4

fn num_cast_from(val: U1) -> Self

impl NumCast<SmallU<2>> for U4

fn num_cast_from(val: U2) -> Self

impl NumCast<u128> for U4

fn num_cast_from(val: u128) -> Self

impl NumCast<u16> for U4

fn num_cast_from(val: u16) -> Self

impl NumCast<u32> for U4

fn num_cast_from(val: u32) -> Self

impl NumCast<u64> for U4

fn num_cast_from(val: u64) -> Self

impl NumCast<u8> for U4

fn num_cast_from(val: u8) -> Self

impl<F> PackScalar<F> for U4

where F: BinaryField, PackedPrimitiveType<U4, F>: PackedField<Scalar = F> + WithUnderlier<Underlier = U4>,

type Packed = PackedPrimitiveType<SmallU<4>, F>

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

type Output = SmallU<N>

The resulting type after applying the & operator.

fn bitand(self, rhs: SmallU<N>) -> SmallU<N>

Performs the & operation.

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

fn bitand_assign(&mut self, rhs: SmallU<N>)

Performs the &= operation.

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

type Output = SmallU<N>

The resulting type after applying the | operator.

fn bitor(self, rhs: SmallU<N>) -> SmallU<N>

Performs the | operation.

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

fn bitor_assign(&mut self, rhs: SmallU<N>)

Performs the |= operation.

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

type Output = SmallU<N>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: SmallU<N>) -> SmallU<N>

Performs the ^ operation.

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

fn bitxor_assign(&mut self, rhs: SmallU<N>)

Performs the ^= operation.

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

fn clone(&self) -> SmallU<N>

Returns a copy of the value.

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

Performs copy-assignment from source.

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

fn conditional_select(a: &Self, b: &Self, choice: Choice) -> Self

Select a or b according to choice.

fn conditional_assign(&mut self, other: &Self, choice: Choice)

Conditionally assign other to self, according to choice.

fn conditional_swap(a: &mut Self, b: &mut Self, choice: Choice)

Conditionally swap self and other if choice == 1; otherwise, reassign both unto themselves.

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

fn ct_eq(&self, other: &Self) -> Choice

Determine if two items are equal.

fn ct_ne(&self, other: &Self) -> Choice

Determine if two items are NOT equal.

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

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

Formats the value using the given formatter.

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

fn default() -> SmallU<N>

Returns the “default value” for a type.

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

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

Formats the value using the given formatter.

impl From<SmallU<1>> for SmallU<4>

fn from(value: SmallU<1>) -> Self

Converts to this type from the input type.

impl From<SmallU<2>> for SmallU<4>

fn from(value: SmallU<2>) -> Self

Converts to this type from the input type.

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

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<const N: usize> LowerHex for SmallU<N>

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

Formats the value using the given formatter.

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

type Output = SmallU<N>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

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

fn cmp(&self, other: &SmallU<N>) -> 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<const N: usize> PartialEq for SmallU<N>

fn eq(&self, other: &SmallU<N>) -> 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<const N: usize> PartialOrd for SmallU<N>

fn partial_cmp(&self, other: &SmallU<N>) -> 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<const N: usize> Random for SmallU<N>

fn random(rng: impl RngCore) -> Self

Generate random value

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

type Output = SmallU<N>

The resulting type after applying the << operator.

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

Performs the << operation.

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

type Output = SmallU<N>

The resulting type after applying the >> operator.

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

Performs the >> operation.

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

const LOG_BITS: usize = _

Number of bits in value

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.

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

const ZERO: Self = _

const ONE: Self = _

const ONES: Self = _

fn fill_with_bit(val: u8) -> Self

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

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.

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.

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.

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

fn zeroed() -> Self

Calls zeroed.

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

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

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

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