Package com.puresoltechnologies.streaming.iterators

Class StatisticsIterator<T extends Number & Comparable<T>>

java.lang.Object

com.puresoltechnologies.streaming.iterators.StatisticsIterator<T>

Type Parameters:

T - is the actual number type.

All Implemented Interfaces:

StreamIterator<T>, Iterator<T>

public class StatisticsIterator<T extends Number & Comparable<T>>
extends Object
implements StreamIterator<T>

This iterator is used to calculate the RunningStatistics when iterating.

Author:

Rick-Rainer Ludwig

Constructor Summary

Constructors

Constructor	Description
StatisticsIterator(StreamIterator<T> iterator)

Method Summary

Modifier and Type	Method	Description
long	getCount()
double	getMax()
double	getMean()
double	getMin()
double	getS()
double	getSigma()
boolean	hasNext()
T	next()	This method overwrites Iterator.next() with a one change: The resulting element is never null.
T	peek()	This method returns the next element which will be returned by next(), without moving forward.

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.puresoltechnologies.streaming.iterators.StreamIterator

empty, filter, flatMap, map, of, spliterator, stream

Constructor Detail

StatisticsIterator

public StatisticsIterator(StreamIterator<T> iterator)

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<T extends Number & Comparable<T>>

next

public T next()
       throws NoSuchElementException

Description copied from interface: StreamIterator

This method overwrites Iterator.next() with a one change: The resulting element is never null.

Specified by:

next in interface Iterator<T extends Number & Comparable<T>>

Specified by:

next in interface StreamIterator<T extends Number & Comparable<T>>

Returns:

An object of generic type T is returned. If the stream has reached its end, a NoSuchElementException is thrown. Iterator.hasNext() will returned false in this case and should be asked for the presence of more elements in advance. The result is never null.

Throws:

NoSuchElementException - is thrown in case the stream has reached its end.

peek

public T peek()
       throws NoSuchElementException

Description copied from interface: StreamIterator

This method returns the next element which will be returned by next(), without moving forward.

Specified by:

peek in interface StreamIterator<T extends Number & Comparable<T>>

Returns:

An object of generic type T is returned. If the stream has reached its end, a NoSuchElementException is thrown. Iterator.hasNext() will returned false in this case and should be asked for the presence of more elements in advance. The result is never null.

Throws:

NoSuchElementException - is thrown in case the stream has reached its end.

getCount

public long getCount()

getMin

public double getMin()

getMax

public double getMax()

getMean

public double getMean()

getSigma

public double getSigma()

getS

public double getS()