Detailed Description

template<typename ParticleType>
class KVTemplateParticleCondition< ParticleType >

An object for handling particle selection.

Template Parameters

ParticleType class which is at least a base class of the particles to be selected

A KVTemplateParticleCondition object can be used to select particles to include in data analysis (see KVEventSelector::SetParticleConditions()), in the calculation of global variables (see KVVarGlob::SetSelection()), or in iterations over events (see KVTemplateEvent).

The Test() method returns true or false for a given nucleus depending on whether or not the condition is fulfilled. Combinations of selections can be performed using Boolean logic operations && and ||.

Lambda expressions were introduced in C++11 and provide an easy way to define small functions on the fly inside code. The lambda must take a const ParticleType* pointer as argument and return a boolean, e.g.:

KVTemplateParticleCondition<KVNucleus> l1("Z>2", [](const KVNucleus* nuc){ return nuc->GetZ()>2; });

KVTemplateParticleCondition<KVReconstructedNucleus> l2("Emeasured & Vpar>0", [](const KVReconstructedNucleus* nuc){ return nuc->IsCalibrated() && nuc->GetVpar()>0; });

KVNucleus

Description of properties and kinematics of atomic nuclei.

Definition KVNucleus.h:126

KVNucleus::GetZ

Int_t GetZ() const

Return the number of proton / atomic number.

Definition KVNucleus.cpp:773

KVParticle::GetVpar

Double_t GetVpar() const

Definition KVParticle.h:675

KVReconstructedNucleus

Nuclei reconstructed from data measured by a detector array .

Definition KVReconstructedNucleus.h:33

KVReconstructedNucleus::IsCalibrated

Bool_t IsCalibrated() const

Definition KVReconstructedNucleus.h:293

KVTemplateParticleCondition

An object for handling particle selection.

Definition KVTemplateParticleCondition.h:67

Note the first argument to the constructor is a name which the user is free to define in order to remember what the condition does.

Like any lambda expressions, variables can be 'captured' from the surrounding scope, which can be useful in some situations. For example, given the following definitions:

int zmin = 3;

KVParticleCondition l3("Z>zmin", [&](const KVNucleus* nuc){ return nuc->GetZ()>=zmin; });

then the limit for the selection can be changed dynamically like so:

KVNucleus N("7Li");
l3.Test(&N);      ==> returns true
zmin=5;
l3.Test(&N);      ==> returns false

Note: KVParticleCondition is an alias for KVTemplateParticleCondition<KVNucleus>.

Definition at line 67 of file KVTemplateParticleCondition.h.

#include <KVTemplateParticleCondition.h>

Inheritance diagram for KVTemplateParticleCondition< ParticleType >:

[legend]

Public Member Functions
	KVTemplateParticleCondition ()

	KVTemplateParticleCondition (const Char_t *cond)

	KVTemplateParticleCondition (const KVString &cond)

	KVTemplateParticleCondition (const KVString &name, const LambdaFunc &F)

	KVTemplateParticleCondition (const KVTemplateParticleCondition &obj)

	~KVTemplateParticleCondition ()

void	AddExtraInclude (const Char_t *inc_file)

void	Copy (TObject &obj) const

bool	IsLambda () const

Bool_t	IsSet () const

KVTemplateParticleCondition &	operator&= (const KVTemplateParticleCondition &other)

KVTemplateParticleCondition &	operator= (const KVString &sel)

KVTemplateParticleCondition &	operator= (const KVTemplateParticleCondition &obj)

KVTemplateParticleCondition &	operator= (const LambdaFunc &f)

KVTemplateParticleCondition &	operator\|= (const KVTemplateParticleCondition &other)

void	Print (Option_t *opt="") const

void	Set (const KVString &cond)

void	Set (const KVString &name, const LambdaFunc &F)

void	SetParticleClassName (const Char_t *cl)

Bool_t	Test (const ParticleType &nuc) const

Bool_t	Test (const ParticleType *nuc) const

