cMHN::sKLScore< T > Class Template Reference

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

#include <score.hpp>

Inheritance diagram for cMHN::sKLScore< T >:

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

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

This score calculates the pointwise static sKL Score, i.e. pointwiseScore(pDE, pThetaE) = (pDE + epsilon) * log((pDE + epsilon) / (pThetaE + epsilon)), with fixed epsilon.

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

Template Parameters

T	type used for calculations

Constructor & Destructor Documentation

~sKLScore()

template<class T >

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

default

sKLScore() [1/3]

template<class T >

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

default

sKLScore() [2/3]

template<class T >

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

default

sKLScore() [3/3]

template<class T >

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

inlineexplicit

Member Function Documentation

epsilon() [1/2]

template<class T >

auto & cMHN::sKLScore< T >::epsilon ( )

inline

epsilon() [2/2]

template<class T >

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

inline

operator=() [1/2]

template<class T >

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

default

operator=() [2/2]

template<class T >

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

default

---

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

• cmhn/common/score.hpp