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

The Kernel_SIGMOID class specifies a sigmoid kernel function: tanh(gamma*u'*v + coef0) More...

#include <Kernel_SIGMOID.hh>

Collaboration diagram for svt::Kernel_SIGMOID:

Public Member Functions

 Kernel_SIGMOID (double gamma=1., double coef0=0.)
 
 ~Kernel_SIGMOID ()
 
void clearCache () const
 
double coef0 () 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 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_gamma
 

Detailed Description

The Kernel_SIGMOID class specifies a sigmoid kernel function: tanh(gamma*u'*v + coef0)

Definition at line 118 of file Kernel_SIGMOID.hh.

Constructor & Destructor Documentation

◆ Kernel_SIGMOID()

svt::Kernel_SIGMOID::Kernel_SIGMOID ( double  gamma = 1.,
double  coef0 = 0. 
)
inline

Definition at line 121 of file Kernel_SIGMOID.hh.

◆ ~Kernel_SIGMOID()

svt::Kernel_SIGMOID::~Kernel_SIGMOID ( )
inline

Definition at line 128 of file Kernel_SIGMOID.hh.

Member Function Documentation

◆ setGamma()

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

Definition at line 131 of file Kernel_SIGMOID.hh.

◆ setCoef0()

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

Definition at line 132 of file Kernel_SIGMOID.hh.

◆ gamma()

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

Definition at line 133 of file Kernel_SIGMOID.hh.

Referenced by setGamma().

◆ coef0()

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

Definition at line 134 of file Kernel_SIGMOID.hh.

Referenced by setCoef0().

◆ updateCache() [1/2]

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

Definition at line 137 of file Kernel_SIGMOID.hh.

◆ updateCache() [2/2]

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

Definition at line 149 of file Kernel_SIGMOID.hh.

◆ clearCache()

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

Definition at line 160 of file Kernel_SIGMOID.hh.

◆ k_function()

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

Definition at line 166 of file Kernel_SIGMOID.hh.

◆ loadParameters()

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

Definition at line 172 of file Kernel_SIGMOID.hh.

◆ saveParameters()

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

Definition at line 180 of file Kernel_SIGMOID.hh.

◆ name()

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

Definition at line 188 of file Kernel_SIGMOID.hh.

Referenced by saveParameters().

◆ description()

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

Definition at line 193 of file Kernel_SIGMOID.hh.

◆ getParamInfos()

static void svt::Kernel_SIGMOID::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 208 of file Kernel_SIGMOID.hh.

Field Documentation

◆ p_gamma

double svt::Kernel_SIGMOID::p_gamma
protected

Definition at line 219 of file Kernel_SIGMOID.hh.

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

◆ p_coef0

double svt::Kernel_SIGMOID::p_coef0
protected

Definition at line 220 of file Kernel_SIGMOID.hh.

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


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