Struct BinomialIter

pub struct BinomialIter { /* private fields */ }

Provides methods to calculate the binomial coefficient for the next higher/lower n/k.

Implementations

impl BinomialIter

pub fn new(n: u32, k: u32) -> BinomialIter

Create a new BinomialIter. This will calculate the binomial coefficient once using the recursive definition.

Panics

If k > n

pub fn n(&self) -> u32

Access the current value of n.

pub fn k(&self) -> u32

Access the current value of k.

pub fn binom(&self) -> u32

Access the current value of n choose k.

pub fn inc_n(&mut self) -> Option<(u32, u32)>

Increase n by one and update the internal state accordingly.

Returns None when calculating n + 1 choose k would overflow, otherwise Some((n + 1, binom)).

pub fn dec_n(&mut self) -> Option<(u32, u32)>

Decrease n by one and update the internal state accordingly.

Returns None when calculating n - 1 choose k would overflow or n - 1 < k, otherwise Some((n - 1, binom)).

pub fn inc_k(&mut self) -> Option<(u32, u32)>

Increase k by one and update the internal state accordingly.

Returns None when calculating n choose k + 1 would overflow or n < k + 1, otherwise Some((k + 1, binom)).

pub fn dec_k(&mut self) -> Option<(u32, u32)>

Decrease k by one and update the internal state accordingly.

Returns None when calculating n choose k - 1 would overflow or k - 1 < 0, otherwise Some((k - 1, binom))

impl BinomialIter

pub fn iter_inc_n(self) -> IncNIter

Returns an iterator which wraps this BinomialIter, returns the current value of n and binom on the first call to next and the result of calling inc_n on the underlying BinominalIter for subsequent calls to next.

impl BinomialIter

pub fn iter_dec_n(self) -> DecNIter

Returns an iterator which wraps this BinomialIter, returns the current value of n and binom on the first call to next and the result of calling dec_n on the underlying BinominalIter for subsequent calls to next.

impl BinomialIter

pub fn iter_inc_k(self) -> IncKIter

Returns an iterator which wraps this BinomialIter, returns the current value of k and binom on the first call to next and the result of calling inc_k on the underlying BinominalIter for subsequent calls to next.

impl BinomialIter

pub fn iter_dec_k(self) -> DecKIter

Returns an iterator which wraps this BinomialIter, returns the current value of k and binom on the first call to next and the result of calling dec_k on the underlying BinominalIter for subsequent calls to next.

Trait Implementations

impl Clone for BinomialIter

fn clone(&self) -> BinomialIter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq for BinomialIter

fn eq(&self, other: &BinomialIter) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for BinomialIter

impl Eq for BinomialIter

impl StructuralPartialEq for BinomialIter