org.clafer.choco.constraint.propagator

Class PropUtil

java.lang.Object

org.clafer.choco.constraint.propagator.PropUtil

public class PropUtil
extends Object

Various static utility functions for writing Choco propagators.

Author:

jimmy

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	domsContain(solver.variables.IntVar[] union, int value) Checks if at least one of the integer's domain contains a value.
static boolean	domSubsetDom(solver.variables.IntVar sub, solver.variables.IntVar sup, solver.ICause propagator) Removes every element in an integer's domain that is not in the other integer's domain.
static boolean	domSubsetEnv(solver.variables.IntVar sub, solver.variables.SetVar sup, solver.ICause propagator) Removes every element in an integer's domain that is not in the set's envelope.
static boolean	domSubsetKer(solver.variables.IntVar sub, solver.variables.SetVar sup, solver.ICause propagator) Removes every element in an integer's domain that is not in the set's kernel.
static boolean	domSubsetSet(solver.variables.IntVar sub, gnu.trove.set.TIntSet sup, solver.ICause propagator) Removes every element in an integer's domain that is not in the set.
static boolean	envsContain(solver.variables.SetVar[] union, int value) Checks if at least one of the set's envelope contains a value.
static boolean	envSubsetDom(solver.variables.SetVar sub, solver.variables.IntVar sup, solver.ICause propagator) Removes every element in a set's envelope that is not in the integer's domain.
static boolean	envSubsetEnv(solver.variables.SetVar sub, solver.variables.SetVar sup, solver.ICause propagator) Removes every element in a set's envelope that is not in the other set's envelope.
static boolean	envSubsetKer(solver.variables.SetVar sub, solver.variables.SetVar sup, solver.ICause propagator) Removes every element in a set's envelope that is not in the set's kernel.
static boolean	envSubsetSet(solver.variables.SetVar sub, gnu.trove.set.TIntSet sup, solver.ICause propagator) Removes every element in a set's envelope that is not in the set.
static boolean	isDomIntersectDom(solver.variables.IntVar i1, solver.variables.IntVar i2) Checks if an integer's domain is contained entirely in the other integer's domain.
static boolean	isDomIntersectEnv(solver.variables.IntVar i1, solver.variables.SetVar i2) Checks if an integer's domain is contained entirely in the set's envelope.
static boolean	isDomIntersectKer(solver.variables.IntVar i1, solver.variables.SetVar i2) Checks if an integer's domain is contained entirely in the set's kernel.
static boolean	isDomSubsetDom(solver.variables.IntVar sub, solver.variables.IntVar sup) Checks if an integer's domain is contained entirely in the other integer's domain.
static boolean	isDomSubsetEnv(solver.variables.IntVar sub, solver.variables.SetVar sup) Checks if an integer's domain is contained entirely in the set's envelope.
static boolean	isDomSubsetKer(solver.variables.IntVar sub, solver.variables.SetVar sup) Checks if an integer's domain is contained entirely in the set's kernel.
static boolean	isEnvIntersectEnv(solver.variables.SetVar i1, solver.variables.SetVar i2) Checks if a set's envelope is contained entirely in the other set's envelope.
static boolean	isEnvIntersectKer(solver.variables.SetVar i1, solver.variables.SetVar i2) Checks if a set's envelope is contained entirely in the set's kernel.
static boolean	isEnvSubsetDom(solver.variables.SetVar sub, solver.variables.IntVar sup) Checks if a set's envelope is contained entirely in the integer's domain.
static boolean	isEnvSubsetEnv(solver.variables.SetVar sub, solver.variables.SetVar sup) Checks if a set's envelope is contained entirely in the other set's envelope.
static boolean	isEnvSubsetKer(solver.variables.SetVar sub, solver.variables.SetVar sup) Checks if a set's envelope is contained entirely in the set's kernel.
static boolean	isKerIntersectKer(solver.variables.SetVar i1, solver.variables.SetVar i2) Checks if a set's kernel is contained entirely in the other set's kernel.
static boolean	isKerSubsetDom(solver.variables.SetVar sub, solver.variables.IntVar sup) Checks if a set's kernel is contained entirely in the integer's domain.
static boolean	isKerSubsetEnv(solver.variables.SetVar sub, solver.variables.SetVar sup) Checks if a set's kernel is contained entirely in the set's envelope.
static boolean	isKerSubsetKer(solver.variables.SetVar sub, solver.variables.SetVar sup) Checks if a set's kernel is contained entirely in the other set's kernel.
static int[]	iterateDom(solver.variables.IntVar ivar) Enumerate the domain of a integer variable.
static int[]	iterateEnv(solver.variables.SetVar set) Enumerate the envelope of a set variable.
static int[]	iterateKer(solver.variables.SetVar set) Enumerate the kernel of a set variable.
static boolean	kersContain(solver.variables.SetVar[] union, int value) Checks if at least one of the set's kernel contains a value.
static boolean	kerSubsetKer(solver.variables.SetVar sub, solver.variables.SetVar sup, solver.ICause propagator) Adds every element in a set's kernel to the other set's kernel.
static solver.variables.delta.IIntDeltaMonitor[]	monitorDeltas(solver.variables.IntVar[] vars, solver.ICause propagator) Monitor the deltas for all the variables.
static solver.variables.delta.monitor.SetDeltaMonitor[]	monitorDeltas(solver.variables.SetVar[] vars, solver.ICause propagator) Monitor the deltas for all the variables.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

