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(hyper_cube_ref< double > unit, std::unordered_map< std::string, double > & physical) const =0
Transform from unit hypercube to physical parameter.
voidtransform(const std::vector< double > & unit, std::unordered_map< std::string, double > & physical) const
std::unordered_map< std::string, double >transform(const std::vector< double > & unit) const
virtual voidinverse_transform(const std::unordered_map< std::string, double > & physical, hyper_cube_ref< double > unit) const =0
Transform from physical parameter to unit hypercube.
voidinverse_transform(const std::unordered_map< std::string, double > & physical, std::vector< double > & unit) const
std::vector< double >inverse_transform(const std::unordered_map< std::string, double > & physical) const
virtual doublelog_prior_density(const std::unordered_map< std::string, double > & ) const =0
Log of prior 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(
    hyper_cube_ref< double > unit,
    std::unordered_map< std::string, double > & physical
) const =0

Transform from unit hypercube to physical parameter.

Reimplemented by: 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, Gambit::Priors::None::transform, Gambit::Priors::FixedPrior::transform, Gambit::Priors::MultiPriors::transform

function transform

inline void transform(
    const std::vector< double > & unit,
    std::unordered_map< std::string, double > & physical
) const

function transform

inline std::unordered_map< std::string, double > transform(
    const std::vector< double > & unit
) const

function inverse_transform

virtual void inverse_transform(
    const std::unordered_map< std::string, double > & physical,
    hyper_cube_ref< double > unit
) const =0

Transform from physical parameter 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::RangePrior1D::inverse_transform, Gambit::Priors::Gaussian::inverse_transform, Gambit::Priors::LogNormal::inverse_transform, Gambit::Priors::FixedPrior::inverse_transform, Gambit::Priors::MultiPriors::inverse_transform

function inverse_transform

inline void inverse_transform(
    const std::unordered_map< std::string, double > & physical,
    std::vector< double > & unit
) const

function inverse_transform

inline std::vector< double > inverse_transform(
    const std::unordered_map< std::string, double > & physical
) const

function log_prior_density

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

Log of prior density.

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

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 2024-07-18 at 13:53:32 +0000