TreeNode (JMSL Numerical Library)

java.lang.Object
- com.imsl.datamining.decisionTree.TreeNode

All Implemented Interfaces:

Serializable, Cloneable
```
public class TreeNode
extends Object
implements Serializable, Cloneable
```
A DecisionTree node which may be used as a child of Tree.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

TreeNode()
Constructs a DecisionTreeNode object.

Constructors
Constructor and Description
`TreeNode()` Constructs a `DecisionTreeNode` object.

Method Summary

Methods
Modifier and Type	Method and Description
`protected TreeNode`	`clone()` Returns a clone of a `TreeNode`.
`int`	`getChildId(int i)` Returns the id of a child node.
`int[]`	`getChildrenIds()` Returns the array of child node id's.
`double`	`getCost()` Returns the misclassification cost of a node (in-sample cost measure at the current node).
`int`	`getNodeId()` Returns the id of the current node.
`double`	`getNodeSplitValue()` Returns the value around which the node may be split, if the split variable is of a continuous type.
`int`	`getNodeValueIndicator(int i)` Returns the indicator value for the `i-`th value of the split variable in the current node, if the split variable is of discrete type.
`int[]`	`getNodeValuesIndicator()` Returns the array indicating which values of the split variable apply in the current node, if the split variable is of discrete type.
`int`	`getNodeVariableId()` Returns the id of the variable that defines the split in the current node.
`double`	`getNumberOfCases()` Returns the number of cases in the training data that fall into the current node.
`int`	`getNumberOfChildren()` Returns the number of child nodes associated with the current node.
`int`	`getParentId()` Returns the id of the parent node of the current node.
`int`	`getPredictedClass()` Returns the predicted class at the current node, for response variables of categorical type.
`double`	`getPredictedVal()` Returns the predicted value at the current node, for response variables of continuous type.
`double[]`	`getSurrogateInfo()` Returns the surrogate split information array.
`double`	`getSurrogateInfo(int i)` Returns a value from the surrogate split information array.
`double`	`getYProb(int i)` Returns a class probability at the current node, if the response variable is of categorical type.
`double[]`	`getYProbs()` Returns class probabilities at the current node, if the response variable is of categorical type.
`void`	`setNumberOfChildren(int nChildren)` Sets the number of child nodes associated with the current node.
`void`	`setSurrogateInfo(double[] surrogateInfo)` Sets the surrogate split information.
`void`	`setYProb(int i, double val)` Sets a class probability at the current node, if the response variable is of categorical type.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TreeNode
```
public TreeNode()
```
    Constructs a DecisionTreeNode object.
- Method Detail
  - clone
```
protected TreeNode clone()
```
    Returns a clone of a TreeNode.
    
    Overrides:
    
    clone in class Object
    
    Returns:
    a TreeNode that is a clone of a node.
  - getChildId
```
public int getChildId(int i)
```
    Returns the id of a child node.
    
    Parameters:
    i - an int specifying the index of the child node.
    
    Returns:
    anint which is the id of the specified node.
  - getChildrenIds
```
public int[] getChildrenIds()
```
    Returns the array of child node id's.
    Note that the length of this array may exceed the actual number of child nodes. Use getNumberOfChildren() to determine the actual number of children.
    
    Returns:
    an int array containing id's of the child nodes.
  - getCost
```
public double getCost()
```
    Returns the misclassification cost of a node (in-sample cost measure at the current node).
    
    Returns:
    a double specifying the misclassification cost of a node.
  - getNodeId
```
public int getNodeId()
```
    Returns the id of the current node.
    The root node has nodeId = 0.
    
    Returns:
    an int which is the node id.
  - getNodeSplitValue
```
public double getNodeSplitValue()
```
    Returns the value around which the node may be split, if the split variable is of a continuous type.
    
    Returns:
    a double which is the value around which the node may be split.
  - getNodeValueIndicator
```
public int getNodeValueIndicator(int i)
```
    Returns the indicator value for the i-th value of the split variable in the current node, if the split variable is of discrete type.
    
    Returns:
    an int which if 0, the value is not in the node, if 1, it is in the node, meaning that it is in the subset that defines the data partition of the node.
  - getNodeValuesIndicator
```
public int[] getNodeValuesIndicator()
```
    Returns the array indicating which values of the split variable apply in the current node, if the split variable is of discrete type.
    
    Returns:
    an int array of indicators.
  - getNodeVariableId
```
public int getNodeVariableId()
```
    Returns the id of the variable that defines the split in the current node.
    
    Returns:
    an int identifying the variable that defines the split in the current node.
  - getNumberOfCases
```
public double getNumberOfCases()
```
    Returns the number of cases in the training data that fall into the current node.
    
    Returns:
    a double indicating the number of cases (or total case weight) in the training data that fall into the current node.
  - getNumberOfChildren
```
public int getNumberOfChildren()
```
    Returns the number of child nodes associated with the current node.
    
    Returns:
    an int that indicates the number of child nodes associated with this TreeNode instance.
  - getParentId
```
public int getParentId()
```
    Returns the id of the parent node of the current node.
    
    Returns:
    an int which is the id of the parent node.
  - getPredictedClass
```
public int getPredictedClass()
```
    Returns the predicted class at the current node, for response variables of categorical type.
    
    Returns:
    an int which indicates the predicted class.
  - getPredictedVal
```
public double getPredictedVal()
```
    Returns the predicted value at the current node, for response variables of continuous type.
    
    Returns:
    a double that indicates the value of the response variable.
  - getSurrogateInfo
```
public double[] getSurrogateInfo()
```
    Returns the surrogate split information array.
    
    Returns:
    a double array containing the surrogate split values.
  - getSurrogateInfo
```
public double getSurrogateInfo(int i)
```
    Returns a value from the surrogate split information array.
    
    Parameters:
    i - an int specifying which value to return.
    
    Returns:
    a double which equals the value at index i.
  - getYProb
```
public double getYProb(int i)
```
    Returns a class probability at the current node, if the response variable is of categorical type.
    
    Parameters:
    i - an int specifying which class of the response variable.
    
    Returns:
    a double which is the specified class probability at the current node.
  - getYProbs
```
public double[] getYProbs()
```
    Returns class probabilities at the current node, if the response variable is of categorical type.
    
    Returns:
    a double array of class probabilities at the current node.
  - setNumberOfChildren
```
public void setNumberOfChildren(int nChildren)
```
    Sets the number of child nodes associated with the current node.
    
    Parameters:
    nChildren - an int that indicates the number of child nodes associated with this TreeNode instance.
  - setSurrogateInfo
```
public void setSurrogateInfo(double[] surrogateInfo)
```
    Sets the surrogate split information.
    
    Parameters:
    surrogateInfo - a double array containing the surrogate split information.
  - setYProb
```
public void setYProb(int i,
            double val)
```
    Sets a class probability at the current node, if the response variable is of categorical type.
    
    Parameters:
    i - an int specifying which class of the response variable.
    val - a double which specifies the indicated class probability at the current node.

Class TreeNode

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TreeNode

Method Detail

clone

getChildId

getChildrenIds

getCost

getNodeId

getNodeSplitValue

getNodeValueIndicator

getNodeValuesIndicator

getNodeVariableId

getNumberOfCases

getNumberOfChildren

getParentId

getPredictedClass

getPredictedVal

getSurrogateInfo

getSurrogateInfo

getYProb

getYProbs

setNumberOfChildren

setSurrogateInfo

setYProb