edu.rice.cs.plt.collect
Class FilteredRelation<T1,T2>

java.lang.Object
  java.util.AbstractCollection<E>
      java.util.AbstractSet<T>
          edu.rice.cs.plt.collect.AbstractPredicateSet<Pair<T1,T2>>
              edu.rice.cs.plt.collect.AbstractRelation<T1,T2>
                  edu.rice.cs.plt.collect.FilteredRelation<T1,T2>

All Implemented Interfaces:

PredicateSet<Pair<T1,T2>>, Relation<T1,T2>, SizedIterable<Pair<T1,T2>>, Predicate<java.lang.Object>, Predicate2<T1,T2>, Composite, java.io.Serializable, java.lang.Iterable<Pair<T1,T2>>, java.util.Collection<Pair<T1,T2>>, java.util.Set<Pair<T1,T2>>

Direct Known Subclasses:

ComplementRelation, IntersectionRelation

public class FilteredRelation<T1,T2>
extends AbstractRelation<T1,T2>
implements Composite, java.io.Serializable

A relation that contains only those pairs contained by both the given relation and the given predicate. Note that size operations will take linear time.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class edu.rice.cs.plt.collect.AbstractRelation

AbstractRelation.InverseRelation

Field Summary

protected Predicate2<? super T1,? super T2>	_pred
protected Relation<T1,T2>	_rel

Constructor Summary

FilteredRelation(Relation<T1,T2> relation, Predicate2<? super T1,? super T2> predicate)

Method Summary

int	compositeHeight() Get the maximum path length from this node to a leaf.
int	compositeSize() Get the number of nodes in the tree rooted at this node.
boolean	contains(java.lang.Object obj) Test whether the set contains an object.
boolean	contains(T1 first, T2 second) Tests whether the given objects appear as a pair in this relation.
PredicateSet<T1>	firstSet() The set of firsts.
boolean	hasFixedSize() true if this iterable is known to have a fixed size.
boolean	isEmpty() Returns size(1) == 0.
boolean	isInfinite() true if the iterable is known to have infinite size.
boolean	isStatic() true if this iterable is unchanging.
java.util.Iterator<Pair<T1,T2>>	iterator()
PredicateSet<T2>	matchFirst(T1 first) The set of seconds corresponding to a specific first.
PredicateSet<T1>	matchSecond(T2 second) The set of firsts corresponding to a specific second.
PredicateSet<T2>	secondSet() The set of seconds.

Methods inherited from class edu.rice.cs.plt.collect.AbstractRelation

add, add, containsFirst, containsSecond, excludeFirsts, excludeSeconds, inverse, remove, remove

Methods inherited from class edu.rice.cs.plt.collect.AbstractPredicateSet

size, size

Methods inherited from class java.util.AbstractSet

equals, hashCode, removeAll

Methods inherited from class java.util.AbstractCollection

addAll, clear, containsAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Set

addAll, clear, containsAll, equals, hashCode, removeAll, retainAll, size, toArray, toArray

Methods inherited from interface edu.rice.cs.plt.iter.SizedIterable

size, size

Field Detail

_rel

protected final Relation<T1,T2> _rel

_pred

protected final Predicate2<? super T1,? super T2> _pred

Constructor Detail

FilteredRelation

public FilteredRelation(Relation<T1,T2> relation,
                        Predicate2<? super T1,? super T2> predicate)

Method Detail

compositeHeight

public int compositeHeight()

Description copied from interface: Composite

Get the maximum path length from this node to a leaf.

Specified by:

compositeHeight in interface Composite

compositeSize

public int compositeSize()

Description copied from interface: Composite

Get the number of nodes in the tree rooted at this node. Always 1 or greater.

Specified by:

compositeSize in interface Composite

isEmpty

public boolean isEmpty()

Description copied from class: AbstractPredicateSet

Returns size(1) == 0.

Specified by:

isEmpty in interface SizedIterable<Pair<T1,T2>>

Specified by:

isEmpty in interface java.util.Collection<Pair<T1,T2>>

Specified by:

isEmpty in interface java.util.Set<Pair<T1,T2>>

