hops
Public Member Functions | List of all members
hops::ModelWrapper Class Reference

#include <ModelWrapper.hpp>

Collaboration diagram for hops::ModelWrapper:
Collaboration graph

Public Member Functions

 ModelWrapper (std::shared_ptr< Model > model)
 
virtual MatrixType::Scalar computeNegativeLogLikelihood (const VectorType &state)
 
virtual std::optional< VectorTypecomputeLogLikelihoodGradient (const VectorType &state)
 
virtual std::optional< MatrixTypecomputeExpectedFisherInformation (const VectorType &state)
 
const std::shared_ptr< Model > & getModel () const
 
void setModel (const std::shared_ptr< Model > &newModel)
 
bool hasModel ()
 

Detailed Description

@Brief Wrapper to help mix in models to proposals. It also allows for swapping models dynamically.

Constructor & Destructor Documentation

◆ ModelWrapper()

hops::ModelWrapper::ModelWrapper ( std::shared_ptr< Model model)
inlineexplicit

Member Function Documentation

◆ computeExpectedFisherInformation()

virtual std::optional<MatrixType> hops::ModelWrapper::computeExpectedFisherInformation ( const VectorType state)
inlinevirtual

@Brief Virtual because later mixins are allowed to override, e.g. Coldness

◆ computeLogLikelihoodGradient()

virtual std::optional<VectorType> hops::ModelWrapper::computeLogLikelihoodGradient ( const VectorType state)
inlinevirtual

@Brief Virtual because later mixins are allowed to override, e.g. Coldness

◆ computeNegativeLogLikelihood()

virtual MatrixType::Scalar hops::ModelWrapper::computeNegativeLogLikelihood ( const VectorType state)
inlinevirtual

@Brief Virtual because later mixins are allowed to override, e.g. Coldness

◆ getModel()

const std::shared_ptr<Model>& hops::ModelWrapper::getModel ( ) const
inline

◆ hasModel()

bool hops::ModelWrapper::hasModel ( )
inline

◆ setModel()

void hops::ModelWrapper::setModel ( const std::shared_ptr< Model > &  newModel)
inline

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