org.chocosolver.solver.variables.impl

Class FixedSetVarImpl

java.lang.Object

org.chocosolver.solver.variables.impl.AbstractVariable

org.chocosolver.solver.variables.impl.FixedSetVarImpl

All Implemented Interfaces:

Serializable, Comparable<Variable>, Identity, SetVar, Variable

public class FixedSetVarImpl
extends AbstractVariable
implements SetVar

Author:

jimmy

See Also:

Serialized Form

Field Summary

Fields inherited from class org.chocosolver.solver.variables.impl.AbstractVariable

_plugexpl, mIdx, modificationEvents, monitors, MSG_BOUND, MSG_EMPTY, MSG_INST, MSG_LOW, MSG_REMOVE, MSG_UNKNOWN, MSG_UPP, name, solver

Fields inherited from interface org.chocosolver.solver.variables.SetVar

END

Fields inherited from interface org.chocosolver.solver.variables.Variable

BOOL, CSTE, INT, KIND, REAL, SET, TYPE, VAR, VIEW

Constructor Summary

Constructors

Constructor and Description
FixedSetVarImpl(String name, int[] values, Solver solver)
FixedSetVarImpl(String name, gnu.trove.set.TIntSet values, Solver solver)

Method Summary

Methods

Modifier and Type	Method and Description
void	addMonitor(IVariableMonitor monitor) Build and add a monitor to the monitor list of this.
boolean	addToKernel(int element, ICause cause) Adds element to the kernel, i.e. enforces that the set variable will contain element in every solution
void	contradiction(ICause cause, IEventType event, String message) Throws a contradiction exception based on
void	createDelta() Create a delta, if necessary, in order to observe removed values of a this.
SetVar	duplicate() Duplicate this.
void	duplicate(Solver solver, gnu.trove.map.hash.THashMap<Object,Object> identitymap) Duplicate this (which naturally adds it into solver).
boolean	envelopeContains(int element) Test whether element is present or not in the envelope
NoDelta	getDelta() Return the delta domain of this
int	getEnvelopeFirst() Get the first element currently in the envelope domain of this.
int	getEnvelopeNext() Get the next element in the envelope domain of this.
int	getEnvelopeSize() Get the number of elements in the envelope domain of this.
int	getKernelFirst() Get the first element currently in the kernel domain of this.
int	getKernelNext() Get the next element in the kernel domain of this.
int	getKernelSize() Get the number of elements in the kernel domain of this.
int	getTypeAndKind() Return a MASK composed of 2 main information: TYPE and KIND.
int[]	getValues() Retrieves the current value of the variable if instantiated, otherwise the lower bound (kernel).
boolean	instantiateTo(int[] value, ICause cause) Enforces the set variable to contain exactly the set of integers given in parameter
boolean	isInstantiated() Indicates whether this is instantiated (see implemtations to know what instantiation means).
boolean	kernelContains(int element) Test whether element is present or not in the kernel
ISetDeltaMonitor	monitorDelta(ICause propagator) Allow propagator to monitor element removal/enforcing of this
void	notifyMonitors(IEventType event) Notify monitors of observed variable modifications
void	notifyPropagators(IEventType event, ICause cause) If this has changed, then notify all of its observers.
void	notifyViews(IEventType event, ICause cause) Notify views of observed variable modifications
void	recordMask(int mask) Analysis propagator event reaction on this, and adapt this
boolean	removeFromEnvelope(int element, ICause cause) Removes element from the envelop, i.e. the set variable cannot contain element anymore
void	removeMonitor(IVariableMonitor monitor)
void	subscribeView(IView view)

Methods inherited from class org.chocosolver.solver.variables.impl.AbstractVariable

compareTo, getId, getIndexInPropagator, getName, getNbProps, getPIndices, getPropagator, getPropagators, getSolver, getViews, isBool, link, toString, unlink

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.chocosolver.solver.variables.Variable

getIndexInPropagator, getName, getNbProps, getPIndices, getPropagator, getPropagators, getSolver, getViews, link, unlink

Methods inherited from interface org.chocosolver.solver.Identity

getId

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

FixedSetVarImpl

public FixedSetVarImpl(String name,
               gnu.trove.set.TIntSet values,
               Solver solver)

FixedSetVarImpl

public FixedSetVarImpl(String name,
               int[] values,
               Solver solver)

Method Detail

getKernelFirst

public int getKernelFirst()

Description copied from interface: SetVar