monitorDeltas

public static solver.variables.delta.IIntDeltaMonitor[] monitorDeltas(solver.variables.IntVar[] vars,
                                                      solver.ICause propagator)

Monitor the deltas for all the variables.

Parameters:

vars - the variables

propagator - the propagator

Returns:

the variables delta monitors

monitorDeltas

public static solver.variables.delta.monitor.SetDeltaMonitor[] monitorDeltas(solver.variables.SetVar[] vars,
                                                             solver.ICause propagator)

Monitor the deltas for all the variables.

Parameters:

vars - the variables

propagator - the propagator

Returns:

the variables delta monitors

iterateDom

public static int[] iterateDom(solver.variables.IntVar ivar)

Enumerate the domain of a integer variable.

Parameters:

ivar - the integer variable

Returns:

dom(int)

iterateEnv

public static int[] iterateEnv(solver.variables.SetVar set)

Enumerate the envelope of a set variable.

Parameters:

set - the set variable

Returns:

env(set)

iterateKer

public static int[] iterateKer(solver.variables.SetVar set)

Enumerate the kernel of a set variable.

Parameters:

set - the set variable

Returns:

ker(set)

domsContain

public static boolean domsContain(solver.variables.IntVar[] union,
                  int value)

Checks if at least one of the integer's domain contains a value.

Parameters:

union - the integers

value - the value

Returns:

true if value ∈ dom(union[i]) for some i, false otherwise

envsContain

public static boolean envsContain(solver.variables.SetVar[] union,
                  int value)

Checks if at least one of the set's envelope contains a value.

Parameters:

union - the sets

value - the value

Returns:

true if value ∈ env(union[i]) for some i, false otherwise

kersContain

public static boolean kersContain(solver.variables.SetVar[] union,
                  int value)

Checks if at least one of the set's kernel contains a value.

Parameters:

union - the sets

value - the value

Returns:

true if value ∈ kernel(union[i]) for some i, false otherwise

isDomIntersectDom

public static boolean isDomIntersectDom(solver.variables.IntVar i1,
                        solver.variables.IntVar i2)

Checks if an integer's domain is contained entirely in the other integer's domain.

Parameters:

i1 - the first operand

i2 - the second operand

Returns:

true if dom(i1) ⋂ dom(i2) ≠ {}, false otherwise

isDomIntersectEnv

public static boolean isDomIntersectEnv(solver.variables.IntVar i1,
                        solver.variables.SetVar i2)

Checks if an integer's domain is contained entirely in the set's envelope.

Parameters:

i1 - the first operand

i2 - the second operand

Returns:

true if dom(i1) ⋂ env(i2) ≠ {}, false otherwise

isDomIntersectKer

public static boolean isDomIntersectKer(solver.variables.IntVar i1,
                        solver.variables.SetVar i2)

