Struct diffgeom::typenum::UInt []

pub struct UInt<U, B> { /* fields omitted */ }

UInt is defined recursively, where B is the least significant bit and U is the rest of the number. Conceptually, U should be bound by the trait Unsigned and B should be bound by the trait Bit, but enforcing these bounds causes linear instead of logrithmic scaling in some places, so they are left off for now. They may be enforced in future.

In order to keep numbers unique, leading zeros are not allowed, so UInt<UTerm, B0> is forbidden.

Example

use typenum::{B0, B1, UInt, UTerm};

type U6 = UInt<UInt<UInt<UTerm, B1>, B1>, B0>;

Methods

impl<U, B> UInt<U, B> where
    B: Bit,
    U: Unsigned

Instantiates a singleton representing this unsigned integer.

Trait Implementations

impl<U, B> Clone for UInt<U, B> where
    B: Clone,
    U: Clone

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

impl<U, B> Cmp<UTerm> for UInt<U, B> where
    B: Bit,
    U: Unsigned

Nonzero > Zero

The result of the comparison. It should only ever be one of Greater, Less, or Equal.

impl<Ul, Ur> Cmp<UInt<Ur, B1>> for UInt<Ul, B1> where
    Ul: Unsigned + PrivateCmp<Ur, Equal>,
    Ur: Unsigned

UInt<Ul, B1> cmp with UInt<Ur, B1>: SoFar is Equal

The result of the comparison. It should only ever be one of Greater, Less, or Equal.

impl<Ul, Ur> Cmp<UInt<Ur, B1>> for UInt<Ul, B0> where
    Ul: Unsigned + PrivateCmp<Ur, Less>,
    Ur: Unsigned

UInt<Ul, B0> cmp with UInt<Ur, B1>: SoFar is Less

The result of the comparison. It should only ever be one of Greater, Less, or Equal.

impl<Ul, Ur> Cmp<UInt<Ur, B0>> for UInt<Ul, B1> where
    Ul: Unsigned + PrivateCmp<Ur, Greater>,
    Ur: Unsigned

UInt<Ul, B1> cmp with UInt<Ur, B0>: SoFar is Greater

The result of the comparison. It should only ever be one of Greater, Less, or Equal.

impl<Ul, Ur> Cmp<UInt<Ur, B0>> for UInt<Ul, B0> where
    Ul: Unsigned + PrivateCmp<Ur, Equal>,
    Ur: Unsigned

UInt<Ul, B0> cmp with UInt<Ur, B0>: SoFar is Equal

The result of the comparison. It should only ever be one of Greater, Less, or Equal.

impl<Ul, Ur> Add<UInt<Ur, B0>> for UInt<Ul, B0> where
    Ul: Unsigned + Add<Ur>,
    Ur: Unsigned

UInt<Ul, B0> + UInt<Ur, B0> = UInt<Ul + Ur, B0>

The resulting type after applying the + operator

The method for the + operator

impl<Ul, Ur> Add<UInt<Ur, B0>> for UInt<Ul, B1> where
    Ul: Unsigned + Add<Ur>,
    Ur: Unsigned

UInt<Ul, B1> + UInt<Ur, B0> = UInt<Ul + Ur, B1>

The resulting type after applying the + operator

The method for the + operator

impl<U> Add<B1> for UInt<U, B1> where
    U: Unsigned + Add<B1>,
    <U as Add<B1>>::Output: Unsigned

UInt<U, B1> + B1 = UInt<U + B1, B0>

The resulting type after applying the + operator

The method for the + operator

impl<Ul, Ur> Add<UInt<Ur, B1>> for UInt<Ul, B1> where
    Ul: Unsigned + Add<Ur>,
    Ur: Unsigned,
    <Ul as Add<Ur>>::Output: Add<B1>, 

UInt<Ul, B1> + UInt<Ur, B1> = UInt<(Ul + Ur) + B1, B0>

The resulting type after applying the + operator

The method for the + operator

impl<Ul, Ur> Add<UInt<Ur, B1>> for UInt<Ul, B0> where
    Ul: Unsigned + Add<Ur>,
    Ur: Unsigned

