Definition at line 92 of file CvSplit.h.

Public Member Functions
	CvSplitKFolds (UInt_t numFolds, TString splitExpr="", Bool_t stratified=kTRUE, UInt_t seed=100)
	Splits a dataset into k folds, ready for use in cross validation.

	~CvSplitKFolds () override

TClass *	IsA () const override

void	MakeKFoldDataSet (DataSetInfo &dsi) override
	Prepares a DataSet for cross validation.

void	Streamer (TBuffer &) override
	Stream an object of class TObject.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TMVA::CvSplit
	CvSplit (UInt_t numFolds)

virtual	~CvSplit ()

UInt_t	GetNumFolds ()

Bool_t	NeedsRebuild ()

virtual void	PrepareFoldDataSet (DataSetInfo &dsi, UInt_t foldNumber, Types::ETreeType tt)
	Set training and test set vectors of dataset described by `dsi`.

virtual void	RecombineKFoldDataSet (DataSetInfo &dsi, Types::ETreeType tt=Types::kTraining)

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TMVA::Configurable
	Configurable (const TString &theOption="")
	constructor

virtual	~Configurable ()
	default destructor

void	AddOptionsXMLTo (void *parent) const
	write options to XML file

template<class T >
void	AddPreDefVal (const T &)

template<class T >
void	AddPreDefVal (const TString &optname, const T &)

void	CheckForUnusedOptions () const
	checks for unused options in option string

template<class T >
TMVA::OptionBase *	DeclareOptionRef (T &ref, const TString &name, const TString &desc)

template<class T >
OptionBase *	DeclareOptionRef (T &ref, const TString &name, const TString &desc="")

template<class T >
TMVA::OptionBase *	DeclareOptionRef (T *&ref, Int_t size, const TString &name, const TString &desc)

template<class T >
OptionBase *	DeclareOptionRef (T *&ref, Int_t size, const TString &name, const TString &desc="")

const char *	GetConfigDescription () const

const char *	GetConfigName () const

const TString &	GetOptions () const

MsgLogger &	Log () const

virtual void	ParseOptions ()
	options parser

void	PrintOptions () const
	prints out the options set in the options string and the defaults

void	ReadOptionsFromStream (std::istream &istr)
	read option back from the weight file

void	ReadOptionsFromXML (void *node)

void	SetConfigDescription (const char *d)

void	SetConfigName (const char *n)

void	SetMsgType (EMsgType t)

void	SetOptions (const TString &s)

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

void	WriteOptionsToStream (std::ostream &o, const TString &prefix) const
	write options to output stream (e.g. in writing the MVA weight files

Public Member Functions inherited from TNamed
	TNamed ()

	TNamed (const char name, const char title)

	TNamed (const TNamed &named)
	TNamed copy ctor.

	TNamed (const TString &name, const TString &title)

virtual	~TNamed ()
	TNamed destructor.

void	Clear (Option_t *option="") override
	Set name and title to empty strings ("").

TObject *	Clone (const char *newname="") const override
	Make a clone of an object using the Streamer facility.

Int_t	Compare (const TObject *obj) const override
	Compare two TNamed objects.

void	Copy (TObject &named) const override
	Copy this to obj.

virtual void	FillBuffer (char *&buffer)
	Encode TNamed into output buffer.

const char *	GetName () const override
	Returns name of object.

const char *	GetTitle () const override
	Returns title of object.

ULong_t	Hash () const override
	Return hash value for this object.

TClass *	IsA () const override

Bool_t	IsSortable () const override

void	ls (Option_t *option="") const override
	List TNamed name and title.

TNamed &	operator= (const TNamed &rhs)
	TNamed assignment operator.

void	Print (Option_t *option="") const override
	Print TNamed name and title.

virtual void	SetName (const char *name)
	Set the name of the TNamed.

virtual void	SetNameTitle (const char name, const char title)
	Set all the TNamed parameters (name and title).

virtual void	SetTitle (const char *title="")
	Set the title of the TNamed.

virtual Int_t	Sizeof () const
	Return size of the TNamed part of the TObject.

void	Streamer (TBuffer &) override
	Stream an object of class TObject.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TObject
	TObject ()
	TObject constructor.

	TObject (const TObject &object)
	TObject copy ctor.

virtual	~TObject ()
	TObject destructor.

void	AbstractMethod (const char *method) const
	Use this method to implement an "abstract" method that you don't want to leave purely abstract.

virtual void	AppendPad (Option_t *option="")
	Append graphics object to current pad.

virtual void	Browse (TBrowser *b)
	Browse object. May be overridden for another default action.

ULong_t	CheckedHash ()
	Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.

virtual const char *	ClassName () const
	Returns name of class to which the object belongs.

virtual void	Delete (Option_t *option="")
	Delete this object.

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Computes distance from point (px,py) to the object.

virtual void	Draw (Option_t *option="")
	Default Draw method for all objects.

virtual void	DrawClass () const
	Draw class inheritance tree of the class to which this object belongs.

virtual TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current selected pad with: `gROOT->SetSelectedPad(c1)`.

virtual void	Dump () const
	Dump contents of object on stdout.

virtual void	Error (const char method, const char msgfmt,...) const
	Issue error message.

virtual void	Execute (const char method, const char params, Int_t *error=nullptr)
	Execute method on this object with the given parameter string, e.g.

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=nullptr)
	Execute method on this object with parameters stored in the TObjArray.

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)
	Execute action corresponding to an event at (px,py).

