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

Interface DoubleIterator

All Superinterfaces:
Iterator<Double>
All Known Implementing Classes:
DoubleDeque.DoubleDequeIterator, DoubleList.DoubleListIterator, EditingDoubleIterator, FilteringDoubleIterator, LimitingDoubleIterator, StridingDoubleIterator
public interface DoubleIterator extends Iterator<Double>
An Iterator specialized for double values. This iterates over primitive doubles using nextDouble().
This is roughly equivalent to DoubleIterator in Java 8, and is present here so environments don't fully support Java 8 APIs (such as RoboVM) can use it.
This interface is closely based on DoubleIterator in OpenJDK 8. This iterator interface is extremely simple and there's no way to implement it in a way that respects compatibility other than the way OpenJDK 8 does. OpenJDK's license is available here, if it applies at all.

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    forEachRemaining(com.github.tommyettinger.function.DoubleConsumer action)
    Performs the given action for each remaining element until all elements have been processed or the action throws an exception.
    default Double
    next()
    double
    nextDouble()
    Returns the next double element in the iteration.

    Methods inherited from interface java.util.Iterator

    forEachRemaining, hasNext, remove

  • Method Details

    • nextDouble

      double nextDouble()
      Returns the next double element in the iteration.
      Returns:
      the next double element in the iteration
      Throws:
      NoSuchElementException - if the iteration has no more elements

    • forEachRemaining

      default void forEachRemaining(com.github.tommyettinger.function.DoubleConsumer action)
      Performs the given action for each remaining element until all elements have been processed or the action throws an exception. Actions are performed in the order of iteration, if that order is specified. Exceptions thrown by the action are relayed to the caller.
      Parameters:
      action - The action to be performed for each element
      Throws:
      NullPointerException - if the specified action is null
      "Implementation Requirements"

      The default implementation behaves as if: 

      
     while (hasNext())
         action.accept(nextDouble());

    • next

      default Double next()
      Specified by:
      next in interface Iterator<Double>
      "Implementation Requirements"
      The default implementation boxes the result of calling nextDouble(), and returns that boxed result.