Logo ROOT  
Reference Guide
Loading...
Searching...
No Matches
TFormula Class Reference

The Formula class.

This is a new version of the TFormula class based on Cling. This class is not 100% backward compatible with the old TFormula class, which is still available in ROOT as ROOT::v5::TFormula. Some of the TFormula member functions available in version 5, such as Analyze and AnalyzeFunction are not available in the new TFormula. On the other hand formula expressions which were valid in version 5 are still valid in TFormula version 6

This class has been implemented during Google Summer of Code 2013 by Maciej Zimnoch.

Example of valid expressions:

  • sin(x)/x
  • [0]*sin(x) + [1]*exp(-[2]*x)
  • x + y**2
  • x^2 + y^2
  • [0]*pow([1],4)
  • 2*pi*sqrt(x/y)
  • gaus(0)*expo(3) + ypol3(5)*x
  • gausn(0)*expo(3) + ypol3(5)*x
  • gaus(x, [0..2]) + expo(y, [3..4])

In the last examples above:

  • gaus(0) is a substitute for [0]*exp(-0.5*((x-[1])/[2])**2) and (0) means start numbering parameters at 0
  • gausn(0) is a substitute for [0]*exp(-0.5*((x-[1])/[2])**2)/(sqrt(2*pi)*[2])) and (0) means start numbering parameters at 0
  • expo(3) is a substitute for exp([3]+[4]*x)
  • pol3(5) is a substitute for par[5]+par[6]*x+par[7]*x**2+par[8]*x**3 (PolN stands for Polynomial of degree N)
  • gaus(x, [0..2]) is a more explicit way of writing gaus(0)
  • expo(y, [3..4]) is a substitute for exp([3]+[4]*y)

See below the full list of predefined functions which can be used as shortcuts in TFormula.

TMath functions can be part of the expression, eg:

  • TMath::Landau(x)*sin(x)
  • TMath::Erf(x)

Formula may contain constants, eg:

  • sqrt2
  • e
  • pi
  • ln10
  • infinity

and more.

Formulas may also contain other user-defined ROOT functions defined with a TFormula, eg, where f1 is defined on one x-dimension and 2 parameters:

  • f1(x, [omega], [phi])
  • f1([0..1])
  • f1([1], [0])
  • f1(y)

To replace only parameter names, the dimension variable can be dropped. Alternatively, to change only the dimension variable, the parameters can be dropped. Note that if a parameter is dropped or keeps its old name, its old value will be copied to the new function. The syntax used in the examples above also applies to the predefined parametrized functions like gaus and expo.

Comparisons operators are also supported (&&, ||, ==, <=, >=, !)

Examples:

sin(x*(x<0.5 || x>1))

If the result of a comparison is TRUE, the result is 1, otherwise 0.

Already predefined names can be given. For example, if the formula

TFormula old("old",sin(x*(x<0.5 || x>1)))

one can assign a name to the formula. By default the name of the object = title = formula itself.

TFormula new("new","x*old")

is equivalent to:

TFormula new("new","x*sin(x*(x<0.5 || x>1))")

The class supports unlimited number of variables and parameters. By default the names which can be used for the variables are x,y,z,t or x[0],x[1],x[2],x[3],....x[N] for N-dimensional formulas.

This class is not anymore the base class for the function classes TF1, but it has now a data member of TF1 which can be accessed via TF1::GetFormula.

TFormula supports gradient and hessian calculations through clad. To calculate the gradient one needs to first declare a CladStorage of the same size as the number of parameters and then pass the variables and the created CladStorage:

TFormula f("f", "x*[0] - y*[1]");
Double_t p[] = {40, 30};
Double_t x[] = {1, 2};
f.SetParameters(p);
f.GradientPar(x, grad);
#define f(i)
Definition RSha256.hxx:104
double Double_t
Double 8 bytes.
Definition RtypesCore.h:73
std::vector< Double_t > CladStorage
Definition TFormula.h:182
Double_t x[n]
Definition legend1.C:17

The process is similar for hessians, except that the size of the created CladStorage should be the square of the number of parameters because HessianPar returns a flattened matrix:

f.HessianPar(x, hess);

List of predefined functions

The list of available predefined functions which can be used as shortcuts is the following:

  1. One Dimensional functions:
    • gaus is a substitute for [Constant]*exp(-0.5*((x-[Mean])/[Sigma])*((x-[Mean])/[Sigma]))
    • landau is a substitute for [Constant]*TMath::Landau (x,[MPV],[Sigma],false)
    • expo is a substitute for exp([Constant]+[Slope]*x)
    • crystalball is substitute for [Constant]*ROOT::Math::crystalball_function (x,[Alpha],[N],[Sigma],[Mean])
    • breitwigner is a substitute for [p0]*ROOT::Math::breitwigner_pdf (x,[p2],[p1])
    • pol0,1,2,...N is a substitute for a polynomial of degree N : ([p0]+[p1]*x+[p2]*pow(x,2)+....[pN]*pow(x,N)
    • cheb0,1,2,...N is a substitute for a Chebyshev polynomial of degree N: ROOT::Math::Chebyshev10(x,[p0],[p1],[p2],...[pN]). Note the maximum N allowed here is 10.
  2. Two Dimensional functions:
    • xygaus is a substitute for [Constant]*exp(-0.5*pow(((x-[MeanX])/[SigmaX]),2 )- 0.5*pow(((y-[MeanY])/[SigmaY]),2)), a 2d Gaussian without correlation.
    • bigaus is a substitute for [Constant]*ROOT::Math::bigaussian_pdf (x,y,[SigmaX],[SigmaY],[Rho],[MeanX],[MeanY]), a 2d gaussian including a correlation parameter. Note the different order of parameters for bigaus: [Constant]=[0], [SigmaX]=[2], [SigmaY]=[4], [Rho]=[5], [MeanX]=[1], [MeanY]=[3]
  3. Three Dimensional functions:
    • xyzgaus is for a 3d Gaussians without correlations: [Constant]*exp(-0.5*pow(((x-[MeanX])/[SigmaX]),2 )- 0.5*pow(((y-[MeanY])/[SigmaY]),2 )- 0.5*pow(((z-[MeanZ])/[SigmaZ]),2))

An expanded note on variables and parameters

In a TFormula, a variable is a defined by a name x, y, z or t or an index like x[0], x[1], x[2]; that is x[N] where N is an integer.

TFormula("", "x[0] * x[1] + 10")

Parameters are similar and can take any name. It is specified using brackets e.g. [expected_mass] or [0].

TFormula("", "exp([expected_mass])-1")

Variables and parameters can be combined in the same TFormula. Here we consider a very simple case where we have an exponential decay after some time t and a number of events with timestamps for which we want to evaluate this function.

TFormula tf ("", "[0]*exp(-[1]*t)");
tf.SetParameter(0, 1);
tf.SetParameter(1, 0.5);
for (auto & event : events) {
tf.Eval(event.t);
}

The distinction between variables and parameters arose from the TFormula's application in fitting. There parameters are fitted to the data provided through variables. In other applications this distinction can go away.

Parameter values can be provided dynamically using TFormula::EvalPar instead of TFormula::Eval. In this way parameters can be used identically to variables. See below for an example that uses only parameters to model a function.

Int_t params[2] = {1, 2}; // {vel_x, vel_y}
TFormula tf ("", "[vel_x]/sqrt(([vel_x + vel_y])**2)");
tf.EvalPar(nullptr, params);
int Int_t
Signed integer 4 bytes (int).
Definition RtypesCore.h:59
The Formula class.
Definition TFormula.h:89

A note on operators

All operators of C/C++ are allowed in a TFormula with a few caveats.

The operators |, &, % can be used but will raise an error if used in conjunction with a variable or a parameter. Variables and parameters are treated as doubles internally for which these operators are not defined. This means the following command will run successfully

-q -e TFormula("", "x+(10%3)").Eval(0)

but not

-q -e TFormula("", "x%10").Eval(0)

.

The operator ^ is defined to mean exponentiation instead of the C/C++ interpretation xor. ** is added, also meaning exponentiation.

The operators ++ and @ are added, and are shorthand for the a linear function. That means the expression x@2 will be expanded to

[n]*x + [n+1]*2
const Int_t n
Definition legend1.C:16

where n is the first previously unused parameter number.

Definition at line 88 of file TFormula.h.

Public Types

enum  { kSingleKey = (1ULL << (0)) , kOverwrite = (1ULL << (1)) , kWriteDelete = (1ULL << (2)) }
enum  {
  kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,
  kBitMask = 0x00ffffff
}
using CladStorage = std::vector<Double_t>
enum  EDeprecatedStatusBits { kObjInCanvas = (1ULL << (3)) }
enum  EStatusBits { kNotGlobal = (1ULL << (10)) , kNormalized = (1ULL << (14)) , kLinear = (1ULL << (16)) , kLambda = (1ULL << (17)) }

Public Member Functions

 TFormula ()
 TFormula (const char *name, const char *formula, int ndim, int npar, bool addToGlobList=true)
 Constructor from a full compile-able C++ expression.
 TFormula (const char *name, const char *formula="", bool addToGlobList=true, bool vectorize=false)
 TFormula (const TFormula &formula)
 ~TFormula () override
void AbstractMethod (const char *method) const
 Call this function within a function that you don't want to define as purely virtual, in order not to force all users deriving from that class to implement that maybe (on their side) unused function; but at the same time, emit a run-time warning if they try to call it, telling that it is not implemented in the derived class: action must thus be taken on the user side to override it.
void AddParameter (const TString &name, Double_t value=0)
void AddVariable (const TString &name, Double_t value=0)
 Adds variable to known variables, and reprocess formula.
void AddVariables (const TString *vars, const Int_t size)
 Adds multiple variables.
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.
void Clear (Option_t *option="") override
 Clear the formula setting expression to empty and reset the variables and parameters containers.
TObjectClone (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.
Int_t Compile (const char *expression="")
 Compile the given expression with Cling backward compatibility method to be used in combination with the empty constructor if no expression is given , the current stored formula (retrieved with GetExpFormula()) or the title is used.
void Copy (TObject &f1) const override
 Copy this to obj.
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 TObjectDrawClone (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.
template<typename... Args>
Double_t Eval (Args... args) const
 Set first 1, 2, 3 or 4 variables (e.g.
Double_t EvalPar (const Double_t *x, const Double_t *params=nullptr) const
Double_t EvalPar (std::nullptr_t, const Double_t *params=nullptr) const
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 void FillBuffer (char *&buffer)
 Encode TNamed into output buffer.
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes.
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes.
bool GenerateGradientPar ()
 Generate gradient computation routine with respect to the parameters.
bool GenerateHessianPar ()
 Generate hessian computation routine with respect to the parameters.
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object.
TString GetExpFormula (Option_t *option="") const
 Return the expression formula.
TString GetGradientFormula () const
TString GetHessianFormula () const
virtual const char * GetIconName () const
 Returns mime type name of object.
const TObjectGetLinearPart (Int_t i) const
 Return linear part.
const char * GetName () const override
 Returns name of object.
Int_t GetNdim () const
Int_t GetNpar () const
Int_t GetNumber () const
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py).
virtual Option_tGetOption () const
Double_t GetParameter (const char *name) const
 Returns parameter value given by string.
Double_t GetParameter (Int_t param) const
 Return parameter value given by integer.
Double_tGetParameters () const
void GetParameters (Double_t *params) const
const char * GetParName (Int_t ipar) const
 Return parameter name given by integer.
Int_t GetParNumber (const char *name) const
 Return parameter index given a name (return -1 for not existing parameters) non need to print an error.
const char * GetTitle () const override
 Returns title of object.
TString GetUniqueFuncName () const
virtual UInt_t GetUniqueID () const
 Return the unique object id.
Double_t GetVariable (const char *name) const
 Returns variable value.
TString GetVarName (Int_t ivar) const
 Returns variable name given its position in the array.
Int_t GetVarNumber (const char *name) const
 Returns variable number (positon in array) given its name.
void GradientPar (const Double_t *x, Double_t *result)
 Compute the gradient with respect to the parameter passing a buffer with a size at least equal to the number of parameters.
void GradientPar (const Double_t *x, TFormula::CladStorage &result)
 Compute the gradient employing automatic differentiation.
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out.
bool HasGeneratedGradient () const
bool HasGeneratedHessian () const
ULong_t Hash () const override
 Return hash value for this object.
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.
void HessianPar (const Double_t *x, Double_t *result)
void HessianPar (const Double_t *x, TFormula::CladStorage &result)
 Compute the gradient employing automatic differentiation.
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)
TClassIsA () const override
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).
Bool_t IsLinear () const
Bool_t IsOnHeap () const
Bool_t IsSortable () const override
Bool_t IsValid () const
Bool_t IsVectorized () const
Bool_t IsZombie () const
void ls (Option_t *option="") const override
 List TNamed name and title.
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 (the base implementation is no-op).
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete.
void operator delete (void *, size_t)
 Operator delete for sized deallocation.
void operator delete (void *ptr)
 Operator delete.
void operator delete (void *ptr, void *vp)
 Only called by placement new when throwing an exception.
void operator delete[] (void *, size_t)
 Operator delete [] for sized deallocation.
void operator delete[] (void *ptr)
 Operator delete [].
void operator delete[] (void *ptr, void *vp)
 Only called by placement new[] when throwing an exception.
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)
TFormulaoperator= (const TFormula &rhs)
 = 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.
