TritsChunk

Struct TritsChunk 

Source
pub struct TritsChunk(/* private fields */);
Expand description

A struct to store 5 ternary digits (~7.8 bits) value into one byte.

TritsChunks helps store ternary numbers into a compact memory structure.

From 0 to ± 121.

Implementations§

Source§

impl TritsChunk

Source

pub fn from_dec(from: i8) -> Self

Creates a TritsChunk from a given decimal value.

§Arguments
  • from - An i8 value representing the decimal value to be converted into a TritsChunk.
§Panics

This function panics if the input value is out of the valid range -121..=121.

§Example
use balanced_ternary::TritsChunk;

let chunk = TritsChunk::from_dec(42);
assert_eq!(chunk.to_dec(), 42);
Source

pub fn to_dec(&self) -> i8

Converts the TritsChunk into its decimal representation.

§Returns

An i8 value representing the decimal form of the TritsChunk.

§Example
use balanced_ternary::TritsChunk;

let chunk = TritsChunk::from_dec(42);
assert_eq!(chunk.to_dec(), 42);
Source

pub fn to_ternary(&self) -> Ternary

Converts the TritsChunk into its ternary representation.

§Returns

A Ternary type representing the ternary form of the TritsChunk.

§Example
use balanced_ternary::{TritsChunk, Ternary};

let chunk = TritsChunk::from_dec(42);
let ternary = chunk.to_ternary();
assert_eq!(ternary.to_dec(), 42);
Source

pub fn to_fixed_ternary(&self) -> Ternary

Converts the TritsChunk into its fixed-length ternary representation.

§Returns

A Ternary type representing the 5-digit fixed-length ternary form of the TritsChunk.

§Example
use balanced_ternary::{TritsChunk, Ternary};

let chunk = TritsChunk::from_dec(42);
let fixed_ternary = chunk.to_fixed_ternary();
assert_eq!(fixed_ternary.to_dec(), 42);
assert_eq!(fixed_ternary.to_digit_slice().len(), 5);
Source

pub fn to_digits(&self) -> Vec<Digit>

Converts the TritsChunk into a vector of its individual ternary digits.

§Returns

A Vec<Digit> representing the individual ternary digits of the TritsChunk.

The resulting vector will always contain 5 digits since the TritsChunk is represented in a fixed-length ternary form.

§Example
use balanced_ternary::{TritsChunk, Digit};

let chunk = TritsChunk::from_dec(42);
let digits: Vec<Digit> = chunk.to_digits();
assert_eq!(digits.len(), 5);
Source

pub fn from_ternary(ternary: Ternary) -> Self

Creates a TritsChunk from a given Ternary value.

§Arguments
  • ternary - A Ternary value to be converted into a TritsChunk.
§Panics

This function panics if the provided ternary value has a logarithmic length greater than 5, indicating that it cannot be represented by a single TritsChunk.

§Example
use balanced_ternary::{TritsChunk, Ternary};

let ternary = Ternary::from_dec(42);
let chunk = TritsChunk::from_ternary(ternary);
assert_eq!(chunk.to_dec(), 42);

Trait Implementations§

Source§

impl Clone for TritsChunk

Source§

fn clone(&self) -> TritsChunk

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TritsChunk

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for TritsChunk

Source§

fn default() -> TritsChunk

Returns the “default value” for a type. Read more
Source§

impl Hash for TritsChunk

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for TritsChunk

Source§

fn cmp(&self, other: &TritsChunk) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for TritsChunk

Source§

fn eq(&self, other: &TritsChunk) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialOrd for TritsChunk

Source§

fn partial_cmp(&self, other: &TritsChunk) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Copy for TritsChunk

Source§

impl Eq for TritsChunk

Source§

impl StructuralPartialEq for TritsChunk

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.