Package com.github.tommyettinger.ds.support.util

Class StridingIntIterator

java.lang.Object

com.github.tommyettinger.ds.support.util.StridingIntIterator

All Implemented Interfaces:

IntIterator, Iterator<Integer>

public class StridingIntIterator
extends Object
implements IntIterator

Wraps an IntIterator so that it starts at an offset, skipping that many items, then returning items that match a given stride, such as every other item, or every tenth item. If the offset is 0, this will try to return the first item and then any items matching the stride, so if the stride is 2, it will return the first item, skip one item, return the item after that, skip, return, skip, return, etc. This has undefined behavior if any items the IntIterator could return are modified during iteration.
You can change the iterator, offset, and stride at once using set(IntIterator, int, int), and can also just change the iterator with set(IntIterator).

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	available
protected boolean	end
protected int	index
IntIterator	iterator
protected int	next
protected int	offset
protected int	stride

Constructor Summary

Constructors

Constructor	Description
StridingIntIterator()
StridingIntIterator(IntIterator iterator, int offset, int stride)

Method Summary

Modifier and Type	Method	Description
boolean	hasNext()
int	nextInt()	Returns the next int element in the iteration.
void	remove()	NOTE: this does not change the stride or offset, so the same sequence of values will be returned regardless of if some elements are removed with this method.
void	set(IntIterator iterator)
void	set(IntIterator iterator, int offset, int stride)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.tommyettinger.ds.support.util.IntIterator

forEachRemaining, next

Methods inherited from interface java.util.Iterator

forEachRemaining

Field Details

iterator

public IntIterator iterator

offset

protected int offset

stride

protected int stride

index

protected int index

end

protected boolean end

available

protected boolean available

next

protected int next

Constructor Details

StridingIntIterator

public StridingIntIterator()

StridingIntIterator

public StridingIntIterator(IntIterator iterator,
 int offset,
 int stride)

Method Details

set

public void set(IntIterator iterator,
 int offset,
 int stride)

set

public void set(IntIterator iterator)

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<Integer>

nextInt

public int nextInt()

Description copied from interface: IntIterator

Returns the next int element in the iteration.

Specified by:

nextInt in interface IntIterator

Returns:

the next int element in the iteration

remove

public void remove()

NOTE: this does not change the stride or offset, so the same sequence of values will be returned regardless of if some elements are removed with this method.

Specified by:

remove in interface Iterator<Integer>