SHOGUN  6.1.3
CC45ClassifierTree Class Reference

## Detailed Description

Class C45ClassifierTree implements the C4.5 algorithm for decision tree learning. The algorithm steps are briefy explained below :
.

function C4.5 (R: a set of non-categorical attributes, C: the categorical attribute, S: a training set):
returns a decision tree;
begin
If S consists of records all with the same value for the categorical attribute,
return a single node with that value;
If R is empty,
return a single node with as value the most frequent
of the values of the categorical attribute in C;
[note that then there will be errors, that is, records that will be improperly classified];
For each non-categorical attribute NC in R :
If NC is continuous then first convert it to nominal attribute by separating into 2 classes about a threshold
Find Gain of all attributes
Let D be the attribute with largest Gain(D,S) among attributes in R;
Let $${d_j| j=1,2, .., m}$$ be the values of attribute D;
Let $${S_j| j=1,2, .., m}$$ be the subsets of S consisting respectively of records with value $$d_j$$ for attribute D;
Return a tree with root labeled D and arcs labeled $$d_1, d_2, .., d_m$$ going respectively to the trees
C4.5(R-{D}, C, $$S_1$$), .., C4.5(R-{D}, C, $$S_m$$);
end C4.5;

Definition at line 75 of file C45ClassifierTree.h.

Inheritance diagram for CC45ClassifierTree:
[legend]

## Public Types

typedef CTreeMachineNode< C45TreeNodeDatanode_t

typedef CBinaryTreeMachineNode< C45TreeNodeDatabnode_t

typedef rxcpp::subjects::subject< ObservedValueSGSubject

typedef rxcpp::observable< ObservedValue, rxcpp::dynamic_observable< ObservedValue > > SGObservable

typedef rxcpp::subscriber< ObservedValue, rxcpp::observer< ObservedValue, void, void, void, void > > SGSubscriber

## Public Member Functions

CC45ClassifierTree ()

virtual ~CC45ClassifierTree ()

virtual const char * get_name () const

virtual CMulticlassLabelsapply_multiclass (CFeatures *data=NULL)

void prune_tree (CDenseFeatures< float64_t > *validation_data, CMulticlassLabels *validation_labels, float64_t epsilon=0.f)

SGVector< float64_tget_certainty_vector () const

void set_weights (SGVector< float64_t > w)

SGVector< float64_tget_weights () const

void clear_weights ()

void set_feature_types (SGVector< bool > ft)

SGVector< bool > get_feature_types () const

void clear_feature_types ()

void set_root (CTreeMachineNode< C45TreeNodeData > *root)

CTreeMachineNode< C45TreeNodeData > * get_root ()

CTreeMachineclone_tree ()

int32_t get_num_machines () const

virtual EProblemType get_machine_problem_type () const

virtual bool is_label_valid (CLabels *lab) const

virtual bool train (CFeatures *data=NULL)

virtual CLabelsapply (CFeatures *data=NULL)

virtual CBinaryLabelsapply_binary (CFeatures *data=NULL)

virtual CRegressionLabelsapply_regression (CFeatures *data=NULL)

virtual CStructuredLabelsapply_structured (CFeatures *data=NULL)

virtual CLatentLabelsapply_latent (CFeatures *data=NULL)

virtual void set_labels (CLabels *lab)

virtual CLabelsget_labels ()

void set_max_train_time (float64_t t)

float64_t get_max_train_time ()

virtual EMachineType get_classifier_type ()

void set_solver_type (ESolverType st)

ESolverType get_solver_type ()

virtual void set_store_model_features (bool store_model)

virtual bool train_locked (SGVector< index_t > indices)

virtual float64_t apply_one (int32_t i)

virtual CLabelsapply_locked (SGVector< index_t > indices)

virtual CBinaryLabelsapply_locked_binary (SGVector< index_t > indices)

virtual CRegressionLabelsapply_locked_regression (SGVector< index_t > indices)

virtual CMulticlassLabelsapply_locked_multiclass (SGVector< index_t > indices)

virtual CStructuredLabelsapply_locked_structured (SGVector< index_t > indices)

virtual CLatentLabelsapply_locked_latent (SGVector< index_t > indices)

virtual void data_lock (CLabels *labs, CFeatures *features)

virtual void post_lock (CLabels *labs, CFeatures *features)

virtual void data_unlock ()

virtual bool supports_locking () const

bool is_data_locked () const

SG_FORCED_INLINE bool cancel_computation () const

SG_FORCED_INLINE void pause_computation ()

SG_FORCED_INLINE void resume_computation ()

int32_t ref ()

int32_t ref_count ()

int32_t unref ()

virtual CSGObjectshallow_copy () const

virtual CSGObjectdeep_copy () const

virtual bool is_generic (EPrimitiveType *generic) const

template<class T >
void set_generic ()

template<>
void set_generic ()

