Struct bee_crypto::ternary::bigint::i384::I384

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

A big integer encoding a signed integer with 384 bits.

T is usually taken as a [u32; 12] or [u8; 48].

E refers to the endianness of the digits in T. This means that in the case of [u32; 12], if E == BigEndian, that the u32 at position i=0 is considered the most significant digit. The endianness E here makes no statement about the endianness of each single digit within itself (this is then dependent on the endianness of the platform this code is run on).

For E == LittleEndian the digit at the last position is considered to be the most significant.

Implementations

impl I384<BigEndian, U8Repr>

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

Creates an instance from an array of inner representation.

impl I384<BigEndian, U32Repr>

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

Creates an instance from an array of inner representation.

impl I384<LittleEndian, U8Repr>

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

Creates an instance from an array of inner representation.

impl I384<LittleEndian, U32Repr>

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

Creates an instance from an array of inner representation.

impl I384<BigEndian, U8Repr>

pub const fn zero() -> Self

Returns the appropriate constant value.

pub const fn one() -> Self

Returns the appropriate constant value.

pub const fn neg_one() -> Self

Returns the appropriate constant value.

pub const fn two() -> Self

Returns the appropriate constant value.

pub const fn neg_two() -> Self

Returns the appropriate constant value.

pub const fn max() -> Self

Returns the appropriate constant value.

pub const fn min() -> Self

Returns the appropriate constant value.

impl I384<LittleEndian, U8Repr>

pub const fn zero() -> Self

Returns the appropriate constant value.

pub const fn one() -> Self

Returns the appropriate constant value.

pub const fn neg_one() -> Self

Returns the appropriate constant value.

pub const fn two() -> Self

Returns the appropriate constant value.

pub const fn neg_two() -> Self

Returns the appropriate constant value.

pub const fn max() -> Self

Returns the appropriate constant value.

pub const fn min() -> Self

Returns the appropriate constant value.

impl I384<BigEndian, U32Repr>

pub const fn zero() -> Self

Returns the appropriate constant value.

pub const fn one() -> Self

Returns the appropriate constant value.

pub const fn neg_one() -> Self

Returns the appropriate constant value.

pub const fn two() -> Self

Returns the appropriate constant value.

pub const fn neg_two() -> Self

Returns the appropriate constant value.

pub const fn max() -> Self

Returns the appropriate constant value.

pub const fn min() -> Self

Returns the appropriate constant value.

impl I384<LittleEndian, U32Repr>

pub const fn zero() -> Self

Returns the appropriate constant value.

pub const fn one() -> Self

Returns the appropriate constant value.

pub const fn neg_one() -> Self

Returns the appropriate constant value.

pub const fn two() -> Self

Returns the appropriate constant value.

pub const fn neg_two() -> Self

Returns the appropriate constant value.

pub const fn max() -> Self

Returns the appropriate constant value.

pub const fn min() -> Self

Returns the appropriate constant value.

impl I384<BigEndian, U8Repr>

pub fn not_inplace(&mut self)

Applies not to all bytes of the I384.

impl 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 to accomodate other (starting from the least significant one).

pub fn as_u384(self) -> U384<BigEndian, U32Repr>

Reinterprets the I384 as an U384.

pub fn from_t242(value: T242<Btrit>) -> Self

Creates an I384 from a balanced T242.

pub fn is_positive(&self) -> bool

Checks if the I384 is positive.

pub fn is_negative(&self) -> bool

Checks if the I384 is negative.

pub fn not_inplace(&mut self)

Applies logical not to all elements in a &[u32], modfiying them in place.

Examples

let xs: I384<LittleEndian, _> = I384::from_array([0xffff_ffffu32; LEN_IN_U32]);
let mut ys = I384::from_array([0x0000_0000u32; LEN_IN_U32]);
ys.not_inplace();
assert_eq!(xs, ys);

pub fn shift_into_u384(self) -> U384<BigEndian, U32Repr>

Shifts the I384 into unsigned space.

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

TODO: Verifiy that the final assert is indeed not necessary. Preliminary testing shows that results are as expected.

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

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

pub fn try_from_t243(balanced_trits: T243<Btrit>) -> Result<Self, Error>

Creates an I384 from a balanced T243.

impl 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 to accomodate other (starting from the least significant one).

pub fn as_u384(self) -> U384<LittleEndian, U32Repr>

Reinterprets the I384 as an U384.

pub fn from_t242(value: T242<Btrit>) -> Self

Creates an I384 from a balanced T242.

pub fn is_positive(&self) -> bool

Checks if the I384 is positive.

