edu.ucla.sspace.graph.isomorphism

Class IsomorphicGraphCounter<G extends Graph<? extends Edge>>

java.lang.Object

edu.ucla.sspace.graph.isomorphism.IsomorphicGraphCounter<G>

All Implemented Interfaces:

Counter<G>, Serializable, Iterable<Map.Entry<G,Integer>>

public class IsomorphicGraphCounter<G extends Graph<? extends Edge>>
extends Object
implements Counter<G>, Serializable

A special-purpose Counter that counts graphs based on isomorphism, rather than object equivalence (which may take into account vertex labeling, etc.). Most commonly, isomorphism is needed when counting the number of motifs in a graph and their relative occurrences. This class allows the isomorhism test to be provided by the user, which can enfornce further refinements on isomorphism (such as vertex and ege types).

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IsomorphicGraphCounter() Creates a new IsomorphicGraphCounter with the default IsomorphismTester that tests for structural equivalence.
IsomorphicGraphCounter(Collection<? extends G> motifs) Creates a new IsomorphicGraphCounter that counts only the specified motifs.
IsomorphicGraphCounter(IsomorphismTester isoTest) Creates a new IsomorphicGraphCounter with the specified isomorphism tester.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Counter<? extends G> c) Counts the number of isomorphic graphs in c and includes their sum in this counter.
void	addInitial(G g) Fill in
int	count(G g) Counts the isomorphic version of this graph, increasing the total by 1
int	count(G g, int count) Counts the isomorphic version of this graph, increasing its total count by the specified positive amount.
void	countAll(Collection<? extends G> c) Counts all the elements in the collection.
int	getCount(G g) Returns the count for graphs that are isomorphic to the provided graph.
double	getFrequency(G obj) Returns the frequency of this object relative to the counts of all other objects.
Set<G>	items() Returns a view of the items currently being counted.
Iterator<Map.Entry<G,Integer>>	iterator() Returns an interator over the elements that have been counted thusfar and their respective counts.
G	max() Returns the element that currently has the largest count.
G	min() Returns the element that currently has the smallest count.
void	reset() Resets the counts for all objects.
int	size() Returns the number of unique instances that are currently being counted.
int	sum() Returns the total number of instances that have been counted.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface edu.ucla.sspace.util.Counter

equals, hashCode

Constructor Detail

IsomorphicGraphCounter

public IsomorphicGraphCounter()

Creates a new IsomorphicGraphCounter with the default IsomorphismTester that tests for structural equivalence.

IsomorphicGraphCounter

public IsomorphicGraphCounter(IsomorphismTester isoTest)

Creates a new IsomorphicGraphCounter with the specified isomorphism tester. Most users will not need this constructor, which is intended for special cases where an IsomorphismTester is tailored to quickly match the type of motifs being counted.

IsomorphicGraphCounter

public IsomorphicGraphCounter(Collection<? extends G> motifs)

Creates a new IsomorphicGraphCounter that counts only the specified motifs. All other non-isomorphic graphs will not be counted.

Method Detail

add

public void add(Counter<? extends G> c)

Counts the number of isomorphic graphs in c and includes their sum in this counter.

Specified by:

add in interface Counter<G extends Graph<? extends Edge>>

addInitial

public void addInitial(G g)

Fill in

count

public int count(G g)

Counts the isomorphic version of this graph, increasing the total by 1

Specified by:

count in interface Counter<G extends Graph<? extends Edge>>

count

public int count(G g,
        int count)

Counts the isomorphic version of this graph, increasing its total count by the specified positive amount.

Specified by:

count in interface Counter<G extends Graph<? extends Edge>>

Parameters:

count - a positive value for the number of times the object occurred

Returns:

the current count for the counted object

Throws:

IllegalArgumentException - if count is not a positive value.

countAll

public void countAll(Collection<? extends G> c)

Counts all the elements in the collection.

Specified by:

countAll in interface Counter<G extends Graph<? extends Edge>>

Parameters:

c - a collection of elements to count

getCount

public int getCount(G g)

Returns the count for graphs that are isomorphic to the provided graph.

Specified by:

getCount in interface Counter<G extends Graph<? extends Edge>>

getFrequency

public double getFrequency(G obj)

Returns the frequency of this object relative to the counts of all other objects. This value may also be interpreted as the probability of the instance of obj being seen in the items that have been counted.

Specified by:

getFrequency in interface Counter<G extends Graph<? extends Edge>>

items

public Set<G> items()

Returns a view of the items currently being counted. The returned view is read-only; any attempts to modify this view will throw an UnsupportedOperationException.

Specified by:

items in interface Counter<G extends Graph<? extends Edge>>

iterator

public Iterator<Map.Entry<G,Integer>> iterator()

Returns an interator over the elements that have been counted thusfar and their respective counts.

Specified by:

iterator in interface Counter<G extends Graph<? extends Edge>>

Specified by:

iterator in interface Iterable<Map.Entry<G extends Graph<? extends Edge>,Integer>>

max

public G max()

Returns the element that currently has the largest count. If no objects have been counted, null is returned. Ties in counts are arbitrarily broken.

Specified by:

max in interface Counter<G extends Graph<? extends Edge>>

min

public G min()

Returns the element that currently has the smallest count. If no objects have been counted, null is returned. Ties in counts are arbitrarily broken.

Specified by:

min in interface Counter<G extends Graph<? extends Edge>>

reset

public void reset()

Resets the counts for all objects. The size of Counter.items() will be 0 after this call.

Specified by:

reset in interface Counter<G extends Graph<? extends Edge>>

size

public int size()

Returns the number of unique instances that are currently being counted.

Specified by:

size in interface Counter<G extends Graph<? extends Edge>>

sum

public int sum()

Returns the total number of instances that have been counted.

Specified by:

sum in interface Counter<G extends Graph<? extends Edge>>