marytts.cart

Class DirectedGraph

java.lang.Object

marytts.cart.DirectedGraph

Direct Known Subclasses:

CART

public class DirectedGraph
extends Object

A directed graph is a layered structure of nodes, in which there are mother-daughter relationships between the node. There is a single root node. Each node can have multiple daughters and/or multiple mothers. Three types of nodes are allowed: DirectedGraphNode (which can have multiple mothers, a leaf and a decision node), LeafNodes (which carry data), and DecisionNodes (which can have multiple daughters).

Author:

marc

Field Summary

Fields

Modifier and Type	Field and Description
protected FeatureDefinition	featDef
protected org.apache.log4j.Logger	logger
protected Properties	properties
protected Node	rootNode

Constructor Summary

Constructors

Constructor and Description
DirectedGraph() Build a new empty directed graph
DirectedGraph(FeatureDefinition featDef) Build a new empty graph with the given feature definition.
DirectedGraph(Node rootNode, FeatureDefinition featDef) Build a new graph with the given node as the root node
DirectedGraph(Node rootNode, FeatureDefinition featDef, Properties properties) Build a new graph with the given node as the root node

Method Summary

Methods

Modifier and Type	Method and Description
Iterator<DecisionNode>	getDecisionNodeIterator() Return an iterator which returns all decision nodes in the tree exactly once.
Iterable<DecisionNode>	getDecisionNodes() A representation of the corresponding node iterator that can be used in extended for() statements.
Iterator<DirectedGraphNode>	getDirectedGraphNodeIterator() Return an iterator which returns all directed graph nodes in the tree exactly once.
Iterable<DirectedGraphNode>	getDirectedGraphNodes() A representation of the corresponding node iterator that can be used in extended for() statements.
FeatureDefinition	getFeatureDefinition()
Iterator<LeafNode>	getLeafNodeIterator() Return an iterator which returns all leaf nodes in the tree exactly once.
Iterable<LeafNode>	getLeafNodes() A representation of the corresponding node iterator that can be used in extended for() statements.
Iterator<Node>	getNodeIterator() Return an iterator which returns all nodes in the tree exactly once.
Iterable<Node>	getNodes() A representation of the corresponding node iterator that can be used in extended for() statements.
int	getNumNodes() Get the number of nodes in this CART
Properties	getProperties() Get the properties object associated with this tree, or null if there is no such object.
Node	getRootNode() Get the root node of this CART
Object	interpret(FeatureVector fv) Walk down the graph as far as possible according to the features in fv, and return the data in the leaf node found there.
protected Object	interpret(Node n, FeatureVector fv) Follow the directed graph down to the most specific leaf with data, starting from node n.
Object	interpret(Target t)
void	setRootNode(Node rNode) Set the root node of this CART
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected org.apache.log4j.Logger logger

rootNode

protected Node rootNode

featDef

protected FeatureDefinition featDef

properties

protected Properties properties

Constructor Detail

DirectedGraph

public DirectedGraph()

Build a new empty directed graph

DirectedGraph

public DirectedGraph(FeatureDefinition featDef)

Build a new empty graph with the given feature definition.

Parameters:

featDef - the feature definition used for interpreting the meaning of decision node criteria.

DirectedGraph

public DirectedGraph(Node rootNode,
             FeatureDefinition featDef)

Build a new graph with the given node as the root node

Parameters:

rootNode - the root node of the graph

featDef - the feature definition used for interpreting the meaning of decision node criteria.

DirectedGraph

public DirectedGraph(Node rootNode,
             FeatureDefinition featDef,
             Properties properties)

Build a new graph with the given node as the root node

Parameters:

rootNode - the root node of the graph

featDef - the feature definition used for interpreting the meaning of decision node criteria.

properties - a generic properties object, which can be used to encode information about the tree and the way the data in it should be represented.

Method Detail

interpret

public Object interpret(Target t)

interpret

public Object interpret(FeatureVector fv)

Walk down the graph as far as possible according to the features in fv, and return the data in the leaf node found there.

Parameters:

fv - a feature vector which must be consistent with the graph's feature definition. (@see #getFeatureDefinition()).

Returns:

the most specific non-null leaf node data that can be retrieved, or null if there is no non-null leaf node data along the fv's path.

interpret

protected Object interpret(Node n,
               FeatureVector fv)

Follow the directed graph down to the most specific leaf with data, starting from node n. This is recursively calling itself.

Parameters:

n - n

fv - fv

Returns:

null if n=null, n.getAllData if n.isLeafNode, interpret (next, fv) if next = ((DecisionNode) n).getNextNode(fv), data if data != null, interpret(g.getLeafNode(), fv) otherwise

getNodeIterator

public Iterator<Node> getNodeIterator()

Return an iterator which returns all nodes in the tree exactly once. Search is done in a depth-first way.

Returns:

a new NodeIterator(Node)

getLeafNodeIterator

public Iterator<LeafNode> getLeafNodeIterator()

Return an iterator which returns all leaf nodes in the tree exactly once. Search is done in a depth-first way.

Returns:

a new NodeIterator(LeafNode)

getDecisionNodeIterator

public Iterator<DecisionNode> getDecisionNodeIterator()

Return an iterator which returns all decision nodes in the tree exactly once. Search is done in a depth-first way.

Returns:

a new NodeIterator(DecisionNode)

getDirectedGraphNodeIterator

public Iterator<DirectedGraphNode> getDirectedGraphNodeIterator()

Return an iterator which returns all directed graph nodes in the tree exactly once. Search is done in a depth-first way.

Returns:

a new NodeIterator(DirectedGraphNode)

getNodes

public Iterable<Node> getNodes()

A representation of the corresponding node iterator that can be used in extended for() statements.

Returns:

a new Iterable(Node)

getLeafNodes

public Iterable<LeafNode> getLeafNodes()

A representation of the corresponding node iterator that can be used in extended for() statements.

Returns:

a new Iterable(LeafNode)

getDecisionNodes

public Iterable<DecisionNode> getDecisionNodes()

A representation of the corresponding node iterator that can be used in extended for() statements.

Returns:

a new Iterable(DecisionNode)

getDirectedGraphNodes

public Iterable<DirectedGraphNode> getDirectedGraphNodes()

A representation of the corresponding node iterator that can be used in extended for() statements.

Returns:

a new Iterable(DirectedGraphNode)

getProperties

public Properties getProperties()

Get the properties object associated with this tree, or null if there is no such object.

Returns:

the properties

getRootNode

public Node getRootNode()

Get the root node of this CART

Returns:

the root node

setRootNode

public void setRootNode(Node rNode)

Set the root node of this CART

Parameters:

rNode - root node

getFeatureDefinition

public FeatureDefinition getFeatureDefinition()

getNumNodes

public int getNumNodes()

Get the number of nodes in this CART

Returns:

the number of nodes

toString

public String toString()

Overrides:

toString in class Object