void Print (Option_t *option="") const override
 Print the formula and its attributes.
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.
void SetName (const char *name) override
 Set the name of the formula.
virtual void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title).
void SetParameter (const char *name, Double_t value)
 Sets parameter value.
void SetParameter (Int_t param, Double_t value)
 Set a parameter given a parameter index.
void SetParameters (const Double_t *params)
 Set a vector of parameters value.
template<typename... Args>
void SetParameters (Double_t arg1, Args &&... args)
 Set a list of parameters.
void SetParName (Int_t ipar, const char *name)
template<typename... Args>
void SetParNames (Args &&... args)
 Set parameter names.
virtual void SetTitle (const char *title="")
 Set the title of the TNamed.
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id.
void SetVariable (const TString &name, Double_t value)
 Sets variable value.
void SetVariables (const std::pair< TString, Double_t > *vars, const Int_t size)
 Sets multiple variables.
void SetVectorized (Bool_t vectorized)
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject.
void Streamer (TBuffer &) override
 Stream a class object.
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message.
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 TClassClass ()
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 Bool_t IsScientificNotation (const TString &formula, int ipos)
static void SetDtorOnly (void *obj)
 Set destructor only flag.
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable.

Protected Types

enum  { kOnlyPrepStep = (1ULL << (3)) }

Protected Member Functions

void DoAddParameter (const TString &name, Double_t value, bool processFormula)
 Adds parameter to known parameters.
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected).
Double_t DoEval (const Double_t *x, const Double_t *p=nullptr) const
 Evaluate formula.
void DoSetParameters (const Double_t *p, Int_t size)
void ExtractFunctors (TString &formula)
 Extracts functors from formula, and put them in fFuncs.
void MakeZombie ()
Bool_t PrepareFormula (TString &formula)
 prepare the formula to be executed normally is called with fFormula
void PreProcessFormula (TString &formula)
 Preprocessing of formula Replace all ** by ^, all ++ by @, and removes spaces.
void ProcessFormula (TString &formula)
 Iterates through functors in fFuncs and performs the appropriate action.
void ReplaceParamName (TString &formula, const TString &oldname, const TString &name)
 Replace in Formula expression the parameter name.
void SavePrimitiveNameTitle (std::ostream &out, const char *variable_name)
 Save object name and title into the output stream "out".
void SetPredefinedParamNames ()
 Set parameter names only in case of pre-defined functions.

Static Protected Member Functions

static Bool_t IsAParameterName (const TString &formula, int ipos)
 check if given position is in a parameter name i.e. within "[ ]"
static Bool_t IsBracket (const char c)
static Bool_t IsFunctionNameChar (const char c)
static Bool_t IsHexadecimal (const TString &formula, int ipos)
static Bool_t IsOperator (const char c)
static void SavePrimitiveConstructor (std::ostream &out, TClass *cl, const char *variable_name, const char *constructor_agrs="", Bool_t empty_line=kTRUE)
 Save object constructor in the output stream "out".
static void SavePrimitiveDraw (std::ostream &out, const char *variable_name, Option_t *option=nullptr)
 Save invocation of primitive Draw() method Skipped if option contains "nodraw" string.
static TString SavePrimitiveVector (std::ostream &out, const char *prefix, Int_t len, Double_t *arr, Int_t flag=0)
 Save array in the output stream "out" as vector.

Protected Attributes

std::map< TString, Double_tfConsts
 !
TString fFormula
 String representing the formula expression.
std::list< TFormulaFunctionfFuncs
 !
std::map< TString, TStringfFunctionsShortcuts
 !
std::vector< TObject * > fLinearParts
 Vector of linear functions.
TString fName
Int_t fNdim
 Dimension - needed for lambda expressions.
Int_t fNpar
 ! Number of parameter (transient since we save the vector)
Int_t fNumber
 Number used to identify pre-defined functions (gaus, expo,..).
std::map< TString, Int_t, TFormulaParamOrderfParams
 || List of parameter names
TString fTitle
std::map< TString, TFormulaVariablefVars
 ! List of variable names
Bool_t fVectorized = false
 Whether we should use vectorized or regular variables.

Private Types

using CallFuncSignature = TInterpreter::CallFuncIFacePtr_t::Generic_t

Private Member Functions

void FillDefaults ()
 Fill structures with default variables, constants and function shortcuts.
void FillParametrizedFunctions (std::map< std::pair< TString, Int_t >, std::pair< TString, TString > > &functions)
 Fill map with parametrized functions.
std::string GetGradientFuncName () const
std::string GetHessianFuncName () const
void HandleExponentiation (TString &formula)
 Handling exponentiation Can handle multiple carets, eg.
void HandleFunctionArguments (TString &formula)
 Handling user functions (and parametrized functions) to take variables and optionally parameters as arguments.
void HandleLinear (TString &formula)
 Handle linear functions defined with the operator ++ (@ is the shorthand).
void HandleParametrizedFunctions (TString &formula)
 Handling parametrized functions Function can be normalized, and have different variable then x.
void HandleParamRanges (TString &formula)
 Handling parameter ranges, in the form of [1..5].
void HandlePolN (TString &formula)
 Handling Polynomial Notation (polN).
bool HasGradientGenerationFailed () const
bool HasHessianGenerationFailed () const
Bool_t InitLambdaExpression (const char *formula)
void InputFormulaIntoCling ()
 Inputs formula, transferred to C++ code into Cling.
Bool_t PrepareEvalMethod ()
 Sets TMethodCall to function inside Cling environment.
void ReInitializeEvalMethod ()
 Re-initialize eval method.
void ReplaceAllNames (TString &formula, std::map< TString, TString > &substitutions)

Static Private Member Functions

static void AddToTObjectTable (TObject *)
 Private helper function which will dispatch to TObjectTable::AddObj.
static Bool_t IsDefaultVariableName (const TString &name)

Private Attributes

Bool_t fAllParametersSetted
 Flag to control if all parameters are setted.
UInt_t fBits
 bit field status word
std::atomic< Bool_tfClingInitialized
 ! Transient to force re-initialization
TString fClingInput
 ! Input function passed to Cling
TString fClingName
 ! Unique name passed to Cling to define the function ( double clingName(double*x, double*p) )
std::vector< Double_tfClingParameters
 Parameter values.
std::vector< Double_tfClingVariables
 ! Cached variables
CallFuncSignature fFuncPtr = nullptr
 ! Function pointer, owned by the JIT.
CallFuncSignature fGradFuncPtr = nullptr
 ! Function pointer, owned by the JIT.
std::string fGradGenerationInput
 ! Input query to clad to generate a gradient
CallFuncSignature fHessFuncPtr = nullptr
 ! Function pointer, owned by the JIT.
std::string fHessGenerationInput
 ! Input query to clad to generate a hessian
void * fLambdaPtr = nullptr
 ! Pointer to the lambda function
Bool_t fLazyInitialization = kFALSE
 ! Transient flag to control lazy initialization (needed for reading from files)
std::unique_ptr< TMethodCallfMethod
 ! Pointer to methodcall
Bool_t fReadyToExecute
 ! Transient to force initialization
std::string fSavedInputFormula
 ! Unique name used to defined the function and used in the global map (need to be saved in case of lazy initialization)
UInt_t fUniqueID
 object unique identifier

Static Private Attributes

static Longptr_t fgDtorOnly = 0
 object for which to call dtor only (i.e. no delete)
static Bool_t fgObjectStat = kTRUE
 if true keep track of objects in TObjectTable
static bool fIsCladRuntimeIncluded = false

#include "inc/TFormula.h"

Inheritance diagram for TFormula:
TNamed TObject

Member Typedef Documentation

◆ CallFuncSignature

◆ CladStorage

using TFormula::CladStorage = std::vector<Double_t>

Definition at line 182 of file TFormula.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protectedinherited
Enumerator
kOnlyPrepStep 

Used to request that the class specific implementation of TObject::Write just prepare the objects to be ready to be written but do not actually write them into the TBuffer.

This is just for example by TBufferMerger to request that the TTree inside the file calls TTree::FlushBaskets (outside of the merging lock) and TBufferMerger will later ask for the write (inside the merging lock). To take advantage of this feature the class needs to overload TObject::Write and use this enum value accordingly. (See TTree::Write and TObject::Write) Do not use, this feature will be migrate to the Merge function (See TClass and TTree::Merge)

Definition at line 106 of file TObject.h.

◆ anonymous enum

anonymous enum
inherited
Enumerator
kSingleKey 

write collection with single key

kOverwrite 

overwrite existing object with same name

kWriteDelete 

write object, then delete previous key with same name

Definition at line 99 of file TObject.h.

◆ anonymous enum

anonymous enum
inherited
Enumerator
kIsOnHeap 

object is on heap

kNotDeleted 

object has not been deleted

kZombie 

object ctor failed

kInconsistent 

class overload Hash but does call RecursiveRemove in destructor

kBitMask 

Definition at line 89 of file TObject.h.

◆ EDeprecatedStatusBits

Enumerator
kObjInCanvas 

for backward compatibility only, use kMustCleanup

Definition at line 84 of file TObject.h.

◆ EStatusBits

Enumerator
kNotGlobal 

Don't store in gROOT->GetListOfFunction (it should be protected).

kNormalized 

Set to true if the TFormula (ex gausn) is normalized.

kLinear 

Set to true if the TFormula is for linear fitting.

kLambda 

Set to true if TFormula has been build with a lambda.

Definition at line 176 of file TFormula.h.

Constructor & Destructor Documentation

◆ TFormula() [1/4]

TFormula::TFormula ( )

Definition at line 503 of file TFormula.cxx.

◆ ~TFormula()

TFormula::~TFormula ( )
override

Definition at line 530 of file TFormula.cxx.

◆ TFormula() [2/4]

TFormula::TFormula ( const char * name,
const char * formula = "",
bool addToGlobList = true,
bool vectorize = false )

Definition at line 547 of file TFormula.cxx.

◆ TFormula() [3/4]

TFormula::TFormula ( const char * name,
const char * formula,
int ndim,
int npar,
bool addToGlobList = true )

Constructor from a full compile-able C++ expression.

Definition at line 593 of file TFormula.cxx.

◆ TFormula() [4/4]

TFormula::TFormula ( const TFormula & formula)

Definition at line 640 of file TFormula.cxx.

Member Function Documentation

◆ AbstractMethod()

void TObject::AbstractMethod ( const char * method) const
inherited

Call this function within a function that you don't want to define as purely virtual, in order not to force all users deriving from that class to implement that maybe (on their side) unused function; but at the same time, emit a run-time warning if they try to call it, telling that it is not implemented in the derived class: action must thus be taken on the user side to override it.

In other word, this method acts as a "runtime purely virtual" warning instead of a "compiler purely virtual" error.

Warning
This interface is a legacy function that is no longer recommended to be used by new development code.
Note
The name "AbstractMethod" does not imply that it's an abstract method in the strict C++ sense.

Definition at line 1149 of file TObject.cxx.

◆ AddParameter()

void TFormula::AddParameter ( const TString & name,
Double_t value = 0 )
inline

Definition at line 192 of file TFormula.h.

◆ AddToTObjectTable()

void TObject::AddToTObjectTable ( TObject * op)
staticprivateinherited

Private helper function which will dispatch to TObjectTable::AddObj.

Included here to avoid circular dependency between header files.

Definition at line 195 of file TObject.cxx.

◆ AddVariable()

void TFormula::AddVariable ( const TString & name,
Double_t value = 0 )

Adds variable to known variables, and reprocess formula.

Definition at line 2682 of file TFormula.cxx.

◆ AddVariables()

void TFormula::AddVariables ( const TString * vars,
const Int_t size )

Adds multiple variables.

First argument is an array of pairs<TString,Double>, where first argument is name of variable, second argument represents value. size - number of variables passed in first argument

Definition at line 2715 of file TFormula.cxx.

◆ AppendPad()

void TObject::AppendPad ( Option_t * option = "")
virtualinherited

Append graphics object to current pad.

In case no current pad is set yet, create a default canvas with the name "c1".

Definition at line 204 of file TObject.cxx.

◆ Browse()

◆ CheckedHash()

ULong_t TObject::CheckedHash ( )
inlineinherited

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

The intent is for this routine to be called instead of directly calling the function Hash during "insert" operations. See TObject::HasInconsistenTObjectHash();

(*) The setup is consistent when all classes in the class hierarchy that overload TObject::Hash do call ROOT::CallRecursiveRemoveIfNeeded in their destructor. i.e. it is safe to call the Hash virtual function during the RecursiveRemove operation.

Definition at line 332 of file TObject.h.

◆ Class()

TClass * TFormula::Class ( )
static
Returns
TClass describing this class

◆ Class_Name()

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

◆ Class_Version()

constexpr Version_t TFormula::Class_Version ( )
inlinestaticconstexpr
Returns
Version of this class

Definition at line 291 of file TFormula.h.

◆ ClassName()

const char * TObject::ClassName ( ) const
virtualinherited

Returns name of class to which the object belongs.

Definition at line 227 of file TObject.cxx.

◆ Clear()

void TFormula::Clear ( Option_t * option = "")
overridevirtual

Clear the formula setting expression to empty and reset the variables and parameters containers.

Reimplemented from TObject.

Definition at line 832 of file TFormula.cxx.

◆ Clone()

TObject * TNamed::Clone ( const char * newname = "") const
overridevirtualinherited

Make a clone of an object using the Streamer facility.

If newname is specified, this will be the name of the new object.

Reimplemented from TObject.

Reimplemented in TStreamerInfo, and TTreeIndex.

Definition at line 73 of file TNamed.cxx.

◆ Compare()

Int_t TNamed::Compare ( const TObject * obj) const
overridevirtualinherited

Compare two TNamed objects.

Returns 0 when equal, -1 when this is smaller and +1 when bigger (like strcmp).

Reimplemented from TObject.

Reimplemented in TStructNodeProperty.

Definition at line 84 of file TNamed.cxx.

◆ Compile()

Int_t TFormula::Compile ( const char * expression = "")

Compile the given expression with Cling backward compatibility method to be used in combination with the empty constructor if no expression is given , the current stored formula (retrieved with GetExpFormula()) or the title is used.

return 0 if the formula compilation is successful

Definition at line 715 of file TFormula.cxx.

◆ Copy()

void TFormula::Copy ( TObject & object) const
overridevirtual

Copy this to obj.

Reimplemented from TObject.

Definition at line 749 of file TFormula.cxx.

◆ DeclFileName()

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

Definition at line 291 of file TFormula.h.

◆ Delete()

void TObject::Delete ( Option_t * option = "")
virtualinherited

◆ DistancetoPrimitive()

◆ DoAddParameter()

void TFormula::DoAddParameter ( const TString & name,
Double_t value,
bool processFormula )
protected

Adds parameter to known parameters.

User should use SetParameter, because parameters are added during initialization part, and after that adding new will be pointless.

Definition at line 2856 of file TFormula.cxx.

◆ DoError()

void TObject::DoError ( int level,
const char * location,
const char * fmt,
va_list va ) const
protectedvirtualinherited

Interface to ErrorHandler (protected).

Reimplemented in TThread, and TTreeViewer.

Definition at line 1059 of file TObject.cxx.

◆ DoEval()

Double_t TFormula::DoEval ( const Double_t * x,
const Double_t * p = nullptr ) const
protected

Evaluate formula.

If formula is not ready to execute(missing parameters/variables), print these which are not known. If parameter has default value, and has not been set, appropriate warning is shown.

Definition at line 3479 of file TFormula.cxx.

◆ DoSetParameters()

void TFormula::DoSetParameters ( const Double_t * p,
Int_t size )
protected

Definition at line 3062 of file TFormula.cxx.

◆ Draw()

◆ DrawClass()

void TObject::DrawClass ( ) const
virtualinherited

Draw class inheritance tree of the class to which this object belongs.

If a class B inherits from a class A, description of B is drawn on the right side of description of A. Member functions overridden by B are shown in class A with a blue line crossing-out the corresponding member function. The following picture is the class inheritance tree of class TPaveLabel:

Reimplemented in TGFrame, TSystemDirectory, and TSystemFile.

Definition at line 308 of file TObject.cxx.

◆ DrawClone()

TObject * TObject::DrawClone ( Option_t * option = "") const
virtualinherited

Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).

If pad was not selected - gPad will be used.

Note
For histograms, use the more specialised TH1::DrawCopy().

Reimplemented in TAxis, TCanvas, TGFrame, TSystemDirectory, and TSystemFile.

Definition at line 319 of file TObject.cxx.

◆ Dump()

void TObject::Dump ( ) const
virtualinherited

Dump contents of object on stdout.

Using the information in the object dictionary (class TClass) each data member is interpreted. If a data member is a pointer, the pointer value is printed

The following output is the Dump of a TArrow object:

fAngle 0 Arrow opening angle (degrees)
fArrowSize 0.2 Arrow Size
fOption.*fData
fX1 0.1 X of 1st point
fY1 0.15 Y of 1st point
fX2 0.67 X of 2nd point
fY2 0.83 Y of 2nd point
fUniqueID 0 object unique identifier
fBits 50331648 bit field status word
fLineColor 1 line color
fLineStyle 1 line style
fLineWidth 1 line width
fFillColor 19 fill area color
fFillStyle 1001 fill area style
#define X(type, name)
UInt_t fUniqueID
object unique identifier
Definition TObject.h:46
UInt_t fBits
bit field status word
Definition TObject.h:47
TLine * line
TCanvas * style()
Definition style.C:1

Reimplemented in TClass, TCollection, TGFrame, TGPack, and TSystemFile.

Definition at line 367 of file TObject.cxx.

◆ Error()

void TObject::Error ( const char * location,
const char * fmt,
... ) const
virtualinherited

Issue error message.

Use "location" to specify the method where the error occurred. Accepts standard printf formatting arguments.

Reimplemented in TFitResult.

Definition at line 1098 of file TObject.cxx.

◆ Eval()

template<typename... Args>
Double_t TFormula::Eval ( Args... args) const

Set first 1, 2, 3 or 4 variables (e.g.

x, y, z and t) and evaluate formula.

Definition at line 326 of file TFormula.h.

◆ EvalPar() [1/2]

Double_t TFormula::EvalPar ( const Double_t * x,
const Double_t * params = nullptr ) const

Definition at line 3190 of file TFormula.cxx.

◆ EvalPar() [2/2]

Double_t TFormula::EvalPar ( std::nullptr_t ,
const Double_t * params = nullptr ) const
inline

