SynAPSE  0.6.0
Synergistic Analysis of Phase Space Evolution
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends
Public Member Functions | Private Member Functions | Private Attributes
DCauchy Class Reference

Defines the methods associated with the Cauchy distribution. More...

#include <DCauchy.hh>

Inheritance diagram for DCauchy:
DFunction

Public Member Functions

 DCauchy ()
 Basic constructor, initilizes a Cauchy distribution. More...
 
 DCauchy (const double mu, const double sigma)
 Standard constructor, initilizes a Cauchy distribution of median mu and width sigma. More...
 
 DCauchy (const DCauchy &df)
 Copy constructor. More...
 
DCauchy & operator= (const DCauchy &df)
 Equality operator. More...
 
 ~DCauchy ()
 Destructor. More...
 
double CDF (const double &v) const
 Cumulative distribution function at v. More...
 
double CDFRadial (const double &R) const
 If the function has an L1, L2 or Linf symmetry, returns its CDF at radius R. More...
 
std::vector< TLine * > Contour1D (const double alpha) const
 Segment that encompass a certain p-value in 1 dimension. More...
 
std::vector< TObject * > Contour2D (const double alpha) const
 Dummy definition for the 2D contour, Cauchy is not normalisable in 2D. More...
 
TF3 * Contour3D (const double alpha) const
 Dummy definition for the 3D contour, Cauchy is not normalisable in 3D. More...
 
std::vector< TLine * > ContourRadial (const double alpha) const
 Segment that encompass a certain p-value in radius. More...
 
double ContourVolume (const double alpha) const
 Volume of the smallest contour of a given p-value. More...
 
double Evaluate (const std::vector< double > &v) const
 Returns the value of the distribution in v. More...
 
double Level (const double alpha) const
 Returns the level of the alpha-contour of the distribution. More...
 
double Norm () const
 Returns the probability content within the defined interval. More...
 
double Radial (const double R) const
 Returns the centred and normalised version of Evaluate. More...
 
double Random ()
 Returns a random value sampled from the Cauchy distribution. More...
 
std::vector< double > RandomVector ()
 Returns a random vector sampled from the Cauchy distribution. More...
 
- Public Member Functions inherited from DFunction
 DFunction ()
 Default constructor, initilizes everything to 0. More...
 
 DFunction (const DFunction &df)
 Copy constructor. More...
 
DFunction & operator= (const DFunction &df)
 Equality operator. More...
 
double operator() (const std::vector< double > &v) const
 Overloaded function operator, calls Evaluate. More...
 
double operator() (const double &v) const
 Overloaded function operator, calls Evaluate. More...
 
double operator() (const double *v) const
 Overloaded function operator, calls Evaluate. More...
 
 ~DFunction ()
 Destructor. More...
 
size_t Dimension () const
 Returns the dimension of the space. More...
 
double Evaluate (const double &v) const
 Returns the value of the PDF. More...
 
double Evaluate (const double *v) const
 Returns the value of the PDF. More...
 
void SetLowerBound (const double lower, const size_t i=0)
 Sets the lower bound of axis i. More...
 
double LowerBound (const size_t i=0) const
 Returns the lower bound of axis i. More...
 
void SetLowerBounds (std::vector< double > lower)
 Sets the vector of lower bounds. More...
 
std::vector< double > LowerBounds () const
 Returns the array of lower bounds. More...
 
void SetName (const std::string &name)
 Returns the name of the function. More...
 
std::string Name () const
 Returns the name of the function. More...
 
void SetRange (const double lower, const double upper, const size_t i=0)
 Returns the upper bound of axis i. More...
 
void SetRange (const std::vector< double > &lower, const std::vector< double > &upper)
 Returns the upper bound of axis i. More...
 
void Range (std::vector< double > &lower, std::vector< double > &upper) const
 Returns the upper bound of axis i. More...
 
void SetTitle (const std::string &title)
 Returns the name of the function. More...
 
std::string Title () const
 Returns the name of the function. More...
 
void SetUpperBound (const double upper, const size_t i=0)
 Sets the upper bound of axis i. More...
 
double UpperBound (const size_t i=0) const
 Returns the upper bound of axis i. More...
 
void SetUpperBounds (std::vector< double > upper)
 Sets the vector of upper bounds. More...
 
std::vector< double > UpperBounds () const
 Returns the array of upper bounds. More...
 
TGraph * Graph (size_t idx=0, std::vector< double > x=std::vector< double >()) const
 Returns a 1D graph of the function in the requested axis. More...
 
TGraph * GraphRadial () const
 Returns a radial graph of the function. More...
 
