edu.cmu.sphinx.trainer

Class Graph

java.lang.Object

edu.cmu.sphinx.trainer.Graph

Direct Known Subclasses:

TranscriptHMMGraph, UtteranceHMMGraph

public class Graph
extends java.lang.Object

Implementation of a graph

Constructor Summary

Constructors

Constructor and Description
Graph() Constructor for class.

Method Summary

Modifier and Type	Method and Description
void	addEdge(Edge edge) Add edge to list of nodes.
void	addNode(Node node) Add node to list of nodes.
void	copyGraph(Graph graph) Copy a graph to the current graph object.
Node	getFinalNode() Get the final node
Node	getInitialNode() Get the initial node
Node	getNode(int index) Get node at the specified position in the list.
boolean	hasMoreEdges()
boolean	hasMoreNodes()
int	indexOf(Node node) Gets the index of a particular node in the graph.
void	insertGraph(Graph graph, Node node) Insert a graph in the current graph, replacing a particular node.
boolean	isEdgeInGraph(Edge edge) Check if an edge is in the graph.
boolean	isFinalNode(Node node) Returns whether the given node is the final node in this graph.
boolean	isInitialNode(Node node) Returns whether the given node is the initial node in this graph.
boolean	isNodeInGraph(Node node) Check if a node is in the graph.
Edge	linkNodes(Node sourceNode, Node destinationNode) Link two nodes.
Edge	nextEdge()
Node	nextNode()
Node[]	nodeToArray() Gets an array containing the nodes in this graph.
void	printGraph() Prints out the graph.
void	setFinalNode(Node node) Set the final node
void	setInitialNode(Node node) Set the initial node
int	size() Get this graph's size.
void	startEdgeIterator() Start iterator for edges.
void	startNodeIterator() Start iterator for nodes.
boolean	validate() Validate the graph.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Graph

public Graph()

Constructor for class. Creates lists of edges and nodes.

Method Detail

setInitialNode

public void setInitialNode(Node node)
                    throws java.lang.IllegalArgumentException

Set the initial node

Parameters:

node - node

Throws:

java.lang.IllegalArgumentException - if node is not in the graph

setFinalNode

public void setFinalNode(Node node)
                  throws java.lang.IllegalArgumentException

Set the final node

Parameters:

node - node

Throws:

java.lang.IllegalArgumentException - if node is not in the graph

getInitialNode

public Node getInitialNode()

Get the initial node

Returns:

initial node

getFinalNode

public Node getFinalNode()

Get the final node

Returns:

final node

size

public int size()

Get this graph's size. The size of a graph is the number of nodes in the graph.

Returns:

the size of the graph

getNode

public Node getNode(int index)

Get node at the specified position in the list. The order is the same in which the nodes were entered.

Parameters:

index - index of item to retun

Returns:

the item

nodeToArray

public Node[] nodeToArray()

Gets an array containing the nodes in this graph.

Returns:

an array of nodes

indexOf

public int indexOf(Node node)

Gets the index of a particular node in the graph.

Parameters:

node - the node

Returns:

the index in this graph, or -1 if not found

isInitialNode

public boolean isInitialNode(Node node)

Returns whether the given node is the initial node in this graph.

Parameters:

node - the node we want to compare

Returns:

if true, the node is the initial node

isFinalNode

public boolean isFinalNode(Node node)

Returns whether the given node is the final node in this graph.

Parameters:

node - the node we want to compare

Returns:

if true, the node is the final node

linkNodes

public Edge linkNodes(Node sourceNode,
                      Node destinationNode)

Link two nodes. If the source or destination nodes are not in the graph, they are added to it. No check is performed to ensure that the nodes are linked to other nodes in the graph.

Parameters:

sourceNode - source node

destinationNode - destination node

Returns:

created edge

addNode

public void addNode(Node node)

Add node to list of nodes.

Parameters:

node - node to add

addEdge

public void addEdge(Edge edge)

Add edge to list of nodes.

Parameters:

edge - edge to add

isNodeInGraph

public boolean isNodeInGraph(Node node)

Check if a node is in the graph.

Parameters:

node - node to check

Returns:

if node in the graph

isEdgeInGraph

public boolean isEdgeInGraph(Edge edge)

Check if an edge is in the graph.

Parameters:

edge - edge to check

Returns:

if edge in the graph

startNodeIterator

public void startNodeIterator()

Start iterator for nodes.

hasMoreNodes

public boolean hasMoreNodes()

Returns:

whether there are more nodes.

nextNode

public Node nextNode()

Returns:

next node.

startEdgeIterator

public void startEdgeIterator()

Start iterator for edges.

hasMoreEdges

public boolean hasMoreEdges()

Returns:

whether there are more edges.

nextEdge

public Edge nextEdge()

Returns:

next edge.

copyGraph

public void copyGraph(Graph graph)

Copy a graph to the current graph object.

Parameters:

graph - the graph to copy from

insertGraph

public void insertGraph(Graph graph,
                        Node node)

Insert a graph in the current graph, replacing a particular node.

Parameters:

graph - the graph to insert

node - the node that this graph will replace

validate

public boolean validate()

Validate the graph. It checks out basics about the graph, such as whether all nodes have at least one incoming and outgoing edge, except for the initial and final.

Returns:

if true, graph validation passed

printGraph

public void printGraph()

Prints out the graph. For debugging purposes.