Logo ROOT   6.08/07
Reference Guide
List of all members | Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
TMVA::Rule Class Reference

Definition at line 56 of file Rule.h.

Public Member Functions

 Rule (RuleEnsemble *re, const std::vector< const TMVA::Node * > &nodes)
 the main constructor for a Rule More...
 
 Rule (RuleEnsemble *re)
 the simple constructor More...
 
 Rule (const Rule &other)
 
 Rule ()
 the simple constructor More...
 
virtual ~Rule ()
 destructor More...
 
void * AddXMLTo (void *parent) const
 
void CalcImportance ()
 
Bool_t ContainsVariable (UInt_t iv) const
 check if variable in node More...
 
Bool_t Equal (const Rule &other, Bool_t useCutValue, Double_t maxdist) const
 Compare two rules. More...
 
Bool_t EvalEvent (const Event &e) const
 
Double_t GetCoefficient () const
 
Double_t GetImportance () const
 
Double_t GetImportanceRef () const
 
UInt_t GetNcuts () const
 
Double_t GetNorm () const
 
UInt_t GetNumVarsUsed () const
 
Double_t GetRelImportance () const
 
const RuleCut * GetRuleCut () const
 
const RuleEnsemble * GetRuleEnsemble () const
 
Double_t GetSigma () const
 
Double_t GetSSB () const
 
Double_t GetSSBNeve () const
 
Double_t GetSupport () const
 
Bool_t IsSignalRule () const
 
Bool_t operator< (const Rule &other) const
 comparison operator < More...
 
void operator= (const Rule &other)
 
Bool_t operator== (const Rule &other) const
 comparison operator == More...
 
void PrintLogger (const char *title=0) const
 print function More...
 
void PrintRaw (std::ostream &os) const
 extensive print function used to print info for the weight file More...
 
void ReadFromXML (void *wghtnode)
 read rule from XML More...
 
void ReadRaw (std::istream &os)
 read function (format is the same as written by PrintRaw) More...
 
Double_t RuleDist (const Rule &other, Bool_t useCutValue) const
 Returns: -1.0 : rules are NOT equal, i.e, variables and/or cut directions are wrong >=0: rules are equal apart from the cutvalue, returns d = sqrt(sum(c1-c2)^2) If not useCutValue, the distance is exactly zero if they are equal. More...
 
void SetCoefficient (Double_t v)
 
void SetImportanceRef (Double_t v)
 
void SetMsgType (EMsgType t)
 
void SetNorm (Double_t norm)
 
void SetRuleCut (RuleCut *rc)
 
void SetRuleEnsemble (const RuleEnsemble *re)
 
void SetSSB (Double_t v)
 
void SetSSBNeve (Double_t v)
 
void SetSupport (Double_t v)
 

Private Member Functions

void Copy (const Rule &other)
 copy function More...
 
const TString & GetVarName (Int_t i) const
 returns the name of a rule More...
 
MsgLogger & Log () const
 message logger More...
 
void Print (std::ostream &os) const
 print function More...
 
void SetSigma (Double_t v)
 

Private Attributes

Double_t fCoefficient
 
RuleCut * fCut
 
Double_t fImportance
 
Double_t fImportanceRef
 
MsgLogger * fLogger
 
Double_t fNorm
 
const RuleEnsemble * fRuleEnsemble
 
Double_t fSigma
 
Double_t fSSB
 
Double_t fSSBNeve
 
Double_t fSupport
 

Friends

std::ostream & operator<< (std::ostream &os, const Rule &rule)
 

#include <TMVA/Rule.h>

Constructor & Destructor Documentation

◆ Rule() [1/4]

TMVA::Rule::Rule ( RuleEnsemble *  re,
const std::vector< const TMVA::Node * > &  nodes 
)

the main constructor for a Rule

Definition at line 62 of file Rule.cxx.

◆ Rule() [2/4]

TMVA::Rule::Rule ( RuleEnsemble *  re)

the simple constructor

Definition at line 90 of file Rule.cxx.

◆ Rule() [3/4]

TMVA::Rule::Rule ( const Rule &  other)
inline

Definition at line 70 of file Rule.h.

◆ Rule() [4/4]

TMVA::Rule::Rule ( )

the simple constructor

Definition at line 108 of file Rule.cxx.