Definition at line 201 of file TFormula.h.

◆ Execute() [1/2]

void TObject::Execute ( const char * method,
const char * params,
Int_t * error = nullptr )
virtualinherited

Execute method on this object with the given parameter string, e.g.

"3.14,1,\"text\"".

Reimplemented in ROOT::R::TRInterface, TCling, TContextMenu, TInterpreter, and TMethodCall.

Definition at line 378 of file TObject.cxx.

◆ Execute() [2/2]

void TObject::Execute ( TMethod * method,
TObjArray * params,
Int_t * error = nullptr )
virtualinherited

Execute method on this object with parameters stored in the TObjArray.

The TObjArray should contain an argv vector like:

argv[0] ... argv[n] = the list of TObjString parameters
Collectable string class.
Definition TObjString.h:28

Reimplemented in ROOT::R::TRInterface, TCling, TContextMenu, TInterpreter, and TMethodCall.

Definition at line 398 of file TObject.cxx.

◆ ExecuteEvent()

◆ ExtractFunctors()

void TFormula::ExtractFunctors ( TString & formula)
protected

Extracts functors from formula, and put them in fFuncs.

Simple grammar:

  • <function> := name(arg1,arg2...)
  • <variable> := name
  • <parameter> := [number]
  • <name> := String containing lower and upper letters, numbers, underscores
  • <number> := Integer number Operators are omitted.

Definition at line 1944 of file TFormula.cxx.

◆ Fatal()

void TObject::Fatal ( const char * location,
const char * fmt,
... ) const
virtualinherited

Issue fatal error message.

Use "location" to specify the method where the fatal error occurred. Accepts standard printf formatting arguments.

Definition at line 1126 of file TObject.cxx.

◆ FillBuffer()

void TNamed::FillBuffer ( char *& buffer)
virtualinherited

Encode TNamed into output buffer.

Reimplemented in TDirectoryFile, TFile, TKey, TKeySQL, TKeyXML, TSQLFile, and TXMLFile.

Definition at line 103 of file TNamed.cxx.

◆ FillDefaults()

void TFormula::FillDefaults ( )
private

Fill structures with default variables, constants and function shortcuts.

Definition at line 967 of file TFormula.cxx.

◆ FillParametrizedFunctions()

void TFormula::FillParametrizedFunctions ( std::map< std::pair< TString, Int_t >, std::pair< TString, TString > > & functions)
private

Fill map with parametrized functions.

Definition at line 2528 of file TFormula.cxx.

◆ FindObject() [1/2]

TObject * TObject::FindObject ( const char * name) const
virtualinherited

Must be redefined in derived classes.

This function is typically used with TCollections, but can also be used to find an object by name inside this object.

Reimplemented in RooAbsCollection, RooLinkedList, TBtree, TCollection, TDirectory, TFolder, TGeometry, TGraph2D, TGraph, TH1, THashList, THashTable, THbookFile, TList, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TListOfTypes, TMap, TObjArray, TPad, TROOT, TViewPubDataMembers, and TViewPubFunctions.

Definition at line 425 of file TObject.cxx.

◆ FindObject() [2/2]

TObject * TObject::FindObject ( const TObject * obj) const
virtualinherited

Must be redefined in derived classes.

This function is typically used with TCollections, but can also be used to find an object inside this object.

Reimplemented in RooAbsCollection, RooLinkedList, TBtree, TCollection, TDirectory, TFolder, TGeometry, TGraph2D, TGraph, TH1, THashList, THashTable, THbookFile, TList, TListOfDataMembers, TListOfEnums, TListOfEnumsWithLock, TListOfFunctions, TListOfFunctionTemplates, TListOfTypes, TMap, TObjArray, TPad, TROOT, TViewPubDataMembers, and TViewPubFunctions.

Definition at line 435 of file TObject.cxx.

◆ GenerateGradientPar()

bool TFormula::GenerateGradientPar ( )

Generate gradient computation routine with respect to the parameters.

returns true on success.

Returns
true if a gradient was generated and GradientPar can be called.

Definition at line 3308 of file TFormula.cxx.

◆ GenerateHessianPar()

bool TFormula::GenerateHessianPar ( )

Generate hessian computation routine with respect to the parameters.

returns true on success.

Returns
true if a hessian was generated and HessianPar can be called.

Definition at line 3374 of file TFormula.cxx.

◆ GetDrawOption()

Option_t * TObject::GetDrawOption ( ) const
virtualinherited

Get option used by the graphics system to draw this object.

Note that before calling object.GetDrawOption(), you must have called object.Draw(..) before in the current pad.

Reimplemented in TBrowser, TFitEditor, TGedFrame, TGFileBrowser, TRootBrowser, and TRootBrowserLite.

Definition at line 445 of file TObject.cxx.

◆ GetDtorOnly()

Longptr_t TObject::GetDtorOnly ( )
staticinherited

Return destructor only flag.

Definition at line 1196 of file TObject.cxx.

◆ GetExpFormula()

TString TFormula::GetExpFormula ( Option_t * option = "") const

Return the expression formula.

  • If option = "P" replace the parameter names with their values
  • If option = "CLING" return the actual expression used to build the function passed to Cling
  • If option = "CLINGP" replace in the Cling expression the parameter with their values

Definition at line 3643 of file TFormula.cxx.

◆ GetGradientFormula()

TString TFormula::GetGradientFormula ( ) const

Definition at line 3715 of file TFormula.cxx.

◆ GetGradientFuncName()

std::string TFormula::GetGradientFuncName ( ) const
inlineprivate

Definition at line 127 of file TFormula.h.

◆ GetHessianFormula()

TString TFormula::GetHessianFormula ( ) const

Definition at line 3723 of file TFormula.cxx.

◆ GetHessianFuncName()

std::string TFormula::GetHessianFuncName ( ) const
inlineprivate

Definition at line 130 of file TFormula.h.

◆ GetIconName()

const char * TObject::GetIconName ( ) const
virtualinherited

Returns mime type name of object.

Used by the TBrowser (via TGMimeTypes class). Override for class of which you would like to have different icons for objects of the same class.

Reimplemented in ROOT::Experimental::XRooFit::xRooNode, TASImage, TBranch, TBranchElement, TGeoVolume, TGMainFrame, TKey, TMethodBrowsable, TSystemFile, and TVirtualBranchBrowsable.

Definition at line 472 of file TObject.cxx.

◆ GetLinearPart()

const TObject * TFormula::GetLinearPart ( Int_t i) const

Return linear part.

Definition at line 2666 of file TFormula.cxx.

◆ GetName()

const char * TNamed::GetName ( ) const
inlineoverridevirtualinherited

Returns name of object.

This default method returns the class name. Classes that give objects a name should override this method.

Reimplemented from TObject.

Definition at line 49 of file TNamed.h.

◆ GetNdim()

Int_t TFormula::GetNdim ( ) const
inline

Definition at line 261 of file TFormula.h.

◆ GetNpar()

Int_t TFormula::GetNpar ( ) const
inline

Definition at line 262 of file TFormula.h.

◆ GetNumber()

Int_t TFormula::GetNumber ( ) const
inline

Definition at line 263 of file TFormula.h.

◆ GetObjectInfo()

char * TObject::GetObjectInfo ( Int_t px,
Int_t py ) const
virtualinherited

Returns string containing info about the object at position (px,py).

This method is typically overridden by classes of which the objects can report peculiarities for different positions. Returned string will be re-used (lock in MT environment).

Reimplemented in TASImage, TAxis3D, TColorWheel, TF1, TF2, TFileDrawMap, TGeoNode, TGeoTrack, TGeoVolume, TGL5DDataSet, TGLHistPainter, TGLParametricEquation, TGLTH3Composition, TGraph, TH1, THistPainter, TNode, TPaletteAxis, TParallelCoordVar, and TVirtualHistPainter.

Definition at line 491 of file TObject.cxx.

◆ GetObjectStat()

Bool_t TObject::GetObjectStat ( )
staticinherited

Get status of object stat flag.

Definition at line 1181 of file TObject.cxx.

◆ GetOption()

virtual Option_t * TObject::GetOption ( ) const
inlinevirtualinherited

◆ GetParameter() [1/2]

Double_t TFormula::GetParameter ( const char * name) const

Returns parameter value given by string.

Definition at line 2946 of file TFormula.cxx.

◆ GetParameter() [2/2]

Double_t TFormula::GetParameter ( Int_t param) const

Return parameter value given by integer.

Definition at line 2960 of file TFormula.cxx.

◆ GetParameters() [1/2]

Double_t * TFormula::GetParameters ( ) const

Definition at line 2986 of file TFormula.cxx.

◆ GetParameters() [2/2]

void TFormula::GetParameters ( Double_t * params) const

Definition at line 2993 of file TFormula.cxx.

◆ GetParName()

const char * TFormula::GetParName ( Int_t ipar) const

Return parameter name given by integer.

Definition at line 2972 of file TFormula.cxx.

◆ GetParNumber()

Int_t TFormula::GetParNumber ( const char * name) const

Return parameter index given a name (return -1 for not existing parameters) non need to print an error.

Definition at line 2934 of file TFormula.cxx.

◆ GetTitle()

const char * TNamed::GetTitle ( ) const
inlineoverridevirtualinherited

Returns title of object.

This default method returns the class title (i.e. description). Classes that give objects a title should override this method.

Reimplemented from TObject.

Definition at line 50 of file TNamed.h.

◆ GetUniqueFuncName()

TString TFormula::GetUniqueFuncName ( ) const
inline

Definition at line 255 of file TFormula.h.

◆ GetUniqueID()

UInt_t TObject::GetUniqueID ( ) const
virtualinherited

Return the unique object id.

Definition at line 480 of file TObject.cxx.

◆ GetVariable()

Double_t TFormula::GetVariable ( const char * name) const

Returns variable value.

Definition at line 2799 of file TFormula.cxx.

◆ GetVarName()

TString TFormula::GetVarName ( Int_t ivar) const

Returns variable name given its position in the array.

Definition at line 2825 of file TFormula.cxx.

◆ GetVarNumber()

Int_t TFormula::GetVarNumber ( const char * name) const

Returns variable number (positon in array) given its name.

Definition at line 2812 of file TFormula.cxx.

◆ GradientPar() [1/2]

void TFormula::GradientPar ( const Double_t * x,
Double_t * result )

Compute the gradient with respect to the parameter passing a buffer with a size at least equal to the number of parameters.

Note that the result buffer needs to be initialized to zero before passed to this function.

Definition at line 3367 of file TFormula.cxx.

◆ GradientPar() [2/2]

void TFormula::GradientPar ( const Double_t * x,
TFormula::CladStorage & result )

Compute the gradient employing automatic differentiation.

