STK::KernelHandler Class Reference

implementation of the DataHandlerBase class for kernel mixture models. More...

#include <STK_KernelHandler.h>

Inheritance diagram for STK::KernelHandler:

Public Types
typedef DataHandlerBase< KernelHandler >	Base
typedef DataHandlerBase< KernelHandler >::InfoMap	InfoMap
typedef std::pair< Kernel::IKernel *, String >	TaggedKernel
typedef Array1D< TaggedKernel >::iterator	Iterator
typedef Array1D< TaggedKernel >::const_iterator	ConstIterator
Public Types inherited from STK::DataHandlerBase< KernelHandler >
typedef std::map< std::string, std::string >	InfoMap

Public Member Functions
	KernelHandler ()
	default constructor
	KernelHandler (Kernel::IKernel *p_kernel, String const &idData, String const &idModel)
	constructor with an instance of a kernel to handle
	~KernelHandler ()
	destructor.
int	nbSample () const
bool	addKernel (Kernel::IKernel *p_kernel, String const &idData, String const &idModel)
	add an instance of a kernel to the handler
template<class Derived , class Array >
bool	addKernel (String const &kernelName, Array const &data, ExprBase< Derived > const &param, String const &idData, String const &idModel)
	add an instance of a kernel to the handler
Kernel::IKernel const *	getKernel (String const &idData) const
	get an instance of a kernel from the handler
void	removeKernel (String const &idData)
	remove an instance of a kernel to the handler
bool	isHandled (Kernel::IKernel *const p_kernel) const
	utility lookup function allowing to know if some pointer on a kernel is handled by the KernelHandler.
Public Member Functions inherited from STK::DataHandlerBase< KernelHandler >
	~DataHandlerBase ()
	destructor
InfoMap const &	info () const
bool	addInfo (std::string const &idData, std::string const &idModel)
	Add an info descriptor to the data handler.
bool	getIdModelName (std::string const &idData, std::string &idModel) const
	Giving the Id of a data set, find the Id of the model.
void	writeInfo (ostream &os) const
	write infoMap on os
Public Member Functions inherited from STK::IRecursiveTemplate< Derived >
Derived &	asDerived ()
	static cast : return a reference of this with a cast to the derived class.
Derived const &	asDerived () const
	static cast : return a const reference of this with a cast to the derived class.
Derived *	asPtrDerived ()
	static cast : return a ptr on a Derived of this with a cast to the derived class.
Derived const *	asPtrDerived () const
	static cast : return a ptr on a constant Derived of this with a cast to the derived class.
Derived *	clone () const
	create a leaf using the copy constructor of the Derived class.
Derived *	clone (bool isRef) const
	create a leaf using the copy constructor of the Derived class and a flag determining if the clone is a reference or not.

Protected Attributes
int	nbSample_
	Number of sample.
Array1D< TaggedKernel >	v_kernel_
	Array of the kernels.
Protected Attributes inherited from STK::DataHandlerBase< KernelHandler >
InfoMap	info_
	Store the informations of the mixtures in the form (idData, idModel) with.

Additional Inherited Members
Protected Member Functions inherited from STK::DataHandlerBase< KernelHandler >
	DataHandlerBase ()
	default constructor
Protected Member Functions inherited from STK::IRecursiveTemplate< Derived >
	IRecursiveTemplate ()
	constructor.
	~IRecursiveTemplate ()
	destructor.

Detailed Description

implementation of the DataHandlerBase class for kernel mixture models.

This class stores the kernels and the idData, allow to add them and to remvoe them.

Definition at line 75 of file STK_KernelHandler.h.

Member Typedef Documentation

Base

typedef DataHandlerBase<KernelHandler> STK::KernelHandler::Base

Definition at line 78 of file STK_KernelHandler.h.

ConstIterator

typedef Array1D<TaggedKernel>::const_iterator STK::KernelHandler::ConstIterator

Definition at line 82 of file STK_KernelHandler.h.

InfoMap

typedef DataHandlerBase<KernelHandler>::InfoMap STK::KernelHandler::InfoMap

Definition at line 79 of file STK_KernelHandler.h.

Iterator

typedef Array1D<TaggedKernel>::iterator STK::KernelHandler::Iterator

Definition at line 81 of file STK_KernelHandler.h.

TaggedKernel

typedef std::pair<Kernel::IKernel*, String> STK::KernelHandler::TaggedKernel