◆ ~Rule()

TMVA::Rule::~Rule ( )
virtual

destructor

Definition at line 126 of file Rule.cxx.

Member Function Documentation

◆ AddXMLTo()

void * TMVA::Rule::AddXMLTo ( void *  parent) const

Definition at line 393 of file Rule.cxx.

◆ CalcImportance()

void TMVA::Rule::CalcImportance ( )
inline

Definition at line 105 of file Rule.h.

◆ ContainsVariable()

Bool_t TMVA::Rule::ContainsVariable ( UInt_t  iv) const

check if variable in node

Definition at line 135 of file Rule.cxx.

◆ Copy()

void TMVA::Rule::Copy ( const Rule &  other)
private

copy function

Definition at line 279 of file Rule.cxx.

◆ Equal()

Bool_t TMVA::Rule::Equal ( const Rule &  other,
Bool_t  useCutValue,
Double_t  mindist 
) const

Compare two rules.

useCutValue: true -> calculate a distance between the two rules based on the cut values if the rule cuts are not equal, the distance is < 0 (-1.0) return true if d<mindist false->=""> ignore mindist, return true if rules are equal, ignoring cut values mindist: min distance allowed between rules; if < 0 => set useCutValue=false;

Definition at line 168 of file Rule.cxx.

◆ EvalEvent()

Bool_t TMVA::Rule::EvalEvent ( const Event &  e) const
inline

Definition at line 197 of file Rule.h.

◆ GetCoefficient()

Double_t TMVA::Rule::GetCoefficient ( ) const
inline

Definition at line 147 of file Rule.h.

◆ GetImportance()

Double_t TMVA::Rule::GetImportance ( ) const
inline

Definition at line 151 of file Rule.h.

◆ GetImportanceRef()

Double_t TMVA::Rule::GetImportanceRef ( ) const
inline

Definition at line 152 of file Rule.h.

◆ GetNcuts()

UInt_t TMVA::Rule::GetNcuts ( ) const
inline

Definition at line 139 of file Rule.h.

◆ GetNorm()

Double_t TMVA::Rule::GetNorm ( ) const
inline

Definition at line 150 of file Rule.h.

◆ GetNumVarsUsed()

UInt_t TMVA::Rule::GetNumVarsUsed ( ) const
inline

Definition at line 136 of file Rule.h.

◆ GetRelImportance()

Double_t TMVA::Rule::GetRelImportance ( ) const
inline

Definition at line 108 of file Rule.h.

◆ GetRuleCut()

const RuleCut* TMVA::Rule::GetRuleCut ( ) const
inline

Definition at line 145 of file Rule.h.

◆ GetRuleEnsemble()

const RuleEnsemble* TMVA::Rule::GetRuleEnsemble ( ) const
inline

Definition at line 146 of file Rule.h.

◆ GetSigma()

Double_t TMVA::Rule::GetSigma ( ) const
inline

Definition at line 149 of file Rule.h.

◆ GetSSB()

Double_t TMVA::Rule::GetSSB ( ) const
inline

Definition at line 123 of file Rule.h.

◆ GetSSBNeve()

Double_t TMVA::Rule::GetSSBNeve ( ) const
inline

Definition at line 124 of file Rule.h.

◆ GetSupport()

Double_t TMVA::Rule::GetSupport ( ) const
inline

Definition at line 148 of file Rule.h.

◆ GetVarName()

const TString & TMVA::Rule::GetVarName ( Int_t  i) const
private

returns the name of a rule

Definition at line 271 of file Rule.cxx.

◆ IsSignalRule()

Bool_t TMVA::Rule::IsSignalRule ( ) const
inline

Definition at line 125 of file Rule.h.

◆ Log()

MsgLogger& TMVA::Rule::Log ( ) const
inlineprivate

message logger

Definition at line 190 of file Rule.h.

◆ operator<()

Bool_t TMVA::Rule::operator< ( const Rule &  other) const

comparison operator <

Definition at line 254 of file Rule.cxx.

◆ operator=()

void TMVA::Rule::operator= ( const Rule &  other)
inline

Definition at line 128 of file Rule.h.

◆ operator==()

Bool_t TMVA::Rule::operator== ( const Rule &  other) const

comparison operator ==

