ilog.concert

Interface IloNumToNumStepFunctionCursor

public interface IloNumToNumStepFunctionCursor

An instance of the class IloNumToNumStepFunctionCursor allows you to inspect the contents of an instance of IloNumToNumStepFunction. A step of a step function is defined as an interval [x1,x2) over which the value of the function is the same. Cursors are intended to iterate forward or backward over the steps of a step function.

The structure of the step function cannot be changed while a cursor is being used to inspect it. Therefore, methods that change the structure of the step function, such as IloNumToNumStepFunction::setValue, should not be called while the cursor is being used.

See Also:

IloNumToNumStepFunction

Method Summary

Methods

Modifier and Type	Method and Description
double	getSegmentMax() This member function returns the right-most point of the step currently specified by the cursor.
double	getSegmentMin() This member function returns the left-most point of the step currently specified by the cursor.
double	getValue() This member function returns the value of the step currently specified by the cursor.
void	next() This operator moves the cursor to the step adjacent to the current step (forward move).
boolean	ok() This member function returns IloFalse if the cursor does not currently specify a step included in the definition interval of the step function.
void	previous() This operator moves the cursor to the step adjacent to the current step (backward move).
void	seek(double f) This member function sets the cursor to specify the step of the function that contains the argument.

Method Detail

ok

boolean ok()

This member function returns IloFalse if the cursor does not currently specify a step included in the definition interval of the step function. Otherwise, it returns IloTrue.

next

void next()

This operator moves the cursor to the step adjacent to the current step (forward move).

previous

void previous()

This operator moves the cursor to the step adjacent to the current step (backward move).

seek

void seek(double f)

This member function sets the cursor to specify the step of the function that contains the argument. An IloException is thrown if the argument does not belong to the definition interval of the step function associated with the invoking cursor.

getSegmentMin

double getSegmentMin()

This member function returns the left-most point of the step currently specified by the cursor.

getSegmentMax

double getSegmentMax()

This member function returns the right-most point of the step currently specified by the cursor.

getValue

double getValue()

This member function returns the value of the step currently specified by the cursor.