Definition at line 80 of file STK_KernelHandler.h.

Constructor & Destructor Documentation

KernelHandler() [1/2]

STK::KernelHandler::KernelHandler

(

)

default constructor

Definition at line 41 of file STK_KernelHandler.cpp.

: Base(), nbSample_(0) {}

KernelHandler() [2/2]

STK::KernelHandler::KernelHandler	(	Kernel::IKernel *	p_kernel,
		String const &	idData,
		String const &	idModel
	)

constructor with an instance of a kernel to handle

Definition at line 43 of file STK_KernelHandler.cpp.

                            : Base()
                            , nbSample_(p_kernel->nbSample())
{}

~KernelHandler()

STK::KernelHandler::~KernelHandler

(

)

destructor.

All pointer on kernels will be deleted.

Definition at line 48 of file STK_KernelHandler.cpp.

{
  for(Iterator it = v_kernel_.beginIterator(); it != v_kernel_.endIterator(); ++it)
  {
    if (it->first)
    {
      Kernel::IKernel* p = it->first;
      it->first = 0;
      if (!isHandled(p)) delete p;
    }
  }
}

References STK::ITContainer1D< Derived >::beginIterator(), STK::ITContainer1D< Derived >::endIterator(), isHandled(), and v_kernel_.

Member Function Documentation

addKernel() [1/2]

bool STK::KernelHandler::addKernel	(	Kernel::IKernel *	p_kernel,
		String const &	idData,
		String const &	idModel
	)

add an instance of a kernel to the handler

Parameters

p_kernel	an instance of a kernel
idData	can be any string given by the user for identifying data.
idModel	represent the idModel of a given model (can be defined inside or outside STK++).

Returns

true if the pair (idData,idModel) has been successfully added to the handler

Definition at line 69 of file STK_KernelHandler.cpp.

{
  if (!p_kernel) return false;
  if (!addInfo(idData, idModel)) return false; // there exists an idData with an other idModel
 
  // check if idData already exists
  Array1D< TaggedKernel >::ConstIterator it;
  for (it = v_kernel_.beginConstIterator() ; it!=v_kernel_.endConstIterator(); ++it)
  { if (it->second == idData) { break;}}
 
  // add kernel if it does not exist otherwise do nothing
  if (it == v_kernel_.endConstIterator())
  {
    v_kernel_.push_back(TaggedKernel(p_kernel, idData));
    nbSample_   = p_kernel->nbSample();
  }
  return true;
}

References STK::DataHandlerBase< KernelHandler >::addInfo(), STK::ITContainer1D< Derived >::beginConstIterator(), STK::ITContainer1D< Derived >::endConstIterator(), STK::Kernel::IKernel::nbSample(), nbSample_, STK::IArray1D< Derived >::push_back(), and v_kernel_.

addKernel() [2/2]

template<class Derived , class Array >

bool STK::KernelHandler::addKernel	(	String const &	kernelName,
		Array const &	data,
		ExprBase< Derived > const &	param,
		String const &	idData,
		String const &	idModel
	)

add an instance of a kernel to the handler

Parameters

kernelName	name of the kernel
data	data set associated to the kernel
param	parameters of the kernel
idData	can be any string given by the user for identifying data.
idModel	represent the idModel of a given model (can be defined inside or outside STK++).

Returns

true if the pair (idData,idModel) has been successfully added to the handler

Definition at line 141 of file STK_KernelHandler.h.

{
  // check if the idData already exists
  Array1D< TaggedKernel >::Iterator it;
  for (it = v_kernel_.beginIterator() ; it!=v_kernel_.endIterator(); ++it)
  { if (it->second == idData) { break;}}
  // if idData already exists return false
  if (it != v_kernel_.endIterator()) return false;
 
  // create kernel
  Kernel::kernelType kt = Kernel::stringToKernelType(kernelName);
  Kernel::IKernel* p_kernel = 0;
  switch (kt)
  {
    case Kernel::laplace_:
      p_kernel = new Kernel::Laplace<Array>(data, param);
      break;
    case Kernel::gaussian_:
      p_kernel = new Kernel::Gaussian<Array>(data, param);
      break;
    case Kernel::hamming_:
      p_kernel = new Kernel::Hamming<Array>(data, param);
      break;
    case Kernel::linear_:
      p_kernel = new Kernel::Linear<Array>(data, param);
      break;
    case Kernel::polynomial_:
      p_kernel = new Kernel::Polynomial<Array>(data, param);
      break;
    case Kernel::rationalQuadratic_:
      p_kernel = new Kernel::RationalQuadratic<Array>(data, param);
      break;
    default:
      break;
  }
  // not an existing kernel
  if (!p_kernel) return false;
  // add kernel to
  v_kernel_.push_back(TaggedKernel(p_kernel, idData));
  nbSample_   = p_kernel->nbSample();
  return addInfo(idData, idModel);
}

