shark::ScaledKernel< InputType > Class Template Reference

Scaled version of a kernel function. More...

#include <shark/Models/Kernels/ScaledKernel.h>

+ Inheritance diagram for shark::ScaledKernel< InputType >:

Public Types

typedef base_type::BatchInputType BatchInputType
 
typedef base_type::ConstInputReference ConstInputReference
 
typedef base_type::ConstBatchInputReference ConstBatchInputReference
 
- Public Types inherited from shark::AbstractKernelFunction< InputType >
enum  Feature
 enumerations of kerneland metric features (flags) More...
 
typedef base_type::InputType InputType
 Input type of the Kernel. More...
 
typedef base_type::BatchInputType BatchInputType
 batch input type of the kernel More...
 
typedef base_type::ConstInputReference ConstInputReference
 Const references to InputType. More...
 
typedef base_type::ConstBatchInputReference ConstBatchInputReference
 Const references to BatchInputType. More...
 
typedef TypedFlags< FeatureFeatures
 This statement declares the member m_features. See Core/Flags.h for details. More...
 
typedef TypedFeatureNotAvailableException< FeatureFeatureNotAvailableException
 
- Public Types inherited from shark::AbstractMetric< InputType >
typedef InputType InputType
 Input type of the Kernel. More...
 
typedef Batch< InputType >::type BatchInputType
 batch input type of the kernel More...
 
typedef ConstProxyReference< InputType const >::type ConstInputReference
 Const references to InputType. More...
 
typedef ConstProxyReference< BatchInputType const >::type ConstBatchInputReference
 Const references to BatchInputType. More...
 
- Public Types inherited from shark::IParameterizable<>
typedef RealVector ParameterVectorType
 

Public Member Functions

 ScaledKernel (AbstractKernelFunction< InputType > *base, double factor=1.0)
 
std::string name () const
 From INameable: return the class name. More...
 
RealVector parameterVector () const
 Return the parameter vector. More...
 
void setParameterVector (RealVector const &newParameters)
 Set the parameter vector. More...
 
std::size_t numberOfParameters () const
 Return the number of parameters. More...
 
boost::shared_ptr< StatecreateState () const
 creates the internal state of the kernel More...
 
const double factor ()
 
void setFactor (double f)
 
const base_typebase () const
 
double eval (ConstInputReference x1, ConstInputReference x2) const
 Evaluates the kernel function. More...
 
void eval (ConstBatchInputReference x1, ConstBatchInputReference x2, RealMatrix &result) const
 Evaluates the subset of the KernelGram matrix which is defined by X1(rows) and X2 (columns). More...
 
void eval (ConstBatchInputReference x1, ConstBatchInputReference x2, RealMatrix &result, State &state) const
 Evaluates the subset of the KernelGram matrix which is defined by X1(rows) and X2 (columns). More...
 
void weightedParameterDerivative (ConstBatchInputReference batchX1, ConstBatchInputReference batchX2, RealMatrix const &coefficients, State const &state, RealVector &gradient) const
 calculates the weighted derivate w.r.t. the parameters of the base kernel More...
 
void weightedInputDerivative (ConstBatchInputReference batchX1, ConstBatchInputReference batchX2, RealMatrix const &coefficientsX2, State const &state, BatchInputType &gradient) const
 calculates the weighted derivate w.r.t. argument \( x_1 \) More...
 
void read (InArchive &ar)
 From ISerializable, reads a metric from an archive. More...
 
void write (OutArchive &ar) const
 The kernel does not serialize anything. More...
 
- Public Member Functions inherited from shark::AbstractKernelFunction< InputType >
 AbstractKernelFunction ()
 
const Featuresfeatures () const
 
virtual void updateFeatures ()
 
bool hasFirstParameterDerivative () const
 
bool hasFirstInputDerivative () const
 
bool isNormalized () const
 
bool supportsVariableInputSize () const
 
double operator() (ConstInputReference x1, ConstInputReference x2) const
 Convenience operator which evaluates the kernel function. More...
 
RealMatrix operator() (ConstBatchInputReference batchX1, ConstBatchInputReference batchX2) const
 Evaluates the subset of the KernelGram matrix which is defined by X1(rows) and X2 (columns). More...
 
virtual double featureDistanceSqr (ConstInputReference x1, ConstInputReference x2) const
 Computes the squared distance in the kernel induced feature space. More...
 
