Package org.plumelib.util

Class MathPlume.MissingNumbersIteratorInt

java.lang.Object
org.plumelib.util.MathPlume.MissingNumbersIteratorInt
All Implemented Interfaces:
Iterator<Integer>
Enclosing class:
MathPlume
static final class MathPlume.MissingNumbersIteratorInt extends Object implements Iterator<Integer>
This iterator returns all the numbers *not* in its argument array (which must be non-empty) but in the argument's range; that is, bigger than its argument's minimum value and smaller than its argument's maximum value. The result contains no duplicates and is in order. If boolean addEnds is set, then the bracketing endpoints are also returned; otherwise, all returned values are between the minimum and maximum of the original values.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    (package private) boolean
    addEnds
    If true, include the value just before the minimum excluded element and the value just after the maximum excluded element.
    (package private) @org.checkerframework.checker.index.qual.IndexFor({"nums"}) int
    currentIndex
    Used only if nums != null, in which case it is an index into nums.
    (package private) int
    currentMissing
    The next element to be returned by the iterator.
    (package private) int
    currentNonmissing
    The current element of the numbers not to include in the iterator.
    (package private) int @MonotonicNonNull @MinLen(1) []
    nums
    The numbers not to include in the iterator.
    (package private) @MonotonicNonNull Iterator<Integer>
    numsItor
    The numbers not to include in the iterator.

  • Constructor Summary

    Constructors
    Constructor
    Description
    MissingNumbersIteratorInt(int @MinLen(1) [] nums, boolean addEnds)
    An iterator over all the numbers not in the argument array, but within its range.
    MissingNumbersIteratorInt(Iterator<Integer> numsItor, boolean addEnds)
    An iterator over all the numbers not in the argument iterator, but within its range.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    hasNext()
     
    Integer
    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

  • Field Details

    • nums

      int @MonotonicNonNull @MinLen(1) [] nums
      The numbers not to include in the iterator.

    • numsItor

      @MonotonicNonNull Iterator<Integer> numsItor
      The numbers not to include in the iterator.

    • currentNonmissing

      int currentNonmissing
      The current element of the numbers not to include in the iterator.

    • currentMissing

      int currentMissing
      The next element to be returned by the iterator.

    • currentIndex

      @org.checkerframework.checker.index.qual.IndexFor({"nums"}) int currentIndex
      Used only if nums != null, in which case it is an index into nums.

    • addEnds

      boolean addEnds
      If true, include the value just before the minimum excluded element and the value just after the maximum excluded element.

  • Constructor Details

    • MissingNumbersIteratorInt

      MissingNumbersIteratorInt(int @MinLen(1) [] nums, boolean addEnds)
      An iterator over all the numbers not in the argument array, but within its range.
      Parameters:
      nums - a non-empty array
      addEnds - if true, include the bracketing endpoints

    • MissingNumbersIteratorInt

      MissingNumbersIteratorInt(Iterator<Integer> numsItor, boolean addEnds)
      An iterator over all the numbers not in the argument iterator, but within its range.
      Parameters:
      numsItor - a non-empty iterator; it must return integers in sorted order
      addEnds - if true, include the bracketing endpoints

  • Method Details

    • hasNext

      public boolean hasNext(@GuardSatisfied MathPlume.MissingNumbersIteratorInt this)
      Specified by:
      hasNext in interface Iterator<Integer>

    • next

      public Integer next(@GuardSatisfied MathPlume.MissingNumbersIteratorInt this)
      Specified by:
      next in interface Iterator<Integer>

    • remove

      public void remove(@GuardSatisfied MathPlume.MissingNumbersIteratorInt this)
      Specified by:
      remove in interface Iterator<Integer>