#include <TUnuranContDist.h>
Inheritance diagram for TUnuranContDist:
The class can be constructed from a function (TF1) representing the probability density function of the distribution. Optionally the derivative of the pdf can also be passed.
It provides a method to set the domain of the distribution ( SetDomain ) which will correspond to the range of the generated random numbers. By default the domain is (-inf, + inf), indipendently of the range set in the TF1 class used to construct the distribution.
In addition, some UNURAN methods requires extra information (cdf function, distribution mode, area of pdf, etc...). This information can as well be set. Some methods require instead of the pdf the log of the pdf. This can also be controlled by setting a flag when constructing this class.
Definition at line 48 of file TUnuranContDist.h.
| TUnuranContDist::TUnuranContDist | ( | TF1 * | pdf = 0, |
|
| TF1 * | deriv = 0, |
|||
| bool | isLogPdf = false | |||
| ) | [explicit] |
Constructor from a TF1 objects specifying the pdf and optionally from another function representing the derivative of the pdf. The flag isLogPdf can be used to pass instead of the pdf (and its derivative) the log (and the derivative of the log) of the pdf. By default the distribution has not domain set (it is defined between [-inf,+inf], no mode, no pdf area and no cdf explicity defined. UnuRan, if needed, can compute some of this quantities, but the user if he knows them can set them in order to speed up the algorithm. For example in case of the Cdf, if the user has not set it, a numerical integration algorithm is used to estimate the Cdf from the Pdf. In case an algorithm requires only the Cdf (no Pdf), an empty distribution can be constructed and then the user must set afterwards the Cdf.
Definition at line 48 of file TUnuranContDist.cxx.
Referenced by Clone().
| TUnuranContDist::TUnuranContDist | ( | const ROOT::Math::IGenFunction & | pdf, | |
| const ROOT::Math::IGenFunction * | dpdf = 0, |
|||
| bool | isLogPdf = false, |
|||
| bool | copyFunc = false | |||
| ) | [explicit] |
Constructor as before but from a generic function object interface for one-dim functions
| TUnuranContDist::~TUnuranContDist | ( | ) | [virtual] |
| TUnuranContDist::TUnuranContDist | ( | const TUnuranContDist & | ) |
| TUnuranContDist & TUnuranContDist::operator= | ( | const TUnuranContDist & | rhs | ) |
Assignment operator
Definition at line 77 of file TUnuranContDist.cxx.
References ROOT::Math::IBaseFunctionOneDim::Clone(), fArea, fCdf, fDPdf, fHasArea, fHasDomain, fHasMode, fIsLogPdf, fMode, fOwnFunc, fPdf, fXmax, and fXmin.
Referenced by TUnuranContDist().
| virtual TUnuranContDist* TUnuranContDist::Clone | ( | ) | const [inline, virtual] |
Clone (required by base class)
Implements TUnuranBaseDist.
Definition at line 91 of file TUnuranContDist.h.
References TUnuranContDist().
| void TUnuranContDist::SetCdf | ( | TF1 * | cdf | ) |
set cdf distribution. If a method requires it and is not set it is then estimated using numerical integration from the pdf
Definition at line 122 of file TUnuranContDist.cxx.
References cdf(), ROOT::Math::IBaseFunctionOneDim::Clone(), fCdf, fDPdf, fOwnFunc, and fPdf.
| void TUnuranContDist::SetCdf | ( | const ROOT::Math::IGenFunction & | cdf | ) |
set cdf distribution using a generic function interface
Definition at line 116 of file TUnuranContDist.cxx.
Set the distribution domain. If min < max a domain is defined otherwise is undefined
Definition at line 109 of file TUnuranContDist.h.
References fHasDomain, fXmax, and fXmin.
| void TUnuranContDist::SetMode | ( | double | mode | ) | [inline] |
set the distribution mode (x position of its maximum)
Definition at line 121 of file TUnuranContDist.h.
| void TUnuranContDist::SetPdfArea | ( | double | area | ) | [inline] |
set the area below the pdf
Definition at line 126 of file TUnuranContDist.h.
check if distribution has a defined domain and return in case its domain
Definition at line 131 of file TUnuranContDist.h.
References fHasDomain, fXmax, and fXmin.
| bool TUnuranContDist::HasCdf | ( | ) | const [inline] |
check if a cdf function is provided for the distribution
Definition at line 140 of file TUnuranContDist.h.
References fCdf.
| bool TUnuranContDist::HasMode | ( | ) | const [inline] |
check if distribution has a pre-computed mode
Definition at line 145 of file TUnuranContDist.h.
References fHasMode.
| bool TUnuranContDist::HasPdfArea | ( | ) | const [inline] |
check if distribution has a pre-computed area below the Pdf
Definition at line 151 of file TUnuranContDist.h.
References fHasArea.
| double TUnuranContDist::Mode | ( | ) | const [inline] |
return the mode (x location of maximum of the pdf)
Definition at line 156 of file TUnuranContDist.h.
References fMode.
| double TUnuranContDist::PdfArea | ( | ) | const [inline] |
| bool TUnuranContDist::IsLogPdf | ( | ) | const [inline] |
flag to control if given function represent the log of a pdf
Definition at line 167 of file TUnuranContDist.h.
References fIsLogPdf.
evaluate the Probability Density function. Used by the UnuRan algorithms
Definition at line 137 of file TUnuranContDist.cxx.
References fPdf.
evaluate the derivative of the pdf. Used by UnuRan
Definition at line 144 of file TUnuranContDist.cxx.
References ROOT::Math::RichardsonDerivator::Derivative1(), fDPdf, fPdf, and h.
evaluate the integral (cdf) on the domain. Used by Unuran algorithm
Definition at line 159 of file TUnuranContDist.cxx.
References fCdf, fPdf, fXmax, fXmin, and ROOT::Math::IntegratorOneDim::Integral().
const ROOT::Math::IGenFunction* TUnuranContDist::fPdf [private] |
Definition at line 191 of file TUnuranContDist.h.
Referenced by Cdf(), DPdf(), operator=(), Pdf(), SetCdf(), and ~TUnuranContDist().
const ROOT::Math::IGenFunction* TUnuranContDist::fDPdf [private] |
Definition at line 192 of file TUnuranContDist.h.
Referenced by DPdf(), operator=(), SetCdf(), and ~TUnuranContDist().
const ROOT::Math::IGenFunction* TUnuranContDist::fCdf [private] |
Definition at line 193 of file TUnuranContDist.h.
Referenced by Cdf(), HasCdf(), operator=(), SetCdf(), and ~TUnuranContDist().
double TUnuranContDist::fXmin [private] |
Definition at line 195 of file TUnuranContDist.h.
Referenced by Cdf(), GetDomain(), operator=(), and SetDomain().
double TUnuranContDist::fXmax [private] |
Definition at line 196 of file TUnuranContDist.h.
Referenced by Cdf(), GetDomain(), operator=(), and SetDomain().
double TUnuranContDist::fMode [private] |
double TUnuranContDist::fArea [private] |
Definition at line 198 of file TUnuranContDist.h.
Referenced by operator=(), PdfArea(), and SetPdfArea().
bool TUnuranContDist::fIsLogPdf [private] |
bool TUnuranContDist::fHasDomain [private] |
Definition at line 202 of file TUnuranContDist.h.
Referenced by GetDomain(), operator=(), and SetDomain().
bool TUnuranContDist::fHasMode [private] |
Definition at line 203 of file TUnuranContDist.h.
Referenced by HasMode(), operator=(), and SetMode().
bool TUnuranContDist::fHasArea [private] |
Definition at line 204 of file TUnuranContDist.h.
Referenced by HasPdfArea(), operator=(), and SetPdfArea().
bool TUnuranContDist::fOwnFunc [private] |
Definition at line 205 of file TUnuranContDist.h.
Referenced by operator=(), SetCdf(), and ~TUnuranContDist().
1.5.1