net.markenwerk.commons.iterators

Class DoubleArrayIterator

java.lang.Object

net.markenwerk.commons.iterators.DoubleArrayIterator

All Implemented Interfaces:

Iterator<Double>

public final class DoubleArrayIterator
extends Object
implements Iterator<Double>

A DoubleArrayIterator is an Iterator that iterates over a given double[].

Calling remove() sets the array to 0 at the index that corresponds to the last value returned by next().

Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor and Description
DoubleArrayIterator(double[] array) Creates a new DoubleArrayIterator that iterates over the given double[].
DoubleArrayIterator(double[] array, double replacement) Creates a new DoubleArrayIterator that iterates over the given double[].

Method Summary

Modifier and Type	Method and Description
boolean	hasNext()
Double	next()
void	remove()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

DoubleArrayIterator

public DoubleArrayIterator(double[] array)
                    throws IllegalArgumentException

Creates a new DoubleArrayIterator that iterates over the given double[].

If the given double[] is null, the new DoubleArrayIterator will behave, as if an empty double[] has been given.

Parameters:

array - The double[] to iterate over.

Throws:

IllegalArgumentException - If the given double[] is null.

DoubleArrayIterator

public DoubleArrayIterator(double[] array,
                           double replacement)
                    throws IllegalArgumentException

Creates a new DoubleArrayIterator that iterates over the given double[].

If the given double[] is null, the new DoubleArrayIterator will behave, as if an empty double[] has been given.

Parameters:

array - The double[] to iterate over.

replacement - The value to replace removed values with.

Throws:

IllegalArgumentException - If the given double[] is null.

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<Double>

next

public Double next()

Specified by:

next in interface Iterator<Double>

remove

public void remove()

Specified by:

remove in interface Iterator<Double>