Cream version 1.06 Core API Specification

jp.ac.kobe_u.cs.cream
Class IntFunc

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

public class IntFunc
extends Constraint

IntFunc constraint implements arithmetic unary function on integers.

Since:
1.0
See Also:
IntArith, IntComparison

Field Summary
static int ABS
          Absolute value function
static int NEGATE
          Negation function
static int SIGN
          Sign function
 
Constructor Summary
IntFunc(Network net, int f, int x0, Variable v1)
           
IntFunc(Network net, int f, Variable v0, int x1)
           
IntFunc(Network net, int f, Variable v0, Variable v1)
          Adds the constraint of v0 == f(v1) 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
 

Field Detail

NEGATE

public static final int NEGATE
Negation function

See Also:
Constant Field Values

ABS

public static final int ABS
Absolute value function

See Also:
Constant Field Values

SIGN

public static final int SIGN
Sign function

See Also:
Constant Field Values
Constructor Detail

IntFunc

public IntFunc(Network net,
               int f,
               Variable v0,
               Variable v1)
Adds the constraint of v0 == f(v1) to the constraint network net.

Parameters:
net - the constraint network
f - the function
v0 - the result
v1 - the argument

IntFunc

public IntFunc(Network net,
               int f,
               Variable v0,
               int x1)

IntFunc

public IntFunc(Network net,
               int f,
               int x0,
               Variable v1)
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