Struct aluvm::data::Number

pub struct Number { /* fields omitted */ }

Type holding number of any layout

Implementations

impl Number

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

Does comparison by ignoring the difference in the last bit of significand for float layouts. For integers performs normal comparison.

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

Checks for the equality ignoring the difference in the last bit of significand for float layouts. For integers performs normal comparison.

impl Number

pub fn int_add(self, rhs: Self, flags: IntFlags) -> Option<Number>

Addition of two integers with configuration flags for overflow and signed format.

Panics

• if applied to float number layouts
• if numbers in arguments has different layout.

pub fn int_sub(self, rhs: Self, flags: IntFlags) -> Option<Number>

Subtraction of two integers with configuration flags for overflow and signed format.

Panics

• if applied to float number layouts
• if numbers in arguments has different layout.

pub fn int_mul(self, rhs: Self, flags: IntFlags) -> Option<Number>

Multiplication of two integers with configuration flags for overflow and signed format.

Panics

• if applied to float number layouts
• if numbers in arguments has different layout.

pub fn int_div(self, rhs: Self, flags: IntFlags) -> Option<Number>

Division of two integers with configuration flags for overflow and signed format.

Panics

• if applied to float number layouts
• if numbers in arguments has different layout.

pub fn float_add(self, rhs: Self, flag: RoundingFlag) -> Option<Number>

Addition of two floats with configuration flags for rounding.

Panics

• if applied to float number layouts
• if numbers in arguments has different layout.

pub fn float_sub(self, rhs: Self, flag: RoundingFlag) -> Option<Number>

Subtraction of two floats with configuration flags for rounding.

Panics

• if applied to float number layouts
• if numbers in arguments has different layout.

pub fn float_mul(self, rhs: Self, flag: RoundingFlag) -> Option<Number>

Multiplication of two floats with configuration flags for rounding.

Panics

• if applied to float number layouts
• if numbers in arguments has different layout.

pub fn float_div(self, rhs: Self, flag: RoundingFlag) -> Option<Number>

Division of two floats with configuration flags for rounding.

Panics

• if applied to float number layouts
• if numbers in arguments has different layout.

impl Number

pub fn abs(self) -> Number

Returns the absolute value of the number

impl Number

pub fn scl(self, shift: Number) -> Number

Cyclic bit shift left. Panics if the number is not an integer.

pub fn scr(self, shift: Number) -> Number

Cyclic bit shift right. Panics if the number is not an integer.

pub fn shr_signed(self, shift: Number) -> Number

Bit shift right for signed value. Panics if the number is not an integer.

pub fn reverse_bits(self) -> Number

Reverses the order of bits in the integer. The least significant bit becomes the most significant bit, second least-significant bit becomes second most-significant bit, etc.

impl Number

pub fn zero(layout: Layout) -> Number

Creates zero value with a given layout

pub fn masked_bit(bit_no: u16, layout: Layout) -> Number

Creates value with the specified bit masked

pub fn with(
    slice: impl AsRef<[u8]>,
    layout: impl Into<Layout>
) -> Option<Number>

Constructs number representation from a slice and a given layout.

Fails returning None if the length of slice does not match the required layout byte length.

pub fn from_slice(slice: impl AsRef<[u8]>) -> Number

Constructs value from slice of bytes.

Panics if the length of the slice is greater than 1024 bytes.

pub fn len(&self) -> u16

Returns length of the used portion of the value

pub fn layout(&self) -> Layout

Returns number layout used by the value

pub fn count_zeros(&self) -> u16

Returns the number of zeros in the binary representation of self.

pub fn count_ones(&self) -> u16

Returns the number of ones in the binary representation of self.

pub fn min_bit_len(&self) -> u16

Measures minimum number of bits required to store the number. For float layouts, always matches the layout bit size.

pub fn is_positive(self) -> bool

Detects if the number value positive (i.e. >0) or not.

pub fn is_zero(self) -> bool

Detects if the value is equal to zero

pub fn is_nan(self) -> bool

Detects if the value is NaN. For integer layouts always false

pub fn is_max(self) -> bool

Detects if the value is equal to the maximum possible value for the used layout. For floats, always false.

pub fn clean(&mut self)

Ensures that all non-value bits are set to zero

pub fn to_clean(self) -> Self

Returns a copy where all non-value bits are set to zero

pub fn reshape(&mut self, to: Layout) -> bool

Transforms internal value layout returning whether this was possible without discarding any bit information

pub fn applying_sign(self, sign: impl Into<bool>) -> Number

Adds or removes negative sign to the number (negates negative or positive number, depending on the method argument value)