a CladStorageObject, i.e.

Parameters
[in]x- The given variables, if nullptr the already stored variables are used.
[out]result- The result of the computation wrt each direction.

a std::vector, which has the size as the nnumber of parameters. Note that the result buffer needs to be initialized to zero before passing it to this function.

Definition at line 3340 of file TFormula.cxx.

◆ HandleExponentiation()

void TFormula::HandleExponentiation ( TString & formula)
private

Handling exponentiation Can handle multiple carets, eg.

2^3^4 will be treated like 2^(3^4)

Definition at line 1739 of file TFormula.cxx.

◆ HandleFunctionArguments()

void TFormula::HandleFunctionArguments ( TString & formula)
private

Handling user functions (and parametrized functions) to take variables and optionally parameters as arguments.

Definition at line 1455 of file TFormula.cxx.

◆ HandleLinear()

void TFormula::HandleLinear ( TString & formula)
private

Handle linear functions defined with the operator ++ (@ is the shorthand).

Definition at line 1839 of file TFormula.cxx.

◆ HandleParametrizedFunctions()

void TFormula::HandleParametrizedFunctions ( TString & formula)
private

Handling parametrized functions Function can be normalized, and have different variable then x.

Variables should be placed in brackets after function name. No brackets are treated like [x]. Normalized function has char 'n' after name, eg. gausn[var](0) will be replaced with [0]*exp(-0.5*((var-[1])/[2])^2)/(sqrt(2*pi)*[2])

Adding function is easy, just follow these rules, and add to TFormula::FillParametrizedFunctions defined further below:

  • Key for function map is pair of name and dimension of function
  • value of key is a pair function body and normalized function body
  • {Vn} is a place where variable appear, n represents n-th variable from variable list. Count starts from 0.
  • [num] stands for parameter number. If user pass to function argument 5, num will stand for (5 + num) parameter.

Definition at line 1205 of file TFormula.cxx.

◆ HandleParamRanges()

void TFormula::HandleParamRanges ( TString & formula)
private

Handling parameter ranges, in the form of [1..5].

Definition at line 1424 of file TFormula.cxx.

◆ HandlePolN()

void TFormula::HandlePolN ( TString & formula)
private

Handling Polynomial Notation (polN).

This section describes how polynomials are handled in the code.

  • If any name appears before 'pol', it is treated as a variable used in the polynomial.
    • Example: varpol2(5) will be replaced with [5] + [6]*var + [7]*var^2.
    • Empty name is treated like variable x.
  • The extended format allows direct variable specification:
    • Example: pol2(x, 0) or pol(x, [A]).
  • Traditional syntax: polN represents a polynomial of degree N:
    • ypol1 → [p0] + [p1] * y
    • pol1(x, 0) → [p0] + [p1] * x
    • pol2(y, 1) → [p1] + [p2] * y + [p3] * TMath::Sq(y)

Definition at line 1035 of file TFormula.cxx.

◆ HandleTimer()

Bool_t TObject::HandleTimer ( TTimer * timer)
virtualinherited

Execute action in response of a timer timing out.

This method must be overridden if an object has to react to timers.

Reimplemented in TGCommandPlugin, TGDNDManager, TGFileContainer, TGHtml, TGLEventHandler, TGPopupMenu, TGraphTime, TGScrollBar, TGShutter, TGTextEdit, TGTextEditor, TGTextEntry, TGTextView, TGToolTip, TGuiBldDragManager, TGWindow, and TTreeViewer.

Definition at line 516 of file TObject.cxx.

◆ HasGeneratedGradient()

bool TFormula::HasGeneratedGradient ( ) const
inline

Definition at line 234 of file TFormula.h.

◆ HasGeneratedHessian()

bool TFormula::HasGeneratedHessian ( ) const
inline

Definition at line 239 of file TFormula.h.

◆ HasGradientGenerationFailed()

bool TFormula::HasGradientGenerationFailed ( ) const
inlineprivate

Definition at line 133 of file TFormula.h.

◆ Hash()

ULong_t TNamed::Hash ( ) const
inlineoverridevirtualinherited

Return hash value for this object.

Note: If this routine is overloaded in a derived class, this derived class should also add

void CallRecursiveRemoveIfNeeded(TObject &obj)
call RecursiveRemove for obj if gROOT is valid and obj.TestBit(kMustCleanup) is true.
Definition TROOT.h:406

Otherwise, when RecursiveRemove is called (by ~TObject or example) for this type of object, the transversal of THashList and THashTable containers will will have to be done without call Hash (and hence be linear rather than logarithmic complexity). You will also see warnings like

Error in <ROOT::Internal::TCheckHashRecursiveRemoveConsistency::CheckRecursiveRemove>: The class SomeName overrides
TObject::Hash but does not call TROOT::RecursiveRemove in its destructor.
ULong_t Hash() const override
Return hash value for this object.
Definition TNamed.h:51
virtual void Error(const char *method, const char *msgfmt,...) const
Issue error message.
Definition TObject.cxx:1098
TObject()
TObject constructor.
Definition TObject.h:259
void RecursiveRemove(TObject *obj) override
Recursively remove this object from the list of Cleanups.
Definition TROOT.cxx:2651

Reimplemented from TObject.

Definition at line 51 of file TNamed.h.

◆ HasHessianGenerationFailed()

bool TFormula::HasHessianGenerationFailed ( ) const
inlineprivate

Definition at line 136 of file TFormula.h.

◆ HasInconsistentHash()

Bool_t TObject::HasInconsistentHash ( ) const
inlineinherited

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

missing call to RecursiveRemove in destructor).

Note: Since the consistency is only tested for during inserts, this routine will return true for object that have never been inserted whether or not they have a consistent setup. This has no negative side-effect as searching for the object with the right or wrong Hash will always yield a not-found answer (Since anyway no hash can be guaranteed unique, there is always a check)

Definition at line 366 of file TObject.h.

◆ HessianPar() [1/2]

void TFormula::HessianPar ( const Double_t * x,
Double_t * result )

Definition at line 3431 of file TFormula.cxx.

◆ HessianPar() [2/2]

void TFormula::HessianPar ( const Double_t * x,
TFormula::CladStorage & result )

Compute the gradient employing automatic differentiation.

Parameters
[in]x- The given variables, if nullptr the already stored variables are used.
[out]result- The 2D hessian matrix flattened to form a vector in row-major order.

Definition at line 3406 of file TFormula.cxx.

◆ Info()

void TObject::Info ( const char * location,
const char * fmt,
... ) const
virtualinherited

Issue info message.

Use "location" to specify the method where the warning occurred. Accepts standard printf formatting arguments.

Definition at line 1072 of file TObject.cxx.

◆ InheritsFrom() [1/2]

Bool_t TObject::InheritsFrom ( const char * classname) const
virtualinherited

Returns kTRUE if object inherits from class "classname".

Reimplemented in TClass.

Definition at line 549 of file TObject.cxx.

◆ InheritsFrom() [2/2]

Bool_t TObject::InheritsFrom ( const TClass * cl) const
virtualinherited

Returns kTRUE if object inherits from TClass cl.

Reimplemented in TClass.

Definition at line 557 of file TObject.cxx.

◆ InitLambdaExpression()

Bool_t TFormula::InitLambdaExpression ( const char * formula)
private

Definition at line 670 of file TFormula.cxx.

◆ InputFormulaIntoCling()

void TFormula::InputFormulaIntoCling ( )
private

Inputs formula, transferred to C++ code into Cling.

Definition at line 941 of file TFormula.cxx.

◆ Inspect()

void TObject::Inspect ( ) const
virtualinherited

Dump contents of this object in a graphics canvas.

Same action as Dump but in a graphical form. In addition pointers to other objects can be followed.

The following picture is the Inspect of a histogram object:

Reimplemented in ROOT::Experimental::XRooFit::xRooNode, TGFrame, TInspectorObject, and TSystemFile.

Definition at line 570 of file TObject.cxx.

◆ InvertBit()

void TObject::InvertBit ( UInt_t f)
inlineinherited

Definition at line 206 of file TObject.h.

◆ IsA()

TClass * TFormula::IsA ( ) const
inlineoverridevirtual
Returns
TClass describing current object

Reimplemented from TObject.

Definition at line 291 of file TFormula.h.

◆ IsAParameterName()

Bool_t TFormula::IsAParameterName ( const TString & formula,
int ipos )
staticprotected

check if given position is in a parameter name i.e. within "[ ]"

Definition at line 418 of file TFormula.cxx.

◆ IsBracket()

Bool_t TFormula::IsBracket ( const char c)
staticprotected

Definition at line 359 of file TFormula.cxx.

◆ IsDefaultVariableName()

Bool_t TFormula::IsDefaultVariableName ( const TString & name)
staticprivate

Definition at line 377 of file TFormula.cxx.

◆ IsDestructed()

Bool_t TObject::IsDestructed ( ) const
inlineinherited

IsDestructed.

Note
This function must be non-virtual as it can be used on destructed (but not yet modified) memory. This is used for example in TClonesArray to record the element that have been destructed but not deleted and thus are ready for re-use (by operator new with placement).
Returns
true if this object's destructor has been run.

Definition at line 186 of file TObject.h.

◆ IsEqual()

Bool_t TObject::IsEqual ( const TObject * obj) const
virtualinherited

Default equal comparison (objects are equal if they have the same address in memory).

More complicated classes might want to override this function.

Reimplemented in TGObject, TObjString, TPair, and TQCommand.

Definition at line 589 of file TObject.cxx.

◆ IsFolder()

◆ IsFunctionNameChar()

Bool_t TFormula::IsFunctionNameChar ( const char c)
staticprotected

Definition at line 371 of file TFormula.cxx.

◆ IsHexadecimal()

Bool_t TFormula::IsHexadecimal ( const TString & formula,
int ipos )
staticprotected

Definition at line 395 of file TFormula.cxx.

◆ IsLinear()

Bool_t TFormula::IsLinear ( ) const
inline

Definition at line 275 of file TFormula.h.

◆ IsOnHeap()

Bool_t TObject::IsOnHeap ( ) const
inlineinherited

Definition at line 160 of file TObject.h.

◆ IsOperator()

Bool_t TFormula::IsOperator ( const char c)
staticprotected

Definition at line 351 of file TFormula.cxx.

◆ IsScientificNotation()

Bool_t TFormula::IsScientificNotation ( const TString & formula,
int ipos )
static

Definition at line 383 of file TFormula.cxx.

◆ IsSortable()

Bool_t TNamed::IsSortable ( ) const
inlineoverridevirtualinherited

Reimplemented from TObject.

Reimplemented in TStructNodeProperty.

Definition at line 52 of file TNamed.h.

◆ IsValid()