virtual RealMatrix featureDistanceSqr (ConstBatchInputReference batchX1, ConstBatchInputReference batchX2) const
 Computes the squared distance in the kernel induced feature space. More...
 
- Public Member Functions inherited from shark::AbstractMetric< InputType >
 AbstractMetric ()
 
virtual ~AbstractMetric ()
 
virtual double featureDistanceSqr (ConstInputReference x1, ConstInputReference x2) const=0
 Computes the squared distance in the kernel induced feature space. More...
 
virtual RealMatrix featureDistanceSqr (ConstBatchInputReference batchX1, ConstBatchInputReference batchX2) const=0
 
double featureDistance (ConstInputReference x1, ConstInputReference x2) const
 Computes the distance in the kernel induced feature space. More...
 
- Public Member Functions inherited from shark::INameable
virtual ~INameable ()
 
- Public Member Functions inherited from shark::IParameterizable<>
virtual ~IParameterizable ()
 
- Public Member Functions inherited from shark::ISerializable
virtual ~ISerializable ()
 Virtual d'tor. More...
 
void load (InArchive &archive, unsigned int version)
 Versioned loading of components, calls read(...). More...
 
void save (OutArchive &archive, unsigned int version) const
 Versioned storing of components, calls write(...). More...
 
 BOOST_SERIALIZATION_SPLIT_MEMBER ()
 

Protected Attributes

AbstractKernelFunction< InputType > * m_base
 kernel to scale More...
 
double m_factor
 scaling factor More...
 
- Protected Attributes inherited from shark::AbstractKernelFunction< InputType >
Features m_features
 

Detailed Description

template<class InputType = RealVector>
class shark::ScaledKernel< InputType >

Scaled version of a kernel function.

For a positive definite kernel k, the scaled kernel

\[ \tilde k(x_1, x_2) := c k(x_1, x_2) \]

is again a positive definite kernel function as long as \( c > 0 \).

Definition at line 49 of file ScaledKernel.h.

Member Typedef Documentation

◆ BatchInputType

template<class InputType = RealVector>
typedef base_type::BatchInputType shark::ScaledKernel< InputType >::BatchInputType

Definition at line 54 of file ScaledKernel.h.

◆ ConstBatchInputReference

Definition at line 56 of file ScaledKernel.h.

◆ ConstInputReference

template<class InputType = RealVector>
typedef base_type::ConstInputReference shark::ScaledKernel< InputType >::ConstInputReference

Definition at line 55 of file ScaledKernel.h.

Constructor & Destructor Documentation

◆ ScaledKernel()

Member Function Documentation

◆ base()

template<class InputType = RealVector>
const base_type* shark::ScaledKernel< InputType >::base ( ) const
inline

◆ createState()

template<class InputType = RealVector>
boost::shared_ptr<State> shark::ScaledKernel< InputType >::createState ( ) const
inlinevirtual

creates the internal state of the kernel

Reimplemented from shark::AbstractKernelFunction< InputType >.

Definition at line 86 of file ScaledKernel.h.

References shark::AbstractKernelFunction< InputTypeT >::createState(), and shark::ScaledKernel< InputType >::m_base.

◆ eval() [1/3]

template<class InputType = RealVector>
double shark::ScaledKernel< InputType >::eval ( ConstInputReference  x1,
ConstInputReference  x2 
) const
inlinevirtual

◆ eval() [2/3]

template<class InputType = RealVector>
void shark::ScaledKernel< InputType >::eval ( ConstBatchInputReference  batchX1,
ConstBatchInputReference  batchX2,
RealMatrix &  result 
) const
inlinevirtual

Evaluates the subset of the KernelGram matrix which is defined by X1(rows) and X2 (columns).

The result matrix is filled in with the values result(i,j) = kernel(x1[i], x2[j]);

Reimplemented from shark::AbstractKernelFunction< InputType >.

Definition at line 107 of file ScaledKernel.h.

References shark::AbstractKernelFunction< InputTypeT >::eval(), shark::ScaledKernel< InputType >::m_base, and shark::ScaledKernel< InputType >::m_factor.

◆ eval() [3/3]

template<class InputType = RealVector>
void shark::ScaledKernel< InputType >::eval ( ConstBatchInputReference  batchX1,
ConstBatchInputReference  batchX2,
RealMatrix &  result,
State state 
) const
inlinevirtual

