The Hamming Kernel is a kernel of the form. More...

#include <STK_Kernel_Hamming.h>

Inheritance diagram for STK::Kernel::Hamming< Array >:

Public Types
typedef IKernelBase< Array >	Base

typedef Array::Type	Type

Public Types inherited from STK::Kernel::IKernelBase< Array >
typedef Array::Type	Type

Public Member Functions
	Hamming (Array const *p_data, Real const &lambda=1.)
	constructor with a constant pointer on the data set

	Hamming (Array const &data, Real const &lambda=1.)
	constructor with a constant pointer on the data set

template<class Derived >
	Hamming (Array const *p_data, ExprBase< Derived > const &param)
	constructor with an array of parameter.

template<class Derived >
	Hamming (Array const &data, ExprBase< Derived > const &param)
	constructor with a constant pointer on the data set

virtual	~Hamming ()
	destructor

Real const &	lambda () const

Stat::MultiFactor< Array > const &	factors () const

void	setLambda (Real const &lambda)
	set the lambda of the kernel

template<class Derived >
void	setParam (ExprBase< Derived > const &param)
	Set parameter using an array.

virtual Real	diag (int i) const
	virtual method.

virtual Real	comp (int i, int j) const
	virtual method implementation.

Public Member Functions inherited from STK::Kernel::IKernelBase< Array >
	IKernelBase (Array const *p_data)
	constructor with a constant pointer on the data set

	IKernelBase (Array const &data)
	constructor with a constant reference on the data set

	IKernelBase (IKernelBase const &kernel)
	copy constructor

virtual	~IKernelBase ()
	destructor

Array const *	p_data () const

virtual bool	run ()
	compute Gram matrix

virtual int	nbSample () const

virtual int	nbVariable () const

virtual Real	value (Type const &v) const
	compute the value of the kernel for the given value

Public Member Functions inherited from STK::Kernel::IKernel
	IKernel ()
	default constructor

	IKernel (IKernel const &kernel)
	copy constructor

virtual	~IKernel ()
	destructor

CSquareX const &	k () const

CSquareX const &	gram () const

Real	kcomp (int i, int j) const

Real	kdist (int i, int j) const

Real	kdiag (int i) const

Real	dist (int i, int j) const

Public Member Functions inherited from STK::IRunnerBase
String const &	error () const
	get the last error message.

Public Attributes
Array const *	p_data_
	pointer on the data set

Public Attributes inherited from STK::Kernel::IKernelBase< Array >
CSquareX	gram_
	the resulting gram_ matrix

Private Member Functions
void	computeDiagonalElement ()
	Compute the diagonal element of the kernel.

Private Attributes
Real	lambda_
	lambda of the kernel

Real	diagElt_
	diagonal element of the kernel

Stat::MultiFactor< Array >	factors_
	factors of the values

Additional Inherited Members
Protected Member Functions inherited from STK::IRunnerBase
	IRunnerBase ()
	default constructor

	IRunnerBase (IRunnerBase const &runner)
	copy constructor

virtual	~IRunnerBase ()
	destructor

virtual void	update ()
	update the runner.

Protected Attributes inherited from STK::Kernel::IKernelBase< Array >
Array const *	p_data_
	pointer on the data set

Protected Attributes inherited from STK::Kernel::IKernel
CSquareX	gram_
	the resulting gram_ matrix

Protected Attributes inherited from STK::IRunnerBase
String	msg_error_
	String with the last error message.

bool	hasRun_
	`true` if run has been used, `false` otherwise

Detailed Description

template<class Array>
class STK::Kernel::Hamming< Array >

The Hamming Kernel is a kernel of the form.

$k(x,y) = \sum_{u\in D^p} \prod_{j=1}^p \lambda^{\delta(u_j,x_j)}\lambda^{\delta(u_j,y_j)}$

where $\lambda \in(0,1)$ represents the similarity index of the kernel. It can be computed recursively.

Note: The creation of this Kernel trigger the computation of the factors present in the data set.

See also: STK::Stat::MultiFactors

Definition at line 60 of file STK_Kernel_Hamming.h.

Member Typedef Documentation

◆ Base

template<class Array >

typedef IKernelBase<Array> STK::Kernel::Hamming< Array >::Base

Definition at line 63 of file STK_Kernel_Hamming.h.

◆ Type

template<class Array >

typedef Array::Type STK::Kernel::Hamming< Array >::Type

Definition at line 64 of file STK_Kernel_Hamming.h.

Constructor & Destructor Documentation

◆ Hamming() [1/4]

template<class Array >

STK::Kernel::Hamming< Array >::Hamming	(	Array const *	p_data,
		Real const &	lambda = `1.`
	)

inline

constructor with a constant pointer on the data set

Parameters

p_data	a pointer on a data set that will be "kernelized"
lambda	the size of the windows to use in the kernel