Bool_t TFormula::IsValid ( ) const
inline

Definition at line 273 of file TFormula.h.

◆ IsVectorized()

Bool_t TFormula::IsVectorized ( ) const
inline

Definition at line 274 of file TFormula.h.

◆ IsZombie()

Bool_t TObject::IsZombie ( ) const
inlineinherited

Definition at line 161 of file TObject.h.

◆ ls()

void TNamed::ls ( Option_t * option = "") const
overridevirtualinherited

List TNamed name and title.

Reimplemented from TObject.

Reimplemented in ROOT::Experimental::XRooFit::xRooBrowser, TNode, TROOT, TStreamerBase, TStreamerElement, TStreamerInfo, TStreamerSTL, TTask, TText, and TVirtualStreamerInfo.

Definition at line 112 of file TNamed.cxx.

◆ MakeZombie()

void TObject::MakeZombie ( )
inlineprotectedinherited

Definition at line 55 of file TObject.h.

◆ MayNotUse()

void TObject::MayNotUse ( const char * method) const
inherited

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

Definition at line 1160 of file TObject.cxx.

◆ Notify()

Bool_t TObject::Notify ( )
virtualinherited

This method must be overridden to handle object notification (the base implementation is no-op).

Different objects in ROOT use the Notify method for different purposes, in coordination with other objects that call this method at the appropriate time.

For example, TLeaf uses it to load class information; TBranchRef to load contents of referenced branches TBranchRef; most notably, based on Notify, TChain implements a callback mechanism to inform interested parties when it switches to a new sub-tree.

Reimplemented in h1analysis, h1analysisTreeReader, TARInterruptHandler, TASInputHandler, TASInterruptHandler, TASLogHandler, TASSigPipeHandler, TBlinkTimer, TBranchElement, TBranchRef, TBreakLineCom, TBrowserTimer, TCollection, TDelCharCom, TDelTextCom, TFileHandler, TGContainerKeyboardTimer, TGContainerScrollTimer, TGInputHandler, TGLRedrawTimer, TGTextEditHist, TGuiBldDragManagerRepeatTimer, TIdleTimer, TInsCharCom, TInsTextCom, TInterruptHandler, TLeafObject, TMessageHandler, TNotifyLink< Type >, TNotifyLink< RNoCleanupNotifierHelper >, TNotifyLink< ROOT::Detail::TBranchProxy >, TNotifyLink< TTreeReader >, TPopupDelayTimer, TProcessEventTimer, TRefTable, TRepeatTimer, TSBRepeatTimer, TSelector, TSelectorDraw, TSelectorEntries, TSignalHandler, TSingleShotCleaner, TSocketHandler, TStdExceptionHandler, TSysEvtHandler, TTermInputHandler, TThreadTimer, TTimeOutTimer, TTimer, TTipDelayTimer, TTree, TTreeFormula, TTreeFormulaManager, TTreeReader, TViewTimer, and TViewUpdateTimer.

Definition at line 618 of file TObject.cxx.

◆ Obsolete()

void TObject::Obsolete ( const char * method,
const char * asOfVers,
const char * removedFromVers ) const
inherited

Use this method to declare a method obsolete.

Specify as of which version the method is obsolete and as from which version it will be removed.

Definition at line 1169 of file TObject.cxx.

◆ operator delete() [1/3]

void TObject::operator delete ( void * ptr,
size_t size )
inherited

Operator delete for sized deallocation.

Definition at line 1234 of file TObject.cxx.

◆ operator delete() [2/3]

void TObject::operator delete ( void * ptr)
inherited

Operator delete.

Definition at line 1212 of file TObject.cxx.

◆ operator delete() [3/3]

void TObject::operator delete ( void * ptr,
void * vp )
inherited

Only called by placement new when throwing an exception.

Definition at line 1266 of file TObject.cxx.

◆ operator delete[]() [1/3]

void TObject::operator delete[] ( void * ptr,
size_t size )
inherited

Operator delete [] for sized deallocation.

Definition at line 1245 of file TObject.cxx.

◆ operator delete[]() [2/3]

void TObject::operator delete[] ( void * ptr)
inherited

Operator delete [].

Definition at line 1223 of file TObject.cxx.

◆ operator delete[]() [3/3]

void TObject::operator delete[] ( void * ptr,
void * vp )
inherited

Only called by placement new[] when throwing an exception.

Definition at line 1274 of file TObject.cxx.

◆ operator new() [1/2]

void * TObject::operator new ( size_t sz)
inlineinherited

Definition at line 189 of file TObject.h.

◆ operator new() [2/2]

void * TObject::operator new ( size_t sz,
void * vp )
inlineinherited

Definition at line 191 of file TObject.h.

◆ operator new[]() [1/2]

void * TObject::operator new[] ( size_t sz)
inlineinherited

Definition at line 190 of file TObject.h.

◆ operator new[]() [2/2]

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

Definition at line 192 of file TObject.h.

◆ operator=()

TFormula & TFormula::operator= ( const TFormula & rhs)

= operator.

Definition at line 662 of file TFormula.cxx.

◆ Paint()

void TObject::Paint ( Option_t * option = "")
virtualinherited

This method must be overridden if a class wants to paint itself.

The difference between Paint() and Draw() is that when a object draws itself it is added to the display list of the pad in which it is drawn (and automatically redrawn whenever the pad is redrawn). While paint just draws the object without adding it to the pad display list.

Reimplemented in ROOT::Experimental::RTreeMapPainter, ROOT::RGeoPainter, TAnnotation, TArrow, TASImage, TASPaletteEditor::LimitLine, TASPaletteEditor::PaintPalette, TAxis3D, TBits, TBox, TButton, TCanvas, TClassTree, TCollection, TColorWheel, TCrown, TDiamond, TDirectory, TEfficiency, TEllipse, TEveArrow, TEveCaloViz, TEveDigitSet, TEveGeoShape, TEveGeoTopNode, TEvePlot3D, TEvePointSet, TEveProjectionAxes, TEveScene, TEveShape, TEveStraightLineSet, TEveText, TEveTriangleSet, TExec, TF1, TF2, TF3, TFile, TFileDrawMap, TFrame, TGaxis, TGenerator, TGeoBoolNode, TGeoIntersection, TGeoNode, TGeoOverlap, TGeoPainter, TGeoPhysicalNode, TGeoShape, TGeoSubtraction, TGeoTrack, TGeoUnion, TGeoVGShape, TGeoVolume, TGL5DDataSet, TGLHistPainter, TGLParametricEquation, TGLTH3Composition, TGraph2D, TGraph2DPainter, TGraph, TGraphEdge, TGraphNode, TGraphPolargram, TGraphTime, TH1, THistPainter, THStack, TLatex, TLegend, TLine, TMacro, TMarker3DBox, TMarker, TMathText, TMultiGraph, TNode, TNodeDiv, TPad, TPaletteAxis, TParallelCoord, TParallelCoordRange, TParallelCoordVar, TParticle, TPave, TPaveLabel, TPaveStats, TPavesText, TPaveText, TPie, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TPrimary, TRatioPlot, TScatter2D, TScatter, TShape, TSpectrum2Painter, TSpider, TSpline, TSQLFile, TStyle, TText, TTreePerfStats, TVirtualGeoPainter, TVirtualGeoTrack, TVirtualHistPainter, TVirtualPad, TWbox, and TXMLFile.

Definition at line 631 of file TObject.cxx.

◆ Pop()

void TObject::Pop ( )
virtualinherited

Pop on object drawn in a pad to the top of the display list.

I.e. it will be drawn last and on top of all other primitives.

Reimplemented in TFrame, TPad, and TVirtualPad.

Definition at line 640 of file TObject.cxx.

◆ PrepareEvalMethod()

bool TFormula::PrepareEvalMethod ( )
private

Sets TMethodCall to function inside Cling environment.

TFormula uses it to execute function. After call, TFormula should be ready to evaluate formula. Returns false on failure.

Definition at line 926 of file TFormula.cxx.

◆ PrepareFormula()

Bool_t TFormula::PrepareFormula ( TString & formula)
protected

prepare the formula to be executed normally is called with fFormula

Definition at line 1899 of file TFormula.cxx.

◆ PreProcessFormula()

void TFormula::PreProcessFormula ( TString & formula)
protected

Preprocessing of formula Replace all ** by ^, all ++ by @, and removes spaces.

Handle also parametrized functions like polN,gaus,expo,landau and exponentiation. Similar functionality should be added here.

Definition at line 1877 of file TFormula.cxx.

◆ Print()

void TFormula::Print ( Option_t * option = "") const
overridevirtual

Print the formula and its attributes.

Reimplemented from TObject.

Definition at line 3732 of file TFormula.cxx.

◆ ProcessFormula()

void TFormula::ProcessFormula ( TString & formula)
protected

Iterates through functors in fFuncs and performs the appropriate action.

If functor has 0 arguments (has only name) can be:

  • variable
    • will be replaced with x[num], where x is an array containing value of this variable under num.
  • pre-defined formula
    • will be replaced with formulas body
  • constant
    • will be replaced with constant value
  • parameter
    • will be replaced with p[num], where p is an array containing value of this parameter under num. If has arguments it can be :
  • function shortcut, eg. sin
    • will be replaced with fullname of function, eg. sin -> TMath::Sin
  • function from cling environment, eg. TMath::BreitWigner(x,y,z)
    • first check if function exists, and has same number of arguments, then accept it and set as found. If all functors after iteration are matched with corresponding action, it inputs C++ code of formula into cling, and sets flag that formula is ready to evaluate.

Definition at line 2189 of file TFormula.cxx.

◆ Read()

Int_t TObject::Read ( const char * name)
virtualinherited

Read contents of object with specified name from the current directory.

First the key with the given name is searched in the current directory, next the key buffer is deserialized into the object. The object must have been created before via the default constructor. See TObject::Write().

Reimplemented in TBuffer, TKey, TKeySQL, and TKeyXML.

Definition at line 673 of file TObject.cxx.

◆ RecursiveRemove()

◆ ReInitializeEvalMethod()

void TFormula::ReInitializeEvalMethod ( )
private

Re-initialize eval method.

This function is called by DoEval and DoEvalVector in case of a previous failure or in case of reading from a file

Definition at line 3586 of file TFormula.cxx.

◆ ReplaceAllNames()

void TFormula::ReplaceAllNames ( TString & formula,
std::map< TString, TString > & substitutions )
private

Definition at line 470 of file TFormula.cxx.

◆ ReplaceParamName()

void TFormula::ReplaceParamName ( TString & formula,
const TString & oldname,
const TString & name )
protected

Replace in Formula expression the parameter name.

Definition at line 3133 of file TFormula.cxx.