Evaluates the subset of the KernelGram matrix which is defined by X1(rows) and X2 (columns).

The result matrix is filled in with the values result(i,j) = kernel(x1[i], x2[j]); The State object is filled in with data used in subsequent derivative computations.

Implements shark::AbstractKernelFunction< InputType >.

Definition at line 112 of file ScaledKernel.h.

References shark::AbstractKernelFunction< InputTypeT >::eval(), shark::ScaledKernel< InputType >::m_base, and shark::ScaledKernel< InputType >::m_factor.

◆ factor()

template<class InputType = RealVector>
const double shark::ScaledKernel< InputType >::factor ( )
inline

◆ name()

template<class InputType = RealVector>
std::string shark::ScaledKernel< InputType >::name ( ) const
inlinevirtual

From INameable: return the class name.

Reimplemented from shark::INameable.

Definition at line 71 of file ScaledKernel.h.

◆ numberOfParameters()

template<class InputType = RealVector>
std::size_t shark::ScaledKernel< InputType >::numberOfParameters ( ) const
inlinevirtual

Return the number of parameters.

Reimplemented from shark::IParameterizable<>.

Definition at line 81 of file ScaledKernel.h.

References shark::ScaledKernel< InputType >::m_base, and shark::IParameterizable< VectorType >::numberOfParameters().

◆ parameterVector()

template<class InputType = RealVector>
RealVector shark::ScaledKernel< InputType >::parameterVector ( ) const
inlinevirtual

Return the parameter vector.

Reimplemented from shark::IParameterizable<>.

Definition at line 74 of file ScaledKernel.h.

References shark::ScaledKernel< InputType >::m_base, and shark::IParameterizable< VectorType >::parameterVector().

◆ read()

template<class InputType = RealVector>
void shark::ScaledKernel< InputType >::read ( InArchive archive)
inlinevirtual

From ISerializable, reads a metric from an archive.

Reimplemented from shark::AbstractMetric< InputType >.

Definition at line 142 of file ScaledKernel.h.

References shark::ScaledKernel< InputType >::m_base, and shark::ScaledKernel< InputType >::m_factor.

◆ setFactor()

template<class InputType = RealVector>
void shark::ScaledKernel< InputType >::setFactor ( double  f)
inline

Definition at line 93 of file ScaledKernel.h.

References shark::ScaledKernel< InputType >::m_factor, and RANGE_CHECK.

◆ setParameterVector()

template<class InputType = RealVector>
void shark::ScaledKernel< InputType >::setParameterVector ( RealVector const &  newParameters)
inlinevirtual

Set the parameter vector.

Reimplemented from shark::IParameterizable<>.

Definition at line 77 of file ScaledKernel.h.

References shark::ScaledKernel< InputType >::m_base, and shark::IParameterizable< VectorType >::setParameterVector().

◆ weightedInputDerivative()

template<class InputType = RealVector>
void shark::ScaledKernel< InputType >::weightedInputDerivative ( ConstBatchInputReference  batchX1,
ConstBatchInputReference  batchX2,
RealMatrix const &  coefficientsX2,
State const &  state,
BatchInputType gradient 
) const
inlinevirtual

◆ weightedParameterDerivative()

template<class InputType = RealVector>
void shark::ScaledKernel< InputType >::weightedParameterDerivative ( ConstBatchInputReference  batchX1,
ConstBatchInputReference  batchX2,
RealMatrix const &  coefficients,
State const &  state,
RealVector &  gradient 
) const
inlinevirtual

calculates the weighted derivate w.r.t. the parameters of the base kernel

Reimplemented from shark::AbstractKernelFunction< InputType >.

Definition at line 118 of file ScaledKernel.h.

References shark::ScaledKernel< InputType >::m_base, shark::ScaledKernel< InputType >::m_factor, and shark::AbstractKernelFunction< InputTypeT >::weightedParameterDerivative().

◆ write()

template<class InputType = RealVector>
void shark::ScaledKernel< InputType >::write ( OutArchive ar) const
inlinevirtual

The kernel does not serialize anything.

Reimplemented from shark::AbstractMetric< InputType >.

Definition at line 148 of file ScaledKernel.h.

References shark::ScaledKernel< InputType >::m_factor.

Member Data Documentation

◆ m_base

◆ m_factor


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