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

Public Member Functions
	JResultHesse ()
	Default constructor.

	JResultHesse (argument_type f, argument_type fp, argument_type fpp)
	Constructor.

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

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

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

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

JResultHesse &	div (const double value)
	Division operator 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.

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

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	fpp
	second derivative

JResult_t	f
	function value

JResult_t	fp
	first derivative

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;
   JResultHesse::fpp = second derivative;

This class implements the JMATH::JMath interface.

Definition at line 212 of file JResult.hh.

Member Typedef Documentation

◆ argument_type

template<class JResult_t >

JResultDerivative<JResult_t>::argument_type JTOOLS::JResultHesse< JResult_t >::argument_type

Definition at line 217 of file JResult.hh.

Constructor & Destructor Documentation

◆ JResultHesse() [1/2]

template<class JResult_t >

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

inline

Default constructor.

Definition at line 223 of file JResult.hh.

                   :
      JResultDerivative<JResult_t>(),
      fpp(JMATH::zero)
    {}

◆ JResultHesse() [2/2]

template<class JResult_t >

JTOOLS::JResultHesse< JResult_t >::JResultHesse	(	argument_type	f,
		argument_type	fp,
		argument_type	fpp )

inline

Constructor.

Parameters

f	function value
fp	first derivative
fpp	second derivative

Definition at line 236 of file JResult.hh.

                                    :
      JResultDerivative<JResult_t>(f, fp),
      fpp(fpp)
    {}

Member Function Documentation

◆ negate()

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

    {
      static_cast<JResultDerivative<JResult_t>&>(*this).negate();
      fpp = -fpp;
 
      return *this;
    }

◆ add() [1/2]

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

    {
      static_cast<JResultDerivative<JResult_t>&>(*this).add(value);
      fpp += value.fpp;
 
      return *this;
    }

◆ sub() [1/2]

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

    {
      static_cast<JResultDerivative<JResult_t>&>(*this).sub(value);
      fpp -= value.fpp;
 
      return *this;
    }

◆ mul() [1/3]

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

    {
      static_cast<JResultDerivative<JResult_t>&>(*this).mul(value);
      fpp *= value;
 
      return *this;
    }

◆ div()

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

    {
      static_cast<JResultDerivative<JResult_t>&>(*this).div(value);
      fpp /= value;
 
      return *this;
    }

◆ add() [2/2]

template<class JResult_t >

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

inlineinherited

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() [2/2]

template<class JResult_t >

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

inlineinherited

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() [2/3]

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);
    }

◆ getP()

template<class JResult_t >

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

inlineinherited

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

inlineinherited

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

inlineinherited

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() [3/3]

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

◆ fpp

template<class JResult_t >

JResult_t JTOOLS::JResultHesse< JResult_t >::fpp

second derivative

Definition at line 318 of file JResult.hh.

◆ f

template<class JResult_t >

JResult_t JTOOLS::JResultDerivative< JResult_t >::f

inherited

function value

Definition at line 194 of file JResult.hh.

◆ fp

template<class JResult_t >

JResult_t JTOOLS::JResultDerivative< JResult_t >::fp

inherited

first derivative

Definition at line 195 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

◆ JResultHesse() [1/2]

◆ JResultHesse() [2/2]

Member Function Documentation

◆ negate()

◆ add() [1/2]

◆ sub() [1/2]

◆ mul() [1/3]

◆ div()

◆ add() [2/2]

◆ sub() [2/2]

◆ mul() [2/3]

◆ getP()

◆ getChi2()

◆ getDerivativeOfChi2()

◆ mul() [3/3]

Member Data Documentation

◆ fpp

◆ f

◆ fp