Public Member Functions inherited from KVBase
	KVBase ()
	Default constructor.

	KVBase (const Char_t name, const Char_t title="")
	Ctor for object with given name and type.

	KVBase (const KVBase &)
	copy ctor

virtual	~KVBase ()

virtual void	Clear (Option_t *opt="")
	Clear object properties : name, type/title, number, label.

const Char_t *	GetLabel () const

UInt_t	GetNumber () const

UInt_t	GetNumberOfObjects () const

virtual TObject *	GetObject () const

virtual const Char_t *	GetType () const

Bool_t	HasLabel () const

virtual Bool_t	IsCalled (const Char_t *name) const

Bool_t	IsLabelled (const Char_t *l) const

virtual Bool_t	IsType (const Char_t *typ) const

virtual void	List ()

KVBase &	operator= (const KVBase &)
	copy assignment operator

Double_t	ProtectedGetX (const TF1 *func, Double_t val, int &status, Double_t xmin=0.0, Double_t xmax=0.0) const

void	SetLabel (const Char_t *lab)

virtual void	SetNumber (UInt_t num)

virtual void	SetType (const Char_t *str)

Public Member Functions inherited from TNamed
	TNamed ()

	TNamed (const char name, const char title)

	TNamed (const TNamed &named)

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

virtual	~TNamed ()

void	Clear (Option_t *option="") override

TObject *	Clone (const char *newname="") const override

Int_t	Compare (const TObject *obj) const override

void	Copy (TObject &named) const override

virtual void	FillBuffer (char *&buffer)

const char *	GetName () const override

const char *	GetTitle () const override

ULong_t	Hash () const override

TClass *	IsA () const override

Bool_t	IsSortable () const override

void	ls (Option_t *option="") const override

TNamed &	operator= (const TNamed &rhs)

void	Print (Option_t *option="") const override

virtual void	SetName (const char *name)

virtual void	SetNameTitle (const char name, const char title)

virtual void	SetTitle (const char *title="")

virtual Int_t	Sizeof () const

void	Streamer (TBuffer &) override

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TObject
	TObject ()

	TObject (const TObject &object)

virtual	~TObject ()

void	AbstractMethod (const char *method) const

virtual void	AppendPad (Option_t *option="")

virtual void	Browse (TBrowser *b)

ULong_t	CheckedHash ()

virtual const char *	ClassName () const

virtual void	Delete (Option_t *option="")

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)

virtual void	Draw (Option_t *option="")

virtual void	DrawClass () const

virtual TObject *	DrawClone (Option_t *option="") const

virtual void	Dump () const

virtual void	Error (const char method, const char msgfmt,...) const

virtual void	Execute (const char method, const char params, Int_t *error=nullptr)

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=nullptr)

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)

virtual void	Fatal (const char method, const char msgfmt,...) const

virtual TObject *	FindObject (const char *name) const

virtual TObject *	FindObject (const TObject *obj) const

virtual Option_t *	GetDrawOption () const

virtual const char *	GetIconName () const

virtual char *	GetObjectInfo (Int_t px, Int_t py) const

virtual Option_t *	GetOption () const

virtual UInt_t	GetUniqueID () const

virtual Bool_t	HandleTimer (TTimer *timer)

Bool_t	HasInconsistentHash () const

virtual void	Info (const char method, const char msgfmt,...) const

virtual Bool_t	InheritsFrom (const char *classname) const

virtual Bool_t	InheritsFrom (const TClass *cl) const

virtual void	Inspect () const

void	InvertBit (UInt_t f)

Bool_t	IsDestructed () const

virtual Bool_t	IsEqual (const TObject *obj) const

virtual Bool_t	IsFolder () const

R__ALWAYS_INLINE Bool_t	IsOnHeap () const

R__ALWAYS_INLINE Bool_t	IsZombie () const

void	MayNotUse (const char *method) const

virtual Bool_t	Notify ()

void	Obsolete (const char method, const char asOfVers, const char *removedFromVers) const

void	operator delete (void *ptr)

void	operator delete (void ptr, void vp)

void	operator delete[] (void *ptr)

void	operator delete[] (void ptr, void vp)

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)

