Struct arithmetic_eval::arith::CheckedArithmetic

pub struct CheckedArithmetic<Kind = Checked>(/* private fields */);

Arithmetic on an integer type (e.g., i32) that checks overflow and other failure conditions for all operations.

As an example, this type implements Arithmetic for all built-in integer types with a definite size (u8, i8, u16, i16, u32, i32, u64, i64, u128, i128).

The type param defines how negation should be performed; it should be one of Checked (default value), Unchecked or NegateOnlyZero. See the docs for these types for more details.

Implementations

impl<Kind> CheckedArithmetic<Kind>

pub const fn new() -> Self

Creates a new arithmetic instance.

Trait Implementations

impl<T, Kind> Arithmetic<T> for CheckedArithmetic<Kind>

where T: Clone + PartialEq + Zero + One + CheckedAdd + CheckedSub + CheckedMul + CheckedDiv, Kind: CheckedArithmeticKind<T>, usize: TryFrom<T>,

fn add(&self, x: T, y: T) -> Result<T, ArithmeticError>

Adds two values.

fn sub(&self, x: T, y: T) -> Result<T, ArithmeticError>

Subtracts two values.

fn mul(&self, x: T, y: T) -> Result<T, ArithmeticError>

Multiplies two values.

fn div(&self, x: T, y: T) -> Result<T, ArithmeticError>

Divides two values.

fn pow(&self, x: T, y: T) -> Result<T, ArithmeticError>

Raises x to the power of y.

fn neg(&self, x: T) -> Result<T, ArithmeticError>

Negates a value.

fn eq(&self, x: &T, y: &T) -> bool

Checks if two values are equal. Note that equality can be a non-trivial operation; e.g., different numbers may be equal as per modular arithmetic.

impl<Kind> Clone for CheckedArithmetic<Kind>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Kind: Debug> Debug for CheckedArithmetic<Kind>

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

Formats the value using the given formatter.

impl<Kind> Default for CheckedArithmetic<Kind>

fn default() -> Self

Returns the “default value” for a type.

impl<T, Kind> OrdArithmetic<T> for CheckedArithmetic<Kind>

where Self: Arithmetic<T>, T: PartialOrd,

fn partial_cmp(&self, x: &T, y: &T) -> Option<Ordering>

Compares two values. Returns None if the numbers are not comparable, or the comparison result otherwise.

impl<Kind> Copy for CheckedArithmetic<Kind>