Lex (Java Constraint Programming (JaCoP) Specification)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

JaCoP.set.constraints
Class Lex

java.lang.Object
  JaCoP.constraints.DecomposedConstraint
      JaCoP.constraints.Constraint
          JaCoP.set.constraints.Lex

public class Lex
extends Constraint
extends Constraint

It creates a lex constraint on a list of set variables. Each consecutive pair of set variables is being constrained to be lexicographically ordered. For example, {}

Version:: 3.1
Author:: Radoslaw Szymanek and Krzysztof Kuchcinski

Field Summary
`SetVar`	`a` It specifies a list on which element a lex relationship holds for every two consecutive variables.
`SetVar`	`b` It specifies a list on which element a lex relationship holds for every two consecutive variables.
`boolean`	`strict` It specifies if the relation is strict or not.
`static java.lang.String[]`	`xmlAttributes` It specifies the arguments required to be saved by an XML format as well as the constructor being called to recreate an object from an XML format.

Fields inherited from class JaCoP.constraints.Constraint
`atomicExecution, consistencyPruningEvents, earlyTerminationOK, id, increaseWeight, numberArgs, numberId`

Fields inherited from class JaCoP.constraints.DecomposedConstraint
`queueIndex`

Constructor Summary
`Lex(SetVar a, SetVar b)` It constructs an Lexical ordering constraint to restrict the domain of the variables a and b.
`Lex(SetVar a, SetVar b, boolean strict)` It constructs an Lexical ordering constraint to restrict the domain of the variables a and b.

Method Summary
`java.util.ArrayList<Var>`	`arguments()` It returns the variables in a scope of the constraint.
`void`	`consistency(Store store)` It is a (most probably incomplete) consistency function which removes the values from variables domains.
`int`	`getConsistencyPruningEvent(Var var)` It retrieves the pruning event which causes reevaluation of the constraint.
`java.lang.String`	`id()` It gives the id string of a constraint.
`void`	`impose(Store store)` It imposes the constraint in a given store.
`void`	`increaseWeight()` It increases the weight of the variables in the constraint scope.
`void`	`removeConstraint()` It removes the constraint by removing this constraint from all variables.
`void`	`removeLevel(int level)` This function is called in case of the backtrack, so a constraint can clear the queue of changed variables which is no longer valid.
`boolean`	`satisfied()` It checks if the constraint is satisfied.
`java.lang.String`	`toString()` It produces a string representation of a constraint state.

Methods inherited from class JaCoP.constraints.Constraint
`cleanAfterFailure, decompose, getGuideConstraint, getGuideValue, getGuideVariable, impose, imposeDecomposition, numberArgs, queueVariable, removeLevelLate, requiresMonotonicity, setConsistencyPruningEvent, supplyGuideFeedback`

Methods inherited from class JaCoP.constraints.DecomposedConstraint
`auxiliaryVariables, imposeDecomposition`

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

a

public SetVar a

It specifies a list on which element a lex relationship holds for every two consecutive variables.

b

public SetVar b

It specifies a list on which element a lex relationship holds for every two consecutive variables.

strict

public boolean strict

It specifies if the relation is strict or not.

xmlAttributes

public static java.lang.String[] xmlAttributes

It specifies the arguments required to be saved by an XML format as well as the constructor being called to recreate an object from an XML format.

Constructor Detail

Lex

public Lex(SetVar a,
           SetVar b)

It constructs an Lexical ordering constraint to restrict the domain of the variables a and b. It is strict by default.

Parameters:: a - variable that is restricted to be less than b with lexical order.; b - variable that is restricted to be greater than a with lexical order.

Lex

public Lex(SetVar a,
           SetVar b,
           boolean strict)

It constructs an Lexical ordering constraint to restrict the domain of the variables a and b.

Parameters:: a - variable that is restricted to be less than b with lexical order.; b - variable that is restricted to be greater than a with lexical order.; strict - specifies if the lex relation is strict.

Method Detail