Data structure for result including value, first derivative and integrals of function. More...

#include <JResult.hh>

Inheritance diagram for JTOOLS::JResultPDF< JResult_t >:

Public Types
typedef JLANG::JClass< JResult_t >::argument_type	argument_type

Public Member Functions
	JResultPDF ()
	Default constructor.

	JResultPDF (argument_type f, argument_type fp, argument_type v, argument_type V)
	Constructor.

	JResultPDF (argument_type R, argument_type x, const JRange< JResult_t > &X)
	Constructor.

JResultPDF &	negate ()
	Prefix unary minus for function value of PDF.

JResultPDF &	add (const JResultPDF &value)
	Addition operator for function value of PDF.

JResultPDF &	sub (const JResultPDF &value)
	Subtraction operator for function value of PDF.

JResultPDF &	mul (const double value)
	Multiplication operator for function value of PDF.

JResultPDF &	div (const double value)
	Division operator for function value of PDF.

double	getP () const
	Get probability of first hit.

double	getChi2 () const
	Get chi2 of first hit.

double	getDerivativeOfChi2 () const
	Get derivative of chi2 of first hit.

JFirst_t &	mul (const JSecond_t &object)
	Multiply with object.

Public Attributes
JResult_t	f
	function value

JResult_t	fp
	first derivative

JResult_t	v
	integral <xmin,x]

JResult_t	V
	integral <xmin,xmax>

Detailed Description

template<class JResult_t>
struct JTOOLS::JResultPDF< JResult_t >

Data structure for result including value, first derivative and integrals of function.

This data structure contains the following data mambers:

   JResultPDF::f   = function value;
   JResultPDF::fp  = first derivative;
   JResultPDF::v   = partial  integral;
   JResultPDF::V   = complete integral.

The partial and complete integrals are used to evaluate the probability of the first hit.

This class implements the JMATH::JMath interface.

Definition at line 337 of file JResult.hh.

Member Typedef Documentation

◆ argument_type

template<class JResult_t >

JLANG::JClass<JResult_t>::argument_type JTOOLS::JResultPDF< JResult_t >::argument_type

Definition at line 341 of file JResult.hh.

Constructor & Destructor Documentation

◆ JResultPDF() [1/3]

template<class JResult_t >

JTOOLS::JResultPDF< JResult_t >::JResultPDF ( )

inline

Default constructor.

Definition at line 347 of file JResult.hh.

                 :
      f (JMATH::zero),
      fp(JMATH::zero),
      v (JMATH::zero),
      V (JMATH::zero)
    {}

◆ JResultPDF() [2/3]

template<class JResult_t >

JTOOLS::JResultPDF< JResult_t >::JResultPDF	(	argument_type	f,
		argument_type	fp,
		argument_type	v,
		argument_type	V )

inline

Constructor.

Parameters

f	function value
fp	first derivative
v	integral <xmin,x]
V	integral <xmin,xmax>

Definition at line 363 of file JResult.hh.

                                :
      f (f ),
      fp(fp),
      v (v),
      V (V)
    {}

◆ JResultPDF() [3/3]

template<class JResult_t >

JTOOLS::JResultPDF< JResult_t >::JResultPDF	(	argument_type	R,
		argument_type	x,
		const JRange< JResult_t > &	X )

inline

Constructor.

This constructor refers to the result of a signal with a constant rate R to produce an event occurring at the given moment x within the fixed range X.

Parameters

R	rate
x	abscissa value
X	abscissa range

Definition at line 383 of file JResult.hh.

                                           :
      f (R),
      fp(JMATH::zero),
      v (R * (X.constrain(x)    - X.getLowerLimit())),
      V (R * (X.getUpperLimit() - X.getLowerLimit()))
    {}

Member Function Documentation

◆ negate()

template<class JResult_t >

JResultPDF & JTOOLS::JResultPDF< JResult_t >::negate ( )

inline

Prefix unary minus for function value of PDF.

Returns: function value of PDF

Definition at line 398 of file JResult.hh.

    {
      f  = -f;
      fp = -fp;
      v  = -v;
      V  = -V;
 
      return *this;
    }

◆ add()

template<class JResult_t >

JResultPDF & JTOOLS::JResultPDF< JResult_t >::add ( const JResultPDF< JResult_t > & value )

inline

Addition operator for function value of PDF.

Parameters

value function value of PDF

