CountingIter (Parallel Template Library (PTL)™ 4.0)

java.lang.Object
- Progeneric.Ptl.Iterators.CountingIter<T>

Type Parameters:
T - The type of objects to iterate.

All Implemented Interfaces:

java.lang.Comparable<CountingIter<T>>, IBaseIter<CountingIter<T>>, IBidIter<T,CountingIter<T>>, IDisposable, IFwdIter<T,CountingIter<T>>, IInpIter<T,CountingIter<T>>, IOutIter<T,CountingIter<T>>, IRanIter<T,CountingIter<T>>, IEquatable<CountingIter<T>>
```
public class CountingIter<T>
extends java.lang.Object
implements IRanIter<T,CountingIter<T>>
```
Defines an iterator adaptor over a "lazy sequence" of consecutive values.

Constructor Summary

Constructors
Constructor and Description
`CountingIter(CountingIter<T> x)` Constructs a new instance from another iterator.
`CountingIter(T start)` Constructs a counting iterator that returns consecutive values on-the-fly whenever it is accessed.
`CountingIter(T start, T step)` Constructs a counting iterator that returns consecutive values on-the-fly whenever it is accessed.

Method Summary

Methods
Modifier and Type	Method and Description
`CountingIter<T>`	`Add(long offset)` Adds the current iterator and an offset.
`void`	`Advance(int offset)` Adds an offset to an iterator.
`void`	`Advance(long offset)` Adds an offset to an iterator.
`IteratorCategory`	`Category()` Gets the iterator category.
`int`	`compareTo(CountingIter<T> other)` Compares this instance to a specified iterator and returns an indication of their relative values.
`CountingIter<T>`	`Copy()` Creates and returns a copy of the current instance.
`T`	`Current()` Returns the current value of the iterator.
`void`	`Decrement()` Decrements the iterator.
`long`	`Difference(CountingIter<T> other)` Subtracts a specified iterator from the current one.
`void`	`Dispose()` Performs application-defined tasks associated with freeing, releasing, or resetting system resources or other cleanup.
`long`	`Distance(CountingIter<T> other)` Determines the number of increments between this instance and a specified iterator.
`boolean`	`Equals(CountingIter<T> other)` Tests whether this instance is equal to a specified object.
`boolean`	`equals(java.lang.Object obj)` Tests whether this instance is equal to a specified object.
`int`	`hashCode()` Returns the hash code for this instance.
`void`	`Increment()` Increments the iterator.
`long`	`Index()` Gets the zero-based position of the element in the array that is located by the current iterator.
`CountingIter<T>`	`Next()` Returns the next iterator.
`CountingIter<T>`	`Previous()` Returns the previous iterator.
`void`	`ResetBegin()` Used to implement the IOutIter ResetBegin method.
`void`	`ResetEnd()` Used to implement the IOutIter ResetEnd method.
`void`	`SetCurrent(T value)` Returns an exception because the iterator is not mutable.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CountingIter
```
public CountingIter(T start)
```
    Constructs a counting iterator that returns consecutive values on-the-fly whenever it is accessed.
    
    Parameters:
    start - The initial value to be incremented.
  - CountingIter
```
public CountingIter(T start,
            T step)
```
    Constructs a counting iterator that returns consecutive values on-the-fly whenever it is accessed.
    
    Parameters:
    start - The initial value to be incremented.
    step - The step that increments the current value.
  - CountingIter
```
public CountingIter(CountingIter<T> x)
```
    Constructs a new instance from another iterator.
    
    Parameters:
    x - The iterator to copy.
- Method Detail
  - Dispose
```
public void Dispose()
```
    Performs application-defined tasks associated with freeing, releasing, or resetting system resources or other cleanup.
    
    Specified by:
    
    Dispose in interface IDisposable
  - Category
```
public IteratorCategory Category()
```
    Gets the iterator category.
    
    Specified by:
    
    Category in interface IBaseIter<CountingIter<T>>
    
    Returns:
    The iterator category.
  - Copy
```
public CountingIter<T> Copy()
```
    Creates and returns a copy of the current instance.
    
    Specified by:
    
    Copy in interface IBaseIter<CountingIter<T>>
    
    Returns:
    A copy of the current instance.
  - Current
```
public T Current()
```
    Returns the current value of the iterator.
    
    Specified by:
    
    Current in interface IInpIter<T,CountingIter<T>>
    
    Returns:
    The current value of the iterator.
  - SetCurrent
```
public void SetCurrent(T value)
```
    Returns an exception because the iterator is not mutable.
    
    Specified by:
    
    SetCurrent in interface IOutIter<T,CountingIter<T>>
    
    Parameters:
    value - The new value for the current element.
    
    Throws:
    
    java.lang.RuntimeException - Thrown because the iterator is not mutable.
  - ResetBegin
