Cream version 1.06 Core API Specification

jp.ac.kobe_u.cs.cream
Class Equals

java.lang.Object
  extended by jp.ac.kobe_u.cs.cream.Constraint
      extended by jp.ac.kobe_u.cs.cream.Equals

public class Equals
extends Constraint

Equals constraint.

Since:
1.0

Constructor Summary
Equals(Network net, Variable[] v)
          Adds the constraint of v[i] == v[j] for each pair of variables in v to the constraint network net.
Equals(Network net, Variable v0, Variable v1)
          Adds the constraint of v0 == v1 for two variables to the constraint network net.
 
Method Summary
 Constraint copy(Network net)
          Creates a copy of this constraint for a new network net.
 boolean isModified()
          Returns true when some argument variable is modified.
 boolean satisfy(Trail trail)
          Performs consistency algorithm.
 String toString()
          Returns the string representation of the constraint.
 
Methods inherited from class jp.ac.kobe_u.cs.cream.Constraint
getIndex, getNetwork, setIndex
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Equals

public Equals(Network net,
              Variable v0,
              Variable v1)
Adds the constraint of v0 == v1 for two variables to the constraint network net.

Parameters:
net - the constraint network
v0 - the first variable
v1 - the second variable

Equals

public Equals(Network net,
              Variable[] v)
Adds the constraint of v[i] == v[j] for each pair of variables in v to the constraint network net.

Parameters:
net - the constraint network
v - the array of variables
Method Detail

copy

public Constraint copy(Network net)
Description copied from class: Constraint
Creates a copy of this constraint for a new network net.

Specified by:
copy in class Constraint
Returns:
the copy of this constraint

isModified

public boolean isModified()
Description copied from class: Constraint
Returns true when some argument variable is modified.

Specified by:
isModified in class Constraint
Returns:
true when some argument variable is modified

satisfy

public boolean satisfy(Trail trail)
Description copied from class: Constraint
Performs consistency algorithm. Assignments are saved to the trail stack.

Specified by:
satisfy in class Constraint
Parameters:
trail - the trail stack
Returns:
true when the consistency algorithm succeeds

toString

public String toString()
Description copied from class: Constraint
Returns the string representation of the constraint.

Specified by:
toString in class Constraint
Returns:
the string representation

Cream version 1.06 Core API Specification

Cream: Constraint Programming Class Library for Java