cMHN::Score< T > Class Template Reference

Class storing all relevant information for a score. More...

#include <score.hpp>

Inheritance diagram for cMHN::Score< T >:

Public Member Functions
	~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::Score< T >

Class storing all relevant information for a score.

Member functions pointwiseScore(pDE, pThetaE) and pointwiseDSDP(pDE, pThetaE) return the point-wise evaluated score and dS/dpThetaE. The member function name() accesses the name given to the regulator. The scores are defined such that lower scores represent better values.

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

Template Parameters

T	type used for calculations

Constructor & Destructor Documentation

~Score()

template<class T >

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

default

Score() [1/4]

template<class T >

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

default

Score() [2/4]

template<class T >

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

default

Score() [3/4]

template<class T >

cMHN::Score< T >::Score ( )

delete

Score() [4/4]

template<class T >

cMHN::Score< T >::Score ( auto const & pointwiseScore, auto const & pointwiseDSDP, auto const & name )

inlineexplicit

Member Function Documentation

name()

template<class T >

auto cMHN::Score< T >::name ( ) const

inline

operator=() [1/2]

template<class T >

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

default

operator=() [2/2]

template<class T >

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

default

pointwiseDSDP()

template<class T >

auto cMHN::Score< T >::pointwiseDSDP ( T const & pDE, T const & pThetaE ) const

inline

pointwiseScore()

template<class T >

auto cMHN::Score< T >::pointwiseScore ( T const & pDE, T const & pThetaE ) const

inline

---

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

• cmhn/common/score.hpp