marytts.cart

Class LeafNode

java.lang.Object

marytts.cart.Node

marytts.cart.LeafNode

Direct Known Subclasses:

LeafNode.FeatureVectorLeafNode, LeafNode.FloatLeafNode, LeafNode.IntArrayLeafNode, LeafNode.PdfLeafNode

public abstract class LeafNode
extends Node

The leaf of a CART.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LeafNode.FeatureVectorLeafNode
static class	LeafNode.FloatLeafNode A leaf class that is suitable for regression trees.
static class	LeafNode.IntAndFloatArrayLeafNode
static class	LeafNode.IntArrayLeafNode An LeafNode class suitable for representing the leaves of classification trees -- the leaf is a collection of items identified by an index number.
static class	LeafNode.LeafType
static class	LeafNode.PdfLeafNode A leaf class that is suitable for regression trees.
static class	LeafNode.StringAndFloatLeafNode

Field Summary

Fields

Modifier and Type	Field and Description
protected int	uniqueLeafId

Fields inherited from class marytts.cart.Node

isRoot, mother, nodeIndex

Constructor Summary

Constructors

Constructor and Description
LeafNode() Create a new LeafNode.

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.
abstract LeafNode.LeafType	getLeafNodeType() The type of this leaf node.
abstract int	getNumberOfData() Count all the data available at and below this node.
int	getNumberOfNodes() Count all the nodes at and below this node.
int	getUniqueLeafId()
abstract boolean	isEmpty() Indicate whether the leaf node has no meaningful data.
boolean	isLeafNode()
void	setUniqueLeafId(int id)
String	toString()

Methods inherited from class marytts.cart.Node

getDecisionPath, getMother, getNodeIndex, getRootNode, isDecisionNode, isDirectedGraphNode, isRoot, setIsRoot, setMother, toString

Methods inherited from class java.lang.Object

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

Field Detail

uniqueLeafId

protected int uniqueLeafId

Constructor Detail

LeafNode

public LeafNode()

Create a new LeafNode.

Method Detail

isLeafNode

public boolean isLeafNode()

Overrides:

isLeafNode in class Node

getNumberOfNodes

public 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.

Specified by:

getNumberOfNodes in class Node

Returns:

1

setUniqueLeafId

public void setUniqueLeafId(int id)

getUniqueLeafId

public int getUniqueLeafId()

toString

public String toString()

Overrides:

toString in class Object

isEmpty

public abstract boolean isEmpty()

Indicate whether the leaf node has no meaningful data.

Returns:

whether the node is empty or not

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.

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.

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.

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.

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[].

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

getLeafNodeType

public abstract LeafNode.LeafType getLeafNodeType()

The type of this leaf node.

Returns:

the type of the leaf node