Checks if an integer's domain is contained entirely in the set's kernel.

Parameters:

i1 - the first operand

i2 - the second operand

Returns:

true if dom(i1) ⋂ ker(i2) ≠ {}, false otherwise

isEnvIntersectEnv

public static boolean isEnvIntersectEnv(solver.variables.SetVar i1,
                        solver.variables.SetVar i2)

Checks if a set's envelope is contained entirely in the other set's envelope.

Parameters:

i1 - the first operand

i2 - the second operand

Returns:

true if env(i1) ⋂ env(i2) ≠ {}, false otherwise

isEnvIntersectKer

public static boolean isEnvIntersectKer(solver.variables.SetVar i1,
                        solver.variables.SetVar i2)

Checks if a set's envelope is contained entirely in the set's kernel.

Parameters:

i1 - the first operand

i2 - the second operand

Returns:

true if env(i1) ⋂ ker(i2) ≠ {}, false otherwise

isKerIntersectKer

public static boolean isKerIntersectKer(solver.variables.SetVar i1,
                        solver.variables.SetVar i2)

Checks if a set's kernel is contained entirely in the other set's kernel.

Parameters:

i1 - the first operand

i2 - the second operand

Returns:

true if ker(i1) ⋂ ker(i2) ≠ {}, false otherwise

isDomSubsetDom

public static boolean isDomSubsetDom(solver.variables.IntVar sub,
                     solver.variables.IntVar sup)

Checks if an integer's domain is contained entirely in the other integer's domain.

Parameters:

sub - the subset

sup - the superset

Returns:

true if dom(sub) ⊆ dom(sup), false otherwise

isDomSubsetEnv

public static boolean isDomSubsetEnv(solver.variables.IntVar sub,
                     solver.variables.SetVar sup)

Checks if an integer's domain is contained entirely in the set's envelope.

Parameters:

sub - the subset

sup - the superset

Returns:

true if dom(sub) ⊆ env(sup), false otherwise

isDomSubsetKer

public static boolean isDomSubsetKer(solver.variables.IntVar sub,
                     solver.variables.SetVar sup)

Checks if an integer's domain is contained entirely in the set's kernel.

Parameters:

sub - the subset

sup - the superset

Returns:

true if dom(sub) ⊆ ker(sup), false otherwise

isEnvSubsetDom

public static boolean isEnvSubsetDom(solver.variables.SetVar sub,
                     solver.variables.IntVar sup)

Checks if a set's envelope is contained entirely in the integer's domain.

Parameters:

sub - the subset

sup - the superset

Returns:

true if env(sub) ⊆ dom(sup), false otherwise

isEnvSubsetEnv

public static boolean isEnvSubsetEnv(solver.variables.SetVar sub,
                     solver.variables.SetVar sup)

Checks if a set's envelope is contained entirely in the other set's envelope.

Parameters:

sub - the subset

sup - the superset

Returns:

true if env(sub) ⊆ env(sup), false otherwise

isEnvSubsetKer

public static boolean isEnvSubsetKer(solver.variables.SetVar sub,
                     solver.variables.SetVar sup)

Checks if a set's envelope is contained entirely in the set's kernel.

Parameters:

sub - the subset

sup - the superset

Returns:

true if env(sub) ⊆ ker(sup), false otherwise

isKerSubsetDom

public static boolean isKerSubsetDom(solver.variables.SetVar sub,
                     solver.variables.IntVar sup)

Checks if a set's kernel is contained entirely in the integer's domain.

Parameters:

sub - the subset

sup - the superset

Returns:

true if ker(sub) ⊆ dom(sup), false otherwise

isKerSubsetEnv

public static boolean isKerSubsetEnv(solver.variables.SetVar sub,
                     solver.variables.SetVar sup)

Checks if a set's kernel is contained entirely in the set's envelope.

Parameters:

sub - the subset

sup - the superset

Returns:

true if ker(sub) ⊆ env(sup), false otherwise

isKerSubsetKer

public static boolean isKerSubsetKer(solver.variables.SetVar sub,
                     solver.variables.SetVar sup)

