org.jscience.mathematics.analysis
Class BasicSampledMappingIterator

java.lang.Object
  extended by org.jscience.mathematics.analysis.BasicSampledMappingIterator
All Implemented Interfaces:
java.io.Serializable, SampledMappingIterator

public class BasicSampledMappingIterator
extends java.lang.Object
implements SampledMappingIterator, java.io.Serializable

This class is a simple wrapper allowing to iterate over a SampledFunction.

The basic implementation of the iteration interface does not perform any transformation on the sample, it only handles a loop over the underlying sampled function.

See Also:
SampledMapping, Serialized Form

Constructor Summary
BasicSampledMappingIterator(SampledMapping function)
          Simple constructor.
 
Method Summary
 SampledMapping getSampledMapping()
          DOCUMENT ME!
 boolean hasNext()
          Check if the iterator can provide another point.
 ValuedPair next()
          Get the next point of a sampled function.
 void remove()
          DOCUMENT ME!
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BasicSampledMappingIterator

public BasicSampledMappingIterator(SampledMapping function)
Simple constructor. Build an instance from a SampledFunction

Parameters:
function - smapled function over which we want to iterate
Method Detail

getSampledMapping

public SampledMapping getSampledMapping()
Description copied from interface: SampledMappingIterator
DOCUMENT ME!

Specified by:
getSampledMapping in interface SampledMappingIterator
Returns:
DOCUMENT ME!

hasNext

public boolean hasNext()
Description copied from interface: SampledMappingIterator
Check if the iterator can provide another point.

Specified by:
hasNext in interface SampledMappingIterator
Returns:
true if the iterator can provide another point.

next

public ValuedPair next()
Description copied from interface: SampledMappingIterator
Get the next point of a sampled function.

Specified by:
next in interface SampledMappingIterator
Returns:
the next point of the sampled function

remove

public void remove()
Description copied from interface: SampledMappingIterator
DOCUMENT ME!

Specified by:
remove in interface SampledMappingIterator