Struct sparse_bin_mat::BinNum

pub struct BinNum { /* fields omitted */ }

A wrapper around an integer limited to value 0 and 1.

Implementations

impl BinNum

pub fn new(number: u8) -> Self

Returns a new BinNum.

Panic

Panics if the given number is not 0 or 1.

pub fn one() -> Self

Returns the binary number 1.

pub fn zero() -> Self

Returns the binary number 0.

pub fn is_one(self) -> bool

Checks if a binary number has value 1.

pub fn is_zero(self) -> bool

Checks if a binary number has value 0.

Trait Implementations

impl Add<BinNum> for BinNum

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self

Performs the + operation.

impl AddAssign<BinNum> for BinNum

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl Clone for BinNum

fn clone(&self) -> BinNum

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for BinNum

impl Debug for BinNum

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

Formats the value using the given formatter.

impl Display for BinNum

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

Formats the value using the given formatter.

impl Eq for BinNum

impl From<u8> for BinNum

fn from(number: u8) -> Self

Performs the conversion.

impl Hash for BinNum

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Mul<BinNum> for BinNum

type Output = Self

The resulting type after applying the * operator.

fn mul(self, other: Self) -> Self

Performs the * operation.

impl MulAssign<BinNum> for BinNum

fn mul_assign(&mut self, other: Self)

Performs the *= operation.

impl Ord for BinNum

fn cmp(&self, other: &BinNum) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<BinNum> for BinNum

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

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

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

This method tests for !=.

impl PartialOrd<BinNum> for BinNum

fn partial_cmp(&self, other: &BinNum) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub 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 StructuralEq for BinNum

impl StructuralPartialEq for BinNum