```
public void ResetBegin()
```
    Used to implement the IOutIter ResetBegin method. This operation has no effect on the current instance.
    
    Specified by:
    
    ResetBegin in interface IBaseIter<CountingIter<T>>
  - ResetEnd
```
public void ResetEnd()
```
    Used to implement the IOutIter ResetEnd method. This operation has no effect on the current instance.
    
    Specified by:
    
    ResetEnd in interface IBaseIter<CountingIter<T>>
  - Increment
```
public void Increment()
```
    Increments the iterator.
    
    Specified by:
    
    Increment in interface IBaseIter<CountingIter<T>>
  - Decrement
```
public void Decrement()
```
    Decrements the iterator.
    
    Specified by:
    
    Decrement in interface IBidIter<T,CountingIter<T>>
  - Next
```
public CountingIter<T> Next()
```
    Returns the next iterator.
    
    Returns:
    The next iterator.
  - Previous
```
public CountingIter<T> Previous()
```
    Returns the previous iterator.
    
    Returns:
    The previous iterator.
  - Advance
```
public void Advance(int offset)
```
    Adds an offset to an iterator. It is equivalent to executing Increment (offset is positive) or Decrement (offset is negative) offset times.
    
    Specified by:
    
    Advance in interface IBaseIter<CountingIter<T>>
    
    Parameters:
    offset - The number of positions the iterator is to be offset.
  - Advance
```
public void Advance(long offset)
```
    Adds an offset to an iterator. It is equivalent to executing Increment (offset is positive) or Decrement (offset is negative) offset times.
    
    Specified by:
    
    Advance in interface IBaseIter<CountingIter<T>>
    
    Parameters:
    offset - The number of positions the iterator is to be offset.
  - Distance
```
public long Distance(CountingIter<T> other)
```
    Determines the number of increments between this instance and a specified iterator.
    
    Specified by:
    
    Distance in interface IBaseIter<CountingIter<T>>
    
    Parameters:
    other - An iterator addressing the position one past the final element in the range [this, other).
    
    Returns:
    The number of times that the current iterator must be incremented until it is equal to the specified iterator.
  - Add
```
public CountingIter<T> Add(long offset)
```
    Adds the current iterator and an offset.
    
    Specified by:
    
    Add in interface IRanIter<T,CountingIter<T>>
    
    Parameters:
    offset - The number of positions added to the current iterator.
    
    Returns:
    Returns a valid iterator addressing the element at the current iterator plus an offset.
  - Difference
```
public long Difference(CountingIter<T> other)
```
    Subtracts a specified iterator from the current one.
    
    Specified by:
    
    Difference in interface IRanIter<T,CountingIter<T>>
    
    Parameters:
    other - An iterator that is to be subtracted from the current one.
    
    Returns:
    The difference between the current iterator and a specified iterator.
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Tests whether this instance is equal to a specified object.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    obj - An object to compare with this instance.
    
    Returns:
    True if obj is an instance of CountingIter and equals the value of this instance; otherwise, false.
  - hashCode
```
public int hashCode()
```
    Returns the hash code for this instance.
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    A 32-bit signed integer hash code.
  - Equals
```
public boolean Equals(CountingIter<T> other)
```
    Tests whether this instance is equal to a specified object.
    
    Specified by:
    
    Equals in interface IEquatable<CountingIter<T>>
    
    Parameters:
    other - An object to compare with this instance.
    
    Returns:
    True if other equals the value of this instance; otherwise, false.
  - compareTo
```
public int compareTo(CountingIter<T> other)
```
    Compares this instance to a specified iterator and returns an indication of their relative values.
    
    Specified by:
    
    compareTo in interface java.lang.Comparable<CountingIter<T>>
    
    Parameters:
    other - An iterator to compare.
    
    Returns:
    
    Less than zero This instance is less than other.
    
    Zero This instance is equal to other.
    
    Greater than zero This instance is greater than other.
  - Index
```
public long Index()
```
    Gets the zero-based position of the element in the array that is located by the current iterator.
    
    Returns:
    The zero-based position of the element in the array that is located by the current iterator.

Less than zero	This instance is less than other.
Zero	This instance is equal to other.
Greater than zero	This instance is greater than other.

Class CountingIter<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CountingIter

CountingIter

CountingIter

Method Detail

Dispose

Category

Copy

Current

SetCurrent

ResetBegin

ResetEnd

Increment

Decrement

Next

Previous

Advance

Advance

Distance

Add

Difference

equals

hashCode

Equals

compareTo

Index