CMP++: Uncertainty Quantification & Bayesian Calibration
Loading...
Searching...
No Matches
cmp::mean::Zero Class Reference

Represents a constant zero mean function. More...

#include <mean++.h>

Inheritance diagram for cmp::mean::Zero:
Collaboration diagram for cmp::mean::Zero:

Public Member Functions

 Zero ()=default
 
 Zero (const Zero &)=default
 
 Zero (Zero &&)=default
 
Zerooperator= (const Zero &)=default
 
Zerooperator= (Zero &&)=default
 
double eval (const Eigen::VectorXd &x, const Eigen::VectorXd &par) const
 Evaluates the zero mean function.
 
double evalGradient (const Eigen::VectorXd &x, const Eigen::VectorXd &log_par, const size_t &i) const
 Evaluates the partial derivative of the zero 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 zero mean function.
 
- Public Member Functions inherited from cmp::mean::Mean
virtual ~Mean ()=default
 

Static Public Member Functions

static std::shared_ptr< Meanmake ()
 Factory method for creating a Zero mean function.
 

Detailed Description

Represents a constant zero mean function.

Mathematical Formulation The mean is zero everywhere:

\[ m(\mathbf{x}) = 0 \]

Constructor & Destructor Documentation

◆ Zero() [1/3]

cmp::mean::Zero::Zero ( )
default

◆ Zero() [2/3]

cmp::mean::Zero::Zero ( const Zero )
default

◆ Zero() [3/3]

cmp::mean::Zero::Zero ( Zero &&  )
default

Member Function Documentation

◆ eval()

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

Evaluates the zero mean function.

Implements cmp::mean::Mean.

◆ evalGradient()

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

Evaluates the partial derivative of the zero mean function.

Implements cmp::mean::Mean.

◆ evalHessian()

double cmp::mean::Zero::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 zero mean function.

Implements cmp::mean::Mean.

◆ make()

static std::shared_ptr< Mean > cmp::mean::Zero::make ( )
inlinestatic

Factory method for creating a Zero mean function.

◆ operator=() [1/2]

Zero & cmp::mean::Zero::operator= ( const Zero )
default

◆ operator=() [2/2]

Zero & cmp::mean::Zero::operator= ( Zero &&  )
default

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