gov.sandia.cognition.learning.algorithm.tree

Class CategorizationTreeNode<InputType,OutputType,InteriorType>

java.lang.Object

gov.sandia.cognition.util.AbstractCloneableSerializable

gov.sandia.cognition.learning.algorithm.tree.AbstractDecisionTreeNode<InputType,OutputType,InteriorType>

gov.sandia.cognition.learning.algorithm.tree.CategorizationTreeNode<InputType,OutputType,InteriorType>

Type Parameters:

InputType - The input type for the tree to make a decision about.

OutputType - The output type of the tree.

InteriorType - The type that is used to make a decision at this node.

All Implemented Interfaces:

DecisionTreeNode<InputType,OutputType>, CloneableSerializable, java.io.Serializable, java.lang.Cloneable

public class CategorizationTreeNode<InputType,OutputType,InteriorType>
extends AbstractDecisionTreeNode<InputType,OutputType,InteriorType>

The CategorizationTreeNode implements a DecisionTreeNode for a tree that does categorization.

Since:

2.0

Author:

Justin Basilico

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected OutputType	outputCategory The output category of the node.

Fields inherited from class gov.sandia.cognition.learning.algorithm.tree.AbstractDecisionTreeNode

childMap, decider, incomingValue, parent

Constructor Summary

Constructors

Constructor and Description
CategorizationTreeNode() Creates a new instance of CategorizationTreeNode.
CategorizationTreeNode(DecisionTreeNode<InputType,OutputType> parent, Categorizer<? super InputType,? extends InteriorType> decider, OutputType outputCategory, java.lang.Object incomingValue) Creates a new instance of CategorizationTreeNode.
CategorizationTreeNode(DecisionTreeNode<InputType,OutputType> parent, OutputType outputCategory) Creates a new instance of CategorizationTreeNode.
CategorizationTreeNode(DecisionTreeNode<InputType,OutputType> parent, OutputType outputCategory, java.lang.Object incomingValue) Creates a new instance of CategorizationTreeNode.

Method Summary

Modifier and Type	Method and Description
CategorizationTreeNode<InputType,OutputType,InteriorType>	clone() This makes public the clone method on the Object class and removes the exception that it throws.
OutputType	getOutput(InputType input) Gets the local output of this node for the given input.
OutputType	getOutputCategory() Gets the output category for the node.
void	setOutputCategory(OutputType outputCategory) Sets the output category for the node.

Methods inherited from class gov.sandia.cognition.learning.algorithm.tree.AbstractDecisionTreeNode

addChild, chooseChild, getChildMap, getChildren, getDecider, getDepth, getIncomingValue, getParent, getTreeSize, isLeaf, setChildMap, setDecider, setIncomingValue, setParent

Methods inherited from class java.lang.Object

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

Field Detail

outputCategory

protected OutputType outputCategory

The output category of the node. All nodes should have this, but it is absolutely required for a leaf node.

Constructor Detail

CategorizationTreeNode

public CategorizationTreeNode()

Creates a new instance of CategorizationTreeNode.

CategorizationTreeNode

public CategorizationTreeNode(DecisionTreeNode<InputType,OutputType> parent,
                              OutputType outputCategory)

Creates a new instance of CategorizationTreeNode.

Parameters:

parent - The parent node of this node. Null if this is a root.

outputCategory - The output category.

CategorizationTreeNode

public CategorizationTreeNode(DecisionTreeNode<InputType,OutputType> parent,
                              OutputType outputCategory,
                              java.lang.Object incomingValue)

Creates a new instance of CategorizationTreeNode.

Parameters:

parent - The parent node of this node. Null if this is a root.

outputCategory - The output category.

incomingValue - The incoming value.

CategorizationTreeNode

public CategorizationTreeNode(DecisionTreeNode<InputType,OutputType> parent,
                              Categorizer<? super InputType,? extends InteriorType> decider,
                              OutputType outputCategory,
                              java.lang.Object incomingValue)

Creates a new instance of CategorizationTreeNode.

Parameters:

parent - The parent node of this node. Null if this is a root.

decider - The decision function.

outputCategory - The output category.

incomingValue - The incoming value.

Method Detail

clone

public CategorizationTreeNode<InputType,OutputType,InteriorType> clone()

Description copied from class: AbstractCloneableSerializable

This makes public the clone method on the Object class and removes the exception that it throws. Its default behavior is to automatically create a clone of the exact type of object that the clone is called on and to copy all primitives but to keep all references, which means it is a shallow copy. Extensions of this class may want to override this method (but call super.clone() to implement a "smart copy". That is, to target the most common use case for creating a copy of the object. Because of the default behavior being a shallow copy, extending classes only need to handle fields that need to have a deeper copy (or those that need to be reset). Some of the methods in ObjectUtil may be helpful in implementing a custom clone method. Note: The contract of this method is that you must use super.clone() as the basis for your implementation.

Specified by:

clone in interface CloneableSerializable

Overrides:

clone in class AbstractDecisionTreeNode<InputType,OutputType,InteriorType>

Returns:

A clone of this object.

getOutput

public OutputType getOutput(InputType input)

Description copied from interface: DecisionTreeNode

Gets the local output of this node for the given input. This is done to determine the output value for a leaf node or the output value in the case that there is no corresponding child node for an input.

Parameters:

input - The input.

Returns:

The local output value for the given input.

getOutputCategory

public OutputType getOutputCategory()

Gets the output category for the node.

Returns:

The output category.

setOutputCategory

public void setOutputCategory(OutputType outputCategory)

Sets the output category for the node.

Parameters:

outputCategory - The output category.