Struct fix::Fix

pub struct Fix<Bits, Base, Exp> {
    pub bits: Bits,
    // some fields omitted
}

Fixed-point number representing Bits × Base ^Exp.

• Bits is an integer primitive type, or any type which can be created from a type-level integer and exponentiated.
• Base is an Unsigned type-level integer.
• Exp is a signed type-level Integer.

Summary of operations

Lower case variables represent values of Bits. Upper case B and E represent type-level integers Base and Exp, respectively.

• −(x B^E) = (−x) B^E
• (x B^E) + (y B^E) = (x + y) B^E
• (x B^E) − (y B^E) = (x − y) B^E
• (x B^E_x) × (y B^E_y) = (x × y) B^{E_x + E_y}
• (x B^E_x) ÷ (y B^E_y) = (x ÷ y) B^{E_x − E_y}
• (x B^E_x) % (y B^E_y) = (x % y) B^E_x
• (x B^E) × y = (x × y) B^E
• (x B^E) ÷ y = (x ÷ y) B^E
• (x B^E) % y = (x % y) B^E

Fields

bits: Bits

The underlying integer.

Methods

impl<Bits, Base, Exp> Fix<Bits, Base, Exp>

fn new(bits: Bits) -> Self

Creates a number.

Examples

use fix::aliases::si::{Kilo, Milli};
Milli::new(25); // 0.025
Kilo::new(25); // 25 000

fn convert<ToExp>(self) -> Fix<Bits, Base, ToExp> where
    Bits: FromUnsigned + Pow + Mul<Output = Bits> + Div<Output = Bits>,
    Base: Unsigned,
    Exp: Sub<ToExp>,
    Diff<Exp, ToExp>: Abs + IsLess<Z0>,
    AbsVal<Diff<Exp, ToExp>>: Integer, 

Converts to another Exp.

Examples

use fix::aliases::si::{Kilo, Milli};
let kilo = Kilo::new(5);
let milli = Milli::new(5_000_000);
assert_eq!(kilo, milli.convert());
assert_eq!(milli, kilo.convert());

Trait Implementations

impl<Bits, Base, Exp> Copy for Fix<Bits, Base, Exp> where
    Bits: Copy, 

impl<Bits, Base, Exp> Clone for Fix<Bits, Base, Exp> where
    Bits: Clone, 

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Bits, Base, Exp> Default for Fix<Bits, Base, Exp> where
    Bits: Default, 

fn default() -> Self

Returns the "default value" for a type.

impl<Bits, Base, Exp> Hash for Fix<Bits, Base, Exp> where
    Bits: Hash, 

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

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<Bits, Base, Exp> Debug for Fix<Bits, Base, Exp> where
    Bits: Debug,
    Base: Unsigned,
    Exp: Integer, 

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

Formats the value using the given formatter.

impl<Bits, Base, Exp> Eq for Fix<Bits, Base, Exp> where
    Bits: Eq, 

impl<Bits, Base, Exp> PartialEq for Fix<Bits, Base, Exp> where
    Bits: PartialEq, 

fn eq(&self, rhs: &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<Bits, Base, Exp> PartialOrd for Fix<Bits, Base, Exp> where
    Bits: PartialOrd, 

fn partial_cmp(&self, rhs: &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<Bits, Base, Exp> Ord for Fix<Bits, Base, Exp> where
    Bits: Ord, 

fn cmp(&self, rhs: &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.

impl<Bits, Base, Exp> Neg for Fix<Bits, Base, Exp> where
    Bits: Neg<Output = Bits>, 

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl<Bits, Base, Exp> Add for Fix<Bits, Base, Exp> where
    Bits: Add<Output = Bits>, 

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl<Bits, Base, Exp> Sub for Fix<Bits, Base, Exp> where
    Bits: Sub<Output = Bits>, 

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl<Bits, Base, LExp, RExp> Mul<Fix<Bits, Base, RExp>> for Fix<Bits, Base, LExp> where
    Bits: Mul<Output = Bits>,
    LExp: Add<RExp>, 

type Output = Fix<Bits, Base, Sum<LExp, RExp>>

The resulting type after applying the * operator.

fn mul(self, rhs: Fix<Bits, Base, RExp>) -> Self::Output

Performs the * operation.

impl<Bits, Base, LExp, RExp> Div<Fix<Bits, Base, RExp>> for Fix<Bits, Base, LExp> where
    Bits: Div<Output = Bits>,
    LExp: Sub<RExp>, 

type Output = Fix<Bits, Base, Diff<LExp, RExp>>

The resulting type after applying the / operator.

fn div(self, rhs: Fix<Bits, Base, RExp>) -> Self::Output

Performs the / operation.

impl<Bits, Base, Exp> Rem for Fix<Bits, Base, Exp> where
    Bits: Rem<Output = Bits>, 

type Output = Self

The resulting type after applying the % operator.

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

Performs the % operation.

impl<Bits, Base, Exp> Mul<Bits> for Fix<Bits, Base, Exp> where
    Bits: Mul<Output = Bits>, 

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl<Bits, Base, Exp> Div<Bits> for Fix<Bits, Base, Exp> where
    Bits: Div<Output = Bits>, 

type Output = Self

The resulting type after applying the / operator.

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

Performs the / operation.

impl<Bits, Base, Exp> Rem<Bits> for Fix<Bits, Base, Exp> where
    Bits: Rem<Output = Bits>, 

type Output = Self

The resulting type after applying the % operator.

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

Performs the % operation.

impl<Bits, Base, Exp> AddAssign for Fix<Bits, Base, Exp> where
    Bits: AddAssign, 

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl<Bits, Base, Exp> SubAssign for Fix<Bits, Base, Exp> where
    Bits: SubAssign, 

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl<Bits, Base, Exp> MulAssign<Bits> for Fix<Bits, Base, Exp> where
    Bits: MulAssign, 

fn mul_assign(&mut self, rhs: Bits)

Performs the *= operation.

impl<Bits, Base, Exp> DivAssign<Bits> for Fix<Bits, Base, Exp> where
    Bits: DivAssign, 

fn div_assign(&mut self, rhs: Bits)

Performs the /= operation.

impl<Bits, Base, LExp, RExp> RemAssign<Fix<Bits, Base, RExp>> for Fix<Bits, Base, LExp> where
    Bits: RemAssign, 

fn rem_assign(&mut self, rhs: Fix<Bits, Base, RExp>)

Performs the %= operation.

impl<Bits, Base, Exp> RemAssign<Bits> for Fix<Bits, Base, Exp> where
    Bits: RemAssign, 

fn rem_assign(&mut self, rhs: Bits)

Performs the %= operation.