pub fn is_negative(&self) -> bool

Checks if the I384 is negative.

pub fn not_inplace(&mut self)

Applies logical not to all elements in a &[u32], modfiying them in place.

Examples

let xs: I384<LittleEndian, _> = I384::from_array([0xffff_ffffu32; LEN_IN_U32]);
let mut ys = I384::from_array([0x0000_0000u32; LEN_IN_U32]);
ys.not_inplace();
assert_eq!(xs, ys);

pub fn shift_into_u384(self) -> U384<LittleEndian, U32Repr>

Shifts the I384 into unsigned space.

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

TODO: Verifiy that the final assert is indeed not necessary. Preliminary testing shows that results are as expected.

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

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

pub fn try_from_t243(balanced_trits: T243<Btrit>) -> Result<Self, Error>

Tries to create an I384 from a balanced T243.

pub fn zero_most_significant_trit(&mut self)

Zeroes the most significant trit of the I384.

Trait Implementations

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

fn clone(&self) -> I384<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 I384<E, T>

impl<E, T, D> Debug for I384<E, T> where
    E: Debug,
    T: BinaryRepresentation<Inner = D>,
    D: Debug, 

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

Formats the value using the given formatter.

impl Default for I384<BigEndian, U8Repr>

fn default() -> Self

Returns the "default value" for a type.

impl Default for I384<BigEndian, U32Repr>

fn default() -> Self

Returns the "default value" for a type.

impl Default for I384<LittleEndian, U8Repr>

fn default() -> Self

Returns the "default value" for a type.

impl Default for I384<LittleEndian, U32Repr>

fn default() -> Self

Returns the "default value" for a type.

impl<E, T> Deref for I384<E, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<E, T> DerefMut for I384<E, T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Eq for I384<BigEndian, U8Repr>

impl Eq for I384<BigEndian, U32Repr>

impl Eq for I384<LittleEndian, U8Repr>

impl Eq for I384<LittleEndian, U32Repr>

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

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

Performs the conversion.

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

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

Performs the conversion.

impl From<I384<BigEndian, [u32; 12]>> for T243<Btrit>

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

Performs the conversion.

impl From<I384<BigEndian, [u8; 48]>> for I384<BigEndian, U32Repr>

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

Performs the conversion.

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

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

Performs the conversion.

impl From<I384<BigEndian, [u8; 48]>> for T243<Btrit>

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

Performs the conversion.

impl From<I384<LittleEndian, [u32; 12]>> for I384<LittleEndian, U8Repr>

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

Performs the conversion.

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

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

Performs the conversion.

impl From<I384<LittleEndian, [u32; 12]>> for T243<Btrit>

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

impl From<T242<Btrit>> for I384<BigEndian, U8Repr>

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

Performs the conversion.

impl From<T242<Btrit>> for I384<BigEndian, U32Repr>

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

Performs the conversion.

impl From<T242<Btrit>> for I384<LittleEndian, U32Repr>

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

Performs the conversion.

impl Ord for I384<BigEndian, U8Repr>

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 Ord for I384<BigEndian, 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 Ord for I384<LittleEndian, U8Repr>

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 Ord for I384<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<I384<BigEndian, [u32; 12]>> for I384<BigEndian, 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 PartialEq<I384<BigEndian, [u8; 48]>> for I384<BigEndian, U8Repr>

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 PartialEq<I384<LittleEndian, [u32; 12]>> for I384<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 PartialEq<I384<LittleEndian, [u8; 48]>> for I384<LittleEndian, U8Repr>

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<I384<BigEndian, [u32; 12]>> for I384<BigEndian, 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 PartialOrd<I384<BigEndian, [u8; 48]>> for I384<BigEndian, U8Repr>

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 PartialOrd<I384<LittleEndian, [u32; 12]>> for I384<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 PartialOrd<I384<LittleEndian, [u8; 48]>> for I384<LittleEndian, U8Repr>

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<I384<BigEndian, [u32; 12]>> for T242<Btrit>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: I384<BigEndian, U32Repr>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<I384<BigEndian, [u8; 48]>> for T242<Btrit>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: I384<BigEndian, U8Repr>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<I384<LittleEndian, [u32; 12]>> for T242<Btrit>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: I384<LittleEndian, U32Repr>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<I384<LittleEndian, [u8; 48]>> for T242<Btrit>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: I384<LittleEndian, U8Repr>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<T243<Btrit>> for I384<BigEndian, U8Repr>

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<T243<Btrit>> for I384<BigEndian, U32Repr>

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<T243<Btrit>> for I384<LittleEndian, U32Repr>

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.