num_integer - Rust
Description: Integer trait and functions.
Keywords: rust, rustlang, rust-lang, num_integer

# Crate num_integer

source ·
Expand description

Integer trait and functions.

### Compatibility

The `num-integer` crate is tested for rustc 1.8 and greater.

## Structs

ExtendedGcd
Greatest common divisor and Bézout coefficients
IterBinomial
An iterator over binomial coefficients.

## Traits

Average
Provides methods to compute the average of two integers, without overflows.
Integer
Roots
Provides methods to compute an integer’s square root, cube root, and arbitrary `n`th root.

## Functions

average_ceil
Returns the ceiling value of the average of `x` and `y` – see Average::average_ceil.
average_floor
Returns the floor value of the average of `x` and `y` – see Average::average_floor.
binomial
Calculate the binomial coefficient.
cbrt
Returns the truncated principal cube root of an integer – see Roots::cbrt.
div_ceil
Ceiled integer division
div_floor
Floored integer division
div_mod_floor
Simultaneous floored integer division and modulus
div_rem
Simultaneous integer division and modulus
gcd
Calculates the Greatest Common Divisor (GCD) of the number and `other`. The result is always non-negative.
gcd_lcm
Calculates the Greatest Common Divisor (GCD) and Lowest Common Multiple (LCM) of the number and `other`.
lcm
Calculates the Lowest Common Multiple (LCM) of the number and `other`.
mod_floor
Floored integer modulus
multinomial
Calculate the multinomial coefficient.
nth_root
Returns the truncated principal `n`th root of an integer – see Roots::nth_root.
sqrt
Returns the truncated principal square root of an integer – see Roots::sqrt.