JTOOLS::JResultDerivative< JResult_t > Struct Template Reference

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

#include <JResult.hh>

Inheritance diagram for JTOOLS::JResultDerivative< JResult_t >:

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

Public Member Functions
	JResultDerivative ()
	Default constructor.
	JResultDerivative (argument_type f, argument_type fp)
	Constructor.
JResultDerivative &	negate ()
	Prefix unary minus for function value of PDF.
JResultDerivative &	add (const JResultDerivative &value)
	Addition operator for function value of PDF.
JResultDerivative &	sub (const JResultDerivative &value)
	Subtraction operator for function value of PDF.
JResultDerivative &	mul (const double value)
	Multiplication operator for function value of PDF.
JResultDerivative &	div (const double value)
	Division operator for function value of PDF.
double	getP (const bool hit) const
	Get probability.
double	getChi2 (const bool hit) const
	Get chi2.
double	getDerivativeOfChi2 (const bool hit) const
	Get derivative of chi2.
JFirst_t &	mul (const JSecond_t &object)
	Multiply with object.

Public Attributes
JResult_t	f
	function value
JResult_t	fp
	first derivative

Detailed Description

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

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

This data structure contains the following data mambers:

   JResultDerivative::f   = function value;
   JResultDerivative::fp  = first  derivative;

This class implements the JMATH::JMath interface.

Definition at line 43 of file JResult.hh.

Member Typedef Documentation

argument_type

template<class JResult_t >

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

Definition at line 47 of file JResult.hh.

Constructor & Destructor Documentation

JResultDerivative() [1/2]

template<class JResult_t >

JTOOLS::JResultDerivative< JResult_t >::JResultDerivative ( )

inline

Default constructor.

Definition at line 53 of file JResult.hh.

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

JResultDerivative() [2/2]

template<class JResult_t >

JTOOLS::JResultDerivative< JResult_t >::JResultDerivative ( argument_type f, argument_type fp )

inline

Constructor.

Parameters

f	function value
fp	first derivative

Definition at line 65 of file JResult.hh.

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

Member Function Documentation

negate()

template<class JResult_t >

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

inline

Prefix unary minus for function value of PDF.

Returns

function value of PDF

Definition at line 77 of file JResult.hh.

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

add()

template<class JResult_t >

JResultDerivative & JTOOLS::JResultDerivative< JResult_t >::add ( const JResultDerivative< 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 92 of file JResult.hh.

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

sub()

template<class JResult_t >

JResultDerivative & JTOOLS::JResultDerivative< JResult_t >::sub ( const JResultDerivative< 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 107 of file JResult.hh.

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

mul() [1/2]

template<class JResult_t >

JResultDerivative & JTOOLS::JResultDerivative< 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 122 of file JResult.hh.

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

div()

template<class JResult_t >

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

inline

Division operator for function value of PDF.

Parameters

value

multiplication factor

Returns

function value of PDF

Definition at line 137 of file JResult.hh.

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

getP()

template<class JResult_t >

double JTOOLS::JResultDerivative< JResult_t >::getP ( const bool hit ) const

inline

Get probability.

If the given hit is false (true), the return value corresponds to the Poisson probability that zero (one or more) hits occur for the given expectation value JResultDerivative::f.

Parameters

hit	hit (or not)

Returns

probability

Definition at line 154 of file JResult.hh.

    {
      if (!hit)
        return exp(-f);                  // probability of 0 hits
      else
        return 1.0 - getP(false);        // probability of 1 or more hits
    }

getChi2()

template<class JResult_t >

double JTOOLS::JResultDerivative< JResult_t >::getChi2 ( const bool hit ) const

inline

Get chi2.

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

Parameters

hit	hit (or not)

Returns

chi2

Definition at line 170 of file JResult.hh.

    {
      if (!hit)
        return  f;                       // = -log(getP(false))
      else
        return -log(getP(true));
    }

getDerivativeOfChi2()

template<class JResult_t >

double JTOOLS::JResultDerivative< JResult_t >::getDerivativeOfChi2 ( const bool hit ) const

inline

Get derivative of chi2.

Parameters

hit	hit (or not)

Returns

derivative

Definition at line 185 of file JResult.hh.

    {
      if (!hit)
        return  fp;
      else
        return -fp * getP(false) / getP(true);
    }

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::JResultDerivative< JResult_t >::f

function value

Definition at line 194 of file JResult.hh.

fp

template<class JResult_t >

JResult_t JTOOLS::JResultDerivative< JResult_t >::fp

first derivative

Definition at line 195 of file JResult.hh.

---

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

• JResult.hh