musrfit  1.9.2
PUserFcnBase Class Referenceabstract

#include <PUserFcnBase.h>

Inheritance diagram for PUserFcnBase:
Collaboration diagram for PUserFcnBase:

Public Member Functions

 PUserFcnBase ()
 
virtual ~PUserFcnBase ()
 
virtual Bool_t NeedGlobalPart () const
 if a user function needs a global part this function should return true, otherwise false (default: false) More...
 
virtual void SetGlobalPart (std::vector< void *> &globalPart, UInt_t idx)
 if a user function is using a global part, this function is used to invoke and retrieve the proper global object More...
 
virtual Bool_t GlobalPartIsValid () const
 if a user function is using a global part, this function returns if the global object part is valid (default: false) More...
 
virtual Double_t operator() (Double_t t, const std::vector< Double_t > &param) const =0
 

Detailed Description

Interface class for the user function.

Definition at line 42 of file PUserFcnBase.h.

Constructor & Destructor Documentation

◆ PUserFcnBase()

PUserFcnBase::PUserFcnBase ( )
inline

Definition at line 45 of file PUserFcnBase.h.

◆ ~PUserFcnBase()

virtual PUserFcnBase::~PUserFcnBase ( )
inlinevirtual

Definition at line 46 of file PUserFcnBase.h.

Member Function Documentation

◆ GlobalPartIsValid()

virtual Bool_t PUserFcnBase::GlobalPartIsValid ( ) const
inlinevirtual

if a user function is using a global part, this function returns if the global object part is valid (default: false)

Definition at line 50 of file PUserFcnBase.h.

Referenced by PTheory::PTheory().

◆ NeedGlobalPart()

virtual Bool_t PUserFcnBase::NeedGlobalPart ( ) const
inlinevirtual

if a user function needs a global part this function should return true, otherwise false (default: false)

Definition at line 48 of file PUserFcnBase.h.

Referenced by PTheory::PTheory().

◆ operator()()

virtual Double_t PUserFcnBase::operator() ( Double_t  t,
const std::vector< Double_t > &  param 
) const
pure virtual

Implemented in PUserFcn.

◆ SetGlobalPart()

virtual void PUserFcnBase::SetGlobalPart ( std::vector< void *> &  globalPart,
UInt_t  idx 
)
inlinevirtual

if a user function is using a global part, this function is used to invoke and retrieve the proper global object

Definition at line 49 of file PUserFcnBase.h.

Referenced by PTheory::PTheory().


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