Struct Bound

pub struct Bound { /* private fields */ }

Bound of a decision variable

Invariant

• lower <= upper
• lower and upper never become NaN
• lower is not +inf and upper is not -inf

Examples

use ommx::Bound;

// Usual
let bound = Bound::try_from([1.0, 2.0]).unwrap();
// Single point `[1.0, 1.0]`
let bound = Bound::try_from(1.0).unwrap();
// Default is `(-inf, inf)`
assert_eq!(Bound::default(), Bound::try_from([f64::NEG_INFINITY, f64::INFINITY]).unwrap());

Implementations

impl Bound

pub fn positive() -> Self

Positive or zero, [0, inf)

pub fn negative() -> Self

Negative or zero, (-inf, 0]

pub fn new(lower: f64, upper: f64) -> Result<Self, BoundError>

pub fn lower(&self) -> f64

pub fn upper(&self) -> f64

pub fn width(&self) -> f64

pub fn set_lower(&mut self, lower: f64) -> Result<(), BoundError>

pub fn set_upper(&mut self, upper: f64) -> Result<(), BoundError>

pub fn as_integer_bound(&self) -> Self

Strengthen the bound for integer decision variables

Since the bound evaluation may be inaccurate due to floating-point arithmetic error, this method rounds to [ceil(lower-atol), floor(upper+atol)] with atol = 1e-6.

pub fn is_finite(&self) -> bool

[lower, upper] with finite lower and upper

pub fn intersection(&self, other: &Self) -> Option<Self>

Take the intersection of two bounds, None if the intersection is empty

pub fn pow(&self, exp: u8) -> Self

pub fn contains(&self, value: f64, atol: f64) -> bool

Check the value is in the bound with absolute tolerance

pub fn as_range(&self) -> RangeInclusive<f64>

pub fn arbitrary_containing(&self, max_abs: f64) -> BoxedStrategy<f64>

Arbitrary finite value within the bound

max_abs is the maximum absolute value of the generated value to keep floating point arithmetic stable.

Trait Implementations

impl Add<Bound> for f64

type Output = <Bound as Add<f64>>::Output

The resulting type after applying the + operator.

fn add(self, rhs: Bound) -> Self::Output

Performs the + operation.

impl Add<f64> for Bound

type Output = Bound

The resulting type after applying the + operator.

fn add(self, rhs: f64) -> Self::Output

Performs the + operation.

impl Add for Bound

type Output = Bound

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl AddAssign<f64> for Bound

fn add_assign(&mut self, rhs: f64)

Performs the += operation.

impl AddAssign for Bound

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Arbitrary for Bound

type Parameters = ()

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = BoxedStrategy<Bound>

The type of Strategy used to generate values of type Self.

fn arbitrary_with(_: Self::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl Clone for Bound

fn clone(&self) -> Bound

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Bound

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

Formats the value using the given formatter.

impl Default for Bound

fn default() -> Self

Returns the “default value” for a type.

impl From<Bound> for Bound

fn from(bound: Bound) -> Self

Converts to this type from the input type.

impl Mul<Bound> for f64

type Output = <Bound as Mul<f64>>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: Bound) -> Self::Output

Performs the * operation.

impl Mul<f64> for Bound

type Output = Bound

The resulting type after applying the * operator.

fn mul(self, rhs: f64) -> Self::Output

Performs the * operation.

impl Mul for Bound

type Output = Bound

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self::Output

Performs the * operation.

impl MulAssign<f64> for Bound

fn mul_assign(&mut self, rhs: f64)

Performs the *= operation.

impl MulAssign for Bound

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl PartialEq<Bound> for f64

fn eq(&self, other: &Bound) -> 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 PartialEq<f64> for Bound

fn eq(&self, other: &f64) -> 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 PartialEq for Bound

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

fn partial_cmp(&self, other: &Bound) -> 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 PartialOrd<f64> for Bound

• a <= [b, c] means a <= b, i.e. a <= x (forall x \in [b, c])
• a >= [b, c] means a >= c, i.e. a >= x (forall x \in [b, c])
• If a is in [b, c], return None

fn partial_cmp(&self, other: &f64) -> 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 TryFrom<[f64; 2]> for Bound

type Error = BoundError

The type returned in the event of a conversion error.

fn try_from([lower, upper]: [f64; 2]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Bound> for Bound

type Error = BoundError

The type returned in the event of a conversion error.

fn try_from(value: Bound) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<f64> for Bound

type Error = BoundError

The type returned in the event of a conversion error.

fn try_from(value: f64) -> Result<Self, Self::Error>

Performs the conversion.

impl Zero for Bound

fn zero() -> Self

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl Copy for Bound

impl StructuralPartialEq for Bound