TH2F * Graph2D (size_t idx=0, size_t idy=1, std::vector< double > x=std::vector< double >()) const
 Returns a 2D histogram of the function in the requested axis. More...
 
TGraph * GraphCDFRadial () const
 Returns a radial graph of the cummulative density function. More...
 
void Draw (const std::string opt="", int idx=0, int idy=1, std::vector< double > x=std::vector< double >()) const
 Draws the function on whichever TCanvas is currently being used (ROOT) More...
 
void DrawRadial (const std::string opt="") const
 Draws the radial function on whichever TCanvas is currently being used (ROOT) More...
 
void Print (const std::string opt="", int idx=0, int idy=1, std::vector< double > x=std::vector< double >()) const
 Creates a canvas, draws the function on it and save it to a file. More...
 
void PrintRadial (const std::string opt="") const
 Creates a canvas, draws the radial function on it and save it to a file. More...
 

Private Member Functions

bool Initialize ()
 Initializes the distribution. More...
 

Private Attributes

double _mean
 Median. More...
 
double _sigma
 Width. More...
 

Additional Inherited Members

- Protected Attributes inherited from DFunction
size_t _dim
 Dimension of the space the function lives in. More...
 
std::vector< double > _lower
 Array of lower bounds. More...
 
std::vector< double > _upper
 Array of upper bounds. More...
 
std::string _name
 Name of the function. More...
 
std::string _title
 Title of the function. More...
 
TRandom3 _rdmzer
 Pseudorandom number generator. More...
 

Detailed Description

Defines the methods associated with the Cauchy distribution.

Only defined in 1D. It cannot be extended to n dimensions as it is not normalisable.

Constructor & Destructor Documentation

DCauchy::DCauchy ( )

Basic constructor, initilizes a Cauchy distribution.

DCauchy::DCauchy ( const double  mu,
const double  sigma 
)

Standard constructor, initilizes a Cauchy distribution of median mu and width sigma.

Parameters
muMedian of the distribution
sigmaWidth of the distribution
DCauchy::DCauchy ( const DCauchy &  df)

Copy constructor.

DCauchy::~DCauchy ( )

Destructor.

Member Function Documentation

double DCauchy::CDF ( const double &  v) const
virtual

Cumulative distribution function at v.

Parameters
vValue in which to evaluate the CDF

Implements DFunction.

double DCauchy::CDFRadial ( const double &  R) const
virtual

If the function has an L1, L2 or Linf symmetry, returns its CDF at radius R.

Parameters
RRadius to evaluate at

Implements DFunction.

std::vector< TLine * > DCauchy::Contour1D ( const double  alpha) const
virtual

Segment that encompass a certain p-value in 1 dimension.

Parameters
alphaP-value

Implements DFunction.

std::vector< TObject * > DCauchy::Contour2D ( const double  alpha) const
virtual

Dummy definition for the 2D contour, Cauchy is not normalisable in 2D.

Parameters
alphaP-value

Implements DFunction.

TF3 * DCauchy::Contour3D ( const double  alpha) const
virtual

Dummy definition for the 3D contour, Cauchy is not normalisable in 3D.

Parameters
alphaP-value

Implements DFunction.

std::vector< TLine * > DCauchy::ContourRadial ( const double  alpha) const
virtual

Segment that encompass a certain p-value in radius.

Parameters
alphaP-value

Implements DFunction.

double DCauchy::ContourVolume ( const double  alpha) const
virtual

Volume of the smallest contour of a given p-value.

Parameters
alphaP-value

Implements DFunction.

double DCauchy::Evaluate ( const std::vector< double > &  v) const
virtual

Returns the value of the distribution in v.

Parameters
vVector in which to evaluate

Implements DFunction.

bool DCauchy::Initialize ( )
private

Initializes the distribution.

double DCauchy::Level ( const double  alpha) const
virtual

Returns the level of the alpha-contour of the distribution.

Parameters
alphaP-value

Implements DFunction.

double DCauchy::Norm ( ) const
virtual

Returns the probability content within the defined interval.

Implements DFunction.

DCauchy & DCauchy::operator= ( const DCauchy &  df)

Equality operator.

double DCauchy::Radial ( const double  R) const
virtual

Returns the centred and normalised version of Evaluate.

Parameters
RRadius to evaluate at

Implements DFunction.

double DCauchy::Random ( )
virtual

Returns a random value sampled from the Cauchy distribution.

Implements DFunction.

std::vector< double > DCauchy::RandomVector ( )
virtual

Returns a random vector sampled from the Cauchy distribution.

Implements DFunction.

Field Documentation

double DCauchy::_mean
private

Median.

double DCauchy::_sigma
private

Width.


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