Struct Tryte

pub struct Tryte<const SIZE: usize = 6> { /* private fields */ }

A struct representing a balanced ternary number with a fixed length of SIZE digits.

The underlying representation of the number is an array of SIZE Digit values. This struct provides conversion methods to and from other formats.

Default SIZE

SIZE is 6 by default (the size of a tryte in a Setun computer).

6 trits ~= 9.505 bits

-364 to 364

Warning

Because arithmetic operations are performed in with 64 bits integers, SIZE cannot be > 40.

40 trits ~= 63,398 bits

-6 078 832 729 528 464 400 to 6 078 832 729 528 464 400

Implementations

impl<const SIZE: usize> Tryte<SIZE>

pub const MAX: Self

++...++

pub const MIN: Self

--...--

pub const ZERO: Self

00...00

pub const fn new(digits: [Digit; SIZE]) -> Self

Creates a new Tryte instance from a given array of Digits.

Arguments

• raw - An array of exactly SIZE Digit values representing the balanced ternary digits.

Returns

A new Tryte instance with the specified balanced ternary digits.

Panics

Panic if SIZE > 40 as 41 trits would be too much information for 64 bits.

Examples

use balanced_ternary::{Tryte, Digit::{Pos, Zero, Neg}};

let digits = [Pos, Zero, Neg, Zero, Pos, Neg];
let tryte = Tryte::new(digits);
assert_eq!(tryte.to_digit_slice(), &digits);

pub fn to_ternary(&self) -> Ternary

Converts the Tryte into its Ternary representation.

Returns

A Ternary object representing the same balanced ternary number.

pub const fn to_digit_slice(&self) -> &[Digit]

Retrieves a slice containing the digits of the Tryte.

Returns

A slice referencing the six-digit array of the Tryte.

This function allows access to the raw representation of the balanced ternary number as a slice of Digit values.

pub fn from_ternary(v: &Ternary) -> Self

Creates a Tryte from the given Ternary.

Arguments

• v - A reference to a Ternary object.

Panics

This function panics if the Ternary contains more than SIZE digits.

pub fn to_i64(&self) -> i64

Converts the Tryte into a signed 64-bit integer.

Returns

A i64 representing the decimal value of the Tryte.

pub fn from_i64(v: i64) -> Self

Creates a Tryte from a signed 64-bit integer.

Arguments

• v - A signed 64-bit integer.

Returns

A Tryte representing the equivalent ternary number.

pub fn digit(&self, index: usize) -> Digit

Retrieves the digit at the specified index in the Tryte.

Arguments

• index - The index of the digit to retrieve (0-based, right-to-left).

Returns

The Digit at the specified index.

Panics

This function panics if the index is greater than 5.

pub fn each(&self, f: impl Fn(Digit) -> Digit) -> Self

See Ternary::each.

pub fn each_with(&self, f: impl Fn(Digit, Digit) -> Digit, with: Digit) -> Self

See Ternary::each_with.

pub fn each_zip(&self, f: impl Fn(Digit, Digit) -> Digit, other: Self) -> Self

See Ternary::each_zip.

pub fn each_zip_carry( &self, f: impl Fn(Digit, Digit, Digit) -> (Digit, Digit), other: Self, ) -> Self

See Ternary::each_zip_carry.

Trait Implementations

impl<const SIZE: usize> Add for Tryte<SIZE>

type Output = Tryte<SIZE>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<const SIZE: usize> BitAnd for Tryte<SIZE>

type Output = Tryte<SIZE>

The resulting type after applying the & operator.

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

Performs the & operation.

impl<const SIZE: usize> BitOr for Tryte<SIZE>

type Output = Tryte<SIZE>

The resulting type after applying the | operator.

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

Performs the | operation.

impl<const SIZE: usize> BitXor for Tryte<SIZE>

type Output = Tryte<SIZE>

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl<const SIZE: usize> Clone for Tryte<SIZE>

fn clone(&self) -> Tryte<SIZE>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const SIZE: usize> Debug for Tryte<SIZE>

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

Formats the value using the given formatter.

impl<const SIZE: usize> Display for Tryte<SIZE>

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

Formats the Tryte for display.

The Tryte is displayed in its balanced ternary representation as a SIZE-character string.

impl<const SIZE: usize> Div for Tryte<SIZE>

type Output = Tryte<SIZE>

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Self::Output

Performs the / operation.

impl<const SIZE: usize> From<&str> for Tryte<SIZE>

fn from(value: &str) -> Self

Converts to this type from the input type.

impl<const SIZE: usize> From<String> for Tryte<SIZE>

fn from(value: String) -> Self

Converts to this type from the input type.

impl<const SIZE: usize> From<Ternary> for Tryte<SIZE>

fn from(value: Ternary) -> Self

Converts to this type from the input type.

impl<const SIZE: usize> From<Tryte<SIZE>> for String

fn from(value: Tryte<SIZE>) -> Self

Converts to this type from the input type.

impl<const SIZE: usize> From<Tryte<SIZE>> for Ternary

fn from(value: Tryte<SIZE>) -> Self

Converts to this type from the input type.

impl<const SIZE: usize> From<Tryte<SIZE>> for i64

fn from(value: Tryte<SIZE>) -> Self

Converts to this type from the input type.

impl<const SIZE: usize> From<i64> for Tryte<SIZE>

fn from(value: i64) -> Self

Converts to this type from the input type.

impl<const SIZE: usize> Hash for Tryte<SIZE>

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 SIZE: usize> Mul for Tryte<SIZE>

type Output = Tryte<SIZE>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<const SIZE: usize> Neg for Tryte<SIZE>

type Output = Tryte<SIZE>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<const SIZE: usize> Not for Tryte<SIZE>

type Output = Tryte<SIZE>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl<const SIZE: usize> PartialEq for Tryte<SIZE>

fn eq(&self, other: &Tryte<SIZE>) -> 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 SIZE: usize> Sub for Tryte<SIZE>

type Output = Tryte<SIZE>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<const SIZE: usize> Copy for Tryte<SIZE>

impl<const SIZE: usize> Eq for Tryte<SIZE>

impl<const SIZE: usize> StructuralPartialEq for Tryte<SIZE>