cMHN::KLTHScore< T > Class Template Reference

Class storing a KL-Taylor-Hybrid Score, specializes the Score class. More...

#include <score.hpp>

Inheritance diagram for cMHN::KLTHScore< T >:

Public Member Functions
	~KLTHScore ()=default
	KLTHScore (KLTHScore const &)=default
	KLTHScore (KLTHScore &&)=default
KLTHScore &	operator= (KLTHScore const &) &=default
KLTHScore &	operator= (KLTHScore &&) &=default
	KLTHScore (T const &threshold)
auto &	threshold ()
auto const	threshold () const
Public Member Functions inherited from cMHN::Score< T >
	~Score ()=default
	Score (Score const &)=default
	Score (Score &&)=default
Score &	operator= (Score const &) &=default
Score &	operator= (Score &&) &=default
	Score ()=delete
	Score (auto const &pointwiseScore, auto const &pointwiseDSDP, auto const &name)
auto	pointwiseScore (T const &pDE, T const &pThetaE) const
auto	pointwiseDSDP (T const &pDE, T const &pThetaE) const
auto	name () const

Detailed Description

template<class T>
class cMHN::KLTHScore< T >

Class storing a KL-Taylor-Hybrid Score, specializes the Score class.

This score calculates the pointwise KL Score, i.e. pointwiseScore(pDE, pThetaE) = pDE * log(pThetaE), if the entry pThetaE is above a given threshold. If pThetaE is smaller than that threshold, it uses a taylor expansion of the logarithm to second order at the threshold value.

Note that none of the functions (pointwiseScore, pointwiseDSDP) can be changed.

Only the threshold value can be changed.

Template Parameters

T	type used for calculations

Constructor & Destructor Documentation

~KLTHScore()

template<class T >

cMHN::KLTHScore< T >::~KLTHScore ( )

default

KLTHScore() [1/3]

template<class T >

cMHN::KLTHScore< T >::KLTHScore ( KLTHScore< T > const &  )

default

KLTHScore() [2/3]

template<class T >

cMHN::KLTHScore< T >::KLTHScore ( KLTHScore< T > &&  )

default

KLTHScore() [3/3]

template<class T >

cMHN::KLTHScore< T >::KLTHScore ( T const &  threshold )

inlineexplicit

Member Function Documentation

operator=() [1/2]

template<class T >

KLTHScore & cMHN::KLTHScore< T >::operator= ( KLTHScore< T > &&  ) &

default

operator=() [2/2]

template<class T >

KLTHScore & cMHN::KLTHScore< T >::operator= ( KLTHScore< T > const &  ) &

default

threshold() [1/2]

template<class T >

auto & cMHN::KLTHScore< T >::threshold ( )

inline

threshold() [2/2]

template<class T >

auto const cMHN::KLTHScore< T >::threshold ( ) const

inline

---

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

• cmhn/common/score.hpp