ilog.concert

Interface IloNumToNumSegmentFunctionCursor

public interface IloNumToNumSegmentFunctionCursor

An instance of the class IloNumToNumSegmentFunctionCursor allows you to inspect the contents of an IloNumToNumSegmentFunction. A segment of a piecewise linear function is defined as an interval [x1, x2) over which the function is linear. Cursors are intended to iterate forward or backward over the segments of a piecewise linear function.

The structure of the piecewise linear function cannot be changed while a cursor is being used to inspect it. Therefore, functions that change the structure of the piecewise linear function, such as , should not be called while the cursor is being used.

See Also:

IloNumToNumSegmentFunction

Method Summary

Methods

Modifier and Type	Method and Description
double	getSegmentMax() This member function returns the right-most point of the segment currently specified by the cursor.
double	getSegmentMin() This member function returns the left-most point of the segment currently specified by the cursor.
double	getValue(double t) This member function returns the value of the piecewise linear function at time t.
double	getValueLeft() This member function returns the value of the function at the left-most point of the segment currently specified by the cursor.
double	getValueRight() This member function returns the value of the function at the right-most point of the segment currently specified by the cursor.
void	next() This operator moves the cursor to the segment adjacent to the current step (forward move).
boolean	ok() This member function returns IloFalse if the cursor does not currently specify a segment included in the definition interval of the piecewise linear function.
void	previous() This operator moves the cursor to the segment adjacent to the current step (backward move).
void	seek(double f) This member function sets the cursor to specify the segment 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 segment included in the definition interval of the piecewise linear function. Otherwise, it returns IloTrue.

next

void next()

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

previous

void previous()

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

seek

void seek(double f)

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

getSegmentMin

double getSegmentMin()

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

getSegmentMax

double getSegmentMax()

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

getValueLeft

double getValueLeft()

This member function returns the value of the function at the left-most point of the segment currently specified by the cursor.

getValueRight

double getValueRight()

This member function returns the value of the function at the right-most point of the segment currently specified by the cursor.

getValue

double getValue(double t)

This member function returns the value of the piecewise linear function at time t. t must be between the left-most and the right-most point of the segment currently specified by the cursor.