marytts.cart

Class Node

java.lang.Object

marytts.cart.Node

Direct Known Subclasses:

DecisionNode, DirectedGraphNode, LeafNode

public abstract class Node
extends Object

A node for the CART or DirectedGraph. All node types inherit from this class

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	isRoot
protected Node	mother
protected int	nodeIndex

Constructor Summary

Constructors

Constructor and Description
Node()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract 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.
abstract Object	getAllData() Get all the data at or below this node.
String	getDecisionPath()
Node	getMother() Get the mother node of this node
int	getNodeIndex() Get the index of this node in the mother's array of daughters
abstract int	getNumberOfData() Count all the data available at and below this node.
abstract int	getNumberOfNodes() Count all the nodes at and below this node.
Node	getRootNode()
boolean	isDecisionNode()
boolean	isDirectedGraphNode()
boolean	isLeafNode()
boolean	isRoot() Get the setting of isRoot
void	setIsRoot(boolean isRoot) Set isRoot to the given value
void	setMother(Node node, int nodeIndex) set the mother node of this node, and remember this node's index in mother.
String	toString(String prefix)

Methods inherited from class java.lang.Object

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

Field Detail

isRoot

protected boolean isRoot

mother

protected Node mother

nodeIndex

protected int nodeIndex

Constructor Detail

Node

public Node()

Method Detail

setMother

public void setMother(Node node,
             int nodeIndex)

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

Parameters:

node - the mother node

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

getMother

public Node getMother()

Get the mother node of this node

Returns:

the mother node

getNodeIndex

public int getNodeIndex()

Get the index of this node in the mother's array of daughters

Returns:

the index

setIsRoot

public void setIsRoot(boolean isRoot)

Set isRoot to the given value

Parameters:

isRoot - the new value of isRoot

isRoot

public boolean isRoot()

Get the setting of isRoot

Returns:

the setting of isRoot

isDecisionNode

public boolean isDecisionNode()

isLeafNode

public boolean isLeafNode()

isDirectedGraphNode

public boolean isDirectedGraphNode()

getRootNode

public Node getRootNode()

getDecisionPath

public String getDecisionPath()

getNumberOfNodes

public abstract int getNumberOfNodes()

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.

Returns:

number of nodes

getNumberOfData

public abstract int getNumberOfData()

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.

Returns:

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

getAllData

public abstract Object getAllData()

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.

Returns:

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

fillData

protected abstract 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. The type of data written depends on the type of nodes; for example, when IntArrayLeafNodes are used, target would be an int[].

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().

toString

public String toString(String prefix)