virtual void	Fatal (const char method, const char msgfmt,...) const
	Issue fatal error message.

virtual TObject *	FindObject (const char *name) const
	Must be redefined in derived classes.

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes.

virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object.

virtual const char *	GetIconName () const
	Returns mime type name of object.

virtual char *	GetObjectInfo (Int_t px, Int_t py) const
	Returns string containing info about the object at position (px,py).

virtual Option_t *	GetOption () const

virtual UInt_t	GetUniqueID () const
	Return the unique object id.

virtual Bool_t	HandleTimer (TTimer *timer)
	Execute action in response of a timer timing out.

Bool_t	HasInconsistentHash () const
	Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.

virtual void	Info (const char method, const char msgfmt,...) const
	Issue info message.

virtual Bool_t	InheritsFrom (const char *classname) const
	Returns kTRUE if object inherits from class "classname".

virtual Bool_t	InheritsFrom (const TClass *cl) const
	Returns kTRUE if object inherits from TClass cl.

virtual void	Inspect () const
	Dump contents of this object in a graphics canvas.

void	InvertBit (UInt_t f)

Bool_t	IsDestructed () const
	IsDestructed.

virtual Bool_t	IsEqual (const TObject *obj) const
	Default equal comparison (objects are equal if they have the same address in memory).

virtual Bool_t	IsFolder () const
	Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).

R__ALWAYS_INLINE Bool_t	IsOnHeap () const

R__ALWAYS_INLINE Bool_t	IsZombie () const

void	MayNotUse (const char *method) const
	Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).

virtual Bool_t	Notify ()
	This method must be overridden to handle object notification.

void	Obsolete (const char method, const char asOfVers, const char *removedFromVers) const
	Use this method to declare a method obsolete.

void	operator delete (void *ptr)
	Operator delete.

void	operator delete[] (void *ptr)
	Operator delete [].

void *	operator new (size_t sz)

void *	operator new (size_t sz, void *vp)

void *	operator new[] (size_t sz)

void *	operator new[] (size_t sz, void *vp)

TObject &	operator= (const TObject &rhs)
	TObject assignment operator.

virtual void	Paint (Option_t *option="")
	This method must be overridden if a class wants to paint itself.

virtual void	Pop ()
	Pop on object drawn in a pad to the top of the display list.

virtual Int_t	Read (const char *name)
	Read contents of object with specified name from the current directory.

virtual void	RecursiveRemove (TObject *obj)
	Recursively remove this object from a list.

void	ResetBit (UInt_t f)

virtual void	SaveAs (const char filename="", Option_t option="") const
	Save this object in the file specified by filename.

virtual void	SavePrimitive (std::ostream &out, Option_t *option="")
	Save a primitive as a C++ statement(s) on output stream "out".

