Struct iota_ternary_preview::bigint::u384::U384

pub struct U384<E, T> { /* fields omitted */ }

Methods

impl<E, T> U384<E, T>

pub fn inner_ref(&self) -> &T

impl U384<BigEndian, U32Repr>

pub fn as_i384(self) -> I384<BigEndian, U32Repr>

pub fn shift_into_i384(self) -> I384<BigEndian, U32Repr>

pub fn add_inplace(&mut self, other: Self)

Adds other onto self in place.

pub fn add_digit_inplace<T: Into<u32>>(&mut self, other: T) -> usize

Adds other in place, returning the number of digits required accomodate other (starting from the least significant one).

pub fn divide_by_two(&mut self)

Divides the u384 by 2 by bitshifting all bits one position to the right.

pub fn from_t242(trits: T242<Utrit>) -> Self

pub fn sub_inplace(&mut self, other: Self)

Subtract other from self inplace.

This function is defined in terms of overflowing_add by making use of the following identity (in terms of Two's complement, and where ! is logical bitwise negation):

!x = -x - 1 => -x = !x + 1

pub fn try_from_t243(trits: T243<Utrit>) -> Result<Self, Error>

Converts a signed integer represented by the balanced trits in t243 to the unsigned binary integer u384. It does this by shifting the t243 into signed range (by adding 1 to all its trits). t243 is assumed to be in little endian representation, with the most significant trit being at the largest index in the array.

This is done in the following steps:

1. 1 is added to all balanced trits, making them unsigned: {-1, 0, 1} -> {0, 1, 2}.
2. The t243 are converted to base 10 and through this immediately to i384 by calculating the sum `s

s = t_242 * 3^241 + t_241 * 3^240 + ...
  + t_{i+1} * 3^{i} + t_i * 3^{i-1} + t_{i-1} * 3^{i-2} + ...
  + t_1 * 3 + t_0

To perform this sum efficiently, its accumulation is staggered, so that each multiplication by 3 is done in each iteration of accumulating loop. This can be understood by factoring the powers of 3 from the previous sum:

s = (...((t_242 * 3 + t_241) * 3 + t_240) * 3 + ...
  +  ...((t_{i+1} * 3 + t_i) * 3 + t_{i-1}) * 3 + ...
  +  ...t_1) * 3 + t_0

Expressed in procedural form, this is the sum accumulated in acc with the index i running from [242..0]:

acc = 0
for i, trit in trits.rev():
    acc := acc + trit * 3^i

impl U384<LittleEndian, U32Repr>

pub fn as_i384(self) -> I384<LittleEndian, U32Repr>

pub fn add_inplace(&mut self, other: Self)

Adds other onto self in place.

pub fn add_digit_inplace<T: Into<u32>>(&mut self, other: T) -> usize

Adds other in place, returning the number of digits required accomodate other (starting from the least significant one).

pub fn divide_by_two(&mut self)

Divides the u384 by 2 by bitshifting all bits one position to the right.

pub fn from_t242(trits: T242<Utrit>) -> Self

pub fn shift_into_i384(self) -> I384<LittleEndian, U32Repr>

pub fn sub_inplace(&mut self, other: Self)

Subtract other from self inplace.

This function is defined in terms of overflowing_add by making use of the following identity (in terms of Two's complement, and where ! is logical bitwise negation):

!x = -x -1 => -x = !x + 1

pub fn try_from_t243(trits: T243<Utrit>) -> Result<Self, Error>

Converts a signed integer represented by the balanced trits in t243 to the unsigned binary integer u384. It does this by shifting the t243 into signed range (by adding 1 to all its trits). t243 is assumed to be in little endian representation, with the most significant trit being at the largest index in the array.

This is done in the following steps:

1. 1 is added to all balanced trits, making them unsigned: {-1, 0, 1} -> {0, 1, 2}.
2. The t243 are converted to base 10 and through this immediately to i384 by calculating the sum `s

s = t_242 * 3^241 + t_241 * 3^240 + ...
  + t_{i+1} * 3^{i} + t_i * 3^{i-1} + t_{i-1} * 3^{i-2} + ...
  + t_1 * 3 + t_0

To perform this sum efficiently, its accumulation is staggered, so that each multiplication by 3 is done in each iteration of accumulating loop. This can be understood by factoring the powers of 3 from the previous sum:

s = (...((t_242 * 3 + t_241) * 3 + t_240) * 3 + ...
  +  ...((t_{i+1} * 3 + t_i) * 3 + t_{i-1}) * 3 + ...
  +  ...t_1) * 3 + t_0

Expressed in procedural form, this is the sum accumulated in acc with the index i running from [242..0]:

acc = 0
for i, trit in trits.rev():
    acc := acc + trit * 3^i

impl U384<BigEndian, U8Repr>

pub const fn from_array(inner: U8Repr) -> Self

impl U384<BigEndian, U32Repr>

pub const fn from_array(inner: U32Repr) -> Self

impl U384<LittleEndian, U8Repr>

pub const fn from_array(inner: U8Repr) -> Self

impl U384<LittleEndian, U32Repr>

pub const fn from_array(inner: U32Repr) -> Self

impl U384<BigEndian, U8Repr>

pub const fn zero() -> Self

pub const fn one() -> Self

pub const fn two() -> Self

pub const fn max() -> Self

impl U384<LittleEndian, U8Repr>

pub const fn zero() -> Self

pub const fn one() -> Self

pub const fn two() -> Self

pub const fn max() -> Self

impl U384<BigEndian, U32Repr>

pub const fn zero() -> Self

pub const fn one() -> Self

pub const fn two() -> Self

pub const fn max() -> Self

impl U384<LittleEndian, U32Repr>

pub const fn zero() -> Self

pub const fn one() -> Self

pub const fn two() -> Self

pub const fn max() -> Self

Trait Implementations

impl<E: Clone, T: Clone> Clone for U384<E, T>

fn clone(&self) -> U384<E, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<E: Copy, T: Copy> Copy for U384<E, T>

impl<E: Debug, R: BinaryRepresentation, D> Debug for U384<E, R> where
    E: Debug,
    R: BinaryRepresentation<T = D>,
    D: Debug, 

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

Formats the value using the given formatter.

impl Eq for U384<LittleEndian, U32Repr>

impl From<T242<Utrit>> for U384<LittleEndian, U32Repr>

fn from(value: T242<Utrit>) -> Self

Performs the conversion.

impl From<U384<BigEndian, [u32; 12]>> for T243<Utrit>

fn from(value: U384<BigEndian, U32Repr>) -> Self

Performs the conversion.

impl From<U384<BigEndian, [u32; 12]>> for U384<BigEndian, U8Repr>

fn from(value: U384<BigEndian, U32Repr>) -> Self

Performs the conversion.

impl From<U384<BigEndian, [u32; 12]>> for U384<LittleEndian, U32Repr>

fn from(value: U384<BigEndian, U32Repr>) -> Self

Performs the conversion.

impl From<U384<BigEndian, [u8; 48]>> for U384<LittleEndian, U8Repr>

fn from(value: U384<BigEndian, U8Repr>) -> Self

Performs the conversion.

impl From<U384<LittleEndian, [u32; 12]>> for T242<Utrit>

fn from(binary_value: U384<LittleEndian, U32Repr>) -> Self

Performs the conversion.

impl From<U384<LittleEndian, [u32; 12]>> for T243<Utrit>

fn from(value: U384<LittleEndian, U32Repr>) -> Self

Performs the conversion.

impl From<U384<LittleEndian, [u32; 12]>> for U384<BigEndian, U32Repr>

fn from(value: U384<LittleEndian, U32Repr>) -> Self

Performs the conversion.

impl From<U384<LittleEndian, [u8; 48]>> for U384<LittleEndian, U32Repr>

fn from(value: U384<LittleEndian, U8Repr>) -> Self

Performs the conversion.

impl From<U384<LittleEndian, [u8; 48]>> for U384<BigEndian, U8Repr>

fn from(value: U384<LittleEndian, U8Repr>) -> Self

Performs the conversion.

impl Ord for U384<LittleEndian, U32Repr>

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<U384<LittleEndian, [u32; 12]>> for U384<LittleEndian, U32Repr>

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<U384<LittleEndian, [u32; 12]>> for U384<LittleEndian, U32Repr>

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

This method returns an ordering between self and other values if one exists.

#[must_use]fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<T243<Utrit>> for U384<LittleEndian, U32Repr>

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.