/*
* Created on Sep 24, 2005
*
* Copyright (c) 2005, The JUNG Authors
*
* All rights reserved.
*
* This software is open-source under the BSD license; see either
* "license.txt" or
* https://github.com/jrtom/jung/blob/master/LICENSE for a description.
*/
package edu.uci.ics.jung.graph.util;
import edu.uci.ics.jung.graph.Graph;
/**
* An interface for a service to access the index of a given edge (in a given graph)
* into the set formed by the given edge and all the other edges it is parallel to.
*
* Note that in current use, this index is assumed to be an integer value in
* the interval [0,n-1], where n-1 is the number of edges parallel to e.
*
* @author Tom Nelson
*
*/
public interface EdgeIndexFunction {
/**
* Returns e's index in graph.
* The index of e is defined as its position in some
* consistent ordering of e and all edges parallel to e.
* @param graph the graph with respect to which the index is calculated
* @param e the edge whose index is to be queried
* @return e's index in graph
*/
int getIndex(Graph graph, E e);
/**
* Resets the indices for edge and its parallel edges in graph.
* Should be invoked when an edge parallel to edge
* has been added or removed.
*
* @param g the graph in which edge's index is to be reset
* @param edge the edge whose index is to be reset
*/
void reset(Graph g, E edge);
/**
* Clears all edge indices for all edges in all graphs.
* Does not recalculate the indices.
*/
void reset();
}
Ads help maintain this website.