Struct TurboQuantBitWidth 

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

Validated TurboQuant bit width.

Implementations

impl TurboQuantBitWidth

pub const fn new(bits: u8) -> TurboQuantCodecResult<Self>

Construct a validated TurboQuant bit width.

Errors

Returns TurboQuantCodecError::InvalidBitWidth unless bits is in the inclusive 2..=4 range.

pub const fn bits(self) -> u8

Return the number of bits stored for each encoded coordinate.

pub const fn levels(self) -> usize

Return the number of quantization levels represented by this bit width.

pub const fn max_code(self) -> u8

Return the maximum representable code for this bit width.

Trait Implementations

impl Clone for TurboQuantBitWidth

fn clone(&self) -> TurboQuantBitWidth

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for TurboQuantBitWidth

impl Debug for TurboQuantBitWidth

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

Formats the value using the given formatter.

impl Eq for TurboQuantBitWidth

impl From<TurboQuantBitWidth> for u8

fn from(value: TurboQuantBitWidth) -> Self

Converts to this type from the input type.

impl Hash for TurboQuantBitWidth

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 Ord for TurboQuantBitWidth

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

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

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

impl TryFrom<u8> for TurboQuantBitWidth

type Error = TurboQuantCodecError

The type returned in the event of a conversion error.

fn try_from(value: u8) -> Result<Self, Self::Error>

Performs the conversion.