Logo ROOT  

Reference Guide
 
Loading...
Searching...
No Matches
List of all members | Classes | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
TMVA::Config Class Reference
TMVA

Singleton class for global configuration settings used by TMVA.

Definition at line 49 of file Config.h.

Classes

class  IONames
 
class  VariablePlotting
 

Public Member Functions

void DisableMT ()
 Force disabling MT running and release the thread pool by using instead seriaql execution.
 
Bool_t DrawProgressBar () const
 
void EnableMT (int numthreads=0)
 Enable MT in TMVA (by default is on when ROOT::EnableImplicitMT() is set.
 
IONames & GetIONames ()
 
ROOT::TThreadExecutor & GetMultiThreadExecutor ()
 
UInt_t GetNCpu ()
 
UInt_t GetNumWorkers () const
 
Executor & GetThreadExecutor ()
 Get executor class for multi-thread usage In case when MT is not enabled will return a serial executor.
 
VariablePlotting & GetVariablePlotting ()
 
virtual TClass * IsA () const
 
Bool_t IsMTEnabled () const
 Check if IMT is enabled.
 
Bool_t IsSilent () const
 
void SetDrawProgressBar (Bool_t d)
 
void SetNumWorkers (UInt_t n)
 
void SetSilent (Bool_t s)
 
void SetUseColor (Bool_t uc)
 
void SetWriteOptionsReference (Bool_t w)
 
virtual void Streamer (TBuffer &)
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
Bool_t UseColor () const
 
Bool_t WriteOptionsReference () const
 

Static Public Member Functions

static TClass * Class ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static void DestroyInstance ()
 static function: destroy TMVA instance
 
static Config & Instance ()
 static function: returns TMVA instance
 

Public Attributes

class TMVA::Config::IONames fIONames
 
class TMVA::Config::VariablePlotting fVariablePlotting
 

Protected Attributes

Executor fExecutor
 

Private Member Functions

 Config ()
 constructor - set defaults
 
 Config (const Config &)
 
virtual ~Config ()
 destructor
 
MsgLogger & Log () const
 
Config & operator= (const Config &)
 

Private Attributes

std::atomic< Bool_t > fDrawProgressBar
 draw progress bar to indicate training evolution
 
MsgLogger * fLogger
 ! message logger
 
std::atomic< UInt_t > fNWorkers
 Default number of workers for multi-process jobs.
 
std::atomic< Bool_t > fSilent
 no output at all
 
std::atomic< Bool_t > fUseColoredConsole
 coloured standard output
 
std::atomic< Bool_t > fWriteOptionsReference
 if set true: Configurable objects write file with option reference
 

Static Private Attributes

static std::atomic< Config * > fgConfigPtr { 0 }
 

#include <TMVA/Config.h>

Constructor & Destructor Documentation

◆ Config() [1/2]

TMVA::Config::Config ( )
private

constructor - set defaults

Definition at line 51 of file Config.cxx.

◆ Config() [2/2]

TMVA::Config::Config ( const Config &  )
private

◆ ~Config()

TMVA::Config::~Config ( )
privatevirtual

destructor

Definition at line 82 of file Config.cxx.

Member Function Documentation

◆ Class()

static TClass * TMVA::Config::Class ( )
static
Returns
TClass describing this class

◆ Class_Name()

static const char * TMVA::Config::Class_Name ( )
static
Returns
Name of this class

◆ Class_Version()

static constexpr Version_t TMVA::Config::Class_Version ( )
inlinestaticconstexpr
Returns
Version of this class

Definition at line 148 of file Config.h.

◆ DeclFileName()

static const char * TMVA::Config::DeclFileName ( )
inlinestatic
Returns
Name of the file containing the class declaration

Definition at line 148 of file Config.h.

◆ DestroyInstance()

void TMVA::Config::DestroyInstance ( )
static

static function: destroy TMVA instance

Definition at line 90 of file Config.cxx.

◆ DisableMT()

void TMVA::Config::DisableMT ( )
inline

Force disabling MT running and release the thread pool by using instead seriaql execution.

Definition at line 87 of file Config.h.

◆ DrawProgressBar()

Bool_t TMVA::Config::DrawProgressBar ( ) const
inline

Definition at line 68 of file Config.h.

◆ EnableMT()

void TMVA::Config::EnableMT ( int  numthreads = 0)
inline

Enable MT in TMVA (by default is on when ROOT::EnableImplicitMT() is set.

Definition at line 84 of file Config.h.

◆ GetIONames()

IONames & TMVA::Config::GetIONames ( )
inline

Definition at line 98 of file Config.h.

◆ GetMultiThreadExecutor()

ROOT::TThreadExecutor & TMVA::Config::GetMultiThreadExecutor ( )
inline

Definition at line 76 of file Config.h.

◆ GetNCpu()

UInt_t TMVA::Config::GetNCpu ( )
inline

Definition at line 70 of file Config.h.

◆ GetNumWorkers()

UInt_t TMVA::Config::GetNumWorkers ( ) const
inline

Definition at line 72 of file Config.h.

◆ GetThreadExecutor()

Executor & TMVA::Config::GetThreadExecutor ( )
inline

Get executor class for multi-thread usage In case when MT is not enabled will return a serial executor.

Definition at line 81 of file Config.h.

◆ GetVariablePlotting()

VariablePlotting & TMVA::Config::GetVariablePlotting ( )
inline

Definition at line 97 of file Config.h.

◆ Instance()

TMVA::Config & TMVA::Config::Instance ( )
static

static function: returns TMVA instance

Definition at line 98 of file Config.cxx.

◆ IsA()

virtual TClass * TMVA::Config::IsA ( ) const
inlinevirtual
Returns
TClass describing current object

Definition at line 148 of file Config.h.

◆ IsMTEnabled()

Bool_t TMVA::Config::IsMTEnabled ( ) const
inline

Check if IMT is enabled.

Definition at line 90 of file Config.h.

◆ IsSilent()

Bool_t TMVA::Config::IsSilent ( ) const
inline

Definition at line 62 of file Config.h.

◆ Log()

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

Definition at line 146 of file Config.h.

◆ operator=()

Config & TMVA::Config::operator= ( const Config &  )
private

◆ SetDrawProgressBar()

void TMVA::Config::SetDrawProgressBar ( Bool_t  d)
inline

Definition at line 69 of file Config.h.

◆ SetNumWorkers()

void TMVA::Config::SetNumWorkers ( UInt_t  n)
inline

Definition at line 73 of file Config.h.

◆ SetSilent()

void TMVA::Config::SetSilent ( Bool_t  s)
inline

Definition at line 63 of file Config.h.

◆ SetUseColor()

void TMVA::Config::SetUseColor ( Bool_t  uc)
inline

Definition at line 60 of file Config.h.

◆ SetWriteOptionsReference()

void TMVA::Config::SetWriteOptionsReference ( Bool_t  w)
inline

Definition at line 66 of file Config.h.

◆ Streamer()

virtual void TMVA::Config::Streamer ( TBuffer &  )
virtual

◆ StreamerNVirtual()

void TMVA::Config::StreamerNVirtual ( TBuffer &  ClassDef_StreamerNVirtual_b)
inline

Definition at line 148 of file Config.h.

◆ UseColor()

Bool_t TMVA::Config::UseColor ( ) const
inline

Definition at line 59 of file Config.h.

◆ WriteOptionsReference()

Bool_t TMVA::Config::WriteOptionsReference ( ) const
inline

Definition at line 65 of file Config.h.

Member Data Documentation

◆ fDrawProgressBar

std::atomic<Bool_t> TMVA::Config::fDrawProgressBar
private

draw progress bar to indicate training evolution

Definition at line 140 of file Config.h.

◆ fExecutor

Executor TMVA::Config::fExecutor
protected

Definition at line 52 of file Config.h.

◆ fgConfigPtr

std::atomic< TMVA::Config * > TMVA::Config::fgConfigPtr { 0 }
staticprivate

Definition at line 137 of file Config.h.

◆ fIONames

class TMVA::Config::IONames TMVA::Config::fIONames

◆ fLogger

MsgLogger* TMVA::Config::fLogger
mutableprivate

! message logger

Definition at line 145 of file Config.h.

◆ fNWorkers

std::atomic<UInt_t> TMVA::Config::fNWorkers
private

Default number of workers for multi-process jobs.

Definition at line 141 of file Config.h.

◆ fSilent

std::atomic<Bool_t> TMVA::Config::fSilent
private

no output at all

Definition at line 143 of file Config.h.

◆ fUseColoredConsole

std::atomic<Bool_t> TMVA::Config::fUseColoredConsole
private

coloured standard output

Definition at line 142 of file Config.h.

◆ fVariablePlotting

class TMVA::Config::VariablePlotting TMVA::Config::fVariablePlotting

◆ fWriteOptionsReference

std::atomic<Bool_t> TMVA::Config::fWriteOptionsReference
private

if set true: Configurable objects write file with option reference

Definition at line 144 of file Config.h.

Libraries for TMVA::Config:
[legend]
The documentation for this class was generated from the following files: