hops::Coldness< ModelType > Class Template Reference

Mixin that adds coldness to model evaluations. More...

#include <Coldness.hpp>

Inheritance diagram for hops::Coldness< ModelType >:

Collaboration diagram for hops::Coldness< ModelType >:

Public Member Functions
	Coldness (ModelType model, double coldness=1)
MatrixType::Scalar	computeNegativeLogLikelihood (const VectorType &state)
std::optional< VectorType >	computeLogLikelihoodGradient (const VectorType &state)
std::optional< MatrixType >	computeExpectedFisherInformation (const VectorType &state)
double	getColdness () const
void	setColdness (double newColdness)

Detailed Description

template<typename ModelType>
class hops::Coldness< ModelType >

Mixin that adds coldness to model evaluations.

The result of calls to model are rescaled the coldness. This is useful for ensemble models such as Parallel Tempering.

Constructor & Destructor Documentation

Coldness()

template<typename ModelType >

hops::Coldness< ModelType >::Coldness ( ModelType  model, double  coldness = 1  )

inlineexplicit

Member Function Documentation

computeExpectedFisherInformation()

template<typename ModelType >

std::optional<MatrixType> hops::Coldness< ModelType >::computeExpectedFisherInformation ( const VectorType &  state )

inline

computeLogLikelihoodGradient()

template<typename ModelType >

std::optional<VectorType> hops::Coldness< ModelType >::computeLogLikelihoodGradient ( const VectorType &  state )

inline

computeNegativeLogLikelihood()

template<typename ModelType >

MatrixType::Scalar hops::Coldness< ModelType >::computeNegativeLogLikelihood ( const VectorType &  state )

inline

getColdness()

template<typename ModelType >

double hops::Coldness< ModelType >::getColdness ( ) const

inline

setColdness()

template<typename ModelType >

void hops::Coldness< ModelType >::setColdness ( double  newColdness )

inline

---

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

• Coldness.hpp