TransformIter (Parallel Template Library (PTL)™ 4.0)

java.lang.Object
- Progeneric.Ptl.Iterators.TransformIter<T,TIterator>

Type Parameters:
T - The type of objects to iterate.
TIterator - The type of iterator that is transformed.

All Implemented Interfaces:

IBaseIter<TransformIter<T,TIterator>>, IDisposable, IInpIter<T,TransformIter<T,TIterator>>, IEquatable<TransformIter<T,TIterator>>
```
public class TransformIter<T,TIterator extends IInpIter<T,TIterator>>
extends java.lang.Object
implements IInpIter<T,TransformIter<T,TIterator>>
```
Defines an iterator over elements which are the result of applying some functional transformation to the elements of an underlying sequence.

Constructor Summary

Constructors
Constructor and Description
`TransformIter(TIterator iter, IFunc1Arg<T,T> func)` Constructs a transform iterator from an input iterator and the specified unary function object.
`TransformIter(TransformIter<T,TIterator> iter)` Constructs a new instance from another iterator.

Method Summary

Methods
Modifier and Type	Method and Description
`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.
`TransformIter<T,TIterator>`	`Copy()` Creates and returns a copy of the current instance.
`T`	`Current()` Returns the transformed value of the underlying iterator.
`void`	`Dispose()` Performs application-defined tasks associated with freeing, releasing, or resetting system resources or other cleanup.
`long`	`Distance(TransformIter<T,TIterator> other)` Determines the number of increments between this instance and a specified iterator.
`boolean`	`equals(java.lang.Object obj)` Tests whether this instance is equal to a specified object.
`boolean`	`Equals(TransformIter<T,TIterator> other)` Tests whether this instance is equal to a specified object.
`int`	`hashCode()` Returns the hash code for this instance.
`void`	`Increment()` Increments the iterator.
`void`	`ResetBegin()` Sets the iterator to its initial position, which is before the first element in the container.
`void`	`ResetEnd()` Sets the iterator to its final position, which is after the last element in the container.

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

- Constructor Detail
  - TransformIter
```
public TransformIter(TIterator iter,
             IFunc1Arg<T,T> func)
```
    Constructs a transform iterator from an input iterator and the specified unary function object.
    
    Parameters:
    iter - The specified iterator that is transformed.
    func - The unary function object.
  - TransformIter
```
public TransformIter(TransformIter<T,TIterator> iter)
```
    Constructs a new instance from another iterator.
    
    Parameters:
    iter - 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<TransformIter<T,TIterator extends IInpIter<T,TIterator>>>
    
    Returns:
    The iterator category.
  - Copy
```
public TransformIter<T,TIterator> Copy()
```
    Creates and returns a copy of the current instance.
    
    Specified by:
    
    Copy in interface IBaseIter<TransformIter<T,TIterator extends IInpIter<T,TIterator>>>
    
    Returns:
    A copy of the current instance.
  - Current
```
public T Current()
```
    Returns the transformed value of the underlying iterator.
    
    Specified by:
    
    Current in interface IInpIter<T,TransformIter<T,TIterator extends IInpIter<T,TIterator>>>
    
    Returns:
    The tranformed value of the underlying iterator.
  - ResetBegin
```
public void ResetBegin()
```
    Sets the iterator to its initial position, which is before the first element in the container.
    Remarks: At this position, Current is undefined. Therefore, you must call Increment to advance the iterator to the first element of the container before reading the value of Current.
    
    Specified by:
    
    ResetBegin in interface IBaseIter<TransformIter<T,TIterator extends IInpIter<T,TIterator>>>
  - ResetEnd
```
public void ResetEnd()
```
    Sets the iterator to its final position, which is after the last element in the container.
    Remarks: At this position, Current is undefined. Therefore, you must call Decrement to advance the iterator to the last element of the container before reading the value of Current.
    
    Specified by:
    
    ResetEnd in interface IBaseIter<TransformIter<T,TIterator extends IInpIter<T,TIterator>>>
  - Increment
```
public void Increment()
```
    Increments the iterator.
    
    Specified by:
    
    Increment in interface IBaseIter<TransformIter<T,TIterator extends IInpIter<T,TIterator>>>
  - Advance
```
public void Advance(int offset)
```
    Adds an offset to an iterator. It is equivalent to executing Increment (offset is positive) offset times.
    
    Specified by:
    
    Advance in interface IBaseIter<TransformIter<T,TIterator extends IInpIter<T,TIterator>>>
    
    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) offset times.
    
    Specified by:
    
    Advance in interface IBaseIter<TransformIter<T,TIterator extends IInpIter<T,TIterator>>>
    
    Parameters:
    offset - The number of positions the iterator is to be offset.
  - Distance
```
public long Distance(TransformIter<T,TIterator> other)
```
    Determines the number of increments between this instance and a specified iterator.
    
    Specified by:
    
    Distance in interface IBaseIter<TransformIter<T,TIterator extends IInpIter<T,TIterator>>>
    
    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.
    
    Throws:
    
    InvalidOperationException - Thrown when the argument iterator is invalid, or it is not reachable from the current instance.
  - 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 TransformIter 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(TransformIter<T,TIterator> other)
```
    Tests whether this instance is equal to a specified object.
    
    Specified by:
    
    Equals in interface IEquatable<TransformIter<T,TIterator extends IInpIter<T,TIterator>>>
    
    Parameters:
    other - An object to compare with this instance.
    
    Returns:
    True if other equals the value of this instance; otherwise, false.

Class TransformIter<T,TIterator extends IInpIter<T,TIterator>>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TransformIter

TransformIter

Method Detail

Dispose

Category

Copy

Current

ResetBegin

ResetEnd

Increment

Advance

Advance

Distance

equals

hashCode

Equals