Struct SumAtomConstraint 

pub struct SumAtomConstraint<T: Atomic>(ThresholdConstraintOver<WeightedSum<T>>);

Constraint over the evaluation over a sum of multiple atoms

This struct represents a guard over the values of a sum of atoms, i.e., it represents a constraint formula of the form cv_1 * v_1 + ... + cv_n * v_n <COMPOP> cp_1 * p_1 + ... + cp_n * p_m + c where cv_1, ..., cv_n, cp_1, ..., cp_m are rational factors, COMPOP is a comparison operator (i.e.,<, >, <=, >=, ==, !=), v_1, ..., v_n are variables, p_1, ..., p_m are parameters, and c is a rational constant.

Additionally, all variable coefficients, i.e., cv_1, ..., cv_n, must be greater than zero.

Tuple Fields

0: ThresholdConstraintOver<WeightedSum<T>>

Implementations

impl<T: Atomic> SumAtomConstraint<T>

pub fn try_new<F: Into<Fraction>, I: IntoIterator<Item = (T, F)> + Clone>( atoms: I, thr: ThresholdConstraint, ) -> Result<Self, SumVarConstraintCreationError>

Try to create a new SumAtomConstraint

A SumAtomConstraint constraints a (weighted) sum of multiple variables, where all variable weights are positive (or all negative, in this case the constraint is transformed such that all variable are positive). Any other form would result in a ComparisonConstraint or if there is only a single variable a SingleAtomConstraint.

Returns an SumVarConstraintCreationError if the coefficients are mixed or only a single variable is present.

pub fn is_upper_guard(&self) -> bool

Check if the guard is an upper guard

pub fn is_lower_guard(&self) -> bool

Check if the guard is a lower guard

pub fn get_atoms(&self) -> &WeightedSum<T>

Get the variable

pub fn to_boolean_expr<S>(&self) -> BooleanExpression<S>

where T: IntoNoDivBooleanExpr<S>, IntegerExpression<S>: From<T>, S: Atomic,

Get boolean expression of the guard

pub fn get_threshold(&self) -> &Threshold

Get the threshold of the guard

pub fn get_threshold_constraint(&self) -> &ThresholdConstraint

Get the threshold constraint of the guard

Trait Implementations

impl<T: Clone + Atomic> Clone for SumAtomConstraint<T>

fn clone(&self) -> SumAtomConstraint<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Atomic> Debug for SumAtomConstraint<T>

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

Formats the value using the given formatter.

impl<T: Atomic> Display for SumAtomConstraint<T>

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

Formats the value using the given formatter.

impl<T: Hash + Atomic> Hash for SumAtomConstraint<T>

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<T: Ord + Atomic> Ord for SumAtomConstraint<T>

fn cmp(&self, other: &SumAtomConstraint<T>) -> 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<T: PartialEq + Atomic> PartialEq for SumAtomConstraint<T>

fn eq(&self, other: &SumAtomConstraint<T>) -> 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<T: PartialOrd + Atomic> PartialOrd for SumAtomConstraint<T>

fn partial_cmp(&self, other: &SumAtomConstraint<T>) -> 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<T: Eq + Atomic> Eq for SumAtomConstraint<T>

impl<T: Atomic> StructuralPartialEq for SumAtomConstraint<T>