virtual void	Paint (Option_t *option="")

virtual void	Pop ()

virtual Int_t	Read (const char *name)

virtual void	RecursiveRemove (TObject *obj)

void	ResetBit (UInt_t f)

virtual void	SaveAs (const char filename="", Option_t option="") const

virtual void	SavePrimitive (std::ostream &out, Option_t *option="")

void	SetBit (UInt_t f)

void	SetBit (UInt_t f, Bool_t set)

virtual void	SetDrawOption (Option_t *option="")

virtual void	SetUniqueID (UInt_t uid)

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

virtual void	SysError (const char method, const char msgfmt,...) const

R__ALWAYS_INLINE Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

virtual void	UseCurrentStyle ()

virtual void	Warning (const char method, const char msgfmt,...) const

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const

Static Public Member Functions
static void	PrintOptimizedList ()

Static Public Member Functions inherited from KVBase
static Bool_t	AreEqual (Double_t x, Double_t y, Long64_t maxdif=1)
	Comparison between two 64-bit floating-point values.

static void	BackupFileWithDate (const Char_t *path)

static void	CombineFiles (const Char_t file1, const Char_t file2, const Char_t *newfilename, Bool_t keep=kTRUE)

static void	Deprecated (const char method, const char advice)

static Bool_t	FindClassSourceFiles (const Char_t class_name, KVString &imp_file, KVString &dec_file, const Char_t dir_name=".")

static Bool_t	FindExecutable (TString &exec, const Char_t *path="$(PATH)")

static const Char_t *	FindFile (const Char_t *search, TString &wfil)

static const Char_t *	GetBINDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetDATABASEFilePath ()

static const Char_t *	GetDATADIRFilePath (const Char_t *namefile="")

static Bool_t	GetDataSetEnv (const Char_t dataset, const Char_t type, Bool_t defval)

static const Char_t *	GetDataSetEnv (const Char_t dataset, const Char_t type, const Char_t *defval)

static Double_t	GetDataSetEnv (const Char_t dataset, const Char_t type, Double_t defval)

static const Char_t *	GetETCDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetExampleFilePath (const Char_t library, const Char_t namefile)
	Return full path to example file for given library (="KVMultiDet", "BackTrack", etc.)

static const Char_t *	GetINCDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetKVBuildDate ()
	Returns KaliVeda build date.

static const Char_t *	GetKVBuildDir ()
	Returns top-level directory used for build.

static const Char_t *	GetKVBuildTime ()
	Returns KaliVeda build time.

static const Char_t *	GetKVBuildType ()
	Returns KaliVeda build type (cmake build: Release, Debug, RelWithDebInfo, ...)

static const Char_t *	GetKVBuildUser ()
	Returns username of person who performed build.

static const Char_t *	GetKVSourceDir ()
	Returns top-level directory of source tree used for build.

static const Char_t *	GetKVVersion ()
	Returns KaliVeda version string.

static const Char_t *	GetLIBDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetListOfPlugins (const Char_t *base)

static const Char_t *	GetListOfPluginURIs (const Char_t *base)

static const Char_t *	GetPluginURI (const Char_t base, const Char_t plugin)

static void	GetTempFileName (TString &base)

static const Char_t *	GetTEMPLATEDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetWORKDIRFilePath (const Char_t *namefile="")

static const Char_t *	gitBranch ()
	Returns git branch of sources.

static const Char_t *	gitCommit ()
	Returns last git commit of sources.

static void	InitEnvironment ()

static bool	is_gnuinstall ()

static Bool_t	IsThisAPlugin (const TString &uri, TString &base)

static TPluginHandler *	LoadPlugin (const Char_t base, const Char_t uri="0")

static Bool_t	OpenContextMenu (const char method, TObject obj, const char *alt_method_name="")

static void	OpenTempFile (TString &base, std::ofstream &fp)

static void	PrintSplashScreen ()
	Prints welcome message and infos on version etc.

static Bool_t	SearchAndOpenKVFile (const Char_t name, KVSQLite::database &dbfile, const Char_t kvsubdir="")