pub fn without_sign(self) -> Number

Removes negative sign if present (negates negative number)

Trait Implementations

impl AsMut<[u8]> for Number

fn as_mut(&mut self) -> &mut [u8]

Performs the conversion.

impl AsRef<[u8]> for Number

fn as_ref(&self) -> &[u8]

Performs the conversion.

impl BitAnd<Number> for Number

type Output = Number

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitOr<Number> for Number

type Output = Number

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitXor<Number> for Number

type Output = Number

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl Clone for Number

fn clone(&self) -> Number

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Number

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

Formats the value using the given formatter.

impl Default for Number

fn default() -> Number

Returns the “default value” for a type.

impl Display for Number

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

Formats the value using the given formatter.

impl From<&'_ IeeeFloat<DoubleS>> for Number

fn from(val: &Double) -> Self

Performs the conversion.

impl From<&'_ IeeeFloat<HalfS>> for Number

fn from(val: &Half) -> Self

Performs the conversion.

impl From<&'_ IeeeFloat<QuadS>> for Number

fn from(val: &Quad) -> Self

Performs the conversion.

impl From<&'_ IeeeFloat<SingleS>> for Number

fn from(val: &Single) -> Self

Performs the conversion.

impl From<&'_ IeeeFloat<X87DoubleExtendedS>> for Number

fn from(val: &X87DoubleExtended) -> Self

Performs the conversion.

impl From<&'_ Number> for MaybeNumber

fn from(val: &Number) -> Self

Performs the conversion.

impl From<&'_ Number> for u8

fn from(val: &Number) -> Self

Performs the conversion.

impl From<&'_ Number> for Half

fn from(val: &Number) -> Self

Performs the conversion.

impl From<&'_ Number> for Single

fn from(val: &Number) -> Self

Performs the conversion.

impl From<&'_ Number> for Double

fn from(val: &Number) -> Self

Performs the conversion.

impl From<&'_ Number> for X87DoubleExtended

fn from(val: &Number) -> Self

Performs the conversion.

impl From<&'_ Number> for Quad

fn from(val: &Number) -> Self

Performs the conversion.

impl From<&'_ Number> for i8

fn from(val: &Number) -> Self

Performs the conversion.

impl From<&'_ Number> for i16

fn from(val: &Number) -> Self

Performs the conversion.

impl From<&'_ Number> for i32

fn from(val: &Number) -> Self

Performs the conversion.

impl From<&'_ Number> for i64

fn from(val: &Number) -> Self

Performs the conversion.

impl From<&'_ Number> for i128

fn from(val: &Number) -> Self

Performs the conversion.

impl From<&'_ Number> for u16

fn from(val: &Number) -> Self

Performs the conversion.

impl From<&'_ Number> for u32

fn from(val: &Number) -> Self

Performs the conversion.

impl From<&'_ Number> for u64

fn from(val: &Number) -> Self

Performs the conversion.

impl From<&'_ Number> for u128

fn from(val: &Number) -> Self

Performs the conversion.

impl From<&'_ Number> for u256

fn from(val: &Number) -> Self

Performs the conversion.

impl From<&'_ Number> for u512

fn from(val: &Number) -> Self

Performs the conversion.

impl From<&'_ Number> for u1024

fn from(val: &Number) -> Self

Performs the conversion.

impl From<&'_ Number> for bf16

fn from(val: &Number) -> Self

Performs the conversion.

impl From<&'_ bf16> for Number

fn from(val: &bf16) -> Self

Performs the conversion.

impl From<&'_ i128> for Number

fn from(val: &i128) -> Self

Performs the conversion.

impl From<&'_ i16> for Number

fn from(val: &i16) -> Self

Performs the conversion.

impl From<&'_ i32> for Number

fn from(val: &i32) -> Self

Performs the conversion.

impl From<&'_ i64> for Number

fn from(val: &i64) -> Self

Performs the conversion.

impl From<&'_ i8> for Number

fn from(val: &i8) -> Self

Performs the conversion.

impl From<&'_ u1024> for Number

fn from(val: &u1024) -> Self

Performs the conversion.

impl From<&'_ u128> for Number

fn from(val: &u128) -> Self

Performs the conversion.

impl From<&'_ u16> for Number

fn from(val: &u16) -> Self

Performs the conversion.

impl From<&'_ u256> for Number

fn from(val: &u256) -> Self

Performs the conversion.

impl From<&'_ u32> for Number

fn from(val: &u32) -> Self

Performs the conversion.

impl From<&'_ u512> for Number

fn from(val: &u512) -> Self

