cMHN::sKLdynScore< T > Class Template Reference

Class storing a dynamic sKL-Divergence Score, specializes the Score class. More...

#include <score.hpp>

Inheritance diagram for cMHN::sKLdynScore< T >:

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

Class storing a dynamic sKL-Divergence Score, specializes the Score class.

This score calculates the pointwise sKL Score with dynamic choice of epsilon, i.e. pointwiseScore(pDE, pThetaE) = (pDE + epsilon) * log((pDE+epsilon) / (pThetaE + epsilon)) with epsilon = (1+delta)|pThetaE| if pThetaE<0, and epsilon = 0 otherwise.

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

Template Parameters

T	type used for calculations

Constructor & Destructor Documentation

~sKLdynScore()

template<class T >

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

default

sKLdynScore() [1/3]

template<class T >

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

default

sKLdynScore() [2/3]

template<class T >

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

default

sKLdynScore() [3/3]

template<class T >

cMHN::sKLdynScore< T >::sKLdynScore ( T const & delta )

inlineexplicit

Member Function Documentation

delta() [1/2]

template<class T >

auto & cMHN::sKLdynScore< T >::delta ( )

inline

delta() [2/2]

template<class T >

auto const cMHN::sKLdynScore< T >::delta ( ) const

inline

operator=() [1/2]

template<class T >

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

default

operator=() [2/2]

template<class T >

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

default

---

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

• cmhn/common/score.hpp