FilterIter (Parallel Template Library (PTL)™ 4.0)

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

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

All Implemented Interfaces:

IBaseIter<FilterIter<T,TIterator>>, IDisposable, IInpIter<T,FilterIter<T,TIterator>>, IEquatable<FilterIter<T,TIterator>>
```
public class FilterIter<T,TIterator extends IInpIter<T,TIterator>>
extends java.lang.Object
implements IInpIter<T,FilterIter<T,TIterator>>
```
The filter iterator adaptor creates a view of an iterator range in which some elements of the range are skipped. A predicate function object controls which elements are skipped. When skipping over elements, it is necessary for the filter adaptor to know when to stop in order to avoid going past the end of the underlying range. A filter iterator is therefore constructed with a pair of iterators indicating the range of elements in the unfiltered sequence to be traversed.

Constructor Summary

Constructors
Constructor and Description
`FilterIter(FilterIter<T,TIterator> iter)` Constructs a new instance from another iterator.
`FilterIter(TIterator first, TIterator last, IFunc1Arg<T,java.lang.Boolean> pred)` Constructs a filter iterator where first is either the first position in the range [first, last) such that pred(first.Current) == true or else first == last.

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.
`FilterIter<T,TIterator>`	`Copy()` Creates and returns a copy of the current instance.
`T`	`Current()` Returns the filtered value of the underlying iterator.
`void`	`Dispose()` Performs application-defined tasks associated with freeing, releasing, or resetting system resources or other cleanup.
`long`	`Distance(FilterIter<T,TIterator> other)` Determines the number of increments between this instance and a specified iterator.
`boolean`	`Equals(FilterIter<T,TIterator> 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()` Continues to increments the iterator until it is either equal to last or pred(Current) == true.
`void`	`ResetBegin()` Used to implement the IInpIter ResetBegin method.
`void`	`ResetEnd()` Used to implement the IInpIter ResetEnd method.

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

- Constructor Detail
  - FilterIter
```
public FilterIter(TIterator first,
          TIterator last,
          IFunc1Arg<T,java.lang.Boolean> pred)
```
    Constructs a filter iterator where first is either the first position in the range [first, last) such that pred(first.Current) == true or else first == last.
    
    Parameters:
    first - An input iterator addressing the position of the first element in the range to be filtered.
    last - An input iterator addressing the position one past the final element in the range to be filtered.
    pred - The specified predicate.
  - FilterIter
```
public FilterIter(FilterIter<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<FilterIter<T,TIterator extends IInpIter<T,TIterator>>>
    
    Returns:
    The iterator category.
  - Copy
```
public FilterIter<T,TIterator> Copy()
```
    Creates and returns a copy of the current instance.
    
    Specified by:
    
    Copy in interface IBaseIter<FilterIter<T,TIterator extends IInpIter<T,TIterator>>>
    
    Returns:
    A copy of the current instance.
  - Current
```
public T Current()
```
    Returns the filtered value of the underlying iterator.
    
    Specified by:
    
    Current in interface IInpIter<T,FilterIter<T,TIterator extends IInpIter<T,TIterator>>>
    
    Returns:
    The filtered value of the underlying iterator.
  - ResetBegin
```
public void ResetBegin()
```
    Used to implement the IInpIter ResetBegin method. This operation has no effect on the current instance.
    
    Specified by:
    
    ResetBegin in interface IBaseIter<FilterIter<T,TIterator extends IInpIter<T,TIterator>>>
  - ResetEnd
```
public void ResetEnd()
```
    Used to implement the IInpIter ResetEnd method. This operation has no effect on the current instance.
    
    Specified by:
    
    ResetEnd in interface IBaseIter<FilterIter<T,TIterator extends IInpIter<T,TIterator>>>
  - Increment
```
public void Increment()
```
    Continues to increments the iterator until it is either equal to last or pred(Current) == true.
    
    Specified by:
    
    Increment in interface IBaseIter<FilterIter<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<FilterIter<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<FilterIter<T,TIterator extends IInpIter<T,TIterator>>>
    
    Parameters:
    offset - The number of positions the iterator is to be offset.
  - Distance
```
public long Distance(FilterIter<T,TIterator> other)
```
    Determines the number of increments between this instance and a specified iterator.
    
    Specified by:
    
    Distance in interface IBaseIter<FilterIter<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 FilterIter 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(FilterIter<T,TIterator> other)
```
    Tests whether this instance is equal to a specified object.
    
    Specified by:
    
    Equals in interface IEquatable<FilterIter<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 FilterIter<T,TIterator extends IInpIter<T,TIterator>>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FilterIter

FilterIter

Method Detail

Dispose

Category

Copy

Current

ResetBegin

ResetEnd

Increment

Advance

Advance

Distance

equals

hashCode

Equals