iRoCS Toolbox  1.1.0
Public Member Functions | Static Public Member Functions | Protected Attributes
svt::Kernel_POLY Class Reference

The Kernel_POLY class specifies a polynomial kernel function: (gamma*u'*v + coef0)^degree. More...

#include <Kernel_POLY.hh>

Collaboration diagram for svt::Kernel_POLY:

Public Member Functions

 Kernel_POLY (double gamma=1., double coef0=0., double degree=3.)
 
 ~Kernel_POLY ()
 
void clearCache () const
 
double coef0 () const
 
double degree () const
 
double gamma () const
 
template<typename FV >
double k_function (const FV &x, const FV &y) const
 
template<typename STDATA >
void loadParameters (STDATA &stData)
 
template<typename STDATA >
void saveParameters (STDATA &stData) const
 
void setCoef0 (double coef0)
 
void setDegree (double degree)
 
void setGamma (double gamma)
 
template<typename ForwardIter , typename Accessor >
void updateCache (const ForwardIter &, const ForwardIter &, Accessor, ProgressReporter *) const
 
template<typename ForwardIter1 , typename Accessor1 , typename ForwardIter2 , typename Accessor2 >
void updateCache (const ForwardIter1 &, const ForwardIter1 &, Accessor1, const ForwardIter2 &, const ForwardIter2 &, Accessor2, ProgressReporter *=0) const
 

Static Public Member Functions

static const char * description ()
 
static void getParamInfos (std::vector< ParamInfo > &p)
 get information about the parameters, that are used in loadParameters() and saveParameters(). More...
 
static const char * name ()
 

Protected Attributes

double p_coef0
 
double p_degree
 
double p_gamma
 

Detailed Description

The Kernel_POLY class specifies a polynomial kernel function: (gamma*u'*v + coef0)^degree.

Definition at line 115 of file Kernel_POLY.hh.

Constructor & Destructor Documentation

◆ Kernel_POLY()

svt::Kernel_POLY::Kernel_POLY ( double  gamma = 1.,
double  coef0 = 0.,
double  degree = 3. 
)
inline

Definition at line 118 of file Kernel_POLY.hh.

◆ ~Kernel_POLY()

svt::Kernel_POLY::~Kernel_POLY ( )
inline

Definition at line 127 of file Kernel_POLY.hh.

Member Function Documentation

◆ setGamma()

void svt::Kernel_POLY::setGamma ( double  gamma)
inline

Definition at line 130 of file Kernel_POLY.hh.

◆ setCoef0()

void svt::Kernel_POLY::setCoef0 ( double  coef0)
inline

Definition at line 131 of file Kernel_POLY.hh.

◆ setDegree()

void svt::Kernel_POLY::setDegree ( double  degree)
inline

Definition at line 132 of file Kernel_POLY.hh.

◆ gamma()

double svt::Kernel_POLY::gamma ( ) const
inline

Definition at line 133 of file Kernel_POLY.hh.

Referenced by setGamma().

◆ coef0()

double svt::Kernel_POLY::coef0 ( ) const
inline

Definition at line 134 of file Kernel_POLY.hh.

Referenced by setCoef0().

◆ degree()

double svt::Kernel_POLY::degree ( ) const
inline

Definition at line 135 of file Kernel_POLY.hh.

Referenced by setDegree().

◆ updateCache() [1/2]

template<typename ForwardIter , typename Accessor >
void svt::Kernel_POLY::updateCache ( const ForwardIter &  ,
const ForwardIter &  ,
Accessor  ,
ProgressReporter  
) const
inline

Definition at line 139 of file Kernel_POLY.hh.

◆ updateCache() [2/2]

template<typename ForwardIter1 , typename Accessor1 , typename ForwardIter2 , typename Accessor2 >
void svt::Kernel_POLY::updateCache ( const ForwardIter1 &  ,
const ForwardIter1 &  ,
Accessor1  ,
const ForwardIter2 &  ,
const ForwardIter2 &  ,
Accessor2  ,
ProgressReporter = 0 
) const
inline

Definition at line 150 of file Kernel_POLY.hh.

◆ clearCache()

void svt::Kernel_POLY::clearCache ( ) const
inline

Definition at line 161 of file Kernel_POLY.hh.

◆ k_function()

template<typename FV >
double svt::Kernel_POLY::k_function ( const FV &  x,
const FV &  y 
) const
inline

Definition at line 167 of file Kernel_POLY.hh.

◆ loadParameters()

template<typename STDATA >
void svt::Kernel_POLY::loadParameters ( STDATA &  stData)
inline

Definition at line 173 of file Kernel_POLY.hh.

◆ saveParameters()

template<typename STDATA >
void svt::Kernel_POLY::saveParameters ( STDATA &  stData) const
inline

Definition at line 183 of file Kernel_POLY.hh.

◆ name()

static const char* svt::Kernel_POLY::name ( )
inlinestatic

Definition at line 192 of file Kernel_POLY.hh.

Referenced by saveParameters().

◆ description()

static const char* svt::Kernel_POLY::description ( )
inlinestatic

Definition at line 197 of file Kernel_POLY.hh.

◆ getParamInfos()

static void svt::Kernel_POLY::getParamInfos ( std::vector< ParamInfo > &  p)
inlinestatic

get information about the parameters, that are used in loadParameters() and saveParameters().

The Infos are appended to the passed array

Parameters
parray of ParamInfos. The Infos will be appended to this array

Definition at line 211 of file Kernel_POLY.hh.

Field Documentation

◆ p_gamma

double svt::Kernel_POLY::p_gamma
protected

Definition at line 225 of file Kernel_POLY.hh.

Referenced by gamma(), k_function(), loadParameters(), saveParameters(), and setGamma().

◆ p_coef0

double svt::Kernel_POLY::p_coef0
protected

Definition at line 226 of file Kernel_POLY.hh.

Referenced by coef0(), k_function(), loadParameters(), saveParameters(), and setCoef0().

◆ p_degree

double svt::Kernel_POLY::p_degree
protected

Definition at line 227 of file Kernel_POLY.hh.

Referenced by degree(), k_function(), loadParameters(), saveParameters(), and setDegree().


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