STK::IRunnerUnsupervised< Array, Weights_ > Class Template Reference

Abstract class for all classes making unsupervised learning. More...

#include <STK_IRunner.h>

Inheritance diagram for STK::IRunnerUnsupervised< Array, Weights_ >:

Public Member Functions
Array const *	p_data () const
	get the data set
virtual void	setData (Array const *p_data)
	Set the data set.
virtual void	setData (Array const &data)
	Set the data set.
virtual bool	run ()=0
	run the computations.
virtual bool	run (Weights_ const &weights)=0
	run the weighted computations.
Public Member Functions inherited from STK::IRunnerBase
String const &	error () const
	get the last error message.

Protected Member Functions
	IRunnerUnsupervised ()
	default constructor.
	IRunnerUnsupervised (Array const *const p_data)
	constructor with a pointer on the constant data set
	IRunnerUnsupervised (Array const &data)
	constructor with a constant reference on the data set
	IRunnerUnsupervised (IRunnerUnsupervised const &runner)
	copy constructor
	~IRunnerUnsupervised ()
	destructor
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
Array const *	p_data_
	A pointer on the original data set.
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 Weights_>
class STK::IRunnerUnsupervised< Array, Weights_ >

Abstract class for all classes making unsupervised learning.

This Interface is designed for unsupervised learning purpose. In a supervised learning setting, use IRunnerSupervised. The data set to process is not copied and a ptr on the data set is stored internally.

The pure virtual methods to implement are

bool run();
bool run(weights);

Definition at line 189 of file STK_IRunner.h.

Constructor & Destructor Documentation

IRunnerUnsupervised() [1/4]

template<class Array , class Weights_ >

STK::IRunnerUnsupervised< Array, Weights_ >::IRunnerUnsupervised ( )

inlineprotected

default constructor.

Definition at line 193 of file STK_IRunner.h.

: p_data_(0) {}

IRunnerUnsupervised() [2/4]

template<class Array , class Weights_ >

STK::IRunnerUnsupervised< Array, Weights_ >::IRunnerUnsupervised ( Array const *const  p_data )

inlineprotected

constructor with a pointer on the constant data set

Parameters

p_data

pointer on the data set to run

Definition at line 197 of file STK_IRunner.h.

: p_data_(p_data) {}

IRunnerUnsupervised() [3/4]

template<class Array , class Weights_ >

STK::IRunnerUnsupervised< Array, Weights_ >::IRunnerUnsupervised ( Array const &  data )

inlineprotected

constructor with a constant reference on the data set

Parameters

data	data set to run

Definition at line 201 of file STK_IRunner.h.

: p_data_(&data) {}

IRunnerUnsupervised() [4/4]

template<class Array , class Weights_ >

STK::IRunnerUnsupervised< Array, Weights_ >::IRunnerUnsupervised ( IRunnerUnsupervised< Array, Weights_ > const &  runner )

inlineprotected

copy constructor

Parameters

runner

the runner to copy

Definition at line 205 of file STK_IRunner.h.

                              : IRunnerBase(runner)
                              , p_data_(runner.p_data_)
    {}

~IRunnerUnsupervised()

template<class Array , class Weights_ >

STK::IRunnerUnsupervised< Array, Weights_ >::~IRunnerUnsupervised ( )

inlineprotected

destructor

Definition at line 210 of file STK_IRunner.h.

{}

Member Function Documentation

p_data()

template<class Array , class Weights_ >

Array const * STK::IRunnerUnsupervised< Array, Weights_ >::p_data ( ) const

inline

get the data set

Returns

a constant reference on the data set.

Definition at line 216 of file STK_IRunner.h.

{ return p_data_;}

References STK::IRunnerUnsupervised< Array, Weights_ >::p_data_.

Referenced by STK::BernoulliModel< Array, WColVector >::computeParameters(), STK::BernoulliModel< Array, WColVector >::computeParameters(), and STK::IRunnerUnsupervised< Array, Weights_ >::setData().

run() [1/2]

template<class Array , class Weights_ >

virtual bool STK::IRunnerUnsupervised< Array, Weights_ >::run ( )

pure virtual

run the computations.

Returns

true if no error occur during the running process, false otherwise

Implements STK::IRunnerBase.

Implemented in STK::LinearAAModel< Array >, STK::ILinearReduct< Array, Weights >, STK::ILinearReduct< Array, VectorX >, STK::Stat::Multivariate< Array, WColVector, Type >, STK::Stat::Multivariate< Array, Real >, STK::IUnivStatModel< ColVector, WColVector, UnivariateLaw >, and STK::IUnivStatModel< Array, WColVector, Law::Bernoulli >.

run() [2/2]

template<class Array , class Weights_ >

virtual bool STK::IRunnerUnsupervised< Array, Weights_ >::run ( Weights_ const &  weights )

pure virtual

run the weighted computations.

Parameters

weights

the weights of the samples

Returns

true if no error occur during the running process, false otherwise

Implemented in STK::LinearAAModel< Array >, STK::ILinearReduct< Array, VectorX >, STK::Stat::Multivariate< Array, WColVector, Type >, STK::IUnivStatModel< ColVector, WColVector, UnivariateLaw >, and STK::ILinearReduct< Array, Weights >.

setData() [1/2]

template<class Array , class Weights_ >

virtual void STK::IRunnerUnsupervised< Array, Weights_ >::setData ( Array const &  data )

inlinevirtual

Set the data set.

If the state of the derived runner change when a new data set is set the user have to overload the udpate() method.

Parameters

data	The data set to run

Definition at line 230 of file STK_IRunner.h.

    {
      p_data_ = &data;
      update();
      this->hasRun_ = false;
    }

References STK::IRunnerBase::hasRun_, STK::IRunnerUnsupervised< Array, Weights_ >::p_data_, and STK::IRunnerBase::update().

setData() [2/2]

template<class Array , class Weights_ >

virtual void STK::IRunnerUnsupervised< Array, Weights_ >::setData ( Array const *  p_data )

inlinevirtual

Set the data set.

If the state of the derived runner change when a new data set is set the user have to overload the udpate() method.

Parameters

p_data

A pointer on the data set to run

Definition at line 221 of file STK_IRunner.h.

    {
      p_data_ = p_data;
      update();
    }

References STK::IRunnerUnsupervised< Array, Weights_ >::p_data(), STK::IRunnerUnsupervised< Array, Weights_ >::p_data_, and STK::IRunnerBase::update().

Member Data Documentation

p_data_

template<class Array , class Weights_ >

Array const* STK::IRunnerUnsupervised< Array, Weights_ >::p_data_

protected

A pointer on the original data set.

Definition at line 250 of file STK_IRunner.h.

Referenced by STK::IRunnerUnsupervised< Array, Weights_ >::p_data(), STK::IRunnerUnsupervised< Array, Weights_ >::setData(), and STK::IRunnerUnsupervised< Array, Weights_ >::setData().

---

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

• STK_IRunner.h