template<>
void set_generic ()

template<>
void set_generic ()

template<>
void set_generic ()

template<>
void set_generic ()

template<>
void set_generic ()

template<>
void set_generic ()

template<>
void set_generic ()

template<>
void set_generic ()

template<>
void set_generic ()

template<>
void set_generic ()

template<>
void set_generic ()

template<>
void set_generic ()

template<>
void set_generic ()

template<>
void set_generic ()

void unset_generic ()

virtual void print_serializable (const char *prefix="")

virtual bool save_serializable (CSerializableFile *file, const char *prefix="")

virtual bool load_serializable (CSerializableFile *file, const char *prefix="")

void set_global_io (SGIO *io)

SGIOget_global_io ()

void set_global_parallel (Parallel *parallel)

Parallelget_global_parallel ()

void set_global_version (Version *version)

Versionget_global_version ()

SGStringList< char > get_modelsel_names ()

void print_modsel_params ()

char * get_modsel_param_descr (const char *param_name)

index_t get_modsel_param_index (const char *param_name)

void build_gradient_parameter_dictionary (CMap< TParameter *, CSGObject *> *dict)

bool has (const std::string &name) const

template<typename T >
bool has (const Tag< T > &tag) const

template<typename T , typename U = void>
bool has (const std::string &name) const

template<typename T >
void set (const Tag< T > &_tag, const T &value)

template<typename T , typename U = void>
void set (const std::string &name, const T &value)

template<typename T >
get (const Tag< T > &_tag) const

template<typename T , typename U = void>
get (const std::string &name) const

SGObservableget_parameters_observable ()

void subscribe_to_parameters (ParameterObserverInterface *obs)

void list_observable_parameters ()

virtual void update_parameter_hash ()

virtual bool parameter_hash_changed ()

virtual bool equals (CSGObject *other, float64_t accuracy=0.0, bool tolerant=false)

virtual CSGObjectclone ()

## Public Attributes

SGIOio

Parallelparallel

Versionversion

Parameterm_parameters

Parameterm_model_selection_parameters

uint32_t m_hash

## Static Public Attributes

static const float64_t MISSING =CMath::NOT_A_NUMBER

## Protected Member Functions

virtual bool train_machine (CFeatures *data=NULL)

virtual void store_model_features ()

virtual bool train_require_labels () const

rxcpp::subscription connect_to_signal_handler ()

void reset_computation_variables ()

virtual void on_next ()

virtual void on_pause ()

virtual void on_complete ()

virtual void load_serializable_pre () throw (ShogunException)

virtual void load_serializable_post () throw (ShogunException)

virtual void save_serializable_pre () throw (ShogunException)

virtual void save_serializable_post () throw (ShogunException)

template<typename T >
void register_param (Tag< T > &_tag, const T &value)

template<typename T >
void register_param (const std::string &name, const T &value)

bool clone_parameters (CSGObject *other)

void observe (const ObservedValue value)

void register_observable_param (const std::string &name, const SG_OBS_VALUE_TYPE type, const std::string &description)

## Protected Attributes

CTreeMachineNode< C45TreeNodeData > * m_root

CDynamicObjectArraym_machines

float64_t m_max_train_time

CLabelsm_labels

ESolverType m_solver_type

bool m_store_model_features

bool m_data_locked

std::atomic< bool > m_cancel_computation

std::atomic< bool > m_pause_computation_flag

std::condition_variable m_pause_computation

std::mutex m_mutex

## ◆ bnode_t

 typedef CBinaryTreeMachineNode bnode_t
inherited

bnode_t type- Tree node with max 2 possible children

Definition at line 55 of file TreeMachine.h.

## ◆ node_t

 typedef CTreeMachineNode node_t
inherited

node_t type- Tree node with many possible children

Definition at line 52 of file TreeMachine.h.

## ◆ SGObservable

 inherited

Definition at line 130 of file SGObject.h.

## ◆ SGSubject

 inherited

Definition at line 127 of file SGObject.h.

## ◆ SGSubscriber

 typedef rxcpp::subscriber< ObservedValue, rxcpp::observer > SGSubscriber
inherited

Definition at line 133 of file SGObject.h.

## ◆ CC45ClassifierTree()

 CC45ClassifierTree ( )

constructor

Definition at line 40 of file C45ClassifierTree.cpp.

## ◆ ~CC45ClassifierTree()

 ~CC45ClassifierTree ( )
virtual

destructor

Definition at line 46 of file C45ClassifierTree.cpp.

## ◆ apply()

 CLabels * apply ( CFeatures * data = NULL )
virtualinherited

apply machine to data if data is not specified apply to the current features

Parameters
 data (test)data to be classified
Returns
classified labels

Definition at line 159 of file Machine.cpp.

## ◆ apply_binary()

 CBinaryLabels * apply_binary ( CFeatures * data = NULL )