References STK::DataHandlerBase< KernelHandler >::addInfo(), STK::ITContainer1D< Derived >::beginIterator(), STK::ITContainer1D< Derived >::endIterator(), STK::Kernel::gaussian_, STK::Kernel::hamming_, STK::Kernel::laplace_, STK::Kernel::linear_, STK::Kernel::IKernel::nbSample(), nbSample_, STK::Kernel::polynomial_, STK::IArray1D< Derived >::push_back(), STK::Kernel::rationalQuadratic_, STK::Kernel::stringToKernelType(), and v_kernel_.

getKernel()

Kernel::IKernel const * STK::KernelHandler::getKernel

(

String const &

idData

)

const

get an instance of a kernel from the handler

Parameters

idData

can be any string given by the user for identifying data.

Returns

0 if the idData has not been found, a pointer to the kernel otherwise

Definition at line 92 of file STK_KernelHandler.cpp.

{
  // check if the idData already exists
  Array1D< TaggedKernel >::ConstIterator it;
  for (it = v_kernel_.beginConstIterator() ; it!=v_kernel_.endConstIterator(); ++it)
  {  if (it->second == idData) { break;}}
  // no data set found
  if (it == v_kernel_.endConstIterator()) { return 0;}
  return it->first;
}

References STK::ITContainer1D< Derived >::beginConstIterator(), STK::ITContainer1D< Derived >::endConstIterator(), and v_kernel_.

isHandled()

bool STK::KernelHandler::isHandled

(

Kernel::IKernel *const

p_kernel

)

const

utility lookup function allowing to know if some pointer on a kernel is handled by the KernelHandler.

Returns

true if the pointed kernel is found, false otherwise

Definition at line 126 of file STK_KernelHandler.cpp.

{
  for(ConstIterator it = v_kernel_.beginConstIterator(); it != v_kernel_.endConstIterator(); ++it)
  { if (it->first == p_kernel) return true;}
  return false;
}

References STK::ITContainer1D< Derived >::beginConstIterator(), STK::ITContainer1D< Derived >::endConstIterator(), and v_kernel_.

Referenced by removeKernel(), and ~KernelHandler().

nbSample()

int STK::KernelHandler::nbSample ( ) const

inline

Returns

the number of sample (the number of rows of the data)

Definition at line 91 of file STK_KernelHandler.h.

{ return nbSample_;}

References nbSample_.

removeKernel()

void STK::KernelHandler::removeKernel

(

String const &

idData

)

remove an instance of a kernel to the handler

Parameters

idData

can be any string given by the user for identifying data.

Definition at line 105 of file STK_KernelHandler.cpp.

{
  // check if the idData exists
  Array1D< TaggedKernel >::Iterator it;
  for (it = v_kernel_.beginIterator() ; it!=v_kernel_.endIterator(); ++it)
  {  if (it->second == idData) { break;}
  }
  // check if kernel has been found
  if (it != v_kernel_.endIterator())
  {
    Kernel::IKernel* p = it->first;
    it->first = 0;
    if (!isHandled(p)) delete p;
    v_kernel_.erase(it.pos(), 1);
  }
}

References STK::ITContainer1D< Derived >::beginIterator(), STK::ITContainer1D< Derived >::endIterator(), STK::IArray1D< Derived >::erase(), isHandled(), and v_kernel_.

Member Data Documentation

nbSample_

int STK::KernelHandler::nbSample_

protected

Number of sample.

Definition at line 135 of file STK_KernelHandler.h.

Referenced by addKernel(), addKernel(), and nbSample().

v_kernel_

Array1D< TaggedKernel > STK::KernelHandler::v_kernel_

protected

Array of the kernels.

Definition at line 137 of file STK_KernelHandler.h.

Referenced by addKernel(), addKernel(), getKernel(), isHandled(), removeKernel(), and ~KernelHandler().

---

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

• STK_KernelHandler.h
• STK_KernelHandler.cpp