ZipIter3 (Parallel Template Library (PTL)™ 4.0)

java.lang.Object
- Progeneric.Ptl.Iterators.ZipIter3<T1,TIterator1,T2,TIterator2,T3,TIterator3>

Type Parameters:
T1 - The type of the first sequence of objects.
TIterator1 - The type of the first iterator.
T2 - The type of the second sequence of objects.
TIterator2 - The type of the second iterator.
T3 - The type of the third sequence of objects.
TIterator3 - The type of the third iterator.

All Implemented Interfaces:

IBaseIter<ZipIter3<T1,TIterator1,T2,TIterator2,T3,TIterator3>>, IDisposable, IInpIter<Tuple3<T1,T2,T3>,ZipIter3<T1,TIterator1,T2,TIterator2,T3,TIterator3>>, IEquatable<ZipIter3<T1,TIterator1,T2,TIterator2,T3,TIterator3>>
```
public class ZipIter3<T1,TIterator1 extends IInpIter<T1,TIterator1>,T2,TIterator2 extends IInpIter<T2,TIterator2>,T3,TIterator3 extends IInpIter<T3,TIterator3>>
extends java.lang.Object
implements IInpIter<Tuple3<T1,T2,T3>,ZipIter3<T1,TIterator1,T2,TIterator2,T3,TIterator3>>
```
Defines an iterator adaptor over tuples of the elements at corresponding positions of heterogeneous underlying iterators. Moving the zip iterator moves all of the iterators in parallel. Dereferencing the zip iterator returns a tuple that contains the results of dereferencing the individual iterators.

Constructor Summary

Constructors
Constructor and Description
`ZipIter3(TIterator1 first1, TIterator2 first2, TIterator3 first3)` Constructs a zip iterator from the specified objects.
`ZipIter3(ZipIter3<T1,TIterator1,T2,TIterator2,T3,TIterator3> 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.
`ZipIter3<T1,TIterator1,T2,TIterator2,T3,TIterator3>`	`Copy()` Creates and returns a copy of the current instance.
`Tuple3<T1,T2,T3>`	`Current()` Returns a tuple of the current values.
`void`	`Dispose()` Performs application-defined tasks associated with freeing, releasing, or resetting system resources or other cleanup.
`long`	`Distance(ZipIter3<T1,TIterator1,T2,TIterator2,T3,TIterator3> 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(ZipIter3<T1,TIterator1,T2,TIterator2,T3,TIterator3> other)` Tests whether this instance is equal to a specified object.
`int`	`hashCode()` Returns the hash code for this instance.
`void`	`Increment()` Increments all underlying iterators.
`void`	`ResetBegin()` Sets all underlying iterators to their initial position, which is before the first element in the container.
`void`	`ResetEnd()` Sets all underlying iterators to their 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
  - ZipIter3
```
public ZipIter3(TIterator1 first1,
        TIterator2 first2,
        TIterator3 first3)
```
    Constructs a zip iterator from the specified objects.
    
    Parameters:
    first1 - An input iterator addressing the position of the first element in the first range.
    first2 - An input iterator addressing the position of the first element in the second range.
    first3 - An input iterator addressing the position of the first element in the third range.
  - ZipIter3
```
public ZipIter3(ZipIter3<T1,TIterator1,T2,TIterator2,T3,TIterator3> 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<ZipIter3<T1,TIterator1 extends IInpIter<T1,TIterator1>,T2,TIterator2 extends IInpIter<T2,TIterator2>,T3,TIterator3 extends IInpIter<T3,TIterator3>>>
    
    Returns:
    The iterator category.
  - Copy
```
public ZipIter3<T1,TIterator1,T2,TIterator2,T3,TIterator3> Copy()
```
    Creates and returns a copy of the current instance.
    
    Specified by:
    
    Copy in interface IBaseIter<ZipIter3<T1,TIterator1 extends IInpIter<T1,TIterator1>,T2,TIterator2 extends IInpIter<T2,TIterator2>,T3,TIterator3 extends IInpIter<T3,TIterator3>>>
    
    Returns:
    A copy of the current instance.
  - Current
```
public Tuple3<T1,T2,T3> Current()
```
    Returns a tuple of the current values.
    
    Specified by:
    
    Current in interface IInpIter<Tuple3<T1,T2,T3>,ZipIter3<T1,TIterator1 extends IInpIter<T1,TIterator1>,T2,TIterator2 extends IInpIter<T2,TIterator2>,T3,TIterator3 extends IInpIter<T3,TIterator3>>>
    
    Returns:
    A tuple of the current values.
  - ResetBegin
```
public void ResetBegin()
```
    Sets all underlying iterators to their 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<ZipIter3<T1,TIterator1 extends IInpIter<T1,TIterator1>,T2,TIterator2 extends IInpIter<T2,TIterator2>,T3,TIterator3 extends IInpIter<T3,TIterator3>>>
  - ResetEnd
```
public void ResetEnd()
```
    Sets all underlying iterators to their 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<ZipIter3<T1,TIterator1 extends IInpIter<T1,TIterator1>,T2,TIterator2 extends IInpIter<T2,TIterator2>,T3,TIterator3 extends IInpIter<T3,TIterator3>>>
  - Increment
```
public void Increment()
```
    Increments all underlying iterators.
    
    Specified by:
    
    Increment in interface IBaseIter<ZipIter3<T1,TIterator1 extends IInpIter<T1,TIterator1>,T2,TIterator2 extends IInpIter<T2,TIterator2>,T3,TIterator3 extends IInpIter<T3,TIterator3>>>
  - 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<ZipIter3<T1,TIterator1 extends IInpIter<T1,TIterator1>,T2,TIterator2 extends IInpIter<T2,TIterator2>,T3,TIterator3 extends IInpIter<T3,TIterator3>>>
    
    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<ZipIter3<T1,TIterator1 extends IInpIter<T1,TIterator1>,T2,TIterator2 extends IInpIter<T2,TIterator2>,T3,TIterator3 extends IInpIter<T3,TIterator3>>>
    
    Parameters:
    offset - The number of positions the iterator is to be offset.
  - Distance
```
public long Distance(ZipIter3<T1,TIterator1,T2,TIterator2,T3,TIterator3> other)
```
    Determines the number of increments between this instance and a specified iterator.
    
    Specified by:
    
    Distance in interface IBaseIter<ZipIter3<T1,TIterator1 extends IInpIter<T1,TIterator1>,T2,TIterator2 extends IInpIter<T2,TIterator2>,T3,TIterator3 extends IInpIter<T3,TIterator3>>>
    
    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 ZipIter 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(ZipIter3<T1,TIterator1,T2,TIterator2,T3,TIterator3> other)
```
    Tests whether this instance is equal to a specified object.
    
    Specified by:
    
    Equals in interface IEquatable<ZipIter3<T1,TIterator1 extends IInpIter<T1,TIterator1>,T2,TIterator2 extends IInpIter<T2,TIterator2>,T3,TIterator3 extends IInpIter<T3,TIterator3>>>
    
    Parameters:
    other - An object to compare with this instance.
    
    Returns:
    True if other equals the value of this instance; otherwise, false.

Class ZipIter3<T1,TIterator1 extends IInpIter<T1,TIterator1>,T2,TIterator2 extends IInpIter<T2,TIterator2>,T3,TIterator3 extends IInpIter<T3,TIterator3>>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ZipIter3

ZipIter3

Method Detail

Dispose

Category

Copy

Current

ResetBegin

ResetEnd

Increment

Advance

Advance

Distance

equals

hashCode

Equals