MeLOn
melon::kernel::Matern12< T, V > Class Template Reference

Class implementation of Matern12 kernel. More...

#include <matern.h>

Inheritance diagram for melon::kernel::Matern12< T, V >:
melon::kernel::Matern< T, V > melon::kernel::StationaryKernel< T, V > melon::kernel::Kernel< T, V >

Public Member Functions

RET evaluate_kernel (std::vector< T > x1, std::vector< V > x2)
 Function for evalualting the kernel for the points x1 and x2. More...
 
RET evaluate_kernel (RET distance)
 Function for evalualting the kernel for a given distance. More...
 
RET calculate_distance (std::vector< T > x1, std::vector< V > x2)
 Function for calculating the distance used in the kernel (type of distance used can vary among kernels) More...
 
- Public Member Functions inherited from melon::kernel::Matern< T, V >
 Matern ()
 
 Matern (std::shared_ptr< const KernelData > data)
 
- Public Member Functions inherited from melon::kernel::Kernel< T, V >
virtual ~Kernel ()=default
 Destructor. More...
 

Additional Inherited Members

- Public Types inherited from melon::kernel::Kernel< T, V >
using RET = decltype(std::declval< T >()+std::declval< V >())
 
- Protected Member Functions inherited from melon::kernel::Matern< T, V >
RET _quadratic_distance (std::vector< T > x1, std::vector< V > x2) override
 Calculates the quadratic distance between two points x1 and x2. More...
 
auto _euclidian_distance (RET quadraticDistance)
 Calculates the euclidian distance from the quadratic distance. More...
 
- Protected Attributes inherited from melon::kernel::Matern< T, V >
std::shared_ptr< const KernelData_data
 

Detailed Description

template<typename T, typename V>
class melon::kernel::Matern12< T, V >

Class implementation of Matern12 kernel.

Member Function Documentation

◆ calculate_distance()

template<typename T , typename V >
Matern12< T, V >::RET melon::kernel::Matern12< T, V >::calculate_distance ( std::vector< T >  x1,
std::vector< V >  x2 
)
virtual

Function for calculating the distance used in the kernel (type of distance used can vary among kernels)

Parameters
[in]x1is a vector containing the first point
[in]x2is a vector containing the second point
Returns
returns the distance used in the kernel

Implements melon::kernel::StationaryKernel< T, V >.

◆ evaluate_kernel() [1/2]

template<typename T , typename V >
Matern12< T, V >::RET melon::kernel::Matern12< T, V >::evaluate_kernel ( RET  distance)
virtual

Function for evalualting the kernel for a given distance.

Parameters
[in]distanceis a distance between two points for which the kernel is evaluated
Returns
returns the result of the kernel evaluation

Implements melon::kernel::StationaryKernel< T, V >.

◆ evaluate_kernel() [2/2]

template<typename T , typename V >
Matern12< T, V >::RET melon::kernel::Matern12< T, V >::evaluate_kernel ( std::vector< T >  x1,
std::vector< V >  x2 
)
virtual

Function for evalualting the kernel for the points x1 and x2.

Parameters
[in]x1is a vector containing the first point
[in]x2is a vector containing the second point
Returns
returns the result of the kernel evaluation

Implements melon::kernel::Kernel< T, V >.


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