Get the first element currently in the kernel domain of this. Returns END if the set is empty. Note that elements are not sorted. To iterate over elements that are present in the kernel, do the following loop: for(int e=getKernelFirst(); e!=SetVar.END; e=getKernelNext()){ // something }

Specified by:

getKernelFirst in interface SetVar

Returns:

the first element in the kernel or END if it is empty.

getKernelNext

public int getKernelNext()

Description copied from interface: SetVar

Get the next element in the kernel domain of this. Returns END once all elements have been visited. To iterate over elements that are present in the kernel, do the following loop: for(int e=getKernelFirst(); e!=SetVar.END; e=getKernelNext()){ // something }

Specified by:

getKernelNext in interface SetVar

Returns:

the next element in the kernel, if any, or END otherwise.

getKernelSize

public int getKernelSize()

Description copied from interface: SetVar

Get the number of elements in the kernel domain of this.

Specified by:

getKernelSize in interface SetVar

Returns:

the number of elements currently present in the kernel.

kernelContains

public boolean kernelContains(int element)

Description copied from interface: SetVar

Test whether element is present or not in the kernel

Specified by:

kernelContains in interface SetVar

Parameters:

element - value to test

Returns:

true iff element is present in the kernel

getEnvelopeFirst

public int getEnvelopeFirst()

Description copied from interface: SetVar

Get the first element currently in the envelope domain of this. Returns END if the set is empty. Note that elements are not sorted. To iterate over elements that are present in the envelope, do the following loop: for(int e=getEnvelopeFirst(); e!=SetVar.END; e=getEnvelopeNext()){ // something }

Specified by:

getEnvelopeFirst in interface SetVar

Returns:

the first element in the envelope or END if it is empty.

getEnvelopeNext

public int getEnvelopeNext()

Description copied from interface: SetVar

Get the next element in the envelope domain of this. Returns END once all elements have been visited. To iterate over elements that are present in the envelope, do the following loop: for(int e=getEnvelopeFirst(); e!=SetVar.END; e=getEnvelopeNext()){ // something }

Specified by:

getEnvelopeNext in interface SetVar

Returns:

the next element in the envelope, if any, or END otherwise.

getEnvelopeSize

public int getEnvelopeSize()

Description copied from interface: SetVar

Get the number of elements in the envelope domain of this.

Specified by:

getEnvelopeSize in interface SetVar

Returns:

the number of elements currently present in the envelope.

envelopeContains

public boolean envelopeContains(int element)

Description copied from interface: SetVar

Test whether element is present or not in the envelope

Specified by:

envelopeContains in interface SetVar

Parameters:

element - value to test

Returns:

true iff element is present in the envelope

addToKernel

public boolean addToKernel(int element,
                  ICause cause)
                    throws ContradictionException

Description copied from interface: SetVar

Adds element to the kernel, i.e. enforces that the set variable will contain element in every solution

Specified by:

addToKernel in interface SetVar

Parameters:

element - value to add

cause - cause of value addition

Returns:

true iff value was not already in the kernel

Throws:

ContradictionException

removeFromEnvelope

public boolean removeFromEnvelope(int element,
                         ICause cause)
                           throws ContradictionException

Description copied from interface: SetVar

Removes element from the envelop, i.e. the set variable cannot contain element anymore

Specified by:

removeFromEnvelope in interface SetVar

Parameters:

element - value to remove

cause - cause of value removal

Returns:

true iff value was present in the envelope

Throws:

ContradictionException

instantiateTo

public boolean instantiateTo(int[] value,
                    ICause cause)
                      throws ContradictionException

Description copied from interface: SetVar

Enforces the set variable to contain exactly the set of integers given in parameter

Specified by:

instantiateTo in interface SetVar

Parameters:

value - a set of integers

cause - cause of instantiation

Returns:

true iff a domain modification occurred

Throws:

ContradictionException

getValues

public int[] getValues()

Description copied from interface: SetVar

Retrieves the current value of the variable if instantiated, otherwise the lower bound (kernel).

Specified by:

getValues in interface SetVar

Returns:

the current value (or kernel if not yet instantiated).

getDelta

public NoDelta getDelta()

Description copied from interface: Variable

Return the delta domain of this

Specified by:

getDelta in interface Variable

Returns:

the delta domain of the variable

createDelta

public void createDelta()

Description copied from interface: Variable

Create a delta, if necessary, in order to observe removed values of a this. If the delta already exists, has no effect.

Specified by:

createDelta in interface Variable

monitorDelta

public ISetDeltaMonitor monitorDelta(ICause propagator)

Description copied from interface: SetVar

Allow propagator to monitor element removal/enforcing of this

Specified by:

monitorDelta in interface SetVar

Parameters:

propagator - observer

Returns:

a new SetDeltaMonitor

isInstantiated

public boolean isInstantiated()

Description copied from interface: Variable

Indicates whether this is instantiated (see implemtations to know what instantiation means).

Specified by:

isInstantiated in interface Variable

Returns:

true if this is instantiated

addMonitor

public void addMonitor(IVariableMonitor monitor)

Description copied from interface: Variable

Build and add a monitor to the monitor list of this. The monitor is inactive at the creation and must be activated (by the engine propagation).

Specified by:

addMonitor in interface Variable

Overrides:

addMonitor in class AbstractVariable

Parameters:

monitor - a variable monitor

removeMonitor

public void removeMonitor(IVariableMonitor monitor)

Specified by:

removeMonitor in interface Variable

Overrides:

removeMonitor in class AbstractVariable

subscribeView

public void subscribeView(IView view)

Specified by:

subscribeView in interface Variable

Overrides:

subscribeView in class AbstractVariable

recordMask

public void recordMask(int mask)

Description copied from interface: Variable

Analysis propagator event reaction on this, and adapt this

Specified by:

recordMask in interface Variable

Overrides:

recordMask in class AbstractVariable

Parameters:

mask - event mask

notifyPropagators

public void notifyPropagators(IEventType event,
                     ICause cause)
                       throws ContradictionException

Description copied from interface: Variable

If this has changed, then notify all of its observers.
Each observer has its update method.

Specified by:

notifyPropagators in interface Variable

Overrides:

notifyPropagators in class AbstractVariable

Parameters:

event - event on this object

cause - object which leads to the modification of this object

Throws:

ContradictionException - if a contradiction occurs during notification

notifyViews

public void notifyViews(IEventType event,
               ICause cause)
                 throws ContradictionException

Description copied from interface: Variable

Notify views of observed variable modifications

Specified by:

notifyViews in interface Variable

Overrides:

notifyViews in class AbstractVariable

Parameters:

event - the event which occurred on the variable

Throws:

ContradictionException

notifyMonitors

public void notifyMonitors(IEventType event)
                    throws ContradictionException

Description copied from interface: Variable

Notify monitors of observed variable modifications

Specified by:

notifyMonitors in interface Variable

Parameters:

event - the event which occurred on the variable

Throws:

ContradictionException

contradiction

public void contradiction(ICause cause,
                 IEventType event,
                 String message)
                   throws ContradictionException

Description copied from interface: Variable

Throws a contradiction exception based on

Specified by:

contradiction in interface Variable

Parameters:

cause - ICause causing the exception

event - event causing the contradiction

message - the detailed message @throws ContradictionException expected behavior

Throws:

ContradictionException

getTypeAndKind

public int getTypeAndKind()

Description copied from interface: Variable

Return a MASK composed of 2 main information: TYPE and KIND.
TYPE is defined in the 3 first bits : VAR ( 1 << 0), CSTE (1 << 1) or VIEW (1 << 2)
KIND is defined on the other bits : INT (1 << 3), BOOL (INT + 1 << 4), GRAPH (1 << 5) or META (1 << 6)

To get the TYPE of a variable:

 int type = var.getTypeAndKind() & Variable.TYPE;
 

To get the KIND of a variable:

 int kind = var.getTypeAndKind() & Variable.KIND;
 

To check a specific type or kind of a variable:

     boolean isVar = (var.getTypeAndKind() & Variable.VAR) !=0;
     boolean isInt = (var.getTypeAndKind() & Variable.INT) !=0;
 

Specified by:

getTypeAndKind in interface Variable

Returns:

an int representing the type and kind of the variable

duplicate

public SetVar duplicate()

Description copied from interface: Variable

Duplicate this.

Specified by:

duplicate in interface Variable

Returns:

a copy of this

duplicate

public void duplicate(Solver solver,
             gnu.trove.map.hash.THashMap<Object,Object> identitymap)

Description copied from interface: Variable

Duplicate this (which naturally adds it into solver).

Specified by:

duplicate in interface Variable

Parameters:

solver - target solver

identitymap - a map to guarantee uniqueness of objects