marytts.cart

Class DirectedGraphNode

java.lang.Object

marytts.cart.Node

marytts.cart.DirectedGraphNode

public class DirectedGraphNode
extends Node

A type of node that can be at the same time a decision node and a leaf node, and that can have more than one mother. Other than tree nodes, thus, directed graph nodes are not necessarily contained in a strict tree structure; furthermore, each node can potentially carry data.

Author:

marc

Field Summary

Fields inherited from class marytts.cart.Node

isRoot, mother, nodeIndex

Constructor Summary

Constructors

Constructor and Description
DirectedGraphNode(DecisionNode decisionNode, Node leafNode)

Method Summary

Modifier and Type	Method and Description
protected void	fillData(Object target, int pos, int len) Write this node's data into the target object at pos, making sure that exactly len data are written.
Object	getAllData() Get all the data at or below this node.
DecisionNode	getDecisionNode()
String	getDecisionPath()
Node	getLeafNode()
Node	getMother() Get a mother node of this node.
List<Node>	getMothers()
Node	getNextNode(FeatureVector fv)
int	getNodeIndex() Get the index of this node in the mother returned by getMother().
int	getNodeIndex(Node aMother) Return this node's index in the given mother's array of daughters.
int	getNumberOfData() Count all the data available at and below this node.
int	getNumberOfNodes() Count all the nodes at and below this node.
int	getUniqueGraphNodeID()
boolean	isDirectedGraphNode()
void	removeMother(Node aMother) Remove the given node from the list of mothers.
void	setDecisionNode(DecisionNode newNode)
void	setLeafNode(Node newNode)
void	setMother(Node node, int nodeIndex) set the mother node of this node, and remember this node's index in mother.
void	setUniqueGraphNodeID(int id)
String	toString()

Methods inherited from class marytts.cart.Node

getRootNode, isDecisionNode, isLeafNode, isRoot, setIsRoot, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectedGraphNode

public DirectedGraphNode(DecisionNode decisionNode,
                         Node leafNode)

Parameters:

decisionNode - decisionNode

leafNode - leafNode

Method Detail

getDecisionNode

public DecisionNode getDecisionNode()

isDirectedGraphNode

public boolean isDirectedGraphNode()

Overrides:

isDirectedGraphNode in class Node

setDecisionNode

public void setDecisionNode(DecisionNode newNode)

getLeafNode

public Node getLeafNode()

setLeafNode

public void setLeafNode(Node newNode)

setMother

public void setMother(Node node,
                      int nodeIndex)

Description copied from class: Node

set the mother node of this node, and remember this node's index in mother.

Overrides:

setMother in class Node

Parameters:

node - the mother node

nodeIndex - the index of this node in the mother node's list of daughters

getMother

public Node getMother()

Get a mother node of this node. DirectedGraphNodes can have more than one node.

Overrides:

getMother in class Node

Returns:

the first mother, or null if there is no mother.

getNodeIndex

public int getNodeIndex()

Get the index of this node in the mother returned by getMother().

Overrides:

getNodeIndex in class Node

Returns:

the index in the mother's daughter array, or 0 if there is no mother.

getMothers

public List<Node> getMothers()

getNodeIndex

public int getNodeIndex(Node aMother)

Return this node's index in the given mother's array of daughters.

Parameters:

aMother - aMother

Returns:

motherToIndex.get(aMother)

Throws:

IllegalArgumentException - if mother is not a mother of this node.

removeMother

public void removeMother(Node aMother)

Remove the given node from the list of mothers.

Parameters:

aMother - aMother

Throws:

IllegalArgumentException - if mother is not a mother of this node.

fillData

protected void fillData(Object target,
                        int pos,
                        int len)

Description copied from class: Node

Write this node's data into the target object at pos, making sure that exactly len data are written. The type of data written depends on the type of nodes; for example, when IntArrayLeafNodes are used, target would be an int[].

Specified by:

fillData in class Node

Parameters:

target - the object to write to, usually an array.

pos - the position in the target at which to start writing

len - the amount of data items to write, usually equals getNumberOfData().

getAllData

public Object getAllData()

Description copied from class: Node

Get all the data at or below this node. The type of data returned depends on the type of nodes; for example, when IntArrayLeafNodes are used, one int[] is returned which contains all int values in all leaf nodes below the current node.

Specified by:

getAllData in class Node

Returns:

an object containing all data below the current node, or null if such a concept is not meaningful.

getNumberOfData

public int getNumberOfData()

Description copied from class: Node

Count all the data available at and below this node. The meaning of this depends on the type of nodes; for example, when IntArrayLeafNodes are used, it is the total number of ints that are saved in all leaf nodes below the current node.

Specified by:

getNumberOfData in class Node

Returns:

an int counting the data below the current node, or -1 if such a concept is not meaningful.

getNumberOfNodes

public int getNumberOfNodes()

Description copied from class: Node

Count all the nodes at and below this node. A leaf will return 1; the root node will report the total number of decision and leaf nodes in the tree.

Specified by:

getNumberOfNodes in class Node

Returns:

number of nodes

getNextNode

public Node getNextNode(FeatureVector fv)

getUniqueGraphNodeID

public int getUniqueGraphNodeID()

setUniqueGraphNodeID

public void setUniqueGraphNodeID(int id)

getDecisionPath

public String getDecisionPath()

Overrides:

getDecisionPath in class Node

toString

public String toString()

Overrides:

toString in class Object