Medusa  1.1
Coordinate Free Mehless Method implementation
mm::RBFWeight< RBFType, vec_t > Class Template Reference

#include <WeightFunction_fwd.hpp>

Detailed Description

template<class RBFType, class vec_t>
class mm::RBFWeight< RBFType, vec_t >

Represents a weight function constructed from a Radial Basis function.

Template Parameters
RBFTypeType of the RBF used. Must satisfy the Radial Basis Function concept.
vec_tVector type used in calculations.

The weight function \(w\) is defined as \(w(x) = f(\|x\|_2^2)\), where \(f\) is the given radial basis function.

This class satisfies the Weight function concept.

Usage example:

double s = 1.23;
RBFWeight<Gaussian<double>, Vec2d> weight(s);
Vec2d p(1.37, -0.97);
double val = weight(p);
std::cout << weight << std::endl;
See also
NoWeight, GaussianWeight, MQWeight, IMQWeight, PHWeight

Definition at line 63 of file WeightFunction_fwd.hpp.

Public Member Functions

 RBFWeight ()
 Construct a weight with default construction of RBF. More...
 
 RBFWeight (const rbf_t &rbf)
 Construct a weight from given RBF. More...
 
template<typename ... Args>
 RBFWeight (Args &&... args)
 Perfect forwarding constructor. Construct RBFWeight as if you were constructing given RBF. More...
 
const rbf_trbf () const
 Returns underlying RBF object. More...
 
rbf_trbf ()
 Returns modifiable underlying RBF object. More...
 
scalar_t operator() (const vector_t &point) const
 Evaluate weight function at point. More...
 

Public Types

enum  { dim = vec_t::dim }
 Store dimension of the domain. More...
 
typedef RBFType rbf_t
 Radial basis function type. More...
 
typedef vec_t vector_t
 Vector type. More...
 
typedef vector_t::scalar_t scalar_t
 Scalar type. More...
 

Friends

template<typename V , typename R >
std::ostream & operator<< (std::ostream &os, const RBFWeight< V, R > &m)
 Output basic info about given weight function. More...
 

Private Attributes

rbf_t rbf_
 RBF function. More...
 

Member Enumeration Documentation

◆ anonymous enum

template<class RBFType , class vec_t >
anonymous enum

Store dimension of the domain.

Enumerator
dim 

Dimensionality of the function domain.

Definition at line 71 of file WeightFunction_fwd.hpp.

Constructor & Destructor Documentation

◆ RBFWeight() [1/3]

template<class RBFType , class vec_t >
mm::RBFWeight< RBFType, vec_t >::RBFWeight ( )
inline

Construct a weight with default construction of RBF.

Definition at line 78 of file WeightFunction_fwd.hpp.

◆ RBFWeight() [2/3]

template<class RBFType , class vec_t >
mm::RBFWeight< RBFType, vec_t >::RBFWeight ( const rbf_t rbf)
inline

Construct a weight from given RBF.

Definition at line 80 of file WeightFunction_fwd.hpp.

◆ RBFWeight() [3/3]

template<class RBFType , class vec_t >
template<typename ... Args>
mm::RBFWeight< RBFType, vec_t >::RBFWeight ( Args &&...  args)
inline

Perfect forwarding constructor. Construct RBFWeight as if you were constructing given RBF.

Definition at line 83 of file WeightFunction_fwd.hpp.

Member Function Documentation

◆ operator()()

template<class RBFType , class vec_t >
scalar_t mm::RBFWeight< RBFType, vec_t >::operator() ( const vector_t point) const
inline

Evaluate weight function at point.

Definition at line 92 of file WeightFunction_fwd.hpp.

◆ rbf() [1/2]

template<class RBFType , class vec_t >
rbf_t& mm::RBFWeight< RBFType, vec_t >::rbf ( )
inline

Returns modifiable underlying RBF object.

Definition at line 89 of file WeightFunction_fwd.hpp.

◆ rbf() [2/2]

template<class RBFType , class vec_t >
const rbf_t& mm::RBFWeight< RBFType, vec_t >::rbf ( ) const
inline

Returns underlying RBF object.

Definition at line 86 of file WeightFunction_fwd.hpp.

Friends And Related Function Documentation

◆ operator<<

template<class RBFType , class vec_t >
template<typename V , typename R >
std::ostream& operator<< ( std::ostream &  os,
const RBFWeight< V, R > &  m 
)
friend

Output basic info about given weight function.

Definition at line 17 of file WeightFunction.hpp.

Member Data Documentation

◆ rbf_

template<class RBFType , class vec_t >
rbf_t mm::RBFWeight< RBFType, vec_t >::rbf_
private

RBF function.

Definition at line 74 of file WeightFunction_fwd.hpp.


The documentation for this class was generated from the following file:
mm::Vec2d
Vec< double, 2 > Vec2d
Convenience typedef for 2d vector of doubles.
Definition: Vec_fwd.hpp:34