Utility class to build Tree models for a <class>DeepSee.PMML.Dataset</class> object. More...

Inheritance diagram for TreeBuilder:

[legend]

Collaboration diagram for TreeBuilder:

[legend]

Public Member Functions
	Build (_.Library.Integer pMaxDepth)
	Utility class to build Tree models for a <class>DeepSee.PMML.Dataset</class> object. More...

_.Library.Status	FindSplits (_.Library.Integer pNode, pSplits)
	Returns an unsorted array of candidate splits for node pNode: More...

_.Library.Status	GetInvertedFilter (pFilter, pInverted)
	Returns the inverse of pFilter, equivalent to a boolean NOT of the entire pFilter.

_.Library.Status	GetNodeFilters (_.Library.Integer pNode, pFilters)
	Returns the combination of filter conditions (pFilters) a record should satisfy. More...

_.Library.Status	MergeFilters (pFilter, pOtherFilter, _.Library.String pLogic)
	Appends pOtherFilter to pFilter using pLogic logic.

_.Library.Status	Print (_.Library.Integer pNode, _.Library.Integer pLevel, _.Library.Boolean pPrintDistribution)
	Prints the tree (starting with pNode) to the terminal.

_.Library.Status	Reset ()
	After changing building parameters, run this method to erase the current tree structure so. More...

_.Library.Status	SplitNode (_.Library.Integer pNode)
	Splits node pNode in <property>SplitsPerNode</property> sub-nodes (or fewer, if. More...

Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...

_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...

_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...

_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...

_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Public Attributes
	ConsiderNullValues
	Whether or not to consider null (missing) values for split criteria. More...

	Dataset
	The dataset to mine. More...

	MinimalSplitCoverage
	Minimal % of the total number of records represented by a node that should be covered by a. More...

	SplitScoringAlgorithm
	Which metric to use to judge split quality. More...

	SplitsPerNode
	Default (maximum) number of branches per node. More...

	TargetField
	The target field whose value is to be derived through this tree. More...

	TrackDistributions
	Whether or not to track distribution information for tree nodes. More...

	Tree
	..Tree = $i More...

Additional Inherited Members
Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...

	JAVATYPE = None
	The Java type to be used when exported.

	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Detailed Description

Utility class to build Tree models for a <class>DeepSee.PMML.Dataset</class> object.

Member Function Documentation

◆ Build()

Build ( _.Library.Integer pMaxDepth )

Utility class to build Tree models for a <class>DeepSee.PMML.Dataset</class> object.

Builds a tree structure with a maximum depth of pMaxDepth.

If a tree structure was already built, this method silently exits. Use <method>Reset</method> to erase an existing tree structure.

◆ FindSplits()

_.Library.Status FindSplits	(	_.Library.Integer	pNode,
			pSplits
	)

Returns an unsorted array of candidate splits for node pNode:

   pSplits(n) = $lb(score, coverage, targetValue, confidence, recordCount, isLeaf)
   pSplits(n,"condition") = ...

◆ GetNodeFilters()

_.Library.Status GetNodeFilters	(	_.Library.Integer	pNode,
			pFilters
	)

Returns the combination of filter conditions (pFilters) a record should satisfy.

to end up in node pNode. This is a combination of the node's own condition, its full ancestry and any prior siblings' conditions.

◆ Reset()

_.Library.Status Reset ( )

After changing building parameters, run this method to erase the current tree structure so.

<method>Build</method> can be run again.

◆ SplitNode()

_.Library.Status SplitNode ( _.Library.Integer pNode )

Splits node pNode in <property>SplitsPerNode</property> sub-nodes (or fewer, if.

not enough candidate splits satisfy coverage and other selection criteria).

Member Data Documentation

◆ ConsiderNullValues

ConsiderNullValues

Whether or not to consider null (missing) values for split criteria.

◆ Dataset

Dataset

The dataset to mine.

◆ MinimalSplitCoverage

MinimalSplitCoverage

Minimal % of the total number of records represented by a node that should be covered by a.

branch. If a branch covers fewer records than this value, it is ignored

◆ SplitScoringAlgorithm

SplitScoringAlgorithm

Which metric to use to judge split quality.

This metric is returned as the split "score"

by <method>FindSplits</method>

◆ SplitsPerNode

SplitsPerNode

Default (maximum) number of branches per node.

◆ TargetField

TargetField

The target field whose value is to be derived through this tree.

This field should be part of <property>Dataset</property>.

◆ TrackDistributions

TrackDistributions

Whether or not to track distribution information for tree nodes.

◆ Tree

Tree

..Tree = $i

..Tree(NodeId) = $lb(parent, targetValue, confidence, count, isLeaf) ..Tree(NodeId, "condition") = [AND|OR|$lb(field, operator, value)] ..Tree(NodeId, "ch", ChildNode) = "" ..Tree(NodeId, "distribution", value) = count

Public Member Functions

Public Attributes

Additional Inherited Members