biz.sc.mm.dm.modelstats.tree

Interface TreeModelStatistics

All Superinterfaces:

ModelStatistics, Verifiable

public interface TreeModelStatistics
extends ModelStatistics, Verifiable

Model statistics of the classification tree model. Contains general information about the tree, and contains tree nodes. Root node and target values are modifiable. The remaining statistics are dynamically computed, by traversing the tree.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List	getAllLeaves() Returns all leaves of the tree, that is all nodes, that Node.isLeaf() function returns true.
java.util.List	getAllNodes() Returns all nodes of the tree, which are not pruned.
int[]	getLeafIds() Returns all ids that are used by the tree leaves.
int	getLeaves() Returns number of all leaves in the tree.
java.lang.String	getName()
Node	getNode(int nodeID) Returns node with specified id
int[]	getNodeIds() Returns all ids that are used by the tree nodes.
int	getNodes() Returns number of all nodes in the tree.
int	getNodesBeforePrunning() Returns number of nodes after tree building, before prunning.
NullStrategyEnum	getNullStrategy() Which null strategy is being used.
int	getNumberOfTrainingObservations() Returns number of observations in training set for this tree.
Node	getRoot() Gets the root node of this decision tree.
java.lang.Object[]	getTargetValues() Get values of target.
int	getTreeDepth() Returns the tree depth, that is the highest level of tree node.
void	setName(java.lang.String name)
void	setNullStrategy(NullStrategyEnum strategy) Set the null processing strategy.

Methods inherited from interface biz.sc.mm.dm.base.Verifiable

verify

Method Detail

getRoot

Node getRoot()

Gets the root node of this decision tree.

Returns:

Root node.

getTargetValues

java.lang.Object[] getTargetValues()

Get values of target. Please note, that order in table returned by this function is different, than order in target attribute value set specified in biz.sc.mm.dm.supervised.classification.ClassificationModel#getTargetCategorySet(). Regression Trees: returns null

Returns:

Values of target

getAllNodes

java.util.List getAllNodes()

Returns all nodes of the tree, which are not pruned.

Returns:

list with all nodes of the tree. Contains elements of type Node.

getAllLeaves

java.util.List getAllLeaves()

Returns all leaves of the tree, that is all nodes, that Node.isLeaf() function returns true.

Returns:

all leaves of the tree. Contains elements of type Node.

getNode

Node getNode(int nodeID)

Returns node with specified id

Parameters:

nodeID - id of the node to return

Returns:

node with specified id, or null if not found.

getNodeIds

int[] getNodeIds()

Returns all ids that are used by the tree nodes.

Returns:

table with all node ids

getLeafIds

int[] getLeafIds()

Returns all ids that are used by the tree leaves. It might be helpfull when using classification tree as a clustering algorithm.

Returns:

table with all leaf ids

getNodes

int getNodes()

Returns number of all nodes in the tree.

Returns:

number of all nodes

getLeaves

int getLeaves()

Returns number of all leaves in the tree.

Returns:

number of all leaves

getTreeDepth

int getTreeDepth()

Returns the tree depth, that is the highest level of tree node.

Returns:

the tree depth

getNodesBeforePrunning

int getNodesBeforePrunning()

Returns number of nodes after tree building, before prunning.

Returns:

number of nodes before pruning phase, or -1 if not supported by the algorithm.

getNumberOfTrainingObservations

int getNumberOfTrainingObservations()

Returns number of observations in training set for this tree.

Returns:

number of training observations

getNullStrategy

NullStrategyEnum getNullStrategy()

Which null strategy is being used.

Returns:

Strategy id.

setNullStrategy

void setNullStrategy(NullStrategyEnum strategy)

Set the null processing strategy.

Parameters:

strategy - The strategy id.

getName

java.lang.String getName()

setName

void setName(java.lang.String name)