Struct Threshold 

pub struct Threshold {
    weighted_parameters: WeightedSum<Parameter>,
    constant: Fraction,
}

WeightedSum of Parameters with additional constant summand

This struct represents a sum over Parameter of the form c_1 * p_1 + ... + c_n * p_n + c where p_1, …, p_n are Parameter and c_1,..,c_n, c are rational numbers represented by Fractions.

Fields

weighted_parameters: WeightedSum<Parameter>

constant: Fraction

Implementations

impl Threshold

pub fn new<S, T>(weighted_parameters: S, constant: T) -> Self

where S: Into<WeightedSum<Parameter>>, T: Into<Fraction>,

Create a new Threshold

pub fn from_integer_comp_expr<T: Atomic>( lhs: IntegerExpression<T>, rhs: IntegerExpression<T>, ) -> Result<(HashMap<T, Fraction>, Threshold), ConstraintRewriteError>

This function is designed to rewrite an comparison expression into a form where the returned HashMap<T, Fraction> forms the new lhs of the equation and the returned threshold is the right hand side of the equation

pub fn from_const<T: Into<Fraction>>(c: T) -> Self

Create a new Threshold from a constant without any parameters

pub fn scale<T: Into<Fraction>>(&mut self, factor: T)

Scale the Threshold by a rational factor

pub fn is_constant(&self) -> bool

Check whether the Threshold only contains a constant

pub fn is_zero(&self) -> bool

Check whether the Threshold always evaluates to 0, i.e. there are no scaled Parameter and the constant is 0

pub fn get_const(&self) -> Option<Fraction>

If the threshold is constant, return the constant

Returns None otherwise

pub fn add_const<F: Into<Fraction>>(&mut self, c: F)

Add a constant to the threshold

pub fn sub_const<F: Into<Fraction>>(&mut self, c: F)

Subtract a constant from the threshold

Trait Implementations

impl Clone for Threshold

fn clone(&self) -> Threshold

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Threshold

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

Formats the value using the given formatter.

impl Display for Threshold

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

Formats the value using the given formatter.

impl Hash for Threshold

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> IntoNoDivBooleanExpr<T> for Threshold

where WeightedSum<Parameter>: IntoNoDivBooleanExpr<T>, T: Atomic,

fn get_scaled_integer_expression( &self, scaling_factor: u32, ) -> IntegerExpression<T>

Encode the object into an IntegerExpression without divisions appearing

fn get_lcm_of_denominators(&self) -> u32

Get the lcm across all denominators in the object

fn encode_comparison_to_boolean_expression<Q>( &self, comparison_op: ComparisonOp, other: &Q, ) -> BooleanExpression<T>

where Q: IntoNoDivBooleanExpr<T>,

Encode the comparison of two expressions into a boolean expression with a that does not contain any real numbers.

impl Ord for Threshold

fn cmp(&self, other: &Threshold) -> 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 Threshold

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

fn partial_cmp(&self, other: &Threshold) -> 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 Eq for Threshold

impl StructuralPartialEq for Threshold