Definition at line 73 of file STK_Kernel_Hamming.h.

          : Base(p_data), lambda_(lambda), diagElt_(1.), factors_(p_data)
    {
      if (!p_data)
      { STKRUNTIME_ERROR_NO_ARG(Hamming::Hamming(p_data,lambda),p_data is 0);}
      factors_.run();
      computeDiagonalElement();
    }

References STK::Kernel::Hamming< Array >::computeDiagonalElement(), STK::Kernel::Hamming< Array >::factors_, STK::Kernel::Hamming< Array >::Hamming(), STK::Kernel::Hamming< Array >::lambda(), STK::Kernel::IKernelBase< Array >::p_data(), and STKRUNTIME_ERROR_NO_ARG.

Referenced by STK::Kernel::Hamming< Array >::Hamming(), and STK::Kernel::Hamming< Array >::Hamming().

◆ Hamming() [2/4]

template<class Array >

STK::Kernel::Hamming< Array >::Hamming	(	Array const &	data,
		Real const &	lambda = `1.`
	)

inline

constructor with a constant pointer on the data set

Parameters

data	a reference on a data set that will be "kernelized"
lambda	the size of the windows to use in the kernel

Definition at line 85 of file STK_Kernel_Hamming.h.

          : Base(data), lambda_(lambda), diagElt_(1.), factors_(data)
    {
      factors_.run();
      computeDiagonalElement();
    }

References STK::Kernel::Hamming< Array >::computeDiagonalElement(), STK::Kernel::Hamming< Array >::factors_, and STK::Kernel::IKernelBase< Array >::run().

◆ Hamming() [3/4]

template<class Array >

template<class Derived >

STK::Kernel::Hamming< Array >::Hamming	(	Array const *	p_data,
		ExprBase< Derived > const &	param
	)

inline

constructor with an array of parameter.

Parameters

p_data	a pointer on a data set that will be "kernelized"
param	array of parameter

Definition at line 96 of file STK_Kernel_Hamming.h.

           : Base(p_data), lambda_(param.empty() ? 1. : param.front())
            , diagElt_(1.), factors_(p_data)
     {
         if (!p_data)
         { STKRUNTIME_ERROR_NO_ARG(Hamming::Hamming(p_data,lambda),p_data is 0);}
         factors_.run();
         computeDiagonalElement();
     }

References STK::Kernel::Hamming< Array >::computeDiagonalElement(), STK::Kernel::Hamming< Array >::factors_, STK::Kernel::Hamming< Array >::Hamming(), STK::Kernel::Hamming< Array >::lambda(), STK::Kernel::IKernelBase< Array >::p_data(), and STKRUNTIME_ERROR_NO_ARG.

◆ Hamming() [4/4]

template<class Array >

template<class Derived >

STK::Kernel::Hamming< Array >::Hamming	(	Array const &	data,
		ExprBase< Derived > const &	param
	)

inline

constructor with a constant pointer on the data set

Parameters

data	a reference on a data set that will be "kernelized"
param	array of parameter

Definition at line 110 of file STK_Kernel_Hamming.h.

           : Base(data), lambda_(param.empty() ? 1. : param.front())
            , diagElt_(1.), factors_(data)
     {
         factors_.run();
         computeDiagonalElement();
     }

References STK::Kernel::Hamming< Array >::computeDiagonalElement(), STK::Kernel::Hamming< Array >::factors_, and STK::Kernel::IKernelBase< Array >::run().

◆ ~Hamming()

template<class Array >

virtual STK::Kernel::Hamming< Array >::~Hamming ( )

inlinevirtual

destructor

Definition at line 119 of file STK_Kernel_Hamming.h.

119{}

Member Function Documentation

◆ comp()

template<class Array >

Real STK::Kernel::Hamming< Array >::comp	(	int	i,
		int	j
	)		const

virtual

virtual method implementation.

Returns: value of the kernel for the ith and jth individuals.

Parameters

i,j	indexes of the individuals

Implements STK::Kernel::IKernel.

Definition at line 176 of file STK_Kernel_Hamming.h.

{
  typedef typename hidden::Traits<Array>::Row RowVector;
  if (hasRun_) return gram_(i,j);
  // create references on row i and j
  RowVector ind1(p_data_->row(i), true), ind2(p_data_->row(j), true);
  Real value = 1.;
  for(int j=factors_.nbLevels().begin(); j < factors_.nbLevels().end(); ++j)
  {
    value *= (ind1[j]==ind2[j]) ? lambda_*lambda_*(factors_.nbLevels()[j]-1) + 1.
                                : lambda_*(lambda_*(factors_.nbLevels()[j]-2) + 2.);
  }
  return value;
}

◆ computeDiagonalElement()

template<class Array >

void STK::Kernel::Hamming< Array >::computeDiagonalElement ( )