UInt<Ul, B0> + UInt<Ur, B1> = UInt<Ul + Ur, B1>

The resulting type after applying the + operator

The method for the + operator

impl<U> Add<B1> for UInt<U, B0> where
    U: Unsigned

UInt<U, B0> + B1 = UInt<U + B1>

The resulting type after applying the + operator

The method for the + operator

impl<U, B> Add<B0> for UInt<U, B> where
    B: Bit,
    U: Unsigned

U + B0 = U

The resulting type after applying the + operator

The method for the + operator

impl<U, B> Add<UTerm> for UInt<U, B> where
    B: Bit,
    U: Unsigned

UInt<U, B> + UTerm = UInt<U, B>

The resulting type after applying the + operator

The method for the + operator

impl<U, B> Shr<B1> for UInt<U, B> where
    B: Bit,
    U: Unsigned

Shifting right a UInt by a 1 bit: UInt<U, B> >> B1 = U

impl<U, B> Shr<B0> for UInt<U, B> where
    B: Bit,
    U: Unsigned

Shifting right any unsigned by a zero bit: U >> B0 = U

impl<U, B, Ur, Br> Shr<UInt<Ur, Br>> for UInt<U, B> where
    B: Bit,
    Br: Bit,
    U: Unsigned + Shr<<UInt<Ur, Br> as Sub<B1>>::Output>,
    Ur: Unsigned,
    UInt<Ur, Br>: Sub<B1>, 

Shifting right UInt by UInt: UInt(U, B) >> Y = U >> (Y - 1)

impl<U, B> Shr<UTerm> for UInt<U, B> where
    B: Bit,
    U: Unsigned

Shifting right UInt by UTerm: UInt<U, B> >> UTerm = UInt<U, B>

impl<U, B> Debug for UInt<U, B> where
    B: Debug,
    U: Debug

Formats the value using the given formatter.

impl<U, B> Eq for UInt<U, B> where
    B: Eq,
    U: Eq

impl<Ul, Bl, Ur> BitXor<Ur> for UInt<Ul, Bl> where
    Bl: Bit,
    Ul: Unsigned,
    Ur: Unsigned,
    UInt<Ul, Bl>: PrivateXor<Ur>,
    <UInt<Ul, Bl> as PrivateXor<Ur>>::Output: Trim, 

Xoring unsigned integers. We use our PrivateXor operator and then Trim the output.

impl<U, B, Ur, Br> Shl<UInt<Ur, Br>> for UInt<U, B> where
    B: Bit,
    Br: Bit,
    U: Unsigned,
    Ur: Unsigned,
    UInt<Ur, Br>: Sub<B1>,
    UInt<UInt<U, B>, B0>: Shl<<UInt<Ur, Br> as Sub<B1>>::Output>, 

Shifting left UInt by UInt: X << Y = UInt(X, B0) << (Y - 1)

impl<U, B> Shl<B1> for UInt<U, B> where
    B: Bit,
    U: Unsigned

Shifting left a UInt by a one bit: UInt<U, B> << B1 = UInt<UInt<U, B>, B0>

impl<U, B> Shl<B0> for UInt<U, B> where
    B: Bit,
    U: Unsigned

Shifting left any unsigned by a zero bit: U << B0 = U

impl<U, B> Shl<UTerm> for UInt<U, B> where
    B: Bit,
    U: Unsigned

Shifting left UInt by UTerm: UInt<U, B> << UTerm = UInt<U, B>

impl<U, B, Ur> Min<Ur> for UInt<U, B> where
    B: Bit,
    U: Unsigned,
    Ur: Unsigned,
    UInt<U, B>: Cmp<Ur>,
    UInt<U, B>: PrivateMin<Ur, <UInt<U, B> as Cmp<Ur>>::Output>, 

The type of the minimum of Self and Rhs

Method returning the minimum

impl<U, B> Len for UInt<U, B> where
    B: Bit,
    U: Unsigned + Len,
    <U as Len>::Output: Add<B1>,
    <<U as Len>::Output as Add<B1>>::Output: Unsigned

Length of a bit is 1

The length as a type-level unsigned integer.

This function isn't used in this crate, but may be useful for others.

