cmp::mean::Constant Class Reference

Represents a constant mean function. More...

#include <mean++.h>

Inheritance diagram for cmp::mean::Constant:

Collaboration diagram for cmp::mean::Constant:

Public Member Functions
	Constant (const Constant &)=default
	Constant (Constant &&)=default
Constant &	operator= (const Constant &)=default
Constant &	operator= (Constant &&)=default
	Constant (const size_t &c)
	Constructs a Constant mean function using the hyperparameter at index c.
double	eval (const Eigen::VectorXd &x, const Eigen::VectorXd &par) const
	Evaluates the constant mean.
double	evalGradient (const Eigen::VectorXd &x, const Eigen::VectorXd &log_par, const size_t &i) const
	Evaluates the partial derivative of the constant mean function.
double	evalHessian (const Eigen::VectorXd &x, const Eigen::VectorXd &log_par, const size_t &i, const size_t &j) const
	Evaluates the second-order partial derivative (Hessian) of the constant mean function.
Public Member Functions inherited from cmp::mean::Mean
virtual	~Mean ()=default

Static Public Member Functions
static std::shared_ptr< Mean >	make (const size_t &c)
	Factory method for creating a Constant mean function.

Private Attributes
size_t	index_
	Hyperparameter index of the constant value.

Detailed Description

Represents a constant mean function.

Mathematical Formulation The mean function returns a constant value from the hyperparameters:

\[ m(\mathbf{x}) = \theta_{\text{index}} \]

Constructor & Destructor Documentation

Constant() [1/3]

cmp::mean::Constant::Constant ( const Constant &  )

default

Constant() [2/3]

cmp::mean::Constant::Constant ( Constant &&  )

default

Constant() [3/3]

cmp::mean::Constant::Constant ( const size_t &  c )

inline

Constructs a Constant mean function using the hyperparameter at index c.

Member Function Documentation

eval()

double cmp::mean::Constant::eval ( const Eigen::VectorXd &  x, const Eigen::VectorXd &  par  ) const

inlinevirtual

Evaluates the constant mean.

Implements cmp::mean::Mean.

evalGradient()

double cmp::mean::Constant::evalGradient ( const Eigen::VectorXd &  x, const Eigen::VectorXd &  log_par, const size_t &  i  ) const

inlinevirtual

Evaluates the partial derivative of the constant mean function.

Implements cmp::mean::Mean.

evalHessian()

double cmp::mean::Constant::evalHessian ( const Eigen::VectorXd &  x, const Eigen::VectorXd &  log_par, const size_t &  i, const size_t &  j  ) const

inlinevirtual

Evaluates the second-order partial derivative (Hessian) of the constant mean function.

Implements cmp::mean::Mean.

make()

static std::shared_ptr< Mean > cmp::mean::Constant::make ( const size_t &  c )

inlinestatic

Factory method for creating a Constant mean function.

operator=() [1/2]

Constant & cmp::mean::Constant::operator= ( const Constant &  )

default

operator=() [2/2]

Constant & cmp::mean::Constant::operator= ( Constant &&  )

default

Member Data Documentation

index_

size_t cmp::mean::Constant::index_

private

Hyperparameter index of the constant value.

---

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

• include/mean++.h