private

Compute the diagonal element of the kernel.

Definition at line 165 of file STK_Kernel_Hamming.h.

{
   diagElt_ = 1.;
   for(int j=factors_.nbLevels().begin(); j < factors_.nbLevels().end(); ++j)
   { diagElt_ *= lambda_*lambda_*(factors_.nbLevels()[j]-1) + 1;}
}

Referenced by STK::Kernel::Hamming< Array >::Hamming(), STK::Kernel::Hamming< Array >::Hamming(), STK::Kernel::Hamming< Array >::Hamming(), STK::Kernel::Hamming< Array >::Hamming(), STK::Kernel::Hamming< Array >::setLambda(), and STK::Kernel::Hamming< Array >::setParam().

◆ diag()

template<class Array >

Real STK::Kernel::Hamming< Array >::diag ( int i ) const

inlinevirtual

virtual method.

Returns: diagonal value of the kernel for the ith individuals.

Parameters

i	index of the individual

Reimplemented from STK::Kernel::IKernel.

Definition at line 173 of file STK_Kernel_Hamming.h.

173{ return diagElt_;}

◆ factors()

template<class Array >

Stat::MultiFactor< Array > const & STK::Kernel::Hamming< Array >::factors ( ) const

inline

Returns: the lambda of the kernel

Definition at line 124 of file STK_Kernel_Hamming.h.

124{return factors_;}

References STK::Kernel::Hamming< Array >::factors_.

◆ lambda()

template<class Array >

Real const & STK::Kernel::Hamming< Array >::lambda ( ) const

inline

Returns: the lambda of the kernel

Definition at line 122 of file STK_Kernel_Hamming.h.

122{return lambda_;}

References STK::Kernel::Hamming< Array >::lambda_.

Referenced by STK::Kernel::Hamming< Array >::Hamming(), STK::Kernel::Hamming< Array >::Hamming(), and STK::Kernel::Hamming< Array >::setLambda().

◆ setLambda()

template<class Array >

void STK::Kernel::Hamming< Array >::setLambda ( Real const & lambda )

inline

set the lambda of the kernel

Definition at line 126 of file STK_Kernel_Hamming.h.

    {
      lambda_ = lambda;
      computeDiagonalElement();
    }

References STK::Kernel::Hamming< Array >::computeDiagonalElement(), STK::Kernel::Hamming< Array >::lambda(), and STK::Kernel::Hamming< Array >::lambda_.

◆ setParam()

template<class Array >

template<class Derived >

void STK::Kernel::Hamming< Array >::setParam ( ExprBase< Derived > const & param )

inline

Set parameter using an array.

Parameters

param array of parameter

Definition at line 135 of file STK_Kernel_Hamming.h.

    {
      lambda_ = (param.empty() ? 1. : param.front());
      computeDiagonalElement();
    }

References STK::Kernel::Hamming< Array >::computeDiagonalElement(), and STK::Kernel::Hamming< Array >::lambda_.

Member Data Documentation

◆ diagElt_

template<class Array >

Real STK::Kernel::Hamming< Array >::diagElt_

private

diagonal element of the kernel

Definition at line 156 of file STK_Kernel_Hamming.h.

◆ factors_

template<class Array >

Stat::MultiFactor<Array> STK::Kernel::Hamming< Array >::factors_

private

factors of the values

Definition at line 158 of file STK_Kernel_Hamming.h.

Referenced by STK::Kernel::Hamming< Array >::factors(), STK::Kernel::Hamming< Array >::Hamming(), STK::Kernel::Hamming< Array >::Hamming(), STK::Kernel::Hamming< Array >::Hamming(), and STK::Kernel::Hamming< Array >::Hamming().

◆ lambda_

template<class Array >

Real STK::Kernel::Hamming< Array >::lambda_

private

lambda of the kernel

Definition at line 154 of file STK_Kernel_Hamming.h.

Referenced by STK::Kernel::Hamming< Array >::lambda(), STK::Kernel::Hamming< Array >::setLambda(), and STK::Kernel::Hamming< Array >::setParam().

◆ p_data_

template<class Array >

Array const* STK::Kernel::IKernelBase< Array >::p_data_

pointer on the data set

Definition at line 90 of file STK_Kernel_IKernelBase.h.

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

STK_Kernel_Hamming.h

Public Types

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Base

◆ Type

Constructor & Destructor Documentation

◆ Hamming() [1/4]

◆ Hamming() [2/4]

◆ Hamming() [3/4]

◆ Hamming() [4/4]

◆ ~Hamming()

Member Function Documentation

◆ comp()

◆ computeDiagonalElement()

◆ diag()

◆ factors()

◆ lambda()

◆ setLambda()

◆ setParam()

Member Data Documentation

◆ diagElt_

◆ factors_

◆ lambda_

◆ p_data_