impl<Ul, Bl, Ur, Br> Rem<UInt<Ur, Br>> for UInt<Ul, Bl> where
    Bl: Bit,
    Br: Bit,
    Ul: Unsigned,
    Ur: Unsigned,
    UInt<Ul, Bl>: Len,
    <UInt<Ul, Bl> as Len>::Output: Sub<B1>,
    (): PrivateDiv<UInt<Ul, Bl>, UInt<Ur, Br>, UTerm, UTerm, <<UInt<Ul, Bl> as Len>::Output as Sub<B1>>::Output>, 

impl<Ul, B, Ur> Mul<UInt<Ur, B>> for UInt<Ul, B0> where
    B: Bit,
    Ul: Unsigned + Mul<UInt<Ur, B>>,
    Ur: Unsigned

UInt<Ul, B0> * UInt<Ur, B> = UInt<(Ul * UInt<Ur, B>), B0>

The resulting type after applying the * operator

The method for the * operator

impl<U, B> Mul<UTerm> for UInt<U, B> where
    B: Bit,
    U: Unsigned

UInt<U, B> * UTerm = UTerm

The resulting type after applying the * operator

The method for the * operator

impl<U, B> Mul<B0> for UInt<U, B> where
    B: Bit,
    U: Unsigned

UInt * B0 = UTerm

The resulting type after applying the * operator

The method for the * operator

impl<U, B> Mul<B1> for UInt<U, B> where
    B: Bit,
    U: Unsigned

UInt * B1 = UInt

The resulting type after applying the * operator

The method for the * operator

impl<Ul, B, Ur> Mul<UInt<Ur, B>> for UInt<Ul, B1> where
    B: Bit,
    Ul: Unsigned + Mul<UInt<Ur, B>>,
    Ur: Unsigned,
    UInt<<Ul as Mul<UInt<Ur, B>>>::Output, B0>: Add<UInt<Ur, B>>, 

UInt<Ul, B1> * UInt<Ur, B> = UInt<(Ul * UInt<Ur, B>), B0> + UInt<Ur, B>

The resulting type after applying the * operator

The method for the * operator

impl<Un, Bn> GetBit<UTerm> for UInt<Un, Bn>

impl<Un, Bn, Ui, Bi> GetBit<UInt<Ui, Bi>> for UInt<Un, Bn> where
    Un: GetBit<<UInt<Ui, Bi> as Sub<B1>>::Output>,
    UInt<Ui, Bi>: Sub<B1>, 

impl<Ul, Bl, Ur, Br> Div<UInt<Ur, Br>> for UInt<Ul, Bl> where
    Bl: Bit,
    Br: Bit,
    Ul: Unsigned,
    Ur: Unsigned,
    UInt<Ul, Bl>: Len,
    <UInt<Ul, Bl> as Len>::Output: Sub<B1>,
    (): PrivateDiv<UInt<Ul, Bl>, UInt<Ur, Br>, UTerm, UTerm, <<UInt<Ul, Bl> as Len>::Output as Sub<B1>>::Output>, 

The resulting type after applying the / operator

The method for the / operator

impl<U, B> Unsigned for UInt<U, B> where
    B: Bit,
    U: Unsigned

impl<U, B> Default for UInt<U, B> where
    B: Default,
    U: Default

impl<Ul, Ur> BitOr<UInt<Ur, B1>> for UInt<Ul, B0> where
    Ul: Unsigned + BitOr<Ur>,
    Ur: Unsigned

UInt<Ul, B0> | UInt<Ur, B1> = UInt<Ul | Ur, B1>

impl<Ul, Ur> BitOr<UInt<Ur, B1>> for UInt<Ul, B1> where
    Ul: Unsigned + BitOr<Ur>,
    Ur: Unsigned

UInt<Ul, B1> | UInt<Ur, B1> = UInt<Ul | Ur, B1>

impl<Ul, Ur> BitOr<UInt<Ur, B0>> for UInt<Ul, B0> where
    Ul: Unsigned + BitOr<Ur>,
    Ur: Unsigned

UInt<Ul, B0> | UInt<Ur, B0> = UInt<Ul | Ur, B0>