void	SetBit (UInt_t f)

void	SetBit (UInt_t f, Bool_t set)
	Set or unset the user status bits as specified in f.

virtual void	SetDrawOption (Option_t *option="")
	Set drawing option for object.

virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

virtual void	SysError (const char method, const char msgfmt,...) const
	Issue system error message.

R__ALWAYS_INLINE Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

virtual void	UseCurrentStyle ()
	Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.

virtual void	Warning (const char method, const char msgfmt,...) const
	Issue warning message.

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory.

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory.

Static Public Member Functions
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TMVA::CvSplit
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TMVA::Configurable
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TNamed
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TObject
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

static Longptr_t	GetDtorOnly ()
	Return destructor only flag.

static Bool_t	GetObjectStat ()
	Get status of object stat flag.

static void	SetDtorOnly (void *obj)
	Set destructor only flag.

static void	SetObjectStat (Bool_t stat)
	Turn on/off tracking of objects in the TObjectTable.

Private Member Functions
std::vector< UInt_t >	GetEventIndexToFoldMapping (UInt_t nEntries, UInt_t numFolds, UInt_t seed=100)
	Generates a vector of fold assignments.

std::vector< std::vector< Event * > >	SplitSets (std::vector< TMVA::Event * > &oldSet, UInt_t numFolds, UInt_t numClasses)
	Split sets for into k-folds.

Private Attributes
friend	CrossValidation

std::map< const TMVA::Event *, UInt_t >	fEventToFoldMapping

UInt_t	fSeed

std::unique_ptr< CvSplitKFoldsExpr >	fSplitExpr

TString	fSplitExprString
	! Expression used to split data into folds. Should output values between 0 and numFolds.

Bool_t	fStratified
	If true, use stratified split. (Balance class presence in each fold).

Additional Inherited Members
Public Types inherited from TObject
enum	{ kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff }

enum	{ kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) }

enum	EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }

enum	EStatusBits { kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) , kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 )) }

Protected Types inherited from TObject
enum	{ kOnlyPrepStep = (1ULL << ( 3 )) }

Protected Member Functions inherited from TMVA::Configurable
void	EnableLooseOptions (Bool_t b=kTRUE)

const TString &	GetReferenceFile () const

Bool_t	LooseOptionCheckingEnabled () const

void	ResetSetFlag ()
	resets the IsSet flag for all declare options to be called before options are read from stream

void	WriteOptionsReferenceToFile ()
	write complete options to output stream

Protected Member Functions inherited from TObject
virtual void	DoError (int level, const char location, const char fmt, va_list va) const
	Interface to ErrorHandler (protected).

void	MakeZombie ()

Protected Attributes inherited from TMVA::CvSplit
Bool_t	fMakeFoldDataSet

UInt_t	fNumFolds

std::vector< std::vector< TMVA::Event * > >	fTestEvents

std::vector< std::vector< TMVA::Event * > >	fTrainEvents

Protected Attributes inherited from TMVA::Configurable
MsgLogger *	fLogger
	! message logger

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

#include <TMVA/CvSplit.h>

Inheritance diagram for TMVA::CvSplitKFolds:

[legend]

Constructor & Destructor Documentation

◆ CvSplitKFolds()

TMVA::CvSplitKFolds::CvSplitKFolds	(	UInt_t	numFolds,
		TString	splitExpr = `""`,
		Bool_t	stratified = `kTRUE`,
		UInt_t	seed = `100`
	)

Splits a dataset into k folds, ready for use in cross validation.

Parameters

[in]	numFolds	Number of folds to split data into
[in]	stratified	If true, use stratified splitting, balancing the number of events across classes and folds. If false, no such balancing is done. For
[in]	splitExpr	Expression used to split data into folds. If `""` a random assignment will be done. Otherwise the expression is fed into a TFormula and evaluated per event. The resulting value is the fold assignment.
[in]	seed	Used only when using random splitting (i.e. when `splitExpr` is `""`). Seed is used to initialise the random number generator when assigning events to folds.

Definition at line 243 of file CvSplit.cxx.

◆ ~CvSplitKFolds()

