cMHN::KLepsScore< T > Class Template Reference

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

#include <score.hpp>

Inheritance diagram for cMHN::KLepsScore< T >:

Public Member Functions
	~KLepsScore ()=default
	KLepsScore (KLepsScore const &)=default
	KLepsScore (KLepsScore &&)=default
KLepsScore &	operator= (KLepsScore const &) &=default
KLepsScore &	operator= (KLepsScore &&) &=default
	KLepsScore (T const &epsilon)
auto &	threshold ()
auto const	epsilon () 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::KLepsScore< T >

Class storing a KL-epsilon Score, specializes the Score class.

This score calculates the pointwise KL Score, i.e. pointwiseScore(pDE, pThetaE) = pDE * log(pThetaE). If pThetaE is smaller than a given epsilon value, pThetaE is substituted by epsilon for the score, and the gradient is set to zero.

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

Template Parameters

T	type used for calculations

Constructor & Destructor Documentation

~KLepsScore()

template<class T >

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

default

KLepsScore() [1/3]

template<class T >

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

default

KLepsScore() [2/3]

template<class T >

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

default

KLepsScore() [3/3]

template<class T >

cMHN::KLepsScore< T >::KLepsScore ( T const & epsilon )

inlineexplicit

Member Function Documentation

epsilon()

template<class T >

auto const cMHN::KLepsScore< T >::epsilon ( ) const

inline

operator=() [1/2]

template<class T >

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

default

operator=() [2/2]

template<class T >

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

default

threshold()

template<class T >

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

inline

---

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

• cmhn/common/score.hpp