org.chocosolver.solver.variables.events

Enum IntEventType

java.lang.Object

java.lang.Enum<IntEventType>

org.chocosolver.solver.variables.events.IntEventType

All Implemented Interfaces:

Serializable, Comparable<IntEventType>, IEventType

public enum IntEventType
extends Enum<IntEventType>
implements IEventType

An enum defining the integer variable event types:

• REMOVE: value removal event,
• INCLOW: lower bound increase event,
• DECUPP: upper bound decrease event,
• BOUND: lower bound increase and/or upper bound decrease event,
• INSTANTIATE: variable instantiation event

Author:

Charles Prud'homme, Jean-Guillaume Fages

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOUND
DECUPP
INCLOW
INSTANTIATE
REMOVE
VOID

Field Summary

Fields inherited from interface org.chocosolver.solver.variables.events.IEventType

ALL_EVENTS

Method Summary

Methods

Modifier and Type	Method and Description
static int	all()
static int	boundAndInst()
int	getMask() Return the value of the mask associated with the event.
int	getStrengthenedMask() Return the strengthened mask associated to the event.
static int	instantiation()
static boolean	isBound(int mask)
static boolean	isDecupp(int mask)
static boolean	isInclow(int mask)
static boolean	isInstantiate(int mask)
static boolean	isRemove(int mask)
static IntEventType	valueOf(String name) Returns the enum constant of this type with the specified name.
static IntEventType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

VOID

public static final IntEventType VOID

REMOVE

public static final IntEventType REMOVE

INCLOW

public static final IntEventType INCLOW

DECUPP

public static final IntEventType DECUPP

BOUND

public static final IntEventType BOUND

INSTANTIATE

public static final IntEventType INSTANTIATE

Method Detail

values

public static IntEventType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (IntEventType c : IntEventType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static IntEventType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getMask

public int getMask()

Description copied from interface: IEventType

Return the value of the mask associated with the event.

Specified by:

getMask in interface IEventType

Returns:

the mask of the event.

getStrengthenedMask

public int getStrengthenedMask()

Description copied from interface: IEventType

Return the strengthened mask associated to the event. This can be equal to the mask.

Specified by:

getStrengthenedMask in interface IEventType

Returns:

the mask of the strenghtened event.

all

public static int all()

boundAndInst

public static int boundAndInst()

instantiation

public static int instantiation()

isInstantiate

public static boolean isInstantiate(int mask)

isRemove

public static boolean isRemove(int mask)

isBound

public static boolean isBound(int mask)

isInclow

public static boolean isInclow(int mask)

isDecupp

public static boolean isDecupp(int mask)