◆ ResetBit()

void TObject::ResetBit ( UInt_t f)
inlineinherited

Definition at line 203 of file TObject.h.

◆ SaveAs()

void TObject::SaveAs ( const char * filename = "",
Option_t * option = "" ) const
virtualinherited

Save this object in the file specified by filename.

  • if "filename" contains ".root" the object is saved in filename as root binary file.
  • if "filename" contains ".xml" the object is saved in filename as a xml ascii file.
  • if "filename" contains ".cc" the object is saved in filename as C code independent from ROOT. The code is generated via SavePrimitive(). Specific code should be implemented in each object to handle this option. Like in TF1::SavePrimitive().
  • otherwise the object is written to filename as a CINT/C++ script. The C++ code to rebuild this object is generated via SavePrimitive(). The "option" parameter is passed to SavePrimitive. By default it is an empty string. It can be used to specify the Draw option in the code generated by SavePrimitive.

    The function is available via the object context menu.

Reimplemented in ROOT::Experimental::XRooFit::xRooNode, TClassTree, TFolder, TGeoVolume, TGObject, TGraph, TH1, TPad, TPaveClass, TSpline3, TSpline5, TSpline, TTreePerfStats, and TVirtualPad.

Definition at line 708 of file TObject.cxx.

◆ SavePrimitive()

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

Save a primitive as a C++ statement(s) on output stream "out".

Reimplemented in TAnnotation, TArc, TArrow, TASImage, TAxis3D, TBox, TButton, TCanvas, TChain, TCrown, TCurlyArc, TCurlyLine, TCutG, TDiamond, TEfficiency, TEllipse, TExec, TF12, TF1, TF2, TF3, TFrame, TGaxis, TGButton, TGButtonGroup, TGCanvas, TGCheckButton, TGColorSelect, TGColumnLayout, TGComboBox, TGCompositeFrame, TGContainer, TGDockableFrame, TGDoubleHSlider, TGDoubleVSlider, TGedMarkerSelect, TGedPatternSelect, TGeoArb8, TGeoBBox, TGeoBoolNode, TGeoCombiTrans, TGeoCompositeShape, TGeoCone, TGeoConeSeg, TGeoCtub, TGeoDecayChannel, TGeoElementRN, TGeoEltu, TGeoGtra, TGeoHalfSpace, TGeoHMatrix, TGeoHype, TGeoIdentity, TGeoIntersection, TGeoMaterial, TGeoMedium, TGeoMixture, TGeoPara, TGeoParaboloid, TGeoPatternCylPhi, TGeoPatternCylR, TGeoPatternParaX, TGeoPatternParaY, TGeoPatternParaZ, TGeoPatternSphPhi, TGeoPatternSphR, TGeoPatternSphTheta, TGeoPatternTrapZ, TGeoPatternX, TGeoPatternY, TGeoPatternZ, TGeoPcon, TGeoPgon, TGeoRotation, TGeoScaledShape, TGeoShapeAssembly, TGeoSphere, TGeoSubtraction, TGeoTessellated, TGeoTorus, TGeoTranslation, TGeoTrap, TGeoTrd1, TGeoTrd2, TGeoTube, TGeoTubeSeg, TGeoUnion, TGeoVolume, TGeoXtru, TGFileContainer, TGFont, TGFrame, TGFSComboBox, TGGC, TGGroupFrame, TGHButtonGroup, TGHorizontal3DLine, TGHorizontalFrame, TGHorizontalLayout, TGHProgressBar, TGHScrollBar, TGHSlider, TGHSplitter, TGHtml, TGIcon, TGLabel, TGLayoutHints, TGLineStyleComboBox, TGLineWidthComboBox, TGListBox, TGListDetailsLayout, TGListLayout, TGListTree, TGListView, TGLVContainer, TGMainFrame, TGMatrixLayout, TGMdiFrame, TGMdiMainFrame, TGMdiMenuBar, TGMenuBar, TGMenuTitle, TGNumberEntry, TGNumberEntryField, TGPictureButton, TGPopupMenu, TGProgressBar, TGRadioButton, TGraph2D, TGraph2DAsymmErrors, TGraph2DErrors, TGraph, TGraphAsymmErrors, TGraphBentErrors, TGraphEdge, TGraphErrors, TGraphMultiErrors, TGraphNode, TGraphPolar, TGraphPolargram, TGraphStruct, TGroupButton, TGRowLayout, TGShapedFrame, TGShutter, TGShutterItem, TGSplitFrame, TGStatusBar, TGTab, TGTabLayout, TGTableLayout, TGTableLayoutHints, TGTextButton, TGTextEdit, TGTextEntry, TGTextLBEntry, TGTextView, TGTileLayout, TGToolBar, TGTransientFrame, TGTripleHSlider, TGTripleVSlider, TGVButtonGroup, TGVertical3DLine, TGVerticalFrame, TGVerticalLayout, TGVFileSplitter, TGVProgressBar, TGVScrollBar, TGVSlider, TGVSplitter, TGXYLayout, TGXYLayoutHints, TH1, TH2Poly, THelix, THStack, TLatex, TLegend, TLine, TMacro, TMarker3DBox, TMarker, TMathText, TMultiGraph, TPad, TPaletteAxis, TParallelCoord, TParallelCoordVar, TPave, TPaveClass, TPaveLabel, TPaveStats, TPavesText, TPaveText, TPie, TPieSlice, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TProfile2D, TProfile3D, TProfile, TRootContainer, TRootEmbeddedCanvas, TScatter2D, TScatter, TSlider, TSliderBox, TSpline3, TSpline5, TStyle, TText, TTreePerfStats, and TWbox.

Definition at line 858 of file TObject.cxx.

◆ SavePrimitiveConstructor()

void TObject::SavePrimitiveConstructor ( std::ostream & out,
TClass * cl,
const char * variable_name,
const char * constructor_agrs = "",
Bool_t empty_line = kTRUE )
staticprotectedinherited

Save object constructor in the output stream "out".

Can be used as first statement when implementing SavePrimitive() method for the object

Definition at line 777 of file TObject.cxx.

◆ SavePrimitiveDraw()

void TObject::SavePrimitiveDraw ( std::ostream & out,
const char * variable_name,
Option_t * option = nullptr )
staticprotectedinherited

Save invocation of primitive Draw() method Skipped if option contains "nodraw" string.

Definition at line 845 of file TObject.cxx.

◆ SavePrimitiveNameTitle()

void TNamed::SavePrimitiveNameTitle ( std::ostream & out,
const char * variable_name )
protectedinherited

Save object name and title into the output stream "out".

Definition at line 135 of file TNamed.cxx.

◆ SavePrimitiveVector()

TString TObject::SavePrimitiveVector ( std::ostream & out,
const char * prefix,
Int_t len,
Double_t * arr,
Int_t flag = 0 )
staticprotectedinherited

Save array in the output stream "out" as vector.

Create unique variable name based on prefix value Returns name of vector which can be used in constructor or in other places of C++ code If flag === kTRUE, just add empty line If flag === 111, check if array is empty and return nullptr or <vectorname>.data()

Definition at line 796 of file TObject.cxx.

◆ SetBit() [1/2]

void TObject::SetBit ( UInt_t f)
inlineinherited

Definition at line 202 of file TObject.h.

◆ SetBit() [2/2]

void TObject::SetBit ( UInt_t f,
Bool_t set )
inherited

Set or unset the user status bits as specified in f.

Definition at line 888 of file TObject.cxx.

◆ SetDrawOption()

void TObject::SetDrawOption ( Option_t * option = "")
virtualinherited

Set drawing option for object.

This option only affects the drawing style and is stored in the option field of the TObjOptLink supporting a TPad's primitive list (TList). Note that it does not make sense to call object.SetDrawOption(option) before having called object.Draw().

Reimplemented in RooPlot, TAxis, TBrowser, TGedFrame, TGFrame, TPad, TPaveStats, TRootBrowserLite, TSystemDirectory, and TSystemFile.

Definition at line 871 of file TObject.cxx.

◆ SetDtorOnly()

void TObject::SetDtorOnly ( void * obj)
staticinherited

Set destructor only flag.

Definition at line 1204 of file TObject.cxx.

◆ SetName()

void TFormula::SetName ( const char * name)
overridevirtual

Set the name of the formula.

We need to allow the list of function to properly handle the hashes.

Reimplemented from TNamed.

Definition at line 2753 of file TFormula.cxx.

◆ SetNameTitle()

void TNamed::SetNameTitle ( const char * name,
const char * title )
virtualinherited

Set all the TNamed parameters (name and title).

WARNING: if the name is changed and the object is a member of a THashTable or THashList container the container must be Rehash()'ed after SetName(). For example the list of objects in the current directory is a THashList.

Reimplemented in RooAbsArg, RooAbsData, RooDataHist, RooDataSet, RooFitResult, RooPlot, TContextMenu, TGraph2D, TGraph, TH1, and TNode.

Definition at line 163 of file TNamed.cxx.

◆ SetObjectStat()

void TObject::SetObjectStat ( Bool_t stat)
staticinherited

Turn on/off tracking of objects in the TObjectTable.

Definition at line 1188 of file TObject.cxx.

◆ SetParameter() [1/2]

void TFormula::SetParameter ( const char * name,
Double_t value )

Sets parameter value.

Definition at line 3006 of file TFormula.cxx.

◆ SetParameter() [2/2]

void TFormula::SetParameter ( Int_t param,
Double_t value )

Set a parameter given a parameter index.

The parameter index is by default the alphabetic order given to the parameters, apart if the users has defined explicitly the parameter names.

Definition at line 3093 of file TFormula.cxx.

◆ SetParameters() [1/2]

void TFormula::SetParameters ( const Double_t * params)

Set a vector of parameters value.

Order in the vector is by default the alphabetic order given to the parameters apart if the users has defined explicitly the parameter names

Definition at line 3083 of file TFormula.cxx.

◆ SetParameters() [2/2]

template<typename... Args>
void TFormula::SetParameters ( Double_t arg1,
Args &&... args )

Set a list of parameters.

The order is by default the alphabetic order given to the parameters, apart if the users has defined explicitly the parameter names. NaN values will be skipped, meaning that the corresponding parameters will not be changed.

Definition at line 301 of file TFormula.h.

◆ SetParName()

void TFormula::SetParName ( Int_t ipar,
const char * name )

Definition at line 3103 of file TFormula.cxx.

◆ SetParNames()

template<typename... Args>
void TFormula::SetParNames ( Args &&... args)

Set parameter names.

Empty strings will be skipped, meaning that the corresponding name will not be changed.

Definition at line 313 of file TFormula.h.

◆ SetPredefinedParamNames()

void TFormula::SetPredefinedParamNames ( )
protected

