Enum satoxid::Lit

pub enum Lit<V> {
    Pos(V),
    Neg(V),
}

Enum to define the polarity of variables. By itself Lit is a constraint, which requires that the variable it wraps is true or false depending on the Variant Pos and Neg.

Example

encoder.add_constraint(Lit::Pos("a"));
encoder.add_constraint(Lit::Neg("b"));

let model = encoder.solve().unwrap();
assert!(model["a"]);
assert!(!model["b"]);

Variants

Pos(V)

Neg(V)

Implementations

impl<V> Lit<V>

pub fn var(&self) -> &V

Returns the underlying variable.

pub fn unwrap(self) -> V

Returns the owned underlying variable

pub fn is_pos(&self) -> bool

Returns true if Lit is positive.

pub fn is_neg(&self) -> bool

Returns false if Lit is negative.

Trait Implementations

impl<V: Clone> Clone for Lit<V>

fn clone(&self) -> Lit<V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<V: Debug> Debug for Lit<V>

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

Formats the value using the given formatter.

impl<V: SatVar> From<Lit<V>> for VarType<V>

fn from(l: Lit<V>) -> Self

Performs the conversion.

impl<V: Hash> Hash for Lit<V>

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, 

Feeds a slice of this type into the given Hasher.

impl<V> Not for Lit<V>

type Output = Self

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl<V: Ord> Ord for Lit<V>

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

This method returns an Ordering between self and other.

#[must_use]

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<V: PartialEq> PartialEq<Lit<V>> for Lit<V>

fn eq(&self, other: &Lit<V>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Lit<V>) -> bool

This method tests for !=.

impl<V: PartialOrd> PartialOrd<Lit<V>> for Lit<V>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<V: Copy> Copy for Lit<V>

impl<V: Eq> Eq for Lit<V>

impl<V> StructuralEq for Lit<V>

impl<V> StructuralPartialEq for Lit<V>