TMVA::CvSplitKFolds::~CvSplitKFolds ( )

inlineoverride

Definition at line 98 of file CvSplit.h.

Member Function Documentation

◆ Class()

static TClass * TMVA::CvSplitKFolds::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * TMVA::CvSplitKFolds::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t TMVA::CvSplitKFolds::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 117 of file CvSplit.h.

◆ DeclFileName()

static const char * TMVA::CvSplitKFolds::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 117 of file CvSplit.h.

◆ GetEventIndexToFoldMapping()

std::vector< UInt_t > TMVA::CvSplitKFolds::GetEventIndexToFoldMapping	(	UInt_t	nEntries,
		UInt_t	numFolds,
		UInt_t	seed = `100`
	)

private

Generates a vector of fold assignments.

Parameters

[in]	nEntries	Number of events in range
[in]	numFolds	Number of folds to split data into
[in]	seed	Random seed

Randomly assigns events to numFolds folds. Each fold will hold at most nEntries / numFolds + 1 events.

Definition at line 293 of file CvSplit.cxx.

◆ IsA()

TClass * TMVA::CvSplitKFolds::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TMVA::CvSplit.

Definition at line 117 of file CvSplit.h.

◆ MakeKFoldDataSet()

void TMVA::CvSplitKFolds::MakeKFoldDataSet ( DataSetInfo & dsi )

overridevirtual

Prepares a DataSet for cross validation.

Implements TMVA::CvSplit.

Definition at line 255 of file CvSplit.cxx.

◆ SplitSets()

std::vector< std::vector< TMVA::Event * > > TMVA::CvSplitKFolds::SplitSets	(	std::vector< TMVA::Event * > &	oldSet,
		UInt_t	numFolds,
		UInt_t	numClasses
	)

private

Split sets for into k-folds.

Parameters

[in]	oldSet	Original, unsplit, events
[in]	numFolds	Number of folds to split data into
[in]	numClasses	number of classes to stratify into

Definition at line 320 of file CvSplit.cxx.

◆ Streamer()

void TMVA::CvSplitKFolds::Streamer ( TBuffer & R__b )

overridevirtual

Stream an object of class TObject.

Reimplemented from TMVA::CvSplit.

◆ StreamerNVirtual()

void TMVA::CvSplitKFolds::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 117 of file CvSplit.h.

Member Data Documentation

◆ CrossValidation

friend TMVA::CvSplitKFolds::CrossValidation

private

Definition at line 94 of file CvSplit.h.

◆ fEventToFoldMapping

std::map<const TMVA::Event *, UInt_t> TMVA::CvSplitKFolds::fEventToFoldMapping

private

Definition at line 114 of file CvSplit.h.

◆ fSeed

UInt_t TMVA::CvSplitKFolds::fSeed

private

Definition at line 107 of file CvSplit.h.

◆ fSplitExpr

std::unique_ptr<CvSplitKFoldsExpr> TMVA::CvSplitKFolds::fSplitExpr

private

Definition at line 109 of file CvSplit.h.

◆ fSplitExprString

TString TMVA::CvSplitKFolds::fSplitExprString

private

! Expression used to split data into folds. Should output values between 0 and numFolds.

Definition at line 108 of file CvSplit.h.

◆ fStratified

Bool_t TMVA::CvSplitKFolds::fStratified

private

If true, use stratified split. (Balance class presence in each fold).

Definition at line 110 of file CvSplit.h.

Libraries for TMVA::CvSplitKFolds:

[legend]

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

tmva/tmva/inc/TMVA/CvSplit.h
tmva/tmva/src/CvSplit.cxx

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ CvSplitKFolds()

◆ ~CvSplitKFolds()

Member Function Documentation

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ DeclFileName()

◆ GetEventIndexToFoldMapping()

◆ IsA()

◆ MakeKFoldDataSet()

◆ SplitSets()

◆ Streamer()

◆ StreamerNVirtual()

Member Data Documentation

◆ CrossValidation

◆ fEventToFoldMapping

◆ fSeed

◆ fSplitExpr

◆ fSplitExprString

◆ fStratified