Enum Predicate

pub enum Predicate {
    IntegerPredicate(IntegerPredicate),
    Literal(Literal),
    False,
    True,
}

This structure is oftentimes used to represent propagations, explanations or decisions.

It can either represent an IntegerPredicate, a Literal which is linked to an IntegerPredicate, or a domain operation which is always true (false) using Predicate::True (Predicate::False).

Variants

IntegerPredicate(IntegerPredicate)

A predicate representing an atomic constraint over an IntegerVariable (either [x >= v], [x <= v], [x == v], or [x != v]).

Literal(Literal)

A predicate represented with a Literal. Oftentimes this Literal is internally linked to an IntegerPredicate.

False

A predicate which is always false.

True

A predicate which is always true.

Implementations

impl Predicate

pub fn get_domain(&self) -> Option<DomainId>

Returns the DomainId corresponding with the Predicate::IntegerPredicate. Returns None in the case of Predicate::Literal, Predicate::False, and Predicate::True.

pub fn get_literal_of_bool_predicate( &self, true_literal: Literal, ) -> Option<Literal>

Returns the Literal corresponding with Predicate::Literal, Predicate::False, and Predicate::True. Will return None in the case of Predicate::IntegerPredicate.

pub fn is_integer_predicate(&self) -> bool

Trait Implementations

impl Clone for Predicate

fn clone(&self) -> Predicate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Predicate

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

Formats the value using the given formatter.

impl Display for Predicate

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

Formats the value using the given formatter.

impl From<IntegerPredicate> for Predicate

fn from(value: IntegerPredicate) -> Self

Converts to this type from the input type.

impl From<Literal> for Predicate

fn from(value: Literal) -> Self

Converts to this type from the input type.

impl From<Predicate> for PropositionalConjunction

fn from(predicate: Predicate) -> Self

Converts to this type from the input type.

impl FromIterator<Predicate> for PropositionalConjunction

fn from_iter<T: IntoIterator<Item = Predicate>>(iter: T) -> Self

Creates a value from an iterator.

impl Hash for Predicate

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

type Output = Predicate

The resulting type after applying the ! operator.

fn not(self) -> Predicate

Performs the unary ! operation.

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 TryFrom<Predicate> for IntegerPredicate

type Error = IntegerPredicateConversionError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for Predicate

impl Eq for Predicate

impl StructuralPartialEq for Predicate