Returns: function value of PDF

Definition at line 415 of file JResult.hh.

    {
      f  += value.f;
      fp += value.fp;
      v  += value.v;
      V  += value.V;
 
      return *this;
    }

◆ sub()

template<class JResult_t >

JResultPDF & JTOOLS::JResultPDF< JResult_t >::sub ( const JResultPDF< JResult_t > & value )

inline

Subtraction operator for function value of PDF.

Parameters

value function value of PDF

Returns: function value of PDF

Definition at line 432 of file JResult.hh.

    {
      f  -= value.f;
      fp -= value.fp;
      v  -= value.v;
      V  -= value.V;
 
      return *this;
    }

◆ mul() [1/2]

template<class JResult_t >

JResultPDF & JTOOLS::JResultPDF< JResult_t >::mul ( const double value )

inline

Multiplication operator for function value of PDF.

Parameters

value multiplication factor

Returns: function value of PDF

Definition at line 449 of file JResult.hh.

    {
      f  *= value;
      fp *= value;
      v  *= value;
      V  *= value;
 
      return *this;
    }

◆ div()

template<class JResult_t >

JResultPDF & JTOOLS::JResultPDF< JResult_t >::div ( const double value )

inline

Division operator for function value of PDF.

Parameters

value division factor

Returns: function value of PDF

Definition at line 466 of file JResult.hh.

    {
      f  /= value;
      fp /= value;
      v  /= value;
      V  /= value;
 
      return *this;
    }

◆ getP()

template<class JResult_t >

double JTOOLS::JResultPDF< JResult_t >::getP ( ) const

inline

Get probability of first hit.

The probability is defined at the moment JResultPDF::f and JResultPDF::v have been evaluated and it is normalised to the total interval corresponding to JResultPDF::V.

Returns: probability

Definition at line 484 of file JResult.hh.

    {
      return exp(-v) * f / (1.0 - exp(-V));
    }

◆ getChi2()

template<class JResult_t >

double JTOOLS::JResultPDF< JResult_t >::getChi2 ( ) const

inline

Get chi2 of first hit.

The chi2 corresponds to -log(P), where P is the probability JResultPDF::f.

Returns: chi2

Definition at line 496 of file JResult.hh.

    {
      return -log(getP());
    }

◆ getDerivativeOfChi2()

template<class JResult_t >

double JTOOLS::JResultPDF< JResult_t >::getDerivativeOfChi2 ( ) const

inline

Get derivative of chi2 of first hit.

Returns: derivative

Definition at line 507 of file JResult.hh.

    {
      return fp/f - f;
    }

◆ mul() [2/2]

template<class JFirst_t , class JSecond_t >

JFirst_t & JMATH::JMath< JFirst_t, JSecond_t >::mul ( const JSecond_t & object )

inlineinherited

Multiply with object.

Parameters

object object

Returns: result object

Definition at line 354 of file JMath.hh.

    {
      return static_cast<JFirst_t&>(*this) = JFirst_t().mul(static_cast<const JFirst_t&>(*this), object);
    }

Member Data Documentation

◆ f

template<class JResult_t >

JResult_t JTOOLS::JResultPDF< JResult_t >::f

function value

Definition at line 513 of file JResult.hh.

◆ fp

template<class JResult_t >

JResult_t JTOOLS::JResultPDF< JResult_t >::fp

first derivative

Definition at line 514 of file JResult.hh.

◆ v

template<class JResult_t >

JResult_t JTOOLS::JResultPDF< JResult_t >::v

integral <xmin,x]

Definition at line 515 of file JResult.hh.

◆ V

template<class JResult_t >

JResult_t JTOOLS::JResultPDF< JResult_t >::V

integral <xmin,xmax>

Definition at line 516 of file JResult.hh.

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

JResult.hh

Public Types

Public Member Functions

Public Attributes

Detailed Description

Member Typedef Documentation

◆ argument_type

Constructor & Destructor Documentation

◆ JResultPDF() [1/3]

◆ JResultPDF() [2/3]

◆ JResultPDF() [3/3]

Member Function Documentation

◆ negate()

◆ add()

◆ sub()

◆ mul() [1/2]

◆ div()

◆ getP()

◆ getChi2()

◆ getDerivativeOfChi2()

◆ mul() [2/2]

Member Data Documentation

◆ f

◆ fp

◆ v

◆ V