class Gambit::Priors::BasePrior

Abstract base class for priors.

#include <base_prior.hpp>

Inherited by Gambit::Priors::Cauchy, Gambit::Priors::CompositePrior, Gambit::Priors::DoubleLogFlatJoin, Gambit::Priors::Dummy, Gambit::Priors::FixedPrior, Gambit::Priors::Gaussian, Gambit::Priors::LogNormal, Gambit::Priors::MultiPriors, Gambit::Priors::None, Gambit::Priors::Plugin, Gambit::Priors::RangePrior1D< T >

Public Functions

Name
virtual~BasePrior() =default
BasePrior()
BasePrior(const int param_size)
BasePrior(const std::vector< std::string > & param_names, const int param_size =0)
BasePrior(const std::string & param_name, const int param_size =0)
virtual voidtransform(const std::vector< double > & , std::unordered_map< std::string, double > & ) const =0
Transform from unit hypercube to parameter.
virtual std::vector< double >inverse_transform(const std::unordered_map< std::string, double > & ) const =0
Transform from parameter back to unit hypercube.
virtual doubleoperator()(const std::vector< double > & ) const
Log of PDF density.
virtual std::vector< std::string >getShownParameters() const
unsigned intsize() const
voidsetSize(const unsigned int size)
unsigned int &sizeRef()
std::vector< std::string >getParameters() const

Protected Attributes

Name
std::vector< std::string >param_names

Public Functions Documentation

function ~BasePrior

virtual ~BasePrior() =default

function BasePrior

inline BasePrior()

function BasePrior

inline explicit BasePrior(
    const int param_size
)

function BasePrior

inline explicit BasePrior(
    const std::vector< std::string > & param_names,
    const int param_size =0
)

function BasePrior

inline explicit BasePrior(
    const std::string & param_name,
    const int param_size =0
)

function transform

virtual void transform(
    const std::vector< double > & ,
    std::unordered_map< std::string, double > & 
) const =0

Transform from unit hypercube to parameter.

Reimplemented by: Gambit::Priors::None::transform, Gambit::Priors::FixedPrior::transform, Gambit::Priors::MultiPriors::transform, Gambit::Priors::DoubleLogFlatJoin::transform, Gambit::Priors::RangePrior1D::transform, Gambit::Priors::Cauchy::transform, Gambit::Priors::CompositePrior::transform, Gambit::Priors::Dummy::transform, Gambit::Priors::Gaussian::transform, Gambit::Priors::LogNormal::transform, Gambit::Priors::Plugin::transform

function inverse_transform

virtual std::vector< double > inverse_transform(
    const std::unordered_map< std::string, double > & 
) const =0

Transform from parameter back to unit hypercube.

Reimplemented by: Gambit::Priors::DoubleLogFlatJoin::inverse_transform, Gambit::Priors::None::inverse_transform, Gambit::Priors::Plugin::inverse_transform, Gambit::Priors::Cauchy::inverse_transform, Gambit::Priors::CompositePrior::inverse_transform, Gambit::Priors::Dummy::inverse_transform, Gambit::Priors::FixedPrior::inverse_transform, Gambit::Priors::MultiPriors::inverse_transform, Gambit::Priors::RangePrior1D::inverse_transform, Gambit::Priors::Gaussian::inverse_transform, Gambit::Priors::LogNormal::inverse_transform

function operator()

inline virtual double operator()(
    const std::vector< double > & 
) const

Log of PDF density.

Reimplemented by: Gambit::Priors::Cauchy::operator(), Gambit::Priors::DoubleLogFlatJoin::operator(), Gambit::Priors::RangePrior1D::operator(), Gambit::Priors::Gaussian::operator(), Gambit::Priors::LogNormal::operator(), Gambit::Priors::Plugin::operator()

function getShownParameters

inline virtual std::vector< std::string > getShownParameters() const

Reimplemented by: Gambit::Priors::CompositePrior::getShownParameters, Gambit::Priors::FixedPrior::getShownParameters, Gambit::Priors::MultiPriors::getShownParameters

function size

inline unsigned int size() const

function setSize

inline void setSize(
    const unsigned int size
)

function sizeRef

inline unsigned int & sizeRef()

function getParameters

inline std::vector< std::string > getParameters() const

Protected Attributes Documentation

variable param_names

std::vector< std::string > param_names;

Updated on 2023-06-26 at 21:36:52 +0000