Struct bare_metal_modulo::OffsetNumC

pub struct OffsetNumC<N: FromPrimitive, const M: usize, const O: isize> { /* private fields */ }

Implementations

impl<N: NumType, const M: usize, const O: isize> OffsetNumC<N, M, O>

pub fn new(num: N) -> Self

pub fn iter(&self) -> ModNumIterator<N, Self>

Returns an iterator starting at a (mod m) and ending at a - 1 (mod m)

pub fn min_max(&self) -> (N, N)

Returns the minimum and maximum possible values.

Trait Implementations

impl<N: NumType, const M: usize, const O: isize> Add<N> for OffsetNumC<N, M, O>

type Output = OffsetNumC<N, M, O>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<N: NumType, const M: usize, const O: isize> Add<OffsetNumC<N, M, O>> for OffsetNumC<N, M, O>

type Output = OffsetNumC<N, M, O>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<N: NumType, const M: usize, const O: isize> AddAssign<N> for OffsetNumC<N, M, O>

fn add_assign(&mut self, rhs: N)

Performs the += operation.

impl<N: NumType, const M: usize, const O: isize> AddAssign<OffsetNumC<N, M, O>> for OffsetNumC<N, M, O>

fn add_assign(&mut self, rhs: OffsetNumC<N, M, O>)

Performs the += operation.

impl<N: Clone + FromPrimitive, const M: usize, const O: isize> Clone for OffsetNumC<N, M, O>

fn clone(&self) -> OffsetNumC<N, M, O>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N: Debug + FromPrimitive, const M: usize, const O: isize> Debug for OffsetNumC<N, M, O>

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

Formats the value using the given formatter.

impl<N: Default + FromPrimitive, const M: usize, const O: isize> Default for OffsetNumC<N, M, O>

fn default() -> OffsetNumC<N, M, O>

Returns the “default value” for a type.

impl<N: Hash + FromPrimitive, const M: usize, const O: isize> Hash for OffsetNumC<N, M, O>

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<N: NumType, const M: usize, const O: isize> MNum for OffsetNumC<N, M, O>

type Num = N

fn a(&self) -> Self::Num

fn m(&self) -> Self::Num

fn with(&self, new_a: Self::Num) -> Self

fn replace(&mut self, new_a: Self::Num)

impl<N: NumType, const M: usize, const O: isize> Neg for OffsetNumC<N, M, O>

type Output = OffsetNumC<N, M, O>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<N: Ord + FromPrimitive, const M: usize, const O: isize> Ord for OffsetNumC<N, M, O>

fn cmp(&self, other: &OffsetNumC<N, M, O>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<N: NumType, const M: usize, const O: isize> PartialEq<N> for OffsetNumC<N, M, O>

Returns true if other is congruent to self.a() (mod self.m())

fn eq(&self, other: &N) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<N: PartialEq + FromPrimitive, const M: usize, const O: isize> PartialEq<OffsetNumC<N, M, O>> for OffsetNumC<N, M, O>

fn eq(&self, other: &OffsetNumC<N, M, O>) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<N: NumType, const M: usize, const O: isize> PartialOrd<N> for OffsetNumC<N, M, O>

fn partial_cmp(&self, other: &N) -> 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<N: PartialOrd + FromPrimitive, const M: usize, const O: isize> PartialOrd<OffsetNumC<N, M, O>> for OffsetNumC<N, M, O>

fn partial_cmp(&self, other: &OffsetNumC<N, M, O>) -> 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<N: NumType, const M: usize, const O: isize> Sub<N> for OffsetNumC<N, M, O>

type Output = OffsetNumC<N, M, O>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<N: NumType, const M: usize, const O: isize> Sub<OffsetNumC<N, M, O>> for OffsetNumC<N, M, O>

type Output = OffsetNumC<N, M, O>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<N: NumType, const M: usize, const O: isize> SubAssign<N> for OffsetNumC<N, M, O>

fn sub_assign(&mut self, rhs: N)

Performs the -= operation.

impl<N: NumType, const M: usize, const O: isize> SubAssign<OffsetNumC<N, M, O>> for OffsetNumC<N, M, O>

fn sub_assign(&mut self, rhs: OffsetNumC<N, M, O>)

Performs the -= operation.

impl<N: Copy + FromPrimitive, const M: usize, const O: isize> Copy for OffsetNumC<N, M, O>

impl<N: Eq + FromPrimitive, const M: usize, const O: isize> Eq for OffsetNumC<N, M, O>

impl<N: FromPrimitive, const M: usize, const O: isize> StructuralEq for OffsetNumC<N, M, O>

impl<N: FromPrimitive, const M: usize, const O: isize> StructuralPartialEq for OffsetNumC<N, M, O>