org.jscience.computing.graph
Interface DirectedGraph

All Superinterfaces:
Graph
All Known Implementing Classes:
DefaultDirectedGraph, DefaultDirectedWeightedGraph, DirectedMultigraph, DirectedSubgraph, DirectedWeightedMultigraph, DirectedWeightedSubgraph, ListenableDirectedGraph, ListenableDirectedWeightedGraph, SemanticNetwork, SimpleDirectedGraph, SimpleDirectedWeightedGraph, UnmodifiableDirectedGraph

public interface DirectedGraph
extends Graph

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.

Since:
Jul 14, 2003

Method Summary
 java.util.List incomingEdgesOf(java.lang.Object vertex)
          Returns a list of all edges incoming into the specified vertex.
 int inDegreeOf(java.lang.Object vertex)
          Returns the "in degree" of the specified vertex.
 int outDegreeOf(java.lang.Object vertex)
          Returns the "out degree" of the specified vertex.
 java.util.List outgoingEdgesOf(java.lang.Object vertex)
          Returns a list of all edges outgoing from the specified vertex.
 
Methods inherited from interface org.jscience.computing.graph.Graph
addAllEdges, addAllVertices, addEdge, addEdge, addVertex, containsEdge, containsEdge, containsVertex, edgeSet, edgesOf, getAllEdges, getEdge, getEdgeFactory, removeAllEdges, removeAllEdges, removeAllVertices, removeEdge, removeEdge, removeVertex, vertexSet
 

Method Detail

inDegreeOf

int inDegreeOf(java.lang.Object vertex)
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.

Parameters:
vertex - vertex whose degree is to be calculated.
Returns:
the degree of the specified vertex.

incomingEdgesOf

java.util.List incomingEdgesOf(java.lang.Object vertex)
Returns a list of all edges incoming into the specified vertex.

Parameters:
vertex - the vertex for which the list of incoming edges to be returned.
Returns:
a list of all edges incoming into the specified vertex.

outDegreeOf

int outDegreeOf(java.lang.Object 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.

Parameters:
vertex - vertex whose degree is to be calculated.
Returns:
the degree of the specified vertex.

outgoingEdgesOf

java.util.List outgoingEdgesOf(java.lang.Object vertex)
Returns a list of all edges outgoing from the specified vertex.

Parameters:
vertex - the vertex for which the list of outgoing edges to be returned.
Returns:
a list of all edges outgoing from the specified vertex.