org.grouplens.lenskit.collections

Class BitSetIterator

java.lang.Object

it.unimi.dsi.fastutil.ints.AbstractIntIterator

it.unimi.dsi.fastutil.ints.AbstractIntBidirectionalIterator

org.grouplens.lenskit.collections.BitSetIterator

All Implemented Interfaces:

BidirectionalIterator<Integer>, IntBidirectionalIterator, IntIterator, ObjectBidirectionalIterator<Integer>, ObjectIterator<Integer>, Iterator<Integer>

public final class BitSetIterator
extends AbstractIntBidirectionalIterator

Iterator over the set bits in a BitSet, returning the indexes of the set bits, in order from 0 to highest index of a set bit.

Since:

0.9

Constructor Summary

Constructors

Constructor and Description
BitSetIterator(BitSet set) Construct an iterator over a bit set.
BitSetIterator(BitSet set, int start) Construct an iterator over a bit set, starting at a desired index.
BitSetIterator(BitSet set, int start, int end) Create an iterator starting at a particular bit and ending at another index.
BitSetIterator(BitSet set, int start, int end, int initial) Create an iterator starting at a particular bit and ending at another index, with an initial position that may not be at the beginning.

Method Summary

Modifier and Type	Method and Description
boolean	hasNext()
boolean	hasPrevious()
int	nextInt()
int	previousInt()

Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractIntBidirectionalIterator

back, previous

Methods inherited from class it.unimi.dsi.fastutil.ints.AbstractIntIterator

next, remove, skip

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface it.unimi.dsi.fastutil.ints.IntIterator

skip

Methods inherited from interface it.unimi.dsi.fastutil.objects.ObjectIterator

skip

Methods inherited from interface java.util.Iterator

forEachRemaining, next, remove

Constructor Detail

BitSetIterator

public BitSetIterator(BitSet set)

Construct an iterator over a bit set.

Parameters:

set - The set to iterate.

BitSetIterator

public BitSetIterator(BitSet set,
                      int start)

Construct an iterator over a bit set, starting at a desired index.

Parameters:

set - The set to iterate.

start - The first bit to return.

BitSetIterator

public BitSetIterator(BitSet set,
                      int start,
                      int end)

Create an iterator starting at a particular bit and ending at another index. The indices returned are inclusive of the starting index, and exclusive of the ending index.

Parameters:

set - The bit set to wrap.

start - The start index, inclusive.

end - The end index, exclusive.

BitSetIterator

public BitSetIterator(BitSet set,
                      int start,
                      int end,
                      int initial)

Create an iterator starting at a particular bit and ending at another index, with an initial position that may not be at the beginning. The indices returned are inclusive of the starting index, and exclusive of the ending index.

Parameters:

set - The bit set to wrap.

start - The start index, inclusive.

end - The end index, exclusive.

initial - The initial position of the iterator. The first call to nextInt() returns the first set bit such that bit >= initial and bit < end.

Method Detail

hasNext

public boolean hasNext()

hasPrevious

public boolean hasPrevious()

nextInt

public int nextInt()

Specified by:

nextInt in interface IntIterator

Overrides:

nextInt in class AbstractIntIterator

previousInt

public int previousInt()

Specified by:

previousInt in interface IntBidirectionalIterator

Overrides:

previousInt in class AbstractIntBidirectionalIterator