Struct Monomial 

pub struct Monomial { /* private fields */ }

A monomial is a finite multiset of variables (each variable optionally raised to a positive exponent). Stored as a sorted map so equality and ordering are deterministic and serde is stable.

The empty monomial represents 1.

Implementations

impl Monomial

pub fn one() -> Self

The empty monomial, representing the multiplicative identity 1.

pub fn singleton(var: impl Into<String>) -> Self

A single variable with exponent 1.

pub fn from_factors( factors: impl IntoIterator<Item = (impl Into<String>, u32)>, ) -> Self

Build from (variable, exponent) pairs. Exponents must be strictly positive; pairs with exponent 0 are dropped.

pub fn factors(&self) -> &BTreeMap<String, u32>

Variables appearing in this monomial (with exponents).

pub fn variables(&self) -> BTreeSet<String>

Set of variable names appearing in this monomial.

pub fn contains(&self, var: &str) -> bool

Whether var appears in this monomial with positive exponent.

pub fn is_one(&self) -> bool

Whether this is the empty (identity) monomial.

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

Multiply two monomials by adding exponents.

Trait Implementations

impl Clone for Monomial

fn clone(&self) -> Monomial

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Monomial

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

Formats the value using the given formatter.

impl Default for Monomial

fn default() -> Monomial

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Monomial

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Monomial

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

Formats the value using the given formatter.

impl Hash for Monomial

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 Ord for Monomial

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Monomial

fn eq(&self, other: &Monomial) -> 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 PartialOrd for Monomial

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Monomial

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Monomial

impl StructuralPartialEq for Monomial