name: DecisionTreeBase <TObject> : public BiGraph<TObject>

synopsis:

This class is never used directly. It is inherited by all DecisionTree
classes.  Users will mainly interact with it indirectly by using some of
the enumerations included in the class definition, and its protected
data, which plays an important part in the control structure for all
DecisionTree classes.

quick start:

PhoneticDecisionTree pdt;
pdt.setStopMode(DecisionTreeBase::DEPTH);
pdt.setDepth(3);

description:

The DecisionTreeBase class is inherited by all DecisionTree classes, and contains some information (data and methods) expected to be common to all such classes. For example, variables that hold debugging information, stop-mode, run-mode and depth are stored in DecisionTreeBase.

However, this information is never accessed by instantiating an DecisionTreeBase object directly. Rather, this information is accessed via the inherited class. A typical case is shown in the quick start example above. PhoneticDecisiontree is an DecisionTree class that inherits DecisionTreeBase. The set methods invoked above are available through inheritance. The data members that store this information are contained in DecisionTreeBase.

dependencies:

public constants:

define the class name:

static const String CLASS_NAME = L"DecisionTreeBase";

define an enumeration for all possible stopping rules for splitting:
```
enum STOPMODE { PURE = 0, THRESH, DEPTH, DEF_STOPMODE = PURE };
```

define an enumeration for run mode

enum RUNMODE { TRAIN = 0, TEST, DEF_RUNMODE = TRAIN };

define static NameMap objects:

static const NameMap STOPMODE_MAP = L"PURE = 0, THRESH, DEPTH, DEF_STOPMODE = PURE";

static const NameMap RUNMODE_MAP = L"TRAIN = 0, TEST, DEF_RUNMODE = TRAIN";

define i/o related variables:

const String DecisionTreeBase::PARAM_DBGL(L"debug_level");

const String DecisionTreeBase::PARAM_STOPMODE(L"stopmode");

const String DecisionTreeBase::PARAM_RUNMODE(L"runmode");

define the default values and arguments: these are some useful constants common to all decision-trees
```
static const long DEF_DEPTH = 0;
```

error codes:

error codes:
```
static const long ERR = 00100200;
```

protected data:

data structure declarations:

typedef Pair<String, SingleLinkedList<String> > Attribute;

typedef SingleLinkedList<Attribute> Attributes;

stopmode type:
```
STOPMODE stopmode_d;
```
runmode type:
```
RUNMODE runmode_d;
```
define parameters that are not part of the i/o for the class:
```
long depth_d;
```
debugging parameters:
```
DebugLevel debug_level_d;
```

required public methods:

static methods: diagnose method is moved outside the class header file and defined in the DecisionTreeBaseDiagnose.h in order to avoid issues related to preprocessing of the diagnose code
```
static const SysString& name();
```
```
static boolean diagnose(Integral::DEBUG debug_level);
```
debug methods: note that setDebug method is not virtual since it operates on protected data found in this class.
```
boolean setDebug(Integral::DEBUG level);
```
```
boolean debug(const unichar* message) const;
```

destructor/constructor(s):

~DecisionTreeBase();

DecisionTreeBase();

DecisionTreeBase(const DecisionTreeBase& arg);

assign methods:

virtual boolean assign(const DecisionTreeBase& arg);

i/o methods:

virtual long sofSize() const = 0;

virtual boolean read(Sof& sof, long tag, const String& name) = 0;

virtual boolean write(Sof& sof, long tag, const String& name) const = 0;

virtual boolean readData(Sof& sof, const String& pname, long size, boolean param, boolean nested) = 0;

virtual boolean writeData(Sof& sof, const String& pname) const = 0;

equality methods:

virtual boolean eq(const DecisionTreeBase& arg) const;

memory management methods: new and delete methods are omitted since only the derived classes will be used
```
virtual boolean clear(Integral::CMODE ctype = Integral::DEF_CMODE);
```

class-specific public methods:

set methods:

virtual boolean setStopMode(STOPMODE stopmode);

virtual boolean setRunMode(RUNMODE runmode);

virtual boolean setDepth(long& depth);

get methods:

STOPMODE getStopMode() const;

RUNMODE getRunMode() const;

long getDepth();

boolean getLeafNodes(BiGraphVertex<TObject>& node, SingleLinkedList<BiGraphVertex<TObject> >& leaf_nodes);

boolean getAllLeafNodes(BiGraphVertex<TObject>& node, SingleLinkedList<BiGraphVertex<TObject> >& leaf_nodes);

DecisionTreeBase interface contract methods:

virtual boolean runDecisionTree() = 0;

virtual boolean setParser(SofParser* parser);

private methods:

none.

examples:

Since this class is never called directly, there are no examples.

notes:

DecisionTreeBase is used by all Decision-Tree classes such as PhoneticDecisionTree etc.