Overrides:

isEmpty in class AbstractPredicateSet<Pair<T1,T2>>

isInfinite

public boolean isInfinite()

Description copied from interface: SizedIterable

true if the iterable is known to have infinite size. If true, an iterator over the iterable in its current state will never return false from hasNext().

Specified by:

isInfinite in interface SizedIterable<Pair<T1,T2>>

Specified by:

isInfinite in class AbstractRelation<T1,T2>

hasFixedSize

public boolean hasFixedSize()

Description copied from interface: SizedIterable

true if this iterable is known to have a fixed size. This is the case if the iterable is immutable, or if changes can only replace values, not remove or add them. An infinite iterable may be fixed if it is guaranteed to never become finite.

Specified by:

hasFixedSize in interface SizedIterable<Pair<T1,T2>>

Specified by:

hasFixedSize in class AbstractRelation<T1,T2>

isStatic

public boolean isStatic()

Description copied from interface: SizedIterable

true if this iterable is unchanging. This implies that hasFixedSize() is true, and that iterator() will always return the same (either == or equal() and immutable) elements in the same order. ("Immutable" here means that equals() invocations are consistent over time -- if two objects are equal, they will never become inequal, and vice versa.)

Specified by:

isStatic in interface SizedIterable<Pair<T1,T2>>

Specified by:

isStatic in class AbstractRelation<T1,T2>

contains

public boolean contains(T1 first,
                        T2 second)

Description copied from class: AbstractRelation

Tests whether the given objects appear as a pair in this relation. Not guaranteed to have types T1 and T2 because the Collection.contains(java.lang.Object) method allows arbitrary objects.

Specified by:

contains in interface Relation<T1,T2>

Specified by:

contains in interface Predicate2<T1,T2>

Specified by:

contains in class AbstractRelation<T1,T2>

contains

public boolean contains(java.lang.Object obj)

Description copied from class: AbstractPredicateSet

Test whether the set contains an object. Overridden here to force subclasses to provide an implementation. The default implementation (AbstractCollection.contains(java.lang.Object)) is a linear search, which is almost always unreasonable for a set.

Specified by:

contains in interface Relation<T1,T2>

Specified by:

contains in interface Predicate<java.lang.Object>

Specified by:

contains in interface java.util.Collection<Pair<T1,T2>>

Specified by:

contains in interface java.util.Set<Pair<T1,T2>>

Specified by:

contains in class AbstractRelation<T1,T2>

iterator

public java.util.Iterator<Pair<T1,T2>> iterator()

Specified by:

iterator in interface java.lang.Iterable<Pair<T1,T2>>

Specified by:

iterator in interface java.util.Collection<Pair<T1,T2>>

Specified by:

iterator in interface java.util.Set<Pair<T1,T2>>

Specified by:

iterator in class AbstractRelation<T1,T2>

firstSet

public PredicateSet<T1> firstSet()

Description copied from interface: Relation

The set of firsts. Need not allow mutation, but must reflect subsequent changes.

Specified by:

firstSet in interface Relation<T1,T2>

Specified by:

firstSet in class AbstractRelation<T1,T2>

matchFirst

public PredicateSet<T2> matchFirst(T1 first)

Description copied from interface: Relation

The set of seconds corresponding to a specific first. Need not allow mutation, but must reflect subsequent changes.

Specified by:

matchFirst in interface Relation<T1,T2>

Specified by:

matchFirst in class AbstractRelation<T1,T2>

secondSet

public PredicateSet<T2> secondSet()

Description copied from interface: Relation

The set of seconds. Need not allow mutation, but must reflect subsequent changes.

Specified by:

secondSet in interface Relation<T1,T2>

Specified by:

secondSet in class AbstractRelation<T1,T2>

matchSecond

public PredicateSet<T1> matchSecond(T2 second)

Description copied from interface: Relation

The set of firsts corresponding to a specific second. Need not allow mutation, but must reflect subsequent changes.

Specified by:

matchSecond in interface Relation<T1,T2>

Specified by:

matchSecond in class AbstractRelation<T1,T2>