virtualinherited

apply machine to data in means of binary classification problem

Definition at line 215 of file Machine.cpp.

## ◆ apply_latent()

 CLatentLabels * apply_latent ( CFeatures * data = NULL )
virtualinherited

apply machine to data in means of latent problem

Reimplemented in CLinearLatentMachine.

Definition at line 239 of file Machine.cpp.

## ◆ apply_locked()

 CLabels * apply_locked ( SGVector< index_t > indices )
virtualinherited

Applies a locked machine on a set of indices. Error if machine is not locked

Parameters
 indices index vector (of locked features) that is predicted

Definition at line 194 of file Machine.cpp.

## ◆ apply_locked_binary()

 CBinaryLabels * apply_locked_binary ( SGVector< index_t > indices )
virtualinherited

applies a locked machine on a set of indices for binary problems

Reimplemented in CKernelMachine.

Definition at line 245 of file Machine.cpp.

## ◆ apply_locked_latent()

 CLatentLabels * apply_locked_latent ( SGVector< index_t > indices )
virtualinherited

applies a locked machine on a set of indices for latent problems

Definition at line 273 of file Machine.cpp.

## ◆ apply_locked_multiclass()

 CMulticlassLabels * apply_locked_multiclass ( SGVector< index_t > indices )
virtualinherited

applies a locked machine on a set of indices for multiclass problems

Definition at line 259 of file Machine.cpp.

## ◆ apply_locked_regression()

 CRegressionLabels * apply_locked_regression ( SGVector< index_t > indices )
virtualinherited

applies a locked machine on a set of indices for regression problems

Reimplemented in CKernelMachine.

Definition at line 252 of file Machine.cpp.

## ◆ apply_locked_structured()

 CStructuredLabels * apply_locked_structured ( SGVector< index_t > indices )
virtualinherited

applies a locked machine on a set of indices for structured problems

Definition at line 266 of file Machine.cpp.

## ◆ apply_multiclass()

 CMulticlassLabels * apply_multiclass ( CFeatures * data = NULL )
virtual

classify data using C4.5 Tree

Parameters
 data data to be classified
Returns
MulticlassLabels corresponding to labels of various test vectors

Reimplemented from CMachine.

Definition at line 50 of file C45ClassifierTree.cpp.

## ◆ apply_one()

 virtual float64_t apply_one ( int32_t i )
virtualinherited

applies to one vector

Definition at line 257 of file Machine.h.

## ◆ apply_regression()

 CRegressionLabels * apply_regression ( CFeatures * data = NULL )
virtualinherited

apply machine to data in means of regression problem

Definition at line 221 of file Machine.cpp.

## ◆ apply_structured()

 CStructuredLabels * apply_structured ( CFeatures * data = NULL )
virtualinherited

apply machine to data in means of SO classification problem

Reimplemented in CLinearStructuredOutputMachine.

Definition at line 233 of file Machine.cpp.

 void build_gradient_parameter_dictionary ( CMap< TParameter *, CSGObject *> * dict )
inherited

Builds a dictionary of all parameters in SGObject as well of those of SGObjects that are parameters of this object. Dictionary maps parameters to the objects that own them.

Parameters
 dict dictionary of parameters to be built.

Definition at line 635 of file SGObject.cpp.

## ◆ cancel_computation()

 SG_FORCED_INLINE bool cancel_computation ( ) const
inherited
Returns
whether the algorithm needs to be stopped

Definition at line 319 of file Machine.h.

## ◆ clear_feature_types()

 void clear_feature_types ( )

clear feature types of various features

Definition at line 103 of file C45ClassifierTree.cpp.

## ◆ clear_weights()

 void clear_weights ( )

clear weights of data points

Definition at line 86 of file C45ClassifierTree.cpp.

## ◆ clone()

 CSGObject * clone ( )
virtualinherited

Creates a clone of the current object. This is done via recursively traversing all parameters, which corresponds to a deep copy. Calling equals on the cloned object always returns true although none of the memory of both objects overlaps.

Returns
an identical copy of the given object, which is disjoint in memory. NULL if the clone fails. Note that the returned object is SG_REF'ed

Definition at line 734 of file SGObject.cpp.

## ◆ clone_parameters()

 bool clone_parameters ( CSGObject * other )
protectedinherited

Definition at line 759 of file SGObject.cpp.

## ◆ clone_tree()

 CTreeMachine* clone_tree ( )
inherited

clone tree

Returns
clone of entire tree

Definition at line 97 of file TreeMachine.h.

## ◆ connect_to_signal_handler()

 rxcpp::subscription connect_to_signal_handler ( )
protectedinherited

connect the machine instance to the signal handler

Definition at line 280 of file Machine.cpp.

## ◆ data_lock()

 void data_lock ( CLabels * labs, CFeatures * features )
virtualinherited