Checks if a set's kernel is contained entirely in the other set's kernel.

Parameters:

sub - the subset

sup - the superset

Returns:

true if ker(sub) ⊆ ker(sup), false otherwise

domSubsetSet

public static boolean domSubsetSet(solver.variables.IntVar sub,
                   gnu.trove.set.TIntSet sup,
                   solver.ICause propagator)
                            throws solver.exception.ContradictionException

Removes every element in an integer's domain that is not in the set.

Parameters:

sub - the subset

sup - the superset

propagator - the propagator

Returns:

true if a variable has been changed, false otherwise

Throws:

solver.exception.ContradictionException

domSubsetDom

public static boolean domSubsetDom(solver.variables.IntVar sub,
                   solver.variables.IntVar sup,
                   solver.ICause propagator)
                            throws solver.exception.ContradictionException

Removes every element in an integer's domain that is not in the other integer's domain.

Parameters:

sub - the subset

sup - the superset

propagator - the propagator

Returns:

true if a variable has been changed, false otherwise

Throws:

solver.exception.ContradictionException

domSubsetEnv

public static boolean domSubsetEnv(solver.variables.IntVar sub,
                   solver.variables.SetVar sup,
                   solver.ICause propagator)
                            throws solver.exception.ContradictionException

Removes every element in an integer's domain that is not in the set's envelope.

Parameters:

sub - the subset

sup - the superset

propagator - the propagator

Returns:

true if a variable has been changed, false otherwise

Throws:

solver.exception.ContradictionException

domSubsetKer

public static boolean domSubsetKer(solver.variables.IntVar sub,
                   solver.variables.SetVar sup,
                   solver.ICause propagator)
                            throws solver.exception.ContradictionException

Removes every element in an integer's domain that is not in the set's kernel.

Parameters:

sub - the subset

sup - the superset

propagator - the propagator

Returns:

true if a variable has been changed, false otherwise

Throws:

solver.exception.ContradictionException

envSubsetSet

public static boolean envSubsetSet(solver.variables.SetVar sub,
                   gnu.trove.set.TIntSet sup,
                   solver.ICause propagator)
                            throws solver.exception.ContradictionException

Removes every element in a set's envelope that is not in the set.

Parameters:

sub - the subset

sup - the superset

propagator - the propagator

Returns:

true if a variable has been changed, false otherwise

Throws:

solver.exception.ContradictionException

envSubsetDom

public static boolean envSubsetDom(solver.variables.SetVar sub,
                   solver.variables.IntVar sup,
                   solver.ICause propagator)
                            throws solver.exception.ContradictionException

Removes every element in a set's envelope that is not in the integer's domain.

Parameters:

sub - the subset

sup - the superset

propagator - the propagator

Returns:

true if a variable has been changed, false otherwise

Throws:

solver.exception.ContradictionException

envSubsetEnv

public static boolean envSubsetEnv(solver.variables.SetVar sub,
                   solver.variables.SetVar sup,
                   solver.ICause propagator)
                            throws solver.exception.ContradictionException

Removes every element in a set's envelope that is not in the other set's envelope.

Parameters:

sub - the subset

sup - the superset

propagator - the propagator

Returns:

true if a variable has been changed, false otherwise

Throws:

solver.exception.ContradictionException

envSubsetKer

public static boolean envSubsetKer(solver.variables.SetVar sub,
                   solver.variables.SetVar sup,
                   solver.ICause propagator)
                            throws solver.exception.ContradictionException

Removes every element in a set's envelope that is not in the set's kernel.

Parameters:

sub - the subset

sup - the superset

propagator - the propagator

Returns:

true if a variable has been changed, false otherwise

Throws:

solver.exception.ContradictionException

kerSubsetKer

public static boolean kerSubsetKer(solver.variables.SetVar sub,
                   solver.variables.SetVar sup,
                   solver.ICause propagator)
                            throws solver.exception.ContradictionException

Adds every element in a set's kernel to the other set's kernel.

Parameters:

sub - the subset

sup - the superset

propagator - the propagator

Returns:

true if a variable has been changed, false otherwise

Throws:

solver.exception.ContradictionException