Set parameter names only in case of pre-defined functions.

Definition at line 2584 of file TFormula.cxx.

◆ SetTitle()

void TNamed::SetTitle ( const char * title = "")
virtualinherited

◆ SetUniqueID()

void TObject::SetUniqueID ( UInt_t uid)
virtualinherited

Set the unique object id.

Definition at line 899 of file TObject.cxx.

◆ SetVariable()

void TFormula::SetVariable ( const TString & name,
Double_t value )

Sets variable value.

Definition at line 2841 of file TFormula.cxx.

◆ SetVariables()

void TFormula::SetVariables ( const std::pair< TString, Double_t > * vars,
const Int_t size )

Sets multiple variables.

First argument is an array of pairs<TString,Double>, where first argument is name of variable, second argument represents value. size - number of variables passed in first argument

Definition at line 2782 of file TFormula.cxx.

◆ SetVectorized()

void TFormula::SetVectorized ( Bool_t vectorized)

Definition at line 3159 of file TFormula.cxx.

◆ Sizeof()

Int_t TNamed::Sizeof ( ) const
virtualinherited

Return size of the TNamed part of the TObject.

Reimplemented in TDirectory, TDirectoryFile, TFile, TKey, TSQLFile, and TXMLFile.

Definition at line 182 of file TNamed.cxx.

◆ Streamer()

void TFormula::Streamer ( TBuffer & b)
overridevirtual

Stream a class object.

Reimplemented from TObject.

Definition at line 3800 of file TFormula.cxx.

◆ StreamerNVirtual()

void TFormula::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b)
inline

Definition at line 291 of file TFormula.h.

◆ SysError()

void TObject::SysError ( const char * location,
const char * fmt,
... ) const
virtualinherited

Issue system error message.

Use "location" to specify the method where the system error occurred. Accepts standard printf formatting arguments.

Definition at line 1112 of file TObject.cxx.

◆ TestBit()

Bool_t TObject::TestBit ( UInt_t f) const
inlineinherited

Definition at line 204 of file TObject.h.

◆ TestBits()

Int_t TObject::TestBits ( UInt_t f) const
inlineinherited

Definition at line 205 of file TObject.h.

◆ UseCurrentStyle()

void TObject::UseCurrentStyle ( )
virtualinherited

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

Reimplemented in TAxis3D, TCanvas, TFrame, TGraph, TH1, TPad, TPaveStats, TPaveText, and TTree.

Definition at line 909 of file TObject.cxx.

◆ Warning()

void TObject::Warning ( const char * location,
const char * fmt,
... ) const
virtualinherited

Issue warning message.

Use "location" to specify the method where the warning occurred. Accepts standard printf formatting arguments.

Definition at line 1084 of file TObject.cxx.

◆ Write() [1/2]

Int_t TObject::Write ( const char * name = nullptr,
Int_t option = 0,
Int_t bufsize = 0 )
virtualinherited

Write this object to the current directory.

For more see the const version of this method.

Reimplemented in ROOT::TBufferMergerFile, TBuffer, TCollection, TDirectory, TDirectoryFile, TFile, TMap, TParallelMergingFile, TSQLFile, TTree, and TXMLFile.

Definition at line 989 of file TObject.cxx.

◆ Write() [2/2]

Int_t TObject::Write ( const char * name = nullptr,
Int_t option = 0,
Int_t bufsize = 0 ) const
virtualinherited

Write this object to the current directory.

The data structure corresponding to this object is serialized. The corresponding buffer is written to the current directory with an associated key with name "name".

Writing an object to a file involves the following steps:

  • Creation of a support TKey object in the current directory. The TKey object creates a TBuffer object.
  • The TBuffer object is filled via the class::Streamer function.
  • If the file is compressed (default) a second buffer is created to hold the compressed buffer.
  • Reservation of the corresponding space in the file by looking in the TFree list of free blocks of the file.
  • The buffer is written to the file.

Bufsize can be given to force a given buffer size to write this object. By default, the buffersize will be taken from the average buffer size of all objects written to the current file so far.

If a name is specified, it will be the name of the key. If name is not given, the name of the key will be the name as returned by GetName().

The option can be a combination of: kSingleKey, kOverwrite or kWriteDelete Using the kOverwrite option a previous key with the same name is overwritten. The previous key is deleted before writing the new object. Using the kWriteDelete option a previous key with the same name is deleted only after the new object has been written. This option is safer than kOverwrite but it is slower. NOTE: Neither kOverwrite nor kWriteDelete reduces the size of a TFile– the space is simply freed up to be overwritten; in the case of a TTree, it is more complicated. If one opens a TTree, appends some entries, then writes it out, the behaviour is effectively the same. If, however, one creates a new TTree and writes it out in this way, only the metadata is replaced, effectively making the old data invisible without deleting it. TTree::Delete() can be used to mark all disk space occupied by a TTree as free before overwriting its metadata this way. The kSingleKey option is only used by TCollection::Write() to write a container with a single key instead of each object in the container with its own key.

An object is read from the file into memory via TKey::Read() or via TObject::Read().

The function returns the total number of bytes written to the file. It returns 0 if the object cannot be written.

Reimplemented in TBuffer, TCollection, TDirectory, TDirectoryFile, TFile, TMap, TParallelMergingFile, TSQLFile, TTree, and TXMLFile.

Definition at line 964 of file TObject.cxx.

Member Data Documentation

◆ fAllParametersSetted

Bool_t TFormula::fAllParametersSetted
private

Flag to control if all parameters are setted.

Definition at line 98 of file TFormula.h.

◆ fBits

UInt_t TObject::fBits
privateinherited

bit field status word

Definition at line 47 of file TObject.h.

◆ fClingInitialized

std::atomic<Bool_t> TFormula::fClingInitialized
private

! Transient to force re-initialization

Definition at line 97 of file TFormula.h.

◆ fClingInput

TString TFormula::fClingInput
private

! Input function passed to Cling

Definition at line 93 of file TFormula.h.

◆ fClingName

TString TFormula::fClingName
private

! Unique name passed to Cling to define the function ( double clingName(double*x, double*p) )

Definition at line 101 of file TFormula.h.

◆ fClingParameters

std::vector<Double_t> TFormula::fClingParameters
private

Parameter values.

Definition at line 95 of file TFormula.h.

◆ fClingVariables

std::vector<Double_t> TFormula::fClingVariables
private

! Cached variables

Definition at line 94 of file TFormula.h.

◆ fConsts

std::map<TString,Double_t> TFormula::fConsts
protected

!

Definition at line 145 of file TFormula.h.

◆ fFormula

TString TFormula::fFormula
protected

String representing the formula expression.

Definition at line 147 of file TFormula.h.

◆ fFuncPtr

CallFuncSignature TFormula::fFuncPtr = nullptr
private

! Function pointer, owned by the JIT.

Definition at line 107 of file TFormula.h.

◆ fFuncs

std::list<TFormulaFunction> TFormula::fFuncs
protected

!

Definition at line 142 of file TFormula.h.

◆ fFunctionsShortcuts

std::map<TString,TString> TFormula::fFunctionsShortcuts
protected

!

Definition at line 146 of file TFormula.h.

◆ fgDtorOnly

Longptr_t TObject::fgDtorOnly = 0
staticprivateinherited

object for which to call dtor only (i.e. no delete)

Definition at line 49 of file TObject.h.

◆ fgObjectStat

Bool_t TObject::fgObjectStat = kTRUE
staticprivateinherited

if true keep track of objects in TObjectTable

Definition at line 50 of file TObject.h.

◆ fGradFuncPtr

CallFuncSignature TFormula::fGradFuncPtr = nullptr
private

! Function pointer, owned by the JIT.

Definition at line 108 of file TFormula.h.

◆ fGradGenerationInput

std::string TFormula::fGradGenerationInput
private

! Input query to clad to generate a gradient

Definition at line 105 of file TFormula.h.

◆ fHessFuncPtr

CallFuncSignature TFormula::fHessFuncPtr = nullptr
private

! Function pointer, owned by the JIT.

Definition at line 109 of file TFormula.h.

◆ fHessGenerationInput

std::string TFormula::fHessGenerationInput
private

! Input query to clad to generate a hessian

Definition at line 106 of file TFormula.h.

◆ fIsCladRuntimeIncluded

bool TFormula::fIsCladRuntimeIncluded = false
staticprivate

Definition at line 111 of file TFormula.h.

◆ fLambdaPtr

void* TFormula::fLambdaPtr = nullptr
private

! Pointer to the lambda function

Definition at line 110 of file TFormula.h.

◆ fLazyInitialization

Bool_t TFormula::fLazyInitialization = kFALSE
private

! Transient flag to control lazy initialization (needed for reading from files)

Definition at line 99 of file TFormula.h.

◆ fLinearParts

std::vector<TObject*> TFormula::fLinearParts
protected

Vector of linear functions.

Definition at line 151 of file TFormula.h.

◆ fMethod

std::unique_ptr<TMethodCall> TFormula::fMethod
private

! Pointer to methodcall

Definition at line 100 of file TFormula.h.

◆ fName

TString TNamed::fName
protectedinherited

Definition at line 32 of file TNamed.h.

◆ fNdim

Int_t TFormula::fNdim
protected

Dimension - needed for lambda expressions.

Definition at line 148 of file TFormula.h.

◆ fNpar

Int_t TFormula::fNpar
protected

! Number of parameter (transient since we save the vector)

Definition at line 149 of file TFormula.h.

◆ fNumber

Int_t TFormula::fNumber
protected

Number used to identify pre-defined functions (gaus, expo,..).

Definition at line 150 of file TFormula.h.

◆ fParams

std::map<TString,Int_t,TFormulaParamOrder> TFormula::fParams
protected

|| List of parameter names

Definition at line 144 of file TFormula.h.

◆ fReadyToExecute

Bool_t TFormula::fReadyToExecute
private

! Transient to force initialization

Definition at line 96 of file TFormula.h.

◆ fSavedInputFormula

std::string TFormula::fSavedInputFormula
private

! Unique name used to defined the function and used in the global map (need to be saved in case of lazy initialization)

Definition at line 102 of file TFormula.h.

◆ fTitle

TString TNamed::fTitle
protectedinherited

Definition at line 33 of file TNamed.h.

◆ fUniqueID

UInt_t TObject::fUniqueID
privateinherited

object unique identifier

Definition at line 46 of file TObject.h.

◆ fVars

std::map<TString,TFormulaVariable> TFormula::fVars
protected

! List of variable names

Definition at line 143 of file TFormula.h.

◆ fVectorized

Bool_t TFormula::fVectorized = false
protected

Whether we should use vectorized or regular variables.

Definition at line 152 of file TFormula.h.


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