Performs the conversion.

impl From<&'_ u64> for Number

fn from(val: &u64) -> Self

Performs the conversion.

impl From<&'_ u8> for Number

fn from(val: &u8) -> Self

Performs the conversion.

impl From<[u8; 1]> for Number

fn from(val: [u8; 1]) -> Number

Performs the conversion.

impl From<[u8; 1024]> for Number

fn from(val: [u8; 1024]) -> Number

Performs the conversion.

impl From<[u8; 128]> for Number

fn from(val: [u8; 128]) -> Number

Performs the conversion.

impl From<[u8; 16]> for Number

fn from(val: [u8; 16]) -> Number

Performs the conversion.

impl From<[u8; 2]> for Number

fn from(val: [u8; 2]) -> Number

Performs the conversion.

impl From<[u8; 20]> for Number

fn from(val: [u8; 20]) -> Number

Performs the conversion.

impl From<[u8; 256]> for Number

fn from(val: [u8; 256]) -> Number

Performs the conversion.

impl From<[u8; 32]> for Number

fn from(val: [u8; 32]) -> Number

Performs the conversion.

impl From<[u8; 4]> for Number

fn from(val: [u8; 4]) -> Number

Performs the conversion.

impl From<[u8; 512]> for Number

fn from(val: [u8; 512]) -> Number

Performs the conversion.

impl From<[u8; 64]> for Number

fn from(val: [u8; 64]) -> Number

Performs the conversion.

impl From<[u8; 8]> for Number

fn from(val: [u8; 8]) -> Number

Performs the conversion.

impl From<IeeeFloat<DoubleS>> for Number

fn from(val: Double) -> Self

Performs the conversion.

impl From<IeeeFloat<HalfS>> for Number

fn from(val: Half) -> Self

Performs the conversion.

impl From<IeeeFloat<QuadS>> for Number

fn from(val: Quad) -> Self

Performs the conversion.

impl From<IeeeFloat<SingleS>> for Number

fn from(val: Single) -> Self

Performs the conversion.

impl From<IeeeFloat<X87DoubleExtendedS>> for Number

fn from(val: X87DoubleExtended) -> Self

Performs the conversion.

impl From<Number> for MaybeNumber

fn from(val: Number) -> Self

Performs the conversion.

impl From<Number> for [u8; 1]

fn from(val: Number) -> Self

Performs the conversion.

impl From<Number> for [u8; 256]

fn from(val: Number) -> Self

Performs the conversion.

impl From<Number> for [u8; 512]

fn from(val: Number) -> Self

Performs the conversion.

impl From<Number> for [u8; 1024]

fn from(val: Number) -> Self

Performs the conversion.

impl From<Number> for u8

fn from(val: Number) -> Self

Performs the conversion.

impl From<Number> for u16

fn from(val: Number) -> Self

Performs the conversion.

impl From<Number> for u32

fn from(val: Number) -> Self

Performs the conversion.

impl From<Number> for u64

fn from(val: Number) -> Self

Performs the conversion.

impl From<Number> for u128

fn from(val: Number) -> Self

Performs the conversion.

impl From<Number> for u256

fn from(val: Number) -> Self

Performs the conversion.

impl From<Number> for u512

fn from(val: Number) -> Self

Performs the conversion.

impl From<Number> for [u8; 2]

fn from(val: Number) -> Self

Performs the conversion.

impl From<Number> for u1024

fn from(val: Number) -> Self

Performs the conversion.

impl From<Number> for bf16

fn from(val: Number) -> Self

Performs the conversion.

impl From<Number> for Half

fn from(val: Number) -> Self

Performs the conversion.

impl From<Number> for Single

fn from(val: Number) -> Self

Performs the conversion.

impl From<Number> for Double

fn from(val: Number) -> Self

Performs the conversion.

impl From<Number> for X87DoubleExtended

fn from(val: Number) -> Self

Performs the conversion.

impl From<Number> for Quad

fn from(val: Number) -> Self

Performs the conversion.

impl From<Number> for i8

fn from(val: Number) -> Self

Performs the conversion.

impl From<Number> for i16

fn from(val: Number) -> Self

Performs the conversion.

impl From<Number> for i32

fn from(val: Number) -> Self

Performs the conversion.

impl From<Number> for [u8; 4]

fn from(val: Number) -> Self

Performs the conversion.

impl From<Number> for i64

fn from(val: Number) -> Self

Performs the conversion.

impl From<Number> for i128

fn from(val: Number) -> Self

Performs the conversion.

impl From<Number> for [u8; 8]

