org.jgrapht.GraphMapping Maven / Gradle / Ivy

/* ==========================================
 * JGraphT : a free Java graph-theory library
 * ==========================================
 *
 * Project Info:  http://jgrapht.sourceforge.net/
 * Project Creator:  Barak Naveh (http://sourceforge.net/users/barak_naveh)
 *
 * (C) Copyright 2003-2008, by Barak Naveh and Contributors.
 *
 * This program and the accompanying materials are dual-licensed under
 * either
 *
 * (a) the terms of the GNU Lesser General Public License version 2.1
 * as published by the Free Software Foundation, or (at your option) any
 * later version.
 *
 * or (per the licensee's choosing)
 *
 * (b) the terms of the Eclipse Public License v1.0 as published by
 * the Eclipse Foundation.
 */
/* -----------------
 * GraphMapping.java
 * -----------------
 * (C) Copyright 2005-2008, by Assaf Lehr and Contributors.
 *
 * Original Author:  Assaf Lehr
 * Contributor(s):   John V. Sichi
 *
 * Changes
 * -------
 */
package org.jgrapht;

/**
 * GraphMapping represents a bidirectional mapping between two graphs (called
 * graph1 and graph2), which allows the caller to obtain the matching vertex or
 * edge in either direction, from graph1 to graph2, or from graph2 to graph1. It
 * does not have to always be a complete bidirectional mapping (it could return
 * null for some lookups).
 *
 * @author Assaf Lehr
 * @since Jul 30, 2005
 */
public interface GraphMapping
{
    

    /**
     * Gets the mapped value where the key is vertex
     *
     * @param vertex vertex in one of the graphs
     * @param forward if true, uses mapping from graph1 to graph2; if false, use
     * mapping from graph2 to graph1
     *
     * @return corresponding vertex in other graph, or null if none
     */
    public V getVertexCorrespondence(V vertex, boolean forward);

    /**
     * Gets the mapped value where the key is edge
     *
     * @param edge edge in one of the graphs
     * @param forward if true, uses mapping from graph1 to graph2; if false, use
     * mapping from graph2 to graph1
     *
     * @return corresponding edge in other graph, or null if none
     */
    public E getEdgeCorrespondence(E edge, boolean forward);
}

// End GraphMapping.java