Overview | Group | Tree | Graph | Index | Concepts |
An instance of the class IloNumToAnySetStepFunctionCursor
allows you to inspect the contents of an IloNumToAnySetStepFunction.
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.
IloNumToAnySetStepFunction::set
,
should not be called while the cursor is being used.See Also:
Constructor and Destructor Summary | |
---|---|
public | IloNumToAnySetStepFunctionCursor(const IloNumToAnySetStepFunction) |
public | IloNumToAnySetStepFunctionCursor(const IloNumToAnySetStepFunction, IloNum) |
public | IloNumToAnySetStepFunctionCursor(const IloNumToAnySetStepFunctionCursor &) |
Method Summary | |
---|---|
public IloAnySet | getComplementSet() |
public IloNum | getSegmentMax() |
public IloNum | getSegmentMin() |
public IloAnySet | getSet() |
public IloBool | isEmpty() |
public IloBool | isFull() |
public IloBool | ok() |
public void | operator++() |
public void | operator--() |
public void | operator=(const IloNumToAnySetStepFunctionCursor &) |
public void | seek(IloNum) |
public IloBool | usesComplementaryRepresentation() |
Constructor and Destructor Detail |
---|
This constructor creates a cursor to inspect the step function argument. This cursor lets you iterate forward or backward over the steps of the function. The cursor initially indicates the first step of the function.
This constructor creates a cursor to inspect the step function argument.
This cursor lets you iterate forward or backward over the steps of the
function. The cursor initially indicates the step of the function that
contains x
.
Note that if n is the number of steps of the function given as argument, the worst-case complexity of this constructor is O(log(n)).
This constructor creates a new cursor that is a copy of the argument. The
new cursor initially indicates the same step and the same function as the
argument cursor
.
Method Detail |
---|
This member function returns the set representing the complement of the
value of the step currently indicated by the cursor. An instance of
IloException
is thrown if the value of the step does not use a
complementary representation.
This member function returns the right-most point of the step currently indicated by the cursor.
This member function returns the left-most point of the step currently indicated by the cursor.
This member function returns the value of the step currently indicated by
the cursor. An instance of IloException
is thrown if the value
of the step uses a complementary representation.
This member function returns IloTrue
if the value of the
current step is the empty set.
This member function returns IloTrue
if the value of the
current step is the full set. (See also: IloNumToAnySetStepFunction::isFull
).
This member function returns IloFalse
if the cursor does not
currently indicate a step included in the definition interval of the step
function. Otherwise, it returns IloTrue
.
This operator moves the cursor to the step adjacent to the current step (forward move).
This operator moves the cursor to the step adjacent to the current step (backward move).
This operator assigns an address to the handle pointer of the invoking
instance of IloNumToAnySetStepFunctionCursor
. That address is
the location of the implementation object of the argument
cursor
. After the execution of this operator, the invoking
object and cursor
both point to the same implementation
object.
This member function sets the cursor to indicate the step of the function
that contains x
. Note that if n is the number of steps
of the step function traversed by the invoking iterator, the worst-case
complexity of this member function is O(log(n)). An instance of
IloException
is thrown if x
does not belong to the
definition interval of the invoking function.
This member function returns IloTrue
if the value of the
current step uses the complementary representation.