Package org.jungrapht.visualization.util

Class ParallelEdgeIndexFunction<V,E>

java.lang.Object

org.jungrapht.visualization.util.ParallelEdgeIndexFunction<V,E>

All Implemented Interfaces:

BiFunction<org.jgrapht.Graph<V,E>,E,Integer>, EdgeIndexFunction<V,E>

Direct Known Subclasses:

PredicatedParallelEdgeIndexFunction

public class ParallelEdgeIndexFunction<V,E>
extends Object
implements EdgeIndexFunction<V,E>

A class which creates and maintains indices for parallel edges. Parallel edges are defined here to be the collection of edges that are returned by graph.edgesConnecting(v, w) for some v and w.

At this time, users are responsible for resetting the indices (by calling reset() ) if changes to the graph make it appropriate.

Author:

Joshua O'Madadhain, Tom Nelson

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<E,Integer>	edgeIndex

Constructor Summary

Constructors

Constructor	Description
ParallelEdgeIndexFunction()

Method Summary

Modifier and Type	Method	Description
Integer	apply(org.jgrapht.Graph<V,E> graph, E edge)	The index of e is defined as its position in some consistent ordering of e and all edges parallel to e.
void	reset()	Clears all edge indices for all edges.
void	reset(org.jgrapht.Graph<V,E> graph, E edge)	Resets the indices for edge and its parallel edges.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.BiFunction

andThen

Field Detail

edgeIndex

protected Map<E,Integer> edgeIndex

Constructor Detail

ParallelEdgeIndexFunction

public ParallelEdgeIndexFunction()

Method Detail

apply

public Integer apply(org.jgrapht.Graph<V,E> graph,
                     E edge)

Description copied from interface: EdgeIndexFunction

The index of e is defined as its position in some consistent ordering of e and all edges parallel to e.

Specified by:

apply in interface BiFunction<org.jgrapht.Graph<V,E>,E,Integer>

Specified by:

apply in interface EdgeIndexFunction<V,E>

Parameters:

graph - the graph and the edge whose index is to be queried

edge - the edge

Returns:

edge's index in this instance's Graph.

reset

public void reset(org.jgrapht.Graph<V,E> graph,
                  E edge)

Description copied from interface: EdgeIndexFunction

Resets the indices for edge and its parallel edges. Should be invoked when an edge parallel to edge has been added or removed.

Specified by:

reset in interface EdgeIndexFunction<V,E>

Parameters:

graph - the graph and the edge whose index is to be reset

reset

public void reset()

Description copied from interface: EdgeIndexFunction

Clears all edge indices for all edges. Does not recalculate the indices.

Specified by:

reset in interface EdgeIndexFunction<V,E>