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. More...
	JResultDerivative (argument_type f, argument_type fp)
	Constructor. More...
JResultDerivative &	negate ()
	Prefix unary minus for function value of PDF. More...
JResultDerivative &	add (const JResultDerivative &value)
	Addition operator for function value of PDF. More...
JResultDerivative &	sub (const JResultDerivative &value)
	Subtraction operator for function value of PDF. More...
JResultDerivative &	mul (const double value)
	Multiplication operator for function value of PDF. More...
JResultDerivative &	div (const double value)
	Division operator for function value of PDF. More...
double	getP (const bool hit) const
	Get probability. More...
double	getChi2 (const bool hit) const
	Get chi2. More...
double	getDerivativeOfChi2 (const bool hit) const
	Get derivative of chi2. More...
JResultDerivative< JResult_t > &	mul (const JNullType &object)
	Multiply with object. More...

Public Attributes
JResult_t	f
	function value More...
JResult_t	fp
	first derivative More...

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 41 of file JResult.hh.

Member Typedef Documentation

template<class JResult_t>

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

Definition at line 45 of file JResult.hh.

Constructor & Destructor Documentation

template<class JResult_t>

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

inline

Default constructor.

Definition at line 51 of file JResult.hh.

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

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 63 of file JResult.hh.

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

Member Function Documentation

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 75 of file JResult.hh.

    {
      f   = -f;
      fp  = -fp;

      return *this;
    }

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 90 of file JResult.hh.

    {
      f   += value.f;
      fp  += value.fp;

      return *this;
    }

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 105 of file JResult.hh.

    {
      f   -= value.f;
      fp  -= value.fp;

      return *this;
    }

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 120 of file JResult.hh.

    {
      f   *= value;
      fp  *= value;

      return *this;
    }

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 135 of file JResult.hh.

    {
      f   /= value;
      fp  /= value;

      return *this;
    }

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 152 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
    }

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 168 of file JResult.hh.

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

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 183 of file JResult.hh.

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

JResultDerivative< JResult_t > & JMATH::JMath< JResultDerivative< JResult_t > , JNullType >::mul ( const JNullType &  object )

inlineinherited

Multiply with object.

Parameters

object

object

Returns

result object

Definition at line 273 of file JMath.hh.

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

Member Data Documentation

template<class JResult_t>

JResult_t JTOOLS::JResultDerivative< JResult_t >::f

function value

Definition at line 192 of file JResult.hh.

template<class JResult_t>

JResult_t JTOOLS::JResultDerivative< JResult_t >::fp

first derivative

Definition at line 193 of file JResult.hh.

---

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

• JResult.hh