ilog.concert

Interface IloIntervalVar

All Superinterfaces:

IloAddable, ilog.concert.IloCopyable

public interface IloIntervalVar
extends IloAddable

An instance of this class represents an interval variable in a model. An instance of this class represents an interval variable in a model. An interval variable is a decision variable whose value is an interval of integers. Thus, the value of an interval variable is characterized by two integers, one for the start of the interval and the other for the end of the interval. An important additional feature of interval variables is the fact that they can be optional: that is, one can decide not to consider them in the solution. When considered in the solution, the interval is said to be present, otherwise it is absent. When an interval is absent attributes like start and end are meaningless. Each constraint and expression on interval variables specifies how it handles absent intervals.

The length of an interval variable is defined as its end value minus its start value. The size of an interval variable is a non-negative integer characteristic of an interval variable, and related to the start and end of the interval variable through an intensity function. When an intensity function is specified, the size is equal to the integral of the intensity function between the start and the end of the interval. By default, when no intensity function is specified, the intensity is assumed to be the constant unit function and thus, the size and length of of the interval are equivalent.

For more information on interval variables, see the concept Interval Variables in the C++ Reference Manual.

Method Summary

Methods

Modifier and Type	Method and Description
int	getEndMax() This member function returns the maximal end value of the invoking interval variable.
int	getEndMin() This member function returns the minimal end value of the invoking interval variable.
int	getGranularity() This member function returns the granularity of the intensity function of the invoking interval variable.
IloNumToNumStepFunction	getIntensity() This member function returns the intensity function of the invoking interval variable.
int	getLengthMax() This member function returns the maximal length value of the invoking interval variable.
int	getLengthMin() This member function returns the minimal length value of the invoking interval variable.
int	getSizeMax() This member function returns the maximal size value of the invoking interval variable.
int	getSizeMin() This member function returns the minimal size value of the invoking interval variable.
int	getStartMax() This member function returns the maximal start value of the invoking interval variable.
int	getStartMin() This member function returns the minimal start value of the invoking interval variable.
boolean	isAbsent() This member function returns true if and only if the invoking interval variable must be absent.
boolean	isPresent() This member function returns true if and only if the invoking interval variable must be present.
void	setAbsent() This member function specifies that the invoking interval variable must be absent.
void	setEndMax(int t) This member function sets t as the maximal end value of the invoking interval variable.
void	setEndMin(int t) This member function sets t as the minimal end value of the invoking interval variable.
void	setIntensity(IloNumToNumStepFunction intensity) This member function specifies an intensity function intensity for the invoking interval variable.
void	setIntensity(IloNumToNumStepFunction intensity, int granularity) This member function specifies an intensity function intensity and a granularity granularity for the invoking interval variable.
void	setLengthMax(int t) This member function sets t as the maximal length value of the invoking interval variable.
void	setLengthMin(int t) This member function sets t as the minimal length value of the invoking interval variable.
void	setOptional() This member function specifies that the invoking interval variable is optional; that is, the presence status of the interval is a decision variable of the problem.
void	setPresent() This member function specifies that the invoking interval variable must be present.
void	setSizeMax(int t) This member function sets t as the maximal size value of the invoking interval variable.
void	setSizeMin(int t) This member function sets t as the minimal size value of the invoking interval variable.
void	setStartMax(int t) This member function sets t as the maximal start value of the invoking interval variable.
void	setStartMin(int t) This member function sets t as the minimal start value of the invoking interval variable.

Methods inherited from interface ilog.concert.IloAddable

getName, setName

Method Detail

getStartMin

int getStartMin()

This member function returns the minimal start value of the invoking interval variable.

getStartMax

int getStartMax()

This member function returns the maximal start value of the invoking interval variable.

getEndMin

int getEndMin()

This member function returns the minimal end value of the invoking interval variable.

getEndMax

int getEndMax()

This member function returns the maximal end value of the invoking interval variable.

getSizeMin

int getSizeMin()

This member function returns the minimal size value of the invoking interval variable.

getSizeMax

int getSizeMax()

This member function returns the maximal size value of the invoking interval variable.

getLengthMin

int getLengthMin()

This member function returns the minimal length value of the invoking interval variable.

getLengthMax

int getLengthMax()

This member function returns the maximal length value of the invoking interval variable.

isPresent

boolean isPresent()

This member function returns true if and only if the invoking interval variable must be present.

isAbsent

boolean isAbsent()

This member function returns true if and only if the invoking interval variable must be absent.

setStartMin

void setStartMin(int t)

This member function sets t as the minimal start value of the invoking interval variable. This member function notifies Concert Technology algorithms about this change of bound in this interval variable.

setStartMax

void setStartMax(int t)

This member function sets t as the maximal start value of the invoking interval variable. This member function notifies Concert Technology algorithms about this change of bound in this interval variable.

setEndMin

void setEndMin(int t)

This member function sets t as the minimal end value of the invoking interval variable. This member function notifies Concert Technology algorithms about this change of bound in this interval variable.

setEndMax

void setEndMax(int t)

This member function sets t as the maximal end value of the invoking interval variable. This member function notifies Concert Technology algorithms about this change of bound in this interval variable.

setSizeMin

void setSizeMin(int t)

This member function sets t as the minimal size value of the invoking interval variable. This member function notifies Concert Technology algorithms about this change of bound in this interval variable.

setSizeMax

void setSizeMax(int t)

This member function sets t as the maximal size value of the invoking interval variable. This member function notifies Concert Technology algorithms about this change of bound in this interval variable.

setLengthMin

void setLengthMin(int t)

This member function sets t as the minimal length value of the invoking interval variable. This member function notifies Concert Technology algorithms about this change of bound in this interval variable.

setLengthMax

void setLengthMax(int t)

This member function sets t as the maximal length value of the invoking interval variable. This member function notifies Concert Technology algorithms about this change of bound in this interval variable.

setPresent

void setPresent()

This member function specifies that the invoking interval variable must be present. This member function notifies Concert Technology algorithms about the change of this interval variable.

setAbsent

void setAbsent()

This member function specifies that the invoking interval variable must be absent. This member function notifies Concert Technology algorithms about the change of this interval variable.

setOptional

void setOptional()

This member function specifies that the invoking interval variable is optional; that is, the presence status of the interval is a decision variable of the problem. This member function notifies Concert Technology algorithms about the change of this interval variable.

getIntensity

IloNumToNumStepFunction getIntensity()

This member function returns the intensity function of the invoking interval variable. If the interval variable was not associated an intensity function, it returns an empty handle.

getGranularity

int getGranularity()

This member function returns the granularity of the intensity function of the invoking interval variable. Note that by default, the granularity is 100 so the intensity function is expressed as a percentage.

setIntensity

void setIntensity(IloNumToNumStepFunction intensity,
                int granularity)

This member function specifies an intensity function intensity and a granularity granularity for the invoking interval variable. This member function notifies Concert Technology algorithms about the change of this interval variable.

setIntensity

void setIntensity(IloNumToNumStepFunction intensity)

This member function specifies an intensity function intensity for the invoking interval variable. As the granularity is not specified, a granularity of 100 is assumed, and the intensity function should be expressed as a percentage. This member function notifies Concert Technology algorithms about the change of this interval variable.