Definition at line 246 of file Rule.cxx.

◆ Print()

void TMVA::Rule::Print ( std::ostream &  os) const
private

print function

Definition at line 298 of file Rule.cxx.

◆ PrintLogger()

void TMVA::Rule::PrintLogger ( const char *  title = 0) const

print function

Definition at line 330 of file Rule.cxx.

◆ PrintRaw()

void TMVA::Rule::PrintRaw ( std::ostream &  os) const

extensive print function used to print info for the weight file

Definition at line 362 of file Rule.cxx.

◆ ReadFromXML()

void TMVA::Rule::ReadFromXML ( void *  wghtnode)

read rule from XML

Definition at line 423 of file Rule.cxx.

◆ ReadRaw()

void TMVA::Rule::ReadRaw ( std::istream &  os)

read function (format is the same as written by PrintRaw)

Definition at line 472 of file Rule.cxx.

◆ RuleDist()

Double_t TMVA::Rule::RuleDist ( const Rule &  other,
Bool_t  useCutValue 
) const

Returns: -1.0 : rules are NOT equal, i.e, variables and/or cut directions are wrong >=0: rules are equal apart from the cutvalue, returns d = sqrt(sum(c1-c2)^2) If not useCutValue, the distance is exactly zero if they are equal.

Definition at line 187 of file Rule.cxx.

◆ SetCoefficient()

void TMVA::Rule::SetCoefficient ( Double_t  v)
inline

Definition at line 90 of file Rule.h.

◆ SetImportanceRef()

void TMVA::Rule::SetImportanceRef ( Double_t  v)
inline

Definition at line 102 of file Rule.h.

◆ SetMsgType()

void TMVA::Rule::SetMsgType ( EMsgType  t)

Definition at line 152 of file Rule.cxx.

◆ SetNorm()

void TMVA::Rule::SetNorm ( Double_t  norm)
inline

Definition at line 87 of file Rule.h.

◆ SetRuleCut()

void TMVA::Rule::SetRuleCut ( RuleCut *  rc)
inline

Definition at line 84 of file Rule.h.

◆ SetRuleEnsemble()

void TMVA::Rule::SetRuleEnsemble ( const RuleEnsemble *  re)
inline

Definition at line 81 of file Rule.h.

◆ SetSigma()

void TMVA::Rule::SetSigma ( Double_t  v)
inlineprivate

Definition at line 167 of file Rule.h.

◆ SetSSB()

void TMVA::Rule::SetSSB ( Double_t  v)
inline

Definition at line 96 of file Rule.h.

◆ SetSSBNeve()

void TMVA::Rule::SetSSBNeve ( Double_t  v)
inline

Definition at line 99 of file Rule.h.

◆ SetSupport()

void TMVA::Rule::SetSupport ( Double_t  v)
inline

Definition at line 93 of file Rule.h.

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  os,
const Rule &  rule 
)
friend

Member Data Documentation

◆ fCoefficient

Double_t TMVA::Rule::fCoefficient
private

Definition at line 182 of file Rule.h.

◆ fCut

RuleCut* TMVA::Rule::fCut
private

Definition at line 178 of file Rule.h.

◆ fImportance

Double_t TMVA::Rule::fImportance
private

Definition at line 183 of file Rule.h.

◆ fImportanceRef

Double_t TMVA::Rule::fImportanceRef
private

Definition at line 184 of file Rule.h.

◆ fLogger

MsgLogger* TMVA::Rule::fLogger
mutableprivate

Definition at line 189 of file Rule.h.

◆ fNorm

Double_t TMVA::Rule::fNorm
private

Definition at line 179 of file Rule.h.

◆ fRuleEnsemble

const RuleEnsemble* TMVA::Rule::fRuleEnsemble
private

Definition at line 185 of file Rule.h.

◆ fSigma

Double_t TMVA::Rule::fSigma
private

Definition at line 181 of file Rule.h.

◆ fSSB

Double_t TMVA::Rule::fSSB
private

Definition at line 186 of file Rule.h.

◆ fSSBNeve

Double_t TMVA::Rule::fSSBNeve
private

Definition at line 187 of file Rule.h.

◆ fSupport

Double_t TMVA::Rule::fSupport
private

Definition at line 180 of file Rule.h.

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