Struct Literal 

pub struct Literal { /* private fields */ }

Implementations

impl Literal

pub fn new(domain_id: DomainId) -> Literal

Creates a new literal wrapping the provided DomainId.

Note: the provided domain_id should have a domain between 0 and 1.

pub fn get_integer_variable(&self) -> AffineView<DomainId>

pub fn get_true_predicate(&self) -> Predicate

pub fn get_false_predicate(&self) -> Predicate

Trait Implementations

impl Clone for Literal

fn clone(&self) -> Literal

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Literal

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

Formats the value using the given formatter.

impl Hash for Literal

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 IntegerVariable for Literal

fn lower_bound(&self, assignment: &Assignments) -> i32

Returns the lower bound represented as a 0-1 value. Literals that evaluate to true have a lower bound of 1. Literal that evaluate to false have a lower bound of 0. Unassigned literals have a lower bound of 0.

fn upper_bound(&self, assignment: &Assignments) -> i32

Returns the upper bound represented as a 0-1 value. Literals that evaluate to true have an upper bound of 1. Literal that evaluate to false have a upper bound of 0. Unassigned literals have a upper bound of 1.

fn contains(&self, assignment: &Assignments, value: i32) -> bool

Returns whether the input value, when interpreted as a bool, can be considered for the literal. Literals that evaluate to true only contain value 1. Literals that evaluate to false only contain value 0. Unassigned literals contain both values 0 and 1.

type AffineView = AffineView<Literal>

fn lower_bound_at_trail_position( &self, assignment: &Assignments, trail_position: usize, ) -> i32

Get the lower bound of the variable at the given trail position.

fn upper_bound_at_trail_position( &self, assignment: &Assignments, trail_position: usize, ) -> i32

Get the upper bound of the variable at the given trail position.

fn contains_at_trail_position( &self, assignment: &Assignments, value: i32, trail_position: usize, ) -> bool

Determine whether the value is in the domain of this variable at the given trail position.

fn iterate_domain(&self, assignment: &Assignments) -> impl Iterator<Item = i32>

Iterate over the values of the domain.

fn watch_all(&self, watchers: &mut Watchers<'_>, events: EnumSet<DomainEvent>)

Register a watch for this variable on the given domain events.

fn unpack_event(&self, event: OpaqueDomainEvent) -> DomainEvent

Decode a domain event for this variable.

fn watch_all_backtrack( &self, watchers: &mut Watchers<'_>, events: EnumSet<DomainEvent>, )

fn get_holes_on_current_decision_level( &self, assignments: &Assignments, ) -> impl Iterator<Item = i32>

Returns all of the holes in the domain which were created at the current decision level

fn get_holes(&self, assignments: &Assignments) -> impl Iterator<Item = i32>

Returns all of the holes in the domain

impl Not for Literal

type Output = Literal

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl PartialEq for Literal

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

type Value = i32

The value used to represent a bound.

fn lower_bound_predicate(&self, bound: Self::Value) -> Predicate

Creates a lower-bound predicate (e.g. [x >= v]).

fn upper_bound_predicate(&self, bound: Self::Value) -> Predicate

Creates an upper-bound predicate (e.g. [x <= v]).

fn equality_predicate(&self, bound: Self::Value) -> Predicate

Creates an equality predicate (e.g. [x == v]).

fn disequality_predicate(&self, bound: Self::Value) -> Predicate

Creates a disequality predicate (e.g. [x != v]).

impl TransformableVariable<AffineView<Literal>> for Literal

fn scaled(&self, scale: i32) -> AffineView<Literal>

Get a variable which domain is scaled compared to the domain of self.

fn offset(&self, offset: i32) -> AffineView<Literal>

Get a variable which domain has a constant offset to the domain of self.

impl ValueSelector<Literal> for InDomainRandom

fn select_value( &mut self, context: &mut SelectionContext<'_>, decision_variable: Literal, ) -> Predicate

Determines which value in the domain of decision_variable to branch next on. The domain of the decision_variable variable should have at least 2 values in it (as it otherwise should not have been selected as decision_variable). Returns a Predicate specifying the required change in the domain.

fn is_restart_pointless(&mut self) -> bool

This method returns whether a restart is currently pointless for the ValueSelector.

fn subscribe_to_events(&self) -> Vec<BrancherEvent>

Indicates which BrancherEvent are relevant for this particular ValueSelector.

fn on_unassign_integer(&mut self, _variable: DomainId, _value: i32)

A function which is called after a DomainId is unassigned during backtracking (i.e. when it was fixed but is no longer), specifically, it provides variable which is the DomainId which has been reset and value which is the value to which the variable was previously fixed. This method could thus be called multiple times in a single backtracking operation by the solver.

fn on_solution(&mut self, _solution: SolutionReference<'_>)

This method is called when a solution is found; either when iterating over all solutions in the case of a satisfiable problem or on solutions of increasing quality when solving an optimisation problem.

impl VariableSelector<Literal> for InputOrder<Literal>

fn select_variable( &mut self, context: &mut SelectionContext<'_>, ) -> Option<Literal>

Determines which variable to select next if there are any left to branch on. Should only return None when all variables which have been passed to the VariableSelector have been assigned. Otherwise it should return the variable to branch on next.

fn subscribe_to_events(&self) -> Vec<BrancherEvent>

Indicates which BrancherEvent are relevant for this particular VariableSelector.

fn on_conflict(&mut self)

A function which is called after a conflict has been found and processed but (currently) does not provide any additional information.

fn on_backtrack(&mut self)

A function which is called whenever a backtrack occurs in the solver.

fn on_unassign_integer(&mut self, _variable: DomainId, _value: i32)

A function which is called after a DomainId is unassigned during backtracking (i.e. when it was fixed but is no longer), specifically, it provides variable which is the DomainId which has been reset. This method could thus be called multiple times in a single backtracking operation by the solver.

fn on_appearance_in_conflict_predicate(&mut self, _predicate: Predicate)

A function which is called when a Predicate appears in a conflict during conflict analysis.

fn is_restart_pointless(&mut self) -> bool

This method returns whether a restart is currently pointless for the VariableSelector.

impl Copy for Literal

impl Eq for Literal

impl StructuralPartialEq for Literal