static Bool_t	SearchAndOpenKVFile (const Char_t name, std::ifstream &file, const Char_t kvsubdir="", KVLockfile *locks=0)

static Bool_t	SearchAndOpenKVFile (const Char_t name, std::ofstream &file, const Char_t kvsubdir="", KVLockfile *locks=0)

static Bool_t	SearchKVFile (const Char_t name, TString &fullpath, const Char_t kvsubdir="")

static const Char_t *	WorkingDirectory ()

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 ()

static Bool_t	GetObjectStat ()

static void	SetDtorOnly (void *obj)

static void	SetObjectStat (Bool_t stat)

Private Types
using	LambdaFunc = std::function< bool(const ParticleType *)>
	number of classes using this as an optimized condition

enum class	LogOp { AND , OR }

Private Member Functions
void	CreateClassFactory () const

void	logical_operator_lambda_condition_test () const

void	Optimize () const
	false if optimisation failed (can't load generated code)

virtual bool	optimized_test (const ParticleType *) const

void	SetClassFactory (KVClassFactory *CF)

Private Attributes
KVClassFactory *	cf

KVString	fClassName

KVString	fCondition

KVString	fCondition_brackets

KVString	fCondition_raw

LambdaFunc	fLambdaCondition

Int_t	fNUsing

const KVTemplateParticleCondition *	fOptimal

KVString	fOptimizedClassName
	used to generate code for optimisation

Bool_t	fOptOK
	name of generated class used for optimisation

enum KVTemplateParticleCondition::LogOp	fOpType

LambdaFunc	fSavedLambda1

LambdaFunc	fSavedLambda2

Static Private Attributes
static KVHashList	fgOptimized

Friends
KVTemplateParticleCondition	operator&& (const KVTemplateParticleCondition &A, const KVTemplateParticleCondition &B)

KVTemplateParticleCondition	operator\|\| (const KVTemplateParticleCondition &A, const KVTemplateParticleCondition &B)

Additional Inherited Members
Public Types inherited from KVBase
enum	EKaliVedaBits { kIsKaliVedaObject = BIT(23) }

Public Types inherited from TObject
enum	EDeprecatedStatusBits

enum	EStatusBits

Public Attributes inherited from TObject
	kBitMask

	kCanDelete

	kCannotPick

	kHasUUID

	kInconsistent

	kInvalidObject

	kIsOnHeap

	kIsReferenced

	kMustCleanup

	kNoContextMenu

	kNotDeleted

	kObjInCanvas

	kOverwrite

	kSingleKey

	kWriteDelete

	kZombie

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

void	MakeZombie ()

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

Protected Attributes inherited from TObject
	kOnlyPrepStep

Member Typedef Documentation

◆ LambdaFunc

template<typename ParticleType >

using KVTemplateParticleCondition< ParticleType >::LambdaFunc = std::function<bool(const ParticleType*)>

private

number of classes using this as an optimized condition

Definition at line 70 of file KVTemplateParticleCondition.h.

Member Enumeration Documentation

◆ LogOp

template<typename ParticleType >

enum class KVTemplateParticleCondition::LogOp

strongprivate

Enumerator
AND
OR

Definition at line 73 of file KVTemplateParticleCondition.h.

Constructor & Destructor Documentation

◆ KVTemplateParticleCondition() [1/5]

template<typename ParticleType >

KVTemplateParticleCondition< ParticleType >::KVTemplateParticleCondition ( )

inline

default ctor

Definition at line 228 of file KVTemplateParticleCondition.h.

◆ KVTemplateParticleCondition() [2/5]

template<typename ParticleType >

KVTemplateParticleCondition< ParticleType >::KVTemplateParticleCondition ( const KVString & cond )

inline

Deprecated:: Particle conditions using strings should not be used, only lambda functions. This constructor is kept for backwards compatibility only.

Create named object and set condition. This must be a valid C++ expression using _NUC_ instead and in place of a const KVNucleus* pointer to the particle to be tested, for example

KVParticleCondition c1("_NUC_->GetZ()>2");

KVParticleCondition c2("_NUC_->GetVpar()>0");

c1

return c1

c2

return c2

Note that the methods used in the selection do not have to be limited to the methods of the KVNucleus class. The 'real' class of the object passed to Test() can be used to cast the base pointer up (or is it down?) to the required pointer type at execution. In this case, you must call the method SetParticleClassName() with the name of the class to use in the cast.

Note that the first call to Test() automatically causes the 'optimization' of the KVParticleCondition, which means that a class implementing the required condition is generated and compiled on the fly before continuing (see method Optimize()).

Definition at line 238 of file KVTemplateParticleCondition.h.

◆ KVTemplateParticleCondition() [3/5]

template<typename ParticleType >

KVTemplateParticleCondition< ParticleType >::KVTemplateParticleCondition ( const Char_t * cond )

inline

Deprecated:: Particle conditions using strings should not be used, only lambda functions. This constructor is kept for backwards compatibility only.

Create named object and set condition. This must be a valid C++ expression using _NUC_ instead and in place of a const KVNucleus* pointer to the particle to be tested, for example

KVParticleCondition c1("_NUC_->GetZ()>2");

KVParticleCondition c2("_NUC_->GetVpar()>0");

Note that the methods used in the selection do not have to be limited to the methods of the KVNucleus class. The 'real' class of the object passed to Test() can be used to cast the base pointer up (or is it down?) to the required pointer type at execution. In this case, you must call the method SetParticleClassName() with the name of the class to use in the cast.

Note that the first call to Test() automatically causes the 'optimization' of the KVParticleCondition, which means that a class implementing the required condition is generated and compiled on the fly before continuing (see method Optimize()).

Definition at line 267 of file KVTemplateParticleCondition.h.

◆ KVTemplateParticleCondition() [4/5]

template<typename ParticleType >

KVTemplateParticleCondition< ParticleType >::KVTemplateParticleCondition ( const KVTemplateParticleCondition< ParticleType > & obj )

inline

Copy constructor. Create new condition which is a copy of existing condition, obj.

Definition at line 296 of file KVTemplateParticleCondition.h.

◆ KVTemplateParticleCondition() [5/5]

template<typename ParticleType >

KVTemplateParticleCondition< ParticleType >::KVTemplateParticleCondition	(	const KVString &	name,
		const LambdaFunc &	F
	)

inline

Create named object using lambda expression for condition The lambda must take a const ParticleType* pointer as argument and return a boolean, e.g.:

KVTemplateParticleCondition<KVNucleus> l1("Z>2", [](const KVNucleus* nuc){ return nuc->GetZ()>2; });

KVTemplateParticleCondition<KVReconstructedNucleus> l2("Emeasured & Vpar>0", [](const KVReconstructedNucleus* nuc){ return nuc->IsCalibrated() && nuc->GetVpar()>0; });

Note the first argument to the constructor is a name which the user is free to define in order to remember what the condition does.

Like any lambda expressions, variables can be 'captured' from the surrounding scope, which can be useful in some situations. For example, given the following definitions:

int zmin = 3;

KVParticleCondition l3("Z>zmin", [&](const KVNucleus* nuc){ return nuc->GetZ()>=zmin; });

then the limit for the selection can be changed dynamically like so:

KVNucleus N("7Li");
l3.Test(&N); ==> returns true
zmin=5;
l3.Test(&N); ==> returns false

Definition at line 307 of file KVTemplateParticleCondition.h.

◆ ~KVTemplateParticleCondition()

template<typename ParticleType >

KVTemplateParticleCondition< ParticleType >::~KVTemplateParticleCondition ( )

inline

default dtor

do not delete optimized condition unless we are the last to use it

Definition at line 344 of file KVTemplateParticleCondition.h.

Member Function Documentation

◆ AddExtraInclude()

template<typename ParticleType >

void KVTemplateParticleCondition< ParticleType >::AddExtraInclude ( const Char_t * inc_file )

inline

Deprecated:: Particle conditions using strings should not be used, only lambda functions. This constructor is kept for backwards compatibility only.

Optimisation of KVParticleCondition::Test() implies the automatic generation of a new class which implements the selection required by the user (see Optimize()).

If the user's condition depends on objects of classes other than the family of particle classes (TLorentVector <- KVParticle <- KVNucleus ...) there will not be by default the necessary '#include' directive for the classes in question in the generated class; the required plugin for Test() to function will not load. In this case, the user should call this method with the name of each '#include' file to be added to the class implementation.

Example:

KVParticleCondition p("_NUC_->GetVpar()>=gDataAnalyser->GetKinematics()->GetNucleus(1)->GetVpar()");

p

winID h TVirtualViewer3D TVirtualGLPainter p

Optimization will not work, as:

gDataAnalyser pointer to current analysis manager (KVDataAnalyser object), defined in KVDataAnalyser.h
gDataAnalyser->GetKinematics() returns a pointer to a KV2Body object, defined in KV2Body.h

Therefore, for this condition to work, the user must first call the methods :

p.AddExtraInclude("KVDataAnalyser.h");

p.AddExtraInclude("KV2Body.h");

before the first call to p.Test() (when optimization occurs).

Definition at line 436 of file KVTemplateParticleCondition.h.

◆ Copy()

template<typename ParticleType >

void KVTemplateParticleCondition< ParticleType >::Copy ( TObject & obj ) const

inlinevirtual

Copy this to obj

force first call to Test to try optimization if existing optimized version exists in static list, pointer will be reset

Reimplemented from KVBase.

Definition at line 471 of file KVTemplateParticleCondition.h.

◆ CreateClassFactory()

template<typename ParticleType >

void KVTemplateParticleCondition< ParticleType >::CreateClassFactory ( ) const

inlineprivate

Initialises KVClassFactory object used for optimization if it doesn't exist

unique name for new class

only first 8 characters are unique

create new class

Definition at line 201 of file KVTemplateParticleCondition.h.

◆ IsLambda()

template<typename ParticleType >

bool KVTemplateParticleCondition< ParticleType >::IsLambda ( ) const

inline

Returns: true if this condition is defined using a lambda expression

Definition at line 338 of file KVTemplateParticleCondition.h.

◆ IsSet()

template<typename ParticleType >

Bool_t KVTemplateParticleCondition< ParticleType >::IsSet ( ) const

inline

Return kTRUE if a condition/selection has been defined

If this is not true, Test() will return true for all and any nuclei.

Definition at line 666 of file KVTemplateParticleCondition.h.

◆ logical_operator_lambda_condition_test()

template<typename ParticleType >

void KVTemplateParticleCondition< ParticleType >::logical_operator_lambda_condition_test ( ) const

inlineprivate

check if we were created by && or || and haven't been initialized yet

Definition at line 75 of file KVTemplateParticleCondition.h.

◆ operator&=()

template<typename ParticleType >

KVTemplateParticleCondition & KVTemplateParticleCondition< ParticleType >::operator&= ( const KVTemplateParticleCondition< ParticleType > & other )

inline

Replace current condition with a logical 'AND' between itself and other

Both conditions must be of same type, i.e. if one uses a lambda expression, the other must also use a lambda expression.

Definition at line 632 of file KVTemplateParticleCondition.h.

◆ operator=() [1/3]

template<typename ParticleType >

KVTemplateParticleCondition & KVTemplateParticleCondition< ParticleType >::operator= ( const KVString & sel )

inline

Deprecated:: Particle conditions using strings should not be used, only lambda functions. This constructor is kept for backwards compatibility only.

Set condition using pseudo-code in string (replacing any previous definition).

This must be a valid C++ expression using _NUC_ instead and in place of a const KVNucleus* pointer to the particle to be tested, for example

KVParticleCondition c1("_NUC_->GetZ()>2");

KVParticleCondition c2("_NUC_->GetVpar()>0");

Note that the methods used in the selection do not have to be limited to the methods of the KVNucleus class. The 'real' class of the object passed to Test() can be used to cast the base pointer up (or is it down?) to the required pointer type at execution. In this case, you must call the method SetParticleClassName() with the name of the class to use in the cast.

Definition at line 499 of file KVTemplateParticleCondition.h.

◆ operator=() [2/3]

template<typename ParticleType >

KVTemplateParticleCondition & KVTemplateParticleCondition< ParticleType >::operator= ( const KVTemplateParticleCondition< ParticleType > & obj )

inline

Set condition to be same as for existing KVParticleCondition object

Definition at line 492 of file KVTemplateParticleCondition.h.

◆ operator=() [3/3]

template<typename ParticleType >

KVTemplateParticleCondition & KVTemplateParticleCondition< ParticleType >::operator= ( const LambdaFunc & f )

inline

Set condition using lambda expression (replacing any previous definition).

Definition at line 521 of file KVTemplateParticleCondition.h.

◆ operator|=()

template<typename ParticleType >

KVTemplateParticleCondition & KVTemplateParticleCondition< ParticleType >::operator|= ( const KVTemplateParticleCondition< ParticleType > & other )

inline

Replace current condition with a logical 'OR' between itself and other

Both conditions must be of same type, i.e. if one uses a lambda expression, the other must also use a lambda expression.

Definition at line 620 of file KVTemplateParticleCondition.h.

◆ Optimize()

template<typename ParticleType >

void KVTemplateParticleCondition< ParticleType >::Optimize ( ) const

inlineprivate

false if optimisation failed (can't load generated code)

Generate a new class which inherits from KVParticleCondition but having a Test() method which tests explicitly the condition which is set by the user.

If needed, the KVNucleus pointer argument will be upcasted to the type given to SetParticleClassName().

The new class is added to the list of plugins of type KVParticleCondition, then an instance of the class is generated and a pointer to it stored in member KVParticleCondition::fOptimal.

This object is then used in the Test() method of this object to test the condition.

If compilation fails, the condition will evaluate to kFALSE for all subsequent calls.

Info("Optimize", "Using existing optimized condition %p", fOptimal);

add Test() method

write body of method

upcasting pointer - we need to add corresponding #include to '.cpp' file

generate .cpp and .h for new class

add plugin for new class

load plugin

we set fOptimal to a non-zero value to avoid calling Optimize every time that Test() is called subsequently.

execute constructor

we set fOptimal to a non-zero value to avoid calling Optimize every time that Test() is called subsequently.

add to list of optimized conditions

Definition at line 106 of file KVTemplateParticleCondition.h.

◆ optimized_test()

template<typename ParticleType >

virtual bool KVTemplateParticleCondition< ParticleType >::optimized_test ( const ParticleType * ) const

inlineprivatevirtual

Definition at line 197 of file KVTemplateParticleCondition.h.

◆ Print()

template<typename ParticleType >

void KVTemplateParticleCondition< ParticleType >::Print ( Option_t * opt = "" ) const

inlinevirtual

Print informations on object

Reimplemented from KVBase.

Definition at line 643 of file KVTemplateParticleCondition.h.

◆ PrintOptimizedList()

template<typename ParticleType >

static void KVTemplateParticleCondition< ParticleType >::PrintOptimizedList ( )

inlinestatic

Definition at line 662 of file KVTemplateParticleCondition.h.

◆ Set() [1/2]

template<typename ParticleType >

void KVTemplateParticleCondition< ParticleType >::Set ( const KVString & cond )

inline

Deprecated:: Particle conditions using strings should not be used, only lambda functions. This constructor is kept for backwards compatibility only.

Set particle condition criteria.

These must be valid C++ expressions using NUC instead and in place of a pointer to the particle to be tested. Note that the methods used in the selection do not have to be limited to the KVNucleus class. The 'real' class of the object passed to Test() will be used to cast the base (KVNucleus) pointer up to the required pointer type at execution.

Deprecate("Prefer to use lambda functions to define KVParticleCondition objects.");

Definition at line 375 of file KVTemplateParticleCondition.h.

◆ Set() [2/2]

template<typename ParticleType >

void KVTemplateParticleCondition< ParticleType >::Set	(	const KVString &	name,
		const LambdaFunc &	F
	)

inline

Set condition using lambda expression (replace any existing definition).

The lambda must take a const KVNucleus* pointer as argument and return a boolean:

KVParticleCondition l1("Z>2", [](const KVNucleus* nuc){ return nuc->GetZ()>2; });

KVParticleCondition l2("Vpar>0", [](const KVNucleus* nuc){ return nuc->GetVpar()>0; });

Note the first argument to the constructor is a name which the user is free to define in order to remember what the condition does.

Definition at line 359 of file KVTemplateParticleCondition.h.

◆ SetClassFactory()

template<typename ParticleType >

void KVTemplateParticleCondition< ParticleType >::SetClassFactory ( KVClassFactory * CF )

inlineprivate

◆ operator&&

template<typename ParticleType >

KVTemplateParticleCondition operator&&	(	const KVTemplateParticleCondition< ParticleType > &	A,
		const KVTemplateParticleCondition< ParticleType > &	B
	)

friend

Perform boolean AND between the two selection conditions

If SetParticleClassName() has been called for either of the two conditions, it will be called for the resulting condition with the same value

Both conditions must be of same type, i.e. if one uses a lambda expression, the other must also use a lambda expression.

If one or other of the conditions is not set, we just return the condition which has been set.

one or both conditions is/are not set

neither is set: return blank (unset) condition

if lambdas are used (error if not both ?)

Definition at line 528 of file KVTemplateParticleCondition.h.

◆ operator||

template<typename ParticleType >

KVTemplateParticleCondition operator\|\|	(	const KVTemplateParticleCondition< ParticleType > &	A,
		const KVTemplateParticleCondition< ParticleType > &	B
	)

friend

Perform boolean OR between the two selection conditions

If SetParticleClassName has been called for either of the two conditions, it will be called for the resulting condition with the same value

Both conditions must be of same type, i.e. if one uses a lambda expression, the other must also use a lambda expression.

If one or other of the conditions is not set, we just return the condition which has been set.

one or both conditions is/are not set

template<typename ParticleType >

KVString KVTemplateParticleCondition< ParticleType >::fOptimizedClassName

private

used to generate code for optimisation

Definition at line 103 of file KVTemplateParticleCondition.h.

◆ fOptOK

template<typename ParticleType >

Bool_t KVTemplateParticleCondition< ParticleType >::fOptOK

mutableprivate

name of generated class used for optimisation

Definition at line 104 of file KVTemplateParticleCondition.h.

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Friends

Additional Inherited Members

Member Typedef Documentation

◆ LambdaFunc

Member Enumeration Documentation

◆ LogOp

Constructor & Destructor Documentation

◆ KVTemplateParticleCondition() [1/5]

◆ KVTemplateParticleCondition() [2/5]

◆ KVTemplateParticleCondition() [3/5]

◆ KVTemplateParticleCondition() [4/5]

◆ KVTemplateParticleCondition() [5/5]

◆ ~KVTemplateParticleCondition()

Member Function Documentation

◆ AddExtraInclude()

◆ Copy()

◆ CreateClassFactory()

◆ IsLambda()

◆ IsSet()

◆ logical_operator_lambda_condition_test()

◆ operator&=()

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ operator|=()

◆ Optimize()

◆ optimized_test()

◆ Print()

◆ PrintOptimizedList()

◆ Set() [1/2]

◆ Set() [2/2]

◆ SetClassFactory()

◆ SetParticleClassName()

◆ Test() [1/2]

◆ Test() [2/2]

Friends And Related Symbol Documentation

◆ operator&&

◆ operator||

Member Data Documentation

◆ cf

◆ fClassName

◆ fCondition

◆ fCondition_brackets

◆ fCondition_raw

◆ fgOptimized

◆ fLambdaCondition

◆ fNUsing

◆ fOptimal

◆ fOptimizedClassName

◆ fOptOK

◆ fOpType

◆ fSavedLambda1

◆ fSavedLambda2