Struct Predicate 

pub struct Predicate { /* private fields */ }

Representation of a domain operation, also known as an atomic constraint. It is a triple (DomainId, PredicateType, value).

To create a Predicate, use Predicate::new or the more concise predicate! macro.

Order

Predicates have a well-defined order. They are first ordered by the domain, and then by predicate type, and finally by the value. The order is chosen such that for a fixed domain x, predicates are ordered as follows: [>= 5], [>= 7], [!= 2], [!= 3], [== 5], [!= 7], [<= 6], [<= 10]

From the order, we get the lower-bound predicates first, ordered by non-decreasing bound, then the (not-)equal predicates, ordered by non-decreasing bound, then the upper-bound predicates, ordered by non-increasing bounds.

Implementations

impl Predicate

pub fn new(id: DomainId, predicate_type: PredicateType, value: i32) -> Predicate

Creates a new Predicate (also known as atomic constraint) which represents a domain operation.

pub fn implies(&self, other: Predicate) -> bool

Returns true if self implies other.

Example

let x = DomainId::new(0);

assert!(predicate![x >= 5].implies(predicate![x >= 3]));
assert!(predicate![x >= 5].implies(predicate![x != 1]));
assert!(predicate![x == 5].implies(predicate![x <= 5]));

pub fn get_predicate_type(&self) -> PredicateType

impl Predicate

pub fn is_equality_predicate(&self) -> bool

pub fn is_lower_bound_predicate(&self) -> bool

pub fn is_upper_bound_predicate(&self) -> bool

pub fn is_not_equal_predicate(&self) -> bool

pub fn get_domain(&self) -> DomainId

Returns the DomainId of the Predicate

pub fn get_right_hand_side(&self) -> i32

pub fn trivially_true() -> Predicate

pub fn trivially_false() -> Predicate

Trait Implementations

impl AtomicConstraint for Predicate

type Identifier = DomainId

The type of identifier used for variables.

fn identifier(&self) -> <Predicate as AtomicConstraint>::Identifier

The identifier of this atomic constraint.

fn comparison(&self) -> Comparison

The Comparison used for this atomic constraint.

fn value(&self) -> i32

The value on the right-hand side of this atomic constraint.

fn negate(&self) -> Predicate

The strongest atomic constraint that is mutually exclusive with self.

impl<Var> CheckerVariable<Predicate> for AffineView<Var>

where Var: IntegerVariable,

fn does_atomic_constrain_self(&self, atomic: &Predicate) -> bool

Tests whether the given atomic is a statement over the variable self.

fn atomic_less_than(&self, value: i32) -> Predicate

Get the atomic constraint [self <= value].

fn atomic_greater_than(&self, value: i32) -> Predicate

Get the atomic constraint [self <= value].

fn atomic_equal(&self, value: i32) -> Predicate

Get the atomic constraint [self == value].

fn atomic_not_equal(&self, value: i32) -> Predicate

Get the atomic constraint [self != value].

fn induced_lower_bound( &self, variable_state: &VariableState<Predicate>, ) -> IntExt

Get the lower bound of the domain.

fn induced_upper_bound( &self, variable_state: &VariableState<Predicate>, ) -> IntExt

Get the upper bound of the domain.

fn induced_fixed_value( &self, variable_state: &VariableState<Predicate>, ) -> Option<i32>

Get the value the variable is fixed to, if the variable is fixed.

fn induced_domain_contains( &self, variable_state: &VariableState<Predicate>, value: i32, ) -> bool

Returns whether the value is in the domain.

fn induced_holes<'this, 'state>( &'this self, variable_state: &'state VariableState<Predicate>, ) -> impl Iterator<Item = i32> + 'state

where 'this: 'state,

Get the holes in the domain.

fn iter_induced_domain<'this, 'state>( &'this self, variable_state: &'state VariableState<Predicate>, ) -> Option<impl Iterator<Item = i32> + 'state>

where 'this: 'state,

Iterate the domain of the variable.

impl CheckerVariable<Predicate> for DomainId

fn does_atomic_constrain_self(&self, atomic: &Predicate) -> bool

Tests whether the given atomic is a statement over the variable self.

