org.jgrapht.DirectedGraph 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.
*/
/* ------------------
* DirectedGraph.java
* ------------------
* (C) Copyright 2003-2008, by Barak Naveh and Contributors.
*
* Original Author: Barak Naveh
* Contributor(s): Christian Hammer
*
* $Id$
*
* Changes
* -------
* 24-Jul-2003 : Initial revision (BN);
* 11-Mar-2004 : Made generic (CH);
* 07-May-2006 : Changed from List to Set (JVS);
*
*/
package org.jgrapht;
import java.util.*;
/**
* A graph whose all edges are directed. This is the root interface of all
* directed graphs.
*
* See
* http://mathworld.wolfram.com/DirectedGraph.html for more on directed
* graphs.
*
* @author Barak Naveh
* @since Jul 14, 2003
*/
public interface DirectedGraph
extends Graph
{
/**
* Returns the "in degree" of the specified vertex. An in degree of a vertex
* in a directed graph is the number of inward directed edges from that
* vertex. See
* http://mathworld.wolfram.com/Indegree.html.
*
* @param vertex vertex whose degree is to be calculated.
*
* @return the degree of the specified vertex.
*/
public int inDegreeOf(V vertex);
/**
* Returns a set of all edges incoming into the specified vertex.
*
* @param vertex the vertex for which the list of incoming edges to be
* returned.
*
* @return a set of all edges incoming into the specified vertex.
*/
public Set incomingEdgesOf(V vertex);
/**
* Returns the "out degree" of the specified vertex. An out degree of a
* vertex in a directed graph is the number of outward directed edges from
* that vertex. See
* http://mathworld.wolfram.com/Outdegree.html.
*
* @param vertex vertex whose degree is to be calculated.
*
* @return the degree of the specified vertex.
*/
public int outDegreeOf(V vertex);
/**
* Returns a set of all edges outgoing from the specified vertex.
*
* @param vertex the vertex for which the list of outgoing edges to be
* returned.
*
* @return a set of all edges outgoing from the specified vertex.
*/
public Set outgoingEdgesOf(V vertex);
}
// End DirectedGraph.java