impl<Ul, Ur> BitOr<UInt<Ur, B0>> for UInt<Ul, B1> where
    Ul: Unsigned + BitOr<Ur>,
    Ur: Unsigned

UInt<Ul, B1> | UInt<Ur, B0> = UInt<Ul | Ur, B1>

impl<B, U> BitOr<UTerm> for UInt<U, B> where
    B: Bit,
    U: Unsigned

X | UTerm = X

impl<U, B> NonZero for UInt<U, B> where
    B: Bit,
    U: Unsigned

impl<U, B> PartialOrd<UInt<U, B>> for UInt<U, B> where
    B: PartialOrd<B>,
    U: PartialOrd<U>, 

impl<U, B> Hash for UInt<U, B> where
    B: Hash,
    U: Hash

impl<U, B> PartialEq<UInt<U, B>> for UInt<U, B> where
    B: PartialEq<B>,
    U: PartialEq<U>, 

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

This method tests for !=.

impl<U, B, Ur> Max<Ur> for UInt<U, B> where
    B: Bit,
    U: Unsigned,
    Ur: Unsigned,
    UInt<U, B>: Cmp<Ur>,
    UInt<U, B>: PrivateMax<Ur, <UInt<U, B> as Cmp<Ur>>::Output>, 

The type of the maximum of Self and Rhs

Method returning the maximum

impl<Ul, Bl, Ur, Br> PartialDiv<UInt<Ur, Br>> for UInt<Ul, Bl> where
    Bl: Bit,
    Br: Bit,
    Ul: Unsigned,
    Ur: Unsigned,
    UInt<Ul, Bl>: Div<UInt<Ur, Br>>,
    UInt<Ul, Bl>: Rem<UInt<Ur, Br>>,
    <UInt<Ul, Bl> as Rem<UInt<Ur, Br>>>::Output == UTerm

The type of the result of the division

Method for performing the division

impl<Ul, Bl, Ur> BitAnd<Ur> for UInt<Ul, Bl> where
    Bl: Bit,
    Ul: Unsigned,
    Ur: Unsigned,
    UInt<Ul, Bl>: PrivateAnd<Ur>,
    <UInt<Ul, Bl> as PrivateAnd<Ur>>::Output: Trim, 

Anding unsigned integers. We use our PrivateAnd operator and then Trim the output.

impl<U, B> Sub<B0> for UInt<U, B> where
    B: Bit,
    U: Unsigned

UInt - B0 = UInt

The resulting type after applying the - operator

The method for the - operator

impl<Ul, Bl, Ur> Sub<Ur> for UInt<Ul, Bl> where
    Bl: Bit,
    Ul: Unsigned,
    Ur: Unsigned,
    UInt<Ul, Bl>: PrivateSub<Ur>,
    <UInt<Ul, Bl> as PrivateSub<Ur>>::Output: Trim, 

Subtracting unsigned integers. We just do our PrivateSub and then Trim the output.

The resulting type after applying the - operator

The method for the - operator

impl<U, B> Sub<B1> for UInt<UInt<U, B>, B1> where
    B: Bit,
    U: Unsigned

UInt<U, B1> - B1 = UInt<U, B0>

The resulting type after applying the - operator

The method for the - operator

impl Sub<B1> for UInt<UTerm, B1>

UInt<UTerm, B1> - B1 = UTerm

The resulting type after applying the - operator

The method for the - operator

impl<U> Sub<B1> for UInt<U, B0> where
    U: Unsigned + Sub<B1>,
    <U as Sub<B1>>::Output: Unsigned

UInt<U, B0> - B1 = UInt<U - B1, B1>

The resulting type after applying the - operator

The method for the - operator

impl<U, B> Ord for UInt<U, B> where
    B: Ord,
    U: Ord

impl<U, B> Copy for UInt<U, B> where
    B: Copy,
    U: Copy

impl<T, N> ArrayLength<T> for UInt<N, B0> where
    N: ArrayLength<T>, 
[src]

Associated type representing the array type for the number

impl<T, N> ArrayLength<T> for UInt<N, B1> where
    N: ArrayLength<T>, 
[src]

Associated type representing the array type for the number