Struct Dodecet 

pub struct Dodecet { /* private fields */ }

A 12-bit dodecet value (0-4095)

Example

use dodecet_encoder::Dodecet;

let d = Dodecet::from_hex(0xABC);
assert_eq!(d.value(), 0xABC);
assert_eq!(d.nibble(0).unwrap(), 0xC);
assert_eq!(d.nibble(1).unwrap(), 0xB);
assert_eq!(d.nibble(2).unwrap(), 0xA);

Implementations

impl Dodecet

pub fn new(value: u16) -> Result<Self>

Create a new dodecet from a u16 value

Errors

Returns DodecetError::Overflow if value > 4095

Example

use dodecet_encoder::Dodecet;

let d = Dodecet::new(0xABC).unwrap();
assert_eq!(d.value(), 0xABC);

pub unsafe fn from_hex_unchecked(value: u16) -> Self

Create a dodecet from a hex value (unchecked)

Safety

Caller must ensure value <= 4095

Example

use dodecet_encoder::Dodecet;

let d = unsafe { Dodecet::from_hex_unchecked(0xABC) };
assert_eq!(d.value(), 0xABC);

pub const fn from_hex(value: u16) -> Self

Create a dodecet from a hex value

Example

use dodecet_encoder::Dodecet;

let d = Dodecet::from_hex(0xABC);
assert_eq!(d.value(), 0xABC);

pub fn from_signed(value: i16) -> Self

Create a dodecet from a signed i16 value (-2048 to 2047)

Example

use dodecet_encoder::Dodecet;

let d = Dodecet::from_signed(-100);
assert_eq!(d.as_signed(), -100);

pub fn value(self) -> u16

Get the raw value

Example

use dodecet_encoder::Dodecet;

let d = Dodecet::from_hex(0xABC);
assert_eq!(d.value(), 0xABC);

pub fn nibble(self, index: u8) -> Result<u8>

Get a specific nibble (0, 1, or 2)

Arguments

• index - Nibble index (0 = LSB, 2 = MSB)

Example

use dodecet_encoder::Dodecet;

let d = Dodecet::from_hex(0xABC);
assert_eq!(d.nibble(0).unwrap(), 0xC);
assert_eq!(d.nibble(1).unwrap(), 0xB);
assert_eq!(d.nibble(2).unwrap(), 0xA);

pub fn set_nibble(&mut self, index: u8, nibble: u8) -> Result<()>

Set a specific nibble

Arguments

• index - Nibble index (0 = LSB, 2 = MSB)
• nibble - New nibble value (0-15)

Example

use dodecet_encoder::Dodecet;

let mut d = Dodecet::from_hex(0xABC);
d.set_nibble(0, 0xD).unwrap();
assert_eq!(d.value(), 0xABD);

pub fn is_zero(self) -> bool

Check if dodecet is zero

Example

use dodecet_encoder::Dodecet;

assert!(Dodecet::from_hex(0).is_zero());
assert!(!Dodecet::from_hex(0xABC).is_zero());

pub fn is_max(self) -> bool

Check if dodecet is at maximum value

Example

use dodecet_encoder::Dodecet;

assert!(Dodecet::from_hex(0xFFF).is_max());
assert!(!Dodecet::from_hex(0xABC).is_max());

pub fn count_ones(self) -> u32

Count set bits (population count)

Example

use dodecet_encoder::Dodecet;

let d = Dodecet::from_hex(0xFFF); // All bits set
assert_eq!(d.count_ones(), 12);

pub fn count_zeros(self) -> u32

Count unset bits

Example

use dodecet_encoder::Dodecet;

let d = Dodecet::from_hex(0x000); // No bits set
// Note: count_zeros() operates on underlying u16, returns 16 for 0x000

pub fn and(self, other: Dodecet) -> Dodecet

Bitwise AND

pub fn or(self, other: Dodecet) -> Dodecet

Bitwise OR

pub fn xor(self, other: Dodecet) -> Dodecet

Bitwise XOR

pub fn not(self) -> Dodecet

Bitwise NOT

pub fn wrapping_add(self, other: Dodecet) -> Dodecet

Arithmetic addition with wrapping

pub fn wrapping_sub(self, other: Dodecet) -> Dodecet

Arithmetic subtraction with wrapping

pub fn wrapping_mul(self, other: Dodecet) -> Dodecet

Arithmetic multiplication with wrapping

pub fn to_hex_string(self) -> String

Convert to hex string (3 characters)

Example

use dodecet_encoder::Dodecet;

let d = Dodecet::from_hex(0xABC);
assert_eq!(d.to_hex_string(), "ABC");

pub fn from_hex_str(s: &str) -> Result<Self>

Parse from hex string

Example

use dodecet_encoder::Dodecet;

let d = Dodecet::from_hex_str("ABC").unwrap();
assert_eq!(d.value(), 0xABC);

pub fn to_binary_string(self) -> String

Convert to binary string (12 characters)

Example

use dodecet_encoder::Dodecet;

let d = Dodecet::from_hex(0xABC);
assert_eq!(d.to_binary_string(), "101010111100");

pub fn as_signed(self) -> i16

Geometric interpretation: Treat as signed value (-2048 to 2047)

Example

use dodecet_encoder::Dodecet;

let d = Dodecet::from_hex(0x800);
assert_eq!(d.as_signed(), -2048);

pub fn normalize(self) -> f64

Normalize to floating point [0.0, 1.0]

Example

use dodecet_encoder::Dodecet;

let d = Dodecet::from_hex(0x800); // Midpoint
assert!((d.normalize() - 0.5).abs() < 0.001);

Trait Implementations

impl Add for Dodecet

type Output = Dodecet

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self::Output

Performs the + operation.

impl Binary for Dodecet

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

Formats the value using the given formatter.

impl BitAnd for Dodecet

type Output = Dodecet

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitOr for Dodecet

type Output = Dodecet

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitXor for Dodecet

type Output = Dodecet

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl Clone for Dodecet

fn clone(&self) -> Dodecet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Dodecet

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

Formats the value using the given formatter.

impl Default for Dodecet

fn default() -> Dodecet

Returns the “default value” for a type.

impl Display for Dodecet

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

Formats the value using the given formatter.

impl From<Dodecet> for u16

fn from(d: Dodecet) -> Self

Converts to this type from the input type.

impl From<u8> for Dodecet

fn from(value: u8) -> Self

Converts to this type from the input type.

impl Hash for Dodecet

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 Mul for Dodecet

type Output = Dodecet

The resulting type after applying the * operator.

fn mul(self, other: Self) -> Self::Output

Performs the * operation.

impl Not for Dodecet

type Output = Dodecet

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl Octal for Dodecet

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

Formats the value using the given formatter.

impl Ord for Dodecet

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

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

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

type Output = Dodecet

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self::Output

Performs the - operation.

impl TryFrom<u16> for Dodecet

type Error = DodecetError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for Dodecet

impl Eq for Dodecet

impl StructuralPartialEq for Dodecet