Module org.chocosolver

Package org.chocosolver.solver.variables.delta

Enum NoDelta

java.lang.Object

java.lang.Enum<NoDelta>

org.chocosolver.solver.variables.delta.NoDelta

All Implemented Interfaces:

Serializable, Comparable<NoDelta>, IDelta, IEnumDelta, IIntervalDelta, IntDelta, ISetDelta

public enum NoDelta
extends Enum<NoDelta>
implements IEnumDelta, IIntervalDelta, ISetDelta

Since:

10/02/11

Author:

Charles Prud'homme

Enum Constant Summary

Enum Constants

Enum Constant	Description
singleton

Field Summary

Fields inherited from interface org.chocosolver.solver.variables.delta.ISetDelta

LB, UB

Method Summary

Modifier and Type	Method	Description
void	add(int lb, int ub, ICause cause)	Adds a new value interval to the delta
void	add(int value, ICause cause)	Adds a new value to the delta
int	get(int idx)	Return the idx^th value stored in the delta, if any
int	get(int index, int kerOrEnv)
ICause	getCause(int idx)	Return the cause of the idx^th cause stored in the delta, if any
ICause	getCause(int index, int kerOrEnv)
IEnvironment	getEnvironment()	Return the associate environment
int	getLB(int idx)	Return the lower bound of idx^th interval stored in the delta, if any
int	getSize(int kerOrEnv)
int	getUB(int idx)	Return the upper bound idx^th interval stored in the delta, if any
void	lazyClear()	Lazy clear the delta, on world change
int	size()	Returns the number of element
static NoDelta	valueOf(String name)	Returns the enum constant of this type with the specified name.
static NoDelta[]	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

singleton

public static final NoDelta singleton

Method Detail

values

public static NoDelta[] 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 (NoDelta c : NoDelta.values())
    System.out.println(c);

Returns:

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

valueOf

public static NoDelta 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

add

public void add(int value,
                ICause cause)

Description copied from interface: IEnumDelta

Adds a new value to the delta

Specified by:

add in interface IEnumDelta

Parameters:

value - value to add

cause - of the removal

lazyClear

public void lazyClear()

Description copied from interface: IDelta

Lazy clear the delta, on world change

Specified by:

lazyClear in interface IDelta

getEnvironment

public IEnvironment getEnvironment()

Description copied from interface: IDelta

Return the associate environment

Specified by:

getEnvironment in interface IDelta

Returns:

associated environment

add

public void add(int lb,
                int ub,
                ICause cause)

Description copied from interface: IIntervalDelta

Adds a new value interval to the delta

Specified by:

add in interface IIntervalDelta

Specified by:

add in interface ISetDelta

Parameters:

lb - lower bound of removed interval

ub - upper bound of removed interval

cause - of the removal

getLB

public int getLB(int idx)
          throws IndexOutOfBoundsException

Description copied from interface: IIntervalDelta

Return the lower bound of idx^th interval stored in the delta, if any

Specified by:

getLB in interface IIntervalDelta

Parameters:

idx - rank of the interval

Returns:

idx^th interval

Throws:

IndexOutOfBoundsException - if idx is out of the bounds

getUB

public int getUB(int idx)
          throws IndexOutOfBoundsException

Description copied from interface: IIntervalDelta

Return the upper bound idx^th interval stored in the delta, if any

Specified by:

getUB in interface IIntervalDelta

Parameters:

idx - rank of the interval

Returns:

idx^th interval

Throws:

IndexOutOfBoundsException - if idx is out of the bounds

get

public int get(int idx)

Description copied from interface: IEnumDelta

Return the idx^th value stored in the delta, if any

Specified by:

get in interface IEnumDelta

Parameters:

idx - rank of the value

Returns:

idx^th value

getCause

public ICause getCause(int idx)

Description copied from interface: IntDelta

Return the cause of the idx^th cause stored in the delta, if any

Specified by:

getCause in interface IntDelta

Parameters:

idx - rank of the interval

Returns:

cause of the removal

size

public int size()

Description copied from interface: IntDelta

Returns the number of element

Specified by:

size in interface IntDelta

Returns:

number of element

getSize

public int getSize(int kerOrEnv)

Specified by:

getSize in interface ISetDelta

get

public int get(int index,
               int kerOrEnv)

Specified by:

get in interface ISetDelta

getCause

public ICause getCause(int index,
                       int kerOrEnv)

Specified by:

getCause in interface ISetDelta