JTOOLS::JResultHesse< JResult_t > Struct Template Reference

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

#include <JResult.hh>

Inheritance diagram for JTOOLS::JResultHesse< JResult_t >:

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

Public Member Functions
	JResultHesse ()
	Default constructor. More...
	JResultHesse (argument_type __f, argument_type __fp)
	Constructor. More...
JResultHesse &	negate ()
	Prefix unary minus for function value of PDF. More...
JResultHesse &	add (const JResultHesse &value)
	Addition operator for function value of PDF. More...
JResultHesse &	sub (const JResultHesse &value)
	Subtraction operator for function value of PDF. More...
JResultHesse &	mul (const double value)
	Multiplication operator for function value of PDF. More...
JResultHesse &	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...
JResultHesse< 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::JResultHesse< JResult_t >

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

This data structure contains the following data mambers:

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

This class implements the JMATH::JMath interface.

Definition at line 40 of file JResult.hh.

Member Typedef Documentation

template<class JResult_t>

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

Definition at line 44 of file JResult.hh.

Constructor & Destructor Documentation

template<class JResult_t>

JTOOLS::JResultHesse< JResult_t >::JResultHesse ( )

inline

Default constructor.

Definition at line 50 of file JResult.hh.

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

template<class JResult_t>

JTOOLS::JResultHesse< JResult_t >::JResultHesse ( argument_type  __f, argument_type  __fp  )

inline

Constructor.

Parameters

__f	function value
__fp	first derivative

Definition at line 62 of file JResult.hh.

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

Member Function Documentation

template<class JResult_t>

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

inline

Prefix unary minus for function value of PDF.

Returns

function value of PDF

Definition at line 74 of file JResult.hh.

    {
      f  = -f;
      fp = -fp;

      return *this;
    }

template<class JResult_t>

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

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

      return *this;
    }

template<class JResult_t>

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

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

      return *this;
    }

template<class JResult_t>

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

    {
      f  *= value;
      fp *= value;

      return *this;
    }

template<class JResult_t>

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

    {
      f  /= value;
      fp /= value;

      return *this;
    }

template<class JResult_t>

double JTOOLS::JResultHesse< 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 JResultHesse::f.

Parameters

hit	hit (or not)

Returns

probability

Definition at line 151 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::JResultHesse< JResult_t >::getChi2 ( const bool  hit ) const

inline

Get chi2.

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

Parameters

hit	hit (or not)

Returns

chi2

Definition at line 167 of file JResult.hh.

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

template<class JResult_t>

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

inline

Get derivative of chi2.

Parameters

hit	hit (or not)

Returns

derivative

Definition at line 182 of file JResult.hh.

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

JResultHesse< JResult_t > & JMATH::JMath< JResultHesse< 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::JResultHesse< JResult_t >::f

function value

Definition at line 191 of file JResult.hh.

template<class JResult_t>

JResult_t JTOOLS::JResultHesse< JResult_t >::fp

first derivative

Definition at line 192 of file JResult.hh.

---

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

• JResult.hh