org.chocosolver.util.iterators

Interface ValueIterator

All Known Implementing Classes:

DisposableValueBoundIterator, DisposableValueIterator

public interface ValueIterator

An interface to declare values iterator.

A value iterator can be iterated in 2 ways: bottom-up (from lower bound to upper bound)
and top-down (from upper bound to lower bound).
To iterate in bottom-up way, first call bottomUpInit(), then hasNext() and next().
To iterate in bottom-up way, first call topDownInit(), then hasPrevious() and previous().

Once a way is selected, using the wrong methods can lead to unexpected behaviour.

 ValueIterator vit = ...;
 vit.bottomUpInit();
 while(vit.hasNext()){
    int v = vit.next();
    // operate on value v here
 }

OR

 ValueIterator vit = ...;
 vit.topDownInit();
 while(vit.hasPrevious()){
    int v = vit.previous();
    // operate on value v here
 }

Since:

05/10/11

Author:

Charles Prud'homme

Method Summary

Methods

Modifier and Type	Method and Description
void	bottomUpInit()
boolean	hasNext() Returns true if the iteration has more values.
boolean	hasPrevious() Returns true if the iteration has more ranges.
int	next() Compute and return the next value.
int	previous() Compute and return the next value.
void	topDownInit()

Method Detail

bottomUpInit

void bottomUpInit()

topDownInit

void topDownInit()

hasNext

boolean hasNext()

Returns true if the iteration has more values. (In other words, returns true if next would return valid value.)

Returns:

true if the getIterator has more values.

hasPrevious

boolean hasPrevious()

Returns true if the iteration has more ranges. (In other words, returns true if next would return a valid value.)

Returns:

true if the getIterator has more values.

next

int next()

Compute and return the next value.

Returns:

the next element in the iteration.

previous

int previous()

Compute and return the next value.

Returns:

the previous element in the iteration.