edu.rice.cs.plt.collect
Class IndexedFunctionalRelation<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.AbstractFunctionalRelation<T1,T2>
                      edu.rice.cs.plt.collect.IndexedFunctionalRelation<T1,T2>

All Implemented Interfaces:

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

public class IndexedFunctionalRelation<T1,T2>
extends AbstractFunctionalRelation<T1,T2>
implements java.io.Serializable

An implementation of the FunctionalRelation interface based on indexing maps.

See Also:

Serialized Form

Nested Class Summary

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

AbstractFunctionalRelation.InverseFunctionalRelation

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

AbstractRelation.InverseRelation

Constructor Summary

IndexedFunctionalRelation()
Index in both directions using HashMaps and HashSets.

IndexedFunctionalRelation(boolean indexSecond)
Index using HashMaps and HashSets.

IndexedFunctionalRelation(Thunk<java.util.Map<T1,T2>> firstIndexFactory)
Create an index based on the given factory.

IndexedFunctionalRelation(Thunk<java.util.Map<T1,T2>> firstIndexFactory, Thunk<java.util.Map<T2,PredicateSet<T1>>> secondIndexFactory, Thunk<java.util.Set<T1>> secondIndexEntryFactory)
Create indices based on the given factories.

Method Summary

boolean	add(T1 first, T2 second) Add Pair.make(first, second) to the set.
void	clear()
LambdaMap<T1,T2>	functionMap() A map view of the relation, mapping firsts to seconds.
boolean	isStatic() true if this iterable is unchanging.
static <T1,T2> IndexedFunctionalRelation<T1,T2>	makeHashBased() Make an IndexedFunctionalRelation indexed by HashMaps and HashSets.
static <T1,T2> IndexedFunctionalRelation<T1,T2>	makeLinkedHashBased() Make an IndexedFunctionalRelation indexed by LinkedHashMaps and LinkedHashSets.
static <T1 extends java.lang.Comparable<? super T1>,T2 extends java.lang.Comparable<? super T2>> IndexedFunctionalRelation<T1,T2>	makeTreeBased() Make an IndexedFunctionalRelation indexed by TreeMaps and TreeSets.
PredicateSet<T1>	matchSecond(T2 second) The set of firsts corresponding to a specific second.
boolean	remove(T1 first, T2 second) Remove Pair.make(first, second) from the set.
PredicateSet<T2>	secondSet() The set of seconds.

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

contains, contains, containsFirst, firstSet, hasFixedSize, inverse, isEmpty, isInfinite, iterator, matchFirst, size, size, value

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

add, containsSecond, excludeFirsts, excludeSeconds, remove

Methods inherited from class java.util.AbstractSet

equals, hashCode, removeAll

Methods inherited from class java.util.AbstractCollection

addAll, containsAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.rice.cs.plt.collect.FunctionalRelation

add

Methods inherited from interface edu.rice.cs.plt.collect.Relation

containsSecond, excludeFirsts, excludeSeconds, remove

Methods inherited from interface java.util.Set

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

Constructor Detail

IndexedFunctionalRelation

public IndexedFunctionalRelation()

Index in both directions using HashMaps and HashSets.

IndexedFunctionalRelation

public IndexedFunctionalRelation(boolean indexSecond)

Index using HashMaps and HashSets. If indexSecond is false, no second-to-first index is created.

IndexedFunctionalRelation

public IndexedFunctionalRelation(Thunk<java.util.Map<T1,T2>> firstIndexFactory,
                                 Thunk<java.util.Map<T2,PredicateSet<T1>>> secondIndexFactory,
                                 Thunk<java.util.Set<T1>> secondIndexEntryFactory)

Create indices based on the given factories.

Parameters:

firstIndexFactory - Maps firsts to seconds.

secondIndexFactory - Maps seconds to sets of firsts.

secondIndexEntryFactory - Produces sets for the second-to-first index.

IndexedFunctionalRelation

public IndexedFunctionalRelation(Thunk<java.util.Map<T1,T2>> firstIndexFactory)

Create an index based on the given factory. No second-to-first index is created.

Parameters:

firstIndexFactory - Maps firsts to seconds.

Method Detail

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 AbstractFunctionalRelation<T1,T2>

functionMap

public LambdaMap<T1,T2> functionMap()

Description copied from interface: FunctionalRelation

A map view of the relation, mapping firsts to seconds. Need not allow mutation, but must reflect subsequent changes.

Specified by:

functionMap in interface FunctionalRelation<T1,T2>

Specified by:

functionMap in class AbstractFunctionalRelation<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 AbstractFunctionalRelation<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 AbstractFunctionalRelation<T1,T2>

add

public boolean add(T1 first,
                   T2 second)

Description copied from interface: Relation

Add Pair.make(first, second) to the set.

Specified by:

add in interface FunctionalRelation<T1,T2>

Specified by:

add in interface Relation<T1,T2>

Overrides:

add in class AbstractRelation<T1,T2>

remove

public boolean remove(T1 first,
                      T2 second)

Description copied from interface: Relation

Remove Pair.make(first, second) from the set.

Specified by:

remove in interface Relation<T1,T2>

Overrides:

remove in class AbstractRelation<T1,T2>

clear

public void clear()

Specified by:

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

Specified by:

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

Overrides:

clear in class java.util.AbstractCollection<Pair<T1,T2>>

makeHashBased

public static <T1,T2> IndexedFunctionalRelation<T1,T2> makeHashBased()

Make an IndexedFunctionalRelation indexed by HashMaps and HashSets.

makeLinkedHashBased

public static <T1,T2> IndexedFunctionalRelation<T1,T2> makeLinkedHashBased()

Make an IndexedFunctionalRelation indexed by LinkedHashMaps and LinkedHashSets.

makeTreeBased

public static <T1 extends java.lang.Comparable<? super T1>,T2 extends java.lang.Comparable<? super T2>> IndexedFunctionalRelation<T1,T2> makeTreeBased()

Make an IndexedFunctionalRelation indexed by TreeMaps and TreeSets.