gov.sandia.cognition.graph

Interface DirectedWeightedNodeEdgeGraph<NodeNameType>

Type Parameters:

NodeNameType - The type used to specify nodes

All Superinterfaces:

DirectedNodeEdgeGraph<NodeNameType>

All Known Implementing Classes:

WeightedDenseMemoryGraph

public interface DirectedWeightedNodeEdgeGraph<NodeNameType>
extends DirectedNodeEdgeGraph<NodeNameType>

Adds the necessary methods for a graph with weighted edges.

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	addEdge(NodeNameType left, NodeNameType right, double weight) Adds a directed edge from left to right with the input weight.
double	getEdgeWeight(int id) This returns the weight of edge id (where id is [0 ...
java.util.Collection<Pair<NodeNameType,java.lang.Double>>	getSuccessorsWithWeights(NodeNameType node) Returns all the nodes this node connects to with edge weights (outgoing edges only).

Methods inherited from interface gov.sandia.cognition.graph.DirectedNodeEdgeGraph

addNode, clear, containsNode, getEdgeEndpointIds, getNode, getNodeId, getNodes, getNumEdges, getNumNodes, getSuccessors

Method Detail

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. NOTE: Calling this method results in an edge with 1.0 weight.

Specified by:

addEdge in interface DirectedNodeEdgeGraph<NodeNameType>

Parameters:

left - The source of the edge

right - The destination of the edge

addEdge

void addEdge(NodeNameType left,
             NodeNameType right,
             double weight)

Adds a directed edge from left to right with the input weight. 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

weight - The weight to assign this edge

getSuccessorsWithWeights

java.util.Collection<Pair<NodeNameType,java.lang.Double>> getSuccessorsWithWeights(NodeNameType node)

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

Parameters:

node - The node whose successors and weights are wanted

Returns:

all the nodes this node connects to.

getEdgeWeight

double getEdgeWeight(int id)

This returns the weight of edge id (where id is [0 ... numEdges())). Note that the ids for edges are not necessarily fixed across calls to addEdge (as edge ordering can change due to insertion of new edges).

Parameters:

id - The id of the edge whose weight is desired

Returns:

The weight for edge id