fn atomic_less_than(&self, value: i32) -> Predicate

Get the atomic constraint [self <= value].

fn atomic_greater_than(&self, value: i32) -> Predicate

Get the atomic constraint [self <= value].

fn atomic_equal(&self, value: i32) -> Predicate

Get the atomic constraint [self == value].

fn atomic_not_equal(&self, value: i32) -> Predicate

Get the atomic constraint [self != value].

fn induced_lower_bound( &self, variable_state: &VariableState<Predicate>, ) -> IntExt

Get the lower bound of the domain.

fn induced_upper_bound( &self, variable_state: &VariableState<Predicate>, ) -> IntExt

Get the upper bound of the domain.

fn induced_fixed_value( &self, variable_state: &VariableState<Predicate>, ) -> Option<i32>

Get the value the variable is fixed to, if the variable is fixed.

fn induced_domain_contains( &self, variable_state: &VariableState<Predicate>, value: i32, ) -> bool

Returns whether the value is in the domain.

fn induced_holes<'this, 'state>( &'this self, variable_state: &'state VariableState<Predicate>, ) -> impl Iterator<Item = i32> + 'state

where 'this: 'state,

Get the holes in the domain.

fn iter_induced_domain<'this, 'state>( &'this self, variable_state: &'state VariableState<Predicate>, ) -> Option<impl Iterator<Item = i32> + 'state>

where 'this: 'state,

Iterate the domain of the variable.

impl CheckerVariable<Predicate> for Literal

fn does_atomic_constrain_self(&self, atomic: &Predicate) -> bool

Tests whether the given atomic is a statement over the variable self.

fn atomic_less_than(&self, value: i32) -> Predicate

Get the atomic constraint [self <= value].

fn atomic_greater_than(&self, value: i32) -> Predicate

Get the atomic constraint [self <= value].

fn atomic_not_equal(&self, value: i32) -> Predicate

Get the atomic constraint [self != value].

fn atomic_equal(&self, value: i32) -> Predicate

Get the atomic constraint [self == value].

fn induced_lower_bound( &self, variable_state: &VariableState<Predicate>, ) -> IntExt

Get the lower bound of the domain.

fn induced_upper_bound( &self, variable_state: &VariableState<Predicate>, ) -> IntExt

Get the upper bound of the domain.

fn induced_fixed_value( &self, variable_state: &VariableState<Predicate>, ) -> Option<i32>

Get the value the variable is fixed to, if the variable is fixed.

fn induced_domain_contains( &self, variable_state: &VariableState<Predicate>, value: i32, ) -> bool

Returns whether the value is in the domain.

fn induced_holes<'this, 'state>( &'this self, variable_state: &'state VariableState<Predicate>, ) -> impl Iterator<Item = i32> + 'state

where 'this: 'state,

Get the holes in the domain.

fn iter_induced_domain<'this, 'state>( &'this self, variable_state: &'state VariableState<Predicate>, ) -> Option<impl Iterator<Item = i32> + 'state>

where 'this: 'state,

Iterate the domain of the variable.

impl Clone for Predicate

fn clone(&self) -> Predicate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Predicate

impl Debug for Predicate

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

Formats the value using the given formatter.

impl Display for Predicate

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

Formats the value using the given formatter.

impl Eq for Predicate

impl Extend<Predicate> for PropositionalConjunction

fn extend<T>(&mut self, iter: T)

where T: IntoIterator<Item = Predicate>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl From<Predicate> for PropositionalConjunction

fn from(predicate: Predicate) -> PropositionalConjunction

Converts to this type from the input type.

impl From<Predicate> for PredicateType

fn from(value: Predicate) -> PredicateType

Converts to this type from the input type.

impl FromIterator<Predicate> for PropositionalConjunction

fn from_iter<T>(iter: T) -> PropositionalConjunction

where T: IntoIterator<Item = Predicate>,

Creates a value from an iterator.

impl Hash for Predicate

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

where __H: Hasher,

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 Not for Predicate

type Output = Predicate

The resulting type after applying the ! operator.

fn not(self) -> <Predicate as Not>::Output

Performs the unary ! operation.

impl Ord for Predicate

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

See Predicate for details on the order.

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 Predicate

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

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