STK::IRunnerRef2D< TContainer2D > Class Template Reference

Abstract base class for all classes having. More...

#include <STK_IRunnerRef2D.h>

Inheritance diagram for STK::IRunnerRef2D< TContainer2D >:

Collaboration diagram for STK::IRunnerRef2D< TContainer2D >:

List of all members.

Public Member Functions
virtual	~IRunnerRef2D ()
	destructor
TContainer2D const &	data () const
	get the data set
virtual void	setData (TContainer2D const &data)
	set the data set.
virtual bool	run ()=0
	run the weighted computations.
virtual bool	run (typename TContainer2D::TContainerVe const &weights)=0
	run the weighted computations.
Protected Member Functions
	IRunnerRef2D (TContainer2D const &data)
	default constructor
	IRunnerRef2D (IRunnerRef2D const &runner)
	copy constructor
virtual void	update ()
	update the runner.
Protected Attributes
TContainer2D const *	p_data_
	A pointer on the original data set.

---

Detailed Description

template<typename TContainer2D>
class STK::IRunnerRef2D< TContainer2D >

Abstract base class for all classes having.

    bool run();
    bool run(weights);

methods on a 2D data set. The data set is not copied. There is just a pointer on the data set.

Definition at line 56 of file STK_IRunnerRef2D.h.

---

Constructor & Destructor Documentation

template<typename TContainer2D>

STK::IRunnerRef2D< TContainer2D >::IRunnerRef2D

(

TContainer2D const &

data

)

[inline, protected]

default constructor

Definition at line 60 of file STK_IRunnerRef2D.h.

                : p_data_(&data)
    { }

template<typename TContainer2D>

STK::IRunnerRef2D< TContainer2D >::IRunnerRef2D

(

IRunnerRef2D< TContainer2D > const &

runner

)

[inline, protected]

copy constructor

Definition at line 64 of file STK_IRunnerRef2D.h.

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

template<typename TContainer2D>

virtual STK::IRunnerRef2D< TContainer2D >::~IRunnerRef2D

(

)

[inline, virtual]

destructor

Definition at line 71 of file STK_IRunnerRef2D.h.

{ }

---

Member Function Documentation

template<typename TContainer2D>

TContainer2D const& STK::IRunnerRef2D< TContainer2D >::data

(

)

const [inline]

get the data set

Returns:

a constant reference on the data set.

Definition at line 76 of file STK_IRunnerRef2D.h.

Referenced by STK::IRunnerRef2D< Matrix >::setData().

{ return *p_data_;}

template<typename TContainer2D>

virtual void STK::IRunnerRef2D< TContainer2D >::setData

(

TContainer2D const &

data

)

[inline, virtual]

set the data set.

Parameters:

data	The data set to run

Definition at line 81 of file STK_IRunnerRef2D.h.

Referenced by STK::LinearAAModel::run().

    {
      p_data_ = &data;
      update();
    }

template<typename TContainer2D>

virtual bool STK::IRunnerRef2D< TContainer2D >::run

(

)

[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

Implements STK::IRunnerBase.

Implemented in STK::LinearAAModel, and STK::ILinearReduct.

Referenced by STK::IAAModel::reduction().

template<typename TContainer2D>

virtual bool STK::IRunnerRef2D< TContainer2D >::run

(

typename TContainer2D::TContainerVe 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

template<typename TContainer2D>

virtual void STK::IRunnerRef2D< TContainer2D >::update

(

)

[inline, protected, virtual]

update the runner.

This virtual method will be called when the state of the runner will change, i.e. when a new data set is set. By default do nothing.

Reimplemented in STK::LocalVariance.

Definition at line 107 of file STK_IRunnerRef2D.h.

Referenced by STK::IRunnerRef2D< Matrix >::setData().

{}

---

Member Data Documentation

template<typename TContainer2D>

TContainer2D const* STK::IRunnerRef2D< TContainer2D >::p_data_ [protected]

A pointer on the original data set.

Definition at line 102 of file STK_IRunnerRef2D.h.

Referenced by STK::IRunnerRef2D< Matrix >::data(), and STK::IRunnerRef2D< Matrix >::setData().

---

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

• STK_IRunnerRef2D.h