gov.sandia.cognition.graph

Interface DirectedNodeEdgeGraph<NodeNameType>

Type Parameters:

NodeNameType -

All Known Subinterfaces:

DirectedWeightedNodeEdgeGraph<NodeNameType>

All Known Implementing Classes:

DenseMemoryGraph, WeightedDenseMemoryGraph

public interface DirectedNodeEdgeGraph<NodeNameType>

This interface defines the minimal set of methods necessary to create and walk a directed graph.

Author:

jdwendt

Method Summary

Modifier and Type	Method and Description
void	addEdge(NodeNameType left, NodeNameType right) Adds a directed edge from left to right.
void	addNode(NodeNameType node) Adds the input node to the graph.
void	clear() Clears the graph back to the original, empty state
boolean	containsNode(NodeNameType node) Returns whether or not the graph contains the specified vertex.
Pair<java.lang.Integer,java.lang.Integer>	getEdgeEndpointIds(int id) Return the edge endpoints (by node id) for edge id (where id [0 ...
NodeNameType	getNode(int id) Returns the node label for the input id.
int	getNodeId(NodeNameType node) Returns the integer ID of the input node.
java.util.Collection<NodeNameType>	getNodes() Returns all of the nodes contained in the graph.
int	getNumEdges() Return the number of edges.
int	getNumNodes() Return the number of nodes
java.util.Collection<NodeNameType>	getSuccessors(NodeNameType node) Returns all the nodes this node connects to (outgoing edges only).

Method Detail

getNodes

java.util.Collection<NodeNameType> getNodes()

Returns all of the nodes contained in the graph.

Returns:

all of the nodes in the graph

getNumNodes

int getNumNodes()

Return the number of nodes

Returns:

the number of nodes

getNumEdges

int getNumEdges()

Return the number of edges.

Returns:

the number of edges

addEdge

void addEdge(NodeNameType left,
             NodeNameType right)

Adds a directed edge from left to right. If left and right are not already in the graph, they are added before the edge is added.

Parameters:

left - The source of the edge

right - The destination of the edge

addNode

void addNode(NodeNameType node)

Adds the input node to the graph. Calling this method is unnecessary if the node participates in any edges. If you call addEdge(Object, Object), it handles adding new nodes.

Parameters:

node - The node to add to the graph

containsNode

boolean containsNode(NodeNameType node)

Returns whether or not the graph contains the specified vertex.

Parameters:

node - The node to check for

Returns:

true if this contains node

getSuccessors

java.util.Collection<NodeNameType> getSuccessors(NodeNameType node)

Returns all the nodes this node connects to (outgoing edges only).

Parameters:

node - The node whose successors are requested

Returns:

all the nodes this node connects to.

getEdgeEndpointIds

Pair<java.lang.Integer,java.lang.Integer> getEdgeEndpointIds(int id)

Return the edge endpoints (by node id) for edge id (where id [0 ... numEdges()).

Parameters:

id - The edge id

Returns:

The node id pair for the source and destination of an edge (use getNode(int) to determine which nodes these are (if you care)).

getNode

NodeNameType getNode(int id)

Returns the node label for the input id. To be used in conjunction with getEdgeEndpointIds(int). If you pass in a bad id, an exception will be thrown.

Parameters:

id - The node id

Returns:

The node label for the input id

getNodeId

int getNodeId(NodeNameType node)

Returns the integer ID of the input node. To be used in conjunction with getEdgeEndpointIds(int).

Parameters:

node - The node value

Returns:

The index for the node as stored internally

clear

void clear()

Clears the graph back to the original, empty state