fn from(val: Number) -> Self

Performs the conversion.

impl From<Number> for [u8; 16]

fn from(val: Number) -> Self

Performs the conversion.

impl From<Number> for [u8; 20]

fn from(val: Number) -> Self

Performs the conversion.

impl From<Number> for [u8; 32]

fn from(val: Number) -> Self

Performs the conversion.

impl From<Number> for [u8; 64]

fn from(val: Number) -> Self

Performs the conversion.

impl From<Number> for [u8; 128]

fn from(val: Number) -> Self

Performs the conversion.

impl From<Step> for Number

fn from(step: Step) -> Self

Performs the conversion.

impl From<bf16> for Number

fn from(val: bf16) -> Self

Performs the conversion.

impl From<i128> for Number

fn from(val: i128) -> Self

Performs the conversion.

impl From<i16> for Number

fn from(val: i16) -> Self

Performs the conversion.

impl From<i32> for Number

fn from(val: i32) -> Self

Performs the conversion.

impl From<i64> for Number

fn from(val: i64) -> Self

Performs the conversion.

impl From<i8> for Number

fn from(val: i8) -> Self

Performs the conversion.

impl From<u1024> for Number

fn from(val: u1024) -> Self

Performs the conversion.

impl From<u128> for Number

fn from(val: u128) -> Self

Performs the conversion.

impl From<u16> for Number

fn from(val: u16) -> Self

Performs the conversion.

impl From<u256> for Number

fn from(val: u256) -> Self

Performs the conversion.

impl From<u32> for Number

fn from(val: u32) -> Self

Performs the conversion.

impl From<u512> for Number

fn from(val: u512) -> Self

Performs the conversion.

impl From<u64> for Number

fn from(val: u64) -> Self

Performs the conversion.

impl From<u8> for Number

fn from(val: u8) -> Self

Performs the conversion.

impl FromStr for Number

type Err = LiteralParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Number

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, 

Feeds a slice of this type into the given Hasher.

impl Index<Range<u16>> for Number

type Output = [u8]

The returned type after indexing.

fn index(&self, index: Range<u16>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<RangeFrom<u16>> for Number

type Output = [u8]

The returned type after indexing.

fn index(&self, index: RangeFrom<u16>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<RangeFull> for Number

type Output = [u8]

The returned type after indexing.

fn index(&self, _: RangeFull) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<RangeInclusive<u16>> for Number

type Output = [u8]

The returned type after indexing.

fn index(&self, index: RangeInclusive<u16>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<RangeTo<u16>> for Number

type Output = [u8]

The returned type after indexing.

fn index(&self, index: RangeTo<u16>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<RangeToInclusive<u16>> for Number

type Output = [u8]

The returned type after indexing.

fn index(&self, index: RangeToInclusive<u16>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<u16> for Number

type Output = u8

The returned type after indexing.

fn index(&self, index: u16) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<Range<u16>> for Number

fn index_mut(&mut self, index: Range<u16>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<RangeFrom<u16>> for Number

fn index_mut(&mut self, index: RangeFrom<u16>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<RangeFull> for Number

fn index_mut(&mut self, _: RangeFull) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<RangeInclusive<u16>> for Number

fn index_mut(&mut self, index: RangeInclusive<u16>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<RangeTo<u16>> for Number

fn index_mut(&mut self, index: RangeTo<u16>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<RangeToInclusive<u16>> for Number

fn index_mut(&mut self, index: RangeToInclusive<u16>) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<u16> for Number

fn index_mut(&mut self, index: u16) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl LowerExp for Number

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

Formats the value using the given formatter.

impl LowerHex for Number

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

Formats the value using the given formatter.

impl Neg for Number

type Output = Number

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Not for Number

type Output = Number

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl Octal for Number

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

Formats the value using the given formatter.

impl Ord for Number

Since we always convert NaN values into None and keep them at the level of MaybeNumber, we can do strict ordering even on float numbers

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<Number> for Number

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

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

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

This method tests for !=.

impl PartialOrd<Number> for Number

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

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

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

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

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

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

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

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

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 Rem<Number> for Number

type Output = Option<Number>

The resulting type after applying the % operator.

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

Performs the % operation.

impl Shl<Number> for Number

type Output = Number

The resulting type after applying the << operator.

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

Performs the << operation.

impl Shr<Number> for Number

type Output = Number

The resulting type after applying the >> operator.

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

Performs the >> operation.

impl UpperExp for Number

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

Formats the value using the given formatter.

impl UpperHex for Number

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

Formats the value using the given formatter.

impl Copy for Number

impl Eq for Number