Locks the machine on given labels and data. After this call, only train_locked and apply_locked may be called

Only possible if supports_locking() returns true

Parameters
 labs labels used for locking features features used for locking

Reimplemented in CKernelMachine.

Definition at line 119 of file Machine.cpp.

## ◆ data_unlock()

 void data_unlock ( )
virtualinherited

Unlocks a locked machine and restores previous state

Reimplemented in CKernelMachine.

Definition at line 150 of file Machine.cpp.

## ◆ deep_copy()

 CSGObject * deep_copy ( ) const
virtualinherited

A deep copy. All the instance variables will also be copied.

Definition at line 232 of file SGObject.cpp.

## ◆ equals()

 bool equals ( CSGObject * other, float64_t accuracy = 0.0, bool tolerant = false )
virtualinherited

Recursively compares the current SGObject to another one. Compares all registered numerical parameters, recursion upon complex (SGObject) parameters. Does not compare pointers!

May be overwritten but please do with care! Should not be necessary in most cases.

Parameters
 other object to compare with accuracy accuracy to use for comparison (optional) tolerant allows linient check on float equality (within accuracy)
Returns
true if all parameters were equal, false if not

Definition at line 656 of file SGObject.cpp.

## ◆ get() [1/2]

 T get ( const Tag< T > & _tag ) const
inherited

Getter for a class parameter, identified by a Tag. Throws an exception if the class does not have such a parameter.

Parameters
 _tag name and type information of parameter
Returns
value of the parameter identified by the input tag

Definition at line 381 of file SGObject.h.

## ◆ get() [2/2]

 T get ( const std::string & name ) const
inherited

Getter for a class parameter, identified by a name. Throws an exception if the class does not have such a parameter.

Parameters
 name name of the parameter
Returns
value of the parameter corresponding to the input name and type

Definition at line 404 of file SGObject.h.

## ◆ get_certainty_vector()

 SGVector< float64_t > get_certainty_vector ( ) const

certainty of classification done by apply_multiclass. For each data point reaching a leaf node, it computes the ratio of weight of training data with same predicted label that reached that leaf node over the total weight of all training data points that reached the same leaf node

Returns
Vector of certainty values associated with data classified in apply_multiclass

Definition at line 70 of file C45ClassifierTree.cpp.

## ◆ get_classifier_type()

 EMachineType get_classifier_type ( )
virtualinherited

get classifier type

Returns
classifier type NONE

Definition at line 99 of file Machine.cpp.

## ◆ get_feature_types()

 SGVector< bool > get_feature_types ( ) const

set feature types of various features

Returns
bool vector - true for nominal feature false for continuous feature type

Definition at line 98 of file C45ClassifierTree.cpp.

## ◆ get_global_io()

 SGIO * get_global_io ( )
inherited

get the io object

Returns
io object

Definition at line 269 of file SGObject.cpp.

## ◆ get_global_parallel()

 Parallel * get_global_parallel ( )
inherited

get the parallel object

Returns
parallel object

Definition at line 311 of file SGObject.cpp.

## ◆ get_global_version()

 Version * get_global_version ( )
inherited

get the version object

Returns
version object

Definition at line 324 of file SGObject.cpp.

## ◆ get_labels()

 CLabels * get_labels ( )
virtualinherited

get labels

Returns
labels

Definition at line 83 of file Machine.cpp.

## ◆ get_machine_problem_type()

 EProblemType get_machine_problem_type ( ) const
virtualinherited

get problem type

Reimplemented from CMachine.

Reimplemented in CCHAIDTree, and CCARTree.

Definition at line 32 of file BaseMulticlassMachine.cpp.

## ◆ get_max_train_time()

 float64_t get_max_train_time ( )
inherited

get maximum training time

Returns
maximum training time

Definition at line 94 of file Machine.cpp.

## ◆ get_modelsel_names()

 SGStringList< char > get_modelsel_names ( )
inherited
Returns
vector of names of all parameters which are registered for model selection

Definition at line 536 of file SGObject.cpp.

## ◆ get_modsel_param_descr()

 char * get_modsel_param_descr ( const char * param_name )
inherited

Returns description of a given parameter string, if it exists. SG_ERROR otherwise

Parameters
 param_name name of the parameter
Returns
description of the parameter

Definition at line 560 of file SGObject.cpp.

## ◆ get_modsel_param_index()

 index_t get_modsel_param_index ( const char * param_name )
inherited

Returns index of model selection parameter with provided index

Parameters
 param_name name of model selection parameter
Returns
index of model selection parameter with provided name, -1 if there is no such

Definition at line 573 of file SGObject.cpp.

## ◆ get_name()

 virtual const char* get_name ( ) const
virtual

get name

Returns
class name C45ClassifierTree

Reimplemented from CTreeMachine< C45TreeNodeData >.

Definition at line 87 of file C45ClassifierTree.h.

## ◆ get_num_machines()

 int32_t get_num_machines ( ) const
inherited

get number of machines

Returns
number of machines

Definition at line 27 of file BaseMulticlassMachine.cpp.

## ◆ get_parameters_observable()

 SGObservable* get_parameters_observable ( )
inherited

Get parameters observable

Returns
RxCpp observable

Definition at line 415 of file SGObject.h.

## ◆ get_root()

 CTreeMachineNode* get_root ( )
inherited

get root

Returns
root the root node of the tree

Definition at line 88 of file TreeMachine.h.

## ◆ get_solver_type()

 ESolverType get_solver_type ( )
inherited

get solver type

Returns
solver

Definition at line 109 of file Machine.cpp.

## ◆ get_weights()

 SGVector< float64_t > get_weights ( ) const

get weights of data points

Returns
vector of weights

Definition at line 81 of file C45ClassifierTree.cpp.

## ◆ has() [1/3]

 bool has ( const std::string & name ) const
inherited

Checks if object has a class parameter identified by a name.

Parameters
 name name of the parameter
Returns
true if the parameter exists with the input name

Definition at line 304 of file SGObject.h.

## ◆ has() [2/3]

 bool has ( const Tag< T > & tag ) const
inherited

Checks if object has a class parameter identified by a Tag.

Parameters
 tag tag of the parameter containing name and type information
Returns
true if the parameter exists with the input tag

Definition at line 315 of file SGObject.h.

## ◆ has() [3/3]

 bool has ( const std::string & name ) const
inherited

Checks if a type exists for a class parameter identified by a name.

Parameters
 name name of the parameter
Returns
true if the parameter exists with the input name and type

Definition at line 326 of file SGObject.h.

## ◆ is_data_locked()

 bool is_data_locked ( ) const
inherited
Returns
whether this machine is locked

Definition at line 308 of file Machine.h.

## ◆ is_generic()

 bool is_generic ( EPrimitiveType * generic ) const
virtualinherited

If the SGSerializable is a class template then TRUE will be returned and GENERIC is set to the type of the generic.

Parameters
 generic set to the type of the generic if returning TRUE
Returns
TRUE if a class template.

Definition at line 330 of file SGObject.cpp.

## ◆ is_label_valid()

 bool is_label_valid ( CLabels * lab ) const
virtualinherited

check whether the labels is valid.

Parameters
 lab the labels being checked, guaranteed to be non-NULL

Reimplemented from CMachine.

Reimplemented in CCARTree, and CCHAIDTree.

Definition at line 37 of file BaseMulticlassMachine.cpp.

## ◆ list_observable_parameters()

 void list_observable_parameters ( )
inherited

Print to stdout a list of observable parameters

Definition at line 878 of file SGObject.cpp.

 bool load_serializable ( CSerializableFile * file, const char * prefix = "" )
virtualinherited

Load this object from file. If it will fail (returning FALSE) then this object will contain inconsistent data and should not be used!

Parameters
 file where to load from prefix prefix for members
Returns
TRUE if done, otherwise FALSE

Definition at line 403 of file SGObject.cpp.

 void load_serializable_post ( ) throw ( ShogunException )
protectedvirtualinherited

Can (optionally) be overridden to post-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::LOAD_SERIALIZABLE_POST is called.

Exceptions
 ShogunException will be thrown if an error occurs.

Definition at line 460 of file SGObject.cpp.

 void load_serializable_pre ( ) throw ( ShogunException )
protectedvirtualinherited

Can (optionally) be overridden to pre-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::LOAD_SERIALIZABLE_PRE is called.

Exceptions
 ShogunException will be thrown if an error occurs.

Definition at line 455 of file SGObject.cpp.

## ◆ observe()

 void observe ( const ObservedValue value )
protectedinherited

Observe a parameter value and emit them to observer.

Parameters
 value Observed parameter's value

Definition at line 828 of file SGObject.cpp.

## ◆ on_complete()

 virtual void on_complete ( )
protectedvirtualinherited

The action which will be done when the user decides to return to prompt and terminate the program execution

Definition at line 427 of file Machine.h.

## ◆ on_next()

 virtual void on_next ( )
protectedvirtualinherited

The action which will be done when the user decides to premature stop the CMachine execution

Definition at line 411 of file Machine.h.

## ◆ on_pause()

 virtual void on_pause ( )
protectedvirtualinherited

The action which will be done when the user decides to pause the CMachine execution

Definition at line 418 of file Machine.h.

## ◆ parameter_hash_changed()

 bool parameter_hash_changed ( )
virtualinherited
Returns
whether parameter combination has changed since last update

Definition at line 296 of file SGObject.cpp.

## ◆ pause_computation()

 SG_FORCED_INLINE void pause_computation ( )
inherited

Pause the algorithm if the flag is set

Definition at line 327 of file Machine.h.

## ◆ post_lock()

 virtual void post_lock ( CLabels * labs, CFeatures * features )
virtualinherited

post lock

Definition at line 299 of file Machine.h.

## ◆ print_modsel_params()

 void print_modsel_params ( )
inherited

prints all parameter registered for model selection and their type

Definition at line 512 of file SGObject.cpp.

## ◆ print_serializable()

 void print_serializable ( const char * prefix = "" )
virtualinherited

prints registered parameters out

Parameters
 prefix prefix for members

Definition at line 342 of file SGObject.cpp.

## ◆ prune_tree()

 void prune_tree ( CDenseFeatures< float64_t > * validation_data, CMulticlassLabels * validation_labels, float64_t epsilon = 0.f )

prune decision tree - uses reduced error pruning algorithm

At each node, starting from leaf nodes up to the root node, this algorithm checks if removing the subtree gives better results (or somewhat comparable results). If so, it replaces the subtree with a leaf node. The algorithm implemented is recursive which starts with the root node. At each node, it prunes its children first and then itself. As the algorithm goes down each level during recursion, it creates the new set of features by pushing subset into subset stack. While retracting, it pops these subsets to access previous state of feature matrix (see add_subset() and remove_subset() in Shogun documentation).

Parameters
 validation_data feature vectors from validation dataset validation_labels multiclass labels from validation dataset epsilon prune subtree even if there is epsilon loss in accuracy

Definition at line 62 of file C45ClassifierTree.cpp.

## ◆ ref()

 int32_t ref ( )
inherited

increase reference counter

Returns
reference count

Definition at line 186 of file SGObject.cpp.

## ◆ ref_count()

 int32_t ref_count ( )
inherited

display reference counter

Returns
reference count

Definition at line 193 of file SGObject.cpp.

## ◆ register_observable_param()

 void register_observable_param ( const std::string & name, const SG_OBS_VALUE_TYPE type, const std::string & description )
protectedinherited

Register which params this object can emit.

Parameters
 name the param name type the param type description a user oriented description

Definition at line 871 of file SGObject.cpp.

## ◆ register_param() [1/2]

 void register_param ( Tag< T > & _tag, const T & value )
protectedinherited

Registers a class parameter which is identified by a tag. This enables the parameter to be modified by set() and retrieved by get(). Parameters can be registered in the constructor of the class.

Parameters
 _tag name and type information of parameter value value of the parameter

Definition at line 472 of file SGObject.h.

## ◆ register_param() [2/2]

 void register_param ( const std::string & name, const T & value )
protectedinherited

Registers a class parameter which is identified by a name. This enables the parameter to be modified by set() and retrieved by get(). Parameters can be registered in the constructor of the class.

Parameters
 name name of the parameter value value of the parameter along with type information

Definition at line 485 of file SGObject.h.

## ◆ reset_computation_variables()

 void reset_computation_variables ( )
protectedinherited

reset the computation variables

Definition at line 403 of file Machine.h.

## ◆ resume_computation()

 SG_FORCED_INLINE void resume_computation ( )
inherited

Resume current computation (sets the flag)

Definition at line 340 of file Machine.h.

## ◆ save_serializable()

 bool save_serializable ( CSerializableFile * file, const char * prefix = "" )
virtualinherited

Save this object to file.

Parameters
 file where to save the object; will be closed during returning if PREFIX is an empty string. prefix prefix for members
Returns
TRUE if done, otherwise FALSE

Definition at line 348 of file SGObject.cpp.

## ◆ save_serializable_post()

 void save_serializable_post ( ) throw ( ShogunException )
protectedvirtualinherited

Can (optionally) be overridden to post-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::SAVE_SERIALIZABLE_POST is called.

Exceptions
 ShogunException will be thrown if an error occurs.

Reimplemented in CKernel.

Definition at line 470 of file SGObject.cpp.

## ◆ save_serializable_pre()

 void save_serializable_pre ( ) throw ( ShogunException )
protectedvirtualinherited

Can (optionally) be overridden to pre-initialize some member variables which are not PARAMETER::ADD'ed. Make sure that at first the overridden method BASE_CLASS::SAVE_SERIALIZABLE_PRE is called.

Exceptions
 ShogunException will be thrown if an error occurs.

Definition at line 465 of file SGObject.cpp.

## ◆ set() [1/2]

 void set ( const Tag< T > & _tag, const T & value )
inherited

Setter for a class parameter, identified by a Tag. Throws an exception if the class does not have such a parameter.

Parameters
 _tag name and type information of parameter value value of the parameter

Definition at line 342 of file SGObject.h.

## ◆ set() [2/2]

 void set ( const std::string & name, const T & value )
inherited

Setter for a class parameter, identified by a name. Throws an exception if the class does not have such a parameter.

Parameters
 name name of the parameter value value of the parameter along with type information

Definition at line 368 of file SGObject.h.

## ◆ set_feature_types()

 void set_feature_types ( SGVector< bool > ft )

set feature types of various features

Parameters
 ft bool vector true for nominal feature false for continuous feature type

Definition at line 92 of file C45ClassifierTree.cpp.

## ◆ set_generic() [1/16]

 void set_generic ( )
inherited

Definition at line 73 of file SGObject.cpp.

## ◆ set_generic() [2/16]

 void set_generic ( )
inherited

Definition at line 78 of file SGObject.cpp.

## ◆ set_generic() [3/16]

 void set_generic ( )
inherited

Definition at line 83 of file SGObject.cpp.

## ◆ set_generic() [4/16]

 void set_generic ( )
inherited

Definition at line 88 of file SGObject.cpp.

## ◆ set_generic() [5/16]

 void set_generic ( )
inherited

Definition at line 93 of file SGObject.cpp.

## ◆ set_generic() [6/16]

 void set_generic ( )
inherited

Definition at line 98 of file SGObject.cpp.

## ◆ set_generic() [7/16]

 void set_generic ( )
inherited

Definition at line 103 of file SGObject.cpp.

## ◆ set_generic() [8/16]

 void set_generic ( )
inherited

Definition at line 108 of file SGObject.cpp.

## ◆ set_generic() [9/16]

 void set_generic ( )
inherited

Definition at line 113 of file SGObject.cpp.

## ◆ set_generic() [10/16]

 void set_generic ( )
inherited

Definition at line 118 of file SGObject.cpp.

## ◆ set_generic() [11/16]

 void set_generic ( )
inherited

Definition at line 123 of file SGObject.cpp.

## ◆ set_generic() [12/16]

 void set_generic ( )
inherited

Definition at line 128 of file SGObject.cpp.

## ◆ set_generic() [13/16]

 void set_generic ( )
inherited

Definition at line 133 of file SGObject.cpp.

## ◆ set_generic() [14/16]

 void set_generic ( )
inherited

Definition at line 138 of file SGObject.cpp.

## ◆ set_generic() [15/16]

 void set_generic ( )
inherited

Definition at line 143 of file SGObject.cpp.

## ◆ set_generic() [16/16]

 void set_generic ( )
inherited

set generic type to T

## ◆ set_global_io()

 void set_global_io ( SGIO * io )
inherited

set the io object

Parameters
 io io object to use

Definition at line 262 of file SGObject.cpp.

## ◆ set_global_parallel()

 void set_global_parallel ( Parallel * parallel )
inherited

set the parallel object

Parameters
 parallel parallel object to use

Definition at line 275 of file SGObject.cpp.

## ◆ set_global_version()

 void set_global_version ( Version * version )
inherited

set the version object

Parameters
 version version object to use

Definition at line 317 of file SGObject.cpp.

## ◆ set_labels()

 void set_labels ( CLabels * lab )
virtualinherited

set labels

Parameters
 lab labels

Reimplemented in CNeuralNetwork, CGaussianProcessMachine, CCARTree, CStructuredOutputMachine, CRelaxedTree, and CMulticlassMachine.

Definition at line 72 of file Machine.cpp.

## ◆ set_max_train_time()

 void set_max_train_time ( float64_t t )
inherited

set maximum training time

Parameters
 t maximimum training time

Definition at line 89 of file Machine.cpp.

## ◆ set_root()

 void set_root ( CTreeMachineNode< C45TreeNodeData > * root )
inherited

set root

Parameters
 root the root node of the tree

Definition at line 78 of file TreeMachine.h.

## ◆ set_solver_type()

 void set_solver_type ( ESolverType st )
inherited

set solver type

Parameters
 st solver type

Definition at line 104 of file Machine.cpp.

## ◆ set_store_model_features()

 void set_store_model_features ( bool store_model )
virtualinherited

Setter for store-model-features-after-training flag

Parameters
 store_model whether model should be stored after training

Definition at line 114 of file Machine.cpp.

## ◆ set_weights()

 void set_weights ( SGVector< float64_t > w )

set weights of data points

Parameters
 w vector of weights

Definition at line 75 of file C45ClassifierTree.cpp.

## ◆ shallow_copy()

 CSGObject * shallow_copy ( ) const
virtualinherited

A shallow copy. All the SGObject instance variables will be simply assigned and SG_REF-ed.

Reimplemented in CGaussianKernel.

Definition at line 226 of file SGObject.cpp.

## ◆ store_model_features()

 virtual void store_model_features ( )
protectedvirtualinherited

enable unlocked cross-validation - no model features to store

Reimplemented from CMachine.

Definition at line 152 of file TreeMachine.h.

## ◆ subscribe_to_parameters()

 void subscribe_to_parameters ( ParameterObserverInterface * obs )
inherited

Subscribe a parameter observer to watch over params

Definition at line 811 of file SGObject.cpp.

## ◆ supports_locking()

 virtual bool supports_locking ( ) const
virtualinherited
Returns
whether this machine supports locking

Reimplemented in CKernelMachine.

Definition at line 305 of file Machine.h.

## ◆ train()

 bool train ( CFeatures * data = NULL )
virtualinherited

train machine

Parameters
 data training data (parameter can be avoided if distance or kernel-based classifiers are used and distance/kernels are initialized with train data). If flag is set, model features will be stored after training.
Returns
whether training was successful

Reimplemented in CRelaxedTree, CAutoencoder, CLinearMachine, CSGDQN, and COnlineSVMSGD.

Definition at line 43 of file Machine.cpp.

## ◆ train_locked()

 virtual bool train_locked ( SGVector< index_t > indices )
virtualinherited

Trains a locked machine on a set of indices. Error if machine is not locked

NOT IMPLEMENTED

Parameters
 indices index vector (of locked features) that is used for training
Returns
whether training was successful

Reimplemented in CKernelMachine.

Definition at line 248 of file Machine.h.

## ◆ train_machine()

 bool train_machine ( CFeatures * data = NULL )
protectedvirtual

train machine - build C4.5 Tree from training data

Parameters
 data training data

Reimplemented from CMachine.

Definition at line 109 of file C45ClassifierTree.cpp.

## ◆ train_require_labels()

 virtual bool train_require_labels ( ) const
protectedvirtualinherited

returns whether machine require labels for training

Definition at line 397 of file Machine.h.

## ◆ unref()

 int32_t unref ( )
inherited

decrement reference counter and deallocate object if refcount is zero before or after decrementing it

Returns
reference count

Definition at line 200 of file SGObject.cpp.

## ◆ unset_generic()

 void unset_generic ( )
inherited

unset generic type

this has to be called in classes specializing a template class

Definition at line 337 of file SGObject.cpp.

## ◆ update_parameter_hash()

 void update_parameter_hash ( )
virtualinherited

Updates the hash of current parameter combination

Definition at line 282 of file SGObject.cpp.

## ◆ io

 SGIO* io
inherited

io

Definition at line 600 of file SGObject.h.

## ◆ m_cancel_computation

 std::atomic m_cancel_computation
protectedinherited

Cancel computation

Definition at line 448 of file Machine.h.

## ◆ m_data_locked

 bool m_data_locked
protectedinherited

whether data is locked

Definition at line 445 of file Machine.h.

inherited

parameters wrt which we can compute gradients

Definition at line 615 of file SGObject.h.

## ◆ m_hash

 uint32_t m_hash
inherited

Hash of parameter values

Definition at line 618 of file SGObject.h.

## ◆ m_labels

 CLabels* m_labels
protectedinherited

labels

Definition at line 436 of file Machine.h.

## ◆ m_machines

 CDynamicObjectArray* m_machines
protectedinherited

machines

Definition at line 56 of file BaseMulticlassMachine.h.

## ◆ m_max_train_time

 float64_t m_max_train_time
protectedinherited

maximum training time

Definition at line 433 of file Machine.h.

## ◆ m_model_selection_parameters

 Parameter* m_model_selection_parameters
inherited

model selection parameters

Definition at line 612 of file SGObject.h.

## ◆ m_mutex

 std::mutex m_mutex
protectedinherited

Definition at line 457 of file Machine.h.

## ◆ m_parameters

 Parameter* m_parameters
inherited

parameters

Definition at line 609 of file SGObject.h.

## ◆ m_pause_computation

 std::condition_variable m_pause_computation
protectedinherited

Conditional variable to make threads wait

Definition at line 454 of file Machine.h.

## ◆ m_pause_computation_flag

 std::atomic m_pause_computation_flag
protectedinherited

Pause computation flag

Definition at line 451 of file Machine.h.

## ◆ m_root

 CTreeMachineNode* m_root
protectedinherited

tree root

Definition at line 156 of file TreeMachine.h.

## ◆ m_solver_type

 ESolverType m_solver_type
protectedinherited

solver type

Definition at line 439 of file Machine.h.

## ◆ m_store_model_features

 bool m_store_model_features
protectedinherited

whether model features should be stored after training

Definition at line 442 of file Machine.h.

## ◆ MISSING

 const float64_t MISSING =CMath::NOT_A_NUMBER
static

denotes that a feature in a vector is missing MISSING = NOT_A_NUMBER

Definition at line 213 of file C45ClassifierTree.h.

## ◆ parallel

 Parallel* parallel
inherited

parallel

Definition at line 603 of file SGObject.h.

## ◆ version

 Version* version
inherited

version

Definition at line 606 of file SGObject.h.

The documentation for this class was generated from the following files:

SHOGUN Machine Learning Toolbox - Documentation