covariance__functions::PeriodicSquareExponential

Search for usage in LXR

Public Member Functions | List of all members
covariance_functions::PeriodicSquareExponential Class Reference

#include <covariance_functions.h>

Inheritance diagram for covariance_functions::PeriodicSquareExponential:
Inheritance graph
[legend]

Public Member Functions

 PeriodicSquareExponential (const Eigen::VectorXd &hyperParameters)
 
virtual CovFunc * clone () const override
 
Eigen::MatrixXd evaluate (const Eigen::VectorXd &x1, const Eigen::VectorXd &x2) override
 
int getExtraParameterCount () const override
 
const Eigen::VectorXd & getExtraParameters () const override
 
int getParameterCount () const override
 
const Eigen::VectorXd & getParameters () const override
 
void setExtraParameters (const Eigen::VectorXd &params) override
 
void setParameters (const Eigen::VectorXd &params) override
 
- Public Member Functions inherited from covariance_functions::CovFunc

Detailed Description

The function computes a combined covariance function. It is a periodic covariance function with an additional square exponential. This combination makes it possible to learn a signal that consists of both periodic and aperiodic parts.

Square Exponential Component:

\[ k _{\textsc{se}}(t,t';\theta_\textsc{se},\ell_\textsc{se}) = \theta_\textsc{se} \cdot \exp\left(-\frac{(t-t')^2}{2\ell_\textsc{se}^{2}}\right) \]

Periodic Component:

\[ k_\textsc{p}(t,t';\theta_\textsc{p},\ell_\textsc{p},\lambda) = \theta_\textsc{p} \cdot \exp\left(-\frac{2\sin^2\left(\frac{\pi}{\lambda} (t-t')\right)}{\ell_\textsc{p}^2}\right) \]

Kernel Combination:

\[ k _\textsc{c}(t,t';\theta_\textsc{se},\ell_\textsc{se},\theta_\textsc{p}, \ell_\textsc{p},\lambda) = k_{\textsc{se}}(t,t';\theta_\textsc{se},\ell_\textsc{se}) + k_\textsc{p}(t,t';\theta_\textsc{p},\ell_\textsc{p},\lambda) \]

Definition at line 93 of file covariance_functions.h.

Constructor & Destructor Documentation

◆ PeriodicSquareExponential() [1/2]

covariance_functions::PeriodicSquareExponential::PeriodicSquareExponential ( )

Definition at line 27 of file covariance_functions.cpp.

◆ PeriodicSquareExponential() [2/2]

covariance_functions::PeriodicSquareExponential::PeriodicSquareExponential ( const Eigen::VectorXd & hyperParameters)
explicit

Definition at line 30 of file covariance_functions.cpp.

Member Function Documentation

◆ clone()

virtual CovFunc * covariance_functions::PeriodicSquareExponential::clone ( ) const
inlineoverridevirtual

Produces a clone to be able to copy the object.

Implements covariance_functions::CovFunc.

Definition at line 124 of file covariance_functions.h.

◆ evaluate()

Eigen::MatrixXd covariance_functions::PeriodicSquareExponential::evaluate ( const Eigen::VectorXd & x1,
const Eigen::VectorXd & x2 )
overridevirtual

Evaluates the covariance function, caches the quantities that are needed to calculate gradient and Hessian.

Implements covariance_functions::CovFunc.

Definition at line 33 of file covariance_functions.cpp.

◆ getExtraParameterCount()

int covariance_functions::PeriodicSquareExponential::getExtraParameterCount ( ) const
overridevirtual

Implements covariance_functions::CovFunc.

Definition at line 95 of file covariance_functions.cpp.

◆ getExtraParameters()

const Eigen::VectorXd & covariance_functions::PeriodicSquareExponential::getExtraParameters ( ) const
overridevirtual

Implements covariance_functions::CovFunc.

Definition at line 85 of file covariance_functions.cpp.

◆ getParameterCount()

int covariance_functions::PeriodicSquareExponential::getParameterCount ( ) const
overridevirtual

Returns the number of hyper-parameters.

Implements covariance_functions::CovFunc.

Definition at line 90 of file covariance_functions.cpp.

◆ getParameters()

const Eigen::VectorXd & covariance_functions::PeriodicSquareExponential::getParameters ( ) const
overridevirtual

Returns the hyper-parameters.

Implements covariance_functions::CovFunc.

Definition at line 80 of file covariance_functions.cpp.

◆ setExtraParameters()

void covariance_functions::PeriodicSquareExponential::setExtraParameters ( const Eigen::VectorXd & params)
overridevirtual

Implements covariance_functions::CovFunc.

Definition at line 75 of file covariance_functions.cpp.

◆ setParameters()

void covariance_functions::PeriodicSquareExponential::setParameters ( const Eigen::VectorXd & params)
overridevirtual

Method to set the hyper-parameters.

Implements covariance_functions::CovFunc.

Definition at line 70 of file covariance_functions.cpp.

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Mon Nov 4 2024 16:38:45 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.