STK::IRunnerBase Class Reference

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

#include <STK_IRunner.h>

Inheritance diagram for STK::IRunnerBase:

Public Member Functions
String const &	error () const
	get the last error message.
virtual bool	run ()=0
	run the computations.

Protected Member Functions
	IRunnerBase ()
	default constructor
	IRunnerBase (IRunnerBase const &runner)
	copy constructor
virtual	~IRunnerBase ()
	destructor
virtual void	update ()
	update the runner.

Protected Attributes
String	msg_error_
	String with the last error message.
bool	hasRun_
	true if run has been used, false otherwise

Detailed Description

Abstract base class for all classes having a.

bool run(); 

method. All classes deriving from this class should implement the run method using this kind of code

bool MyClass::run()
{
  try
  {
  // do something
 
  }
  catch(const Exception& e)
  { msg_error_ = e.error();
    return false;
  }
  return true;
}

Definition at line 64 of file STK_IRunner.h.

Constructor & Destructor Documentation

IRunnerBase() [1/2]

STK::IRunnerBase::IRunnerBase ( )

inlineprotected

default constructor

Definition at line 68 of file STK_IRunner.h.

: msg_error_(), hasRun_(false) {}

IRunnerBase() [2/2]

STK::IRunnerBase::IRunnerBase ( IRunnerBase const &  runner )

inlineprotected

copy constructor

Parameters

runner

the runner to copy

Definition at line 72 of file STK_IRunner.h.

                      : msg_error_(runner.msg_error_)
                      , hasRun_(runner.hasRun_){}

~IRunnerBase()

virtual STK::IRunnerBase::~IRunnerBase ( )

inlineprotectedvirtual

destructor

Definition at line 76 of file STK_IRunner.h.

{}

Member Function Documentation

error()

String const & STK::IRunnerBase::error ( ) const

inline

get the last error message.

Returns

the last error message

Definition at line 82 of file STK_IRunner.h.

{ return msg_error_;}

References msg_error_.

Referenced by STK::IArray1D< Derived >::allocate(), STK::TReadWriteCsv< Type >::appendData(), STK::ImportFromCsv::asNumeric(), STK::ImportFromCsv::asOnlyNumeric(), STK::ImportFromCsv::asString(), STK::IMixtureAlgoPredict::burnStep(), STK::lapack::Qr::computeQr(), STK::Svd< Array >::computeSvd(), STK::lapack::Svd::computeSvd(), STK::Svd< Array >::diag(), STK::TReadWriteCsv< Type >::eraseColumn(), STK::IArray2D< Derived >::initializeCol(), STK::IArray2D< Derived >::initializeCols(), STK::FullStrategy::initStep(), STK::IArray1D< Derived >::insertElt(), STK::MemAllocator< Type_, Size_ >::malloc(), STK::IArray2D< Derived >::mallocCols(), STK::IMixtureAlgoPredict::predictBayesClassifier(), STK::TReadWriteCsv< Type >::push_back(), STK::TReadWriteCsv< Type >::push_front(), STK::TReadWriteCsv< Type >::read(), STK::ReadWritePages::read(), STK::TReadWriteCsv< Type >::read(), STK::ReadWritePages::read(), STK::DataHandler::readDataFromCsvFile(), STK::DataHandler::readDataFromCsvFile(), STK::MemAllocator< Type_, Size_ >::realloc(), STK::AdditiveBSplineRegression< YArray, XArray, Weights >::regressionStep(), STK::AdditiveBSplineRegression< YArray, XArray, Weights >::regressionStep(), STK::IArray2D< Derived >::reserveCols(), STK::LinearAAModel< Array >::run(), STK::EMAlgo::run(), STK::CEMAlgo::run(), STK::SEMAlgo::run(), STK::SemiSEMAlgo::run(), STK::ImputeAlgo::run(), STK::SimulAlgo::run(), STK::EMPredict::run(), STK::SemiSEMPredict::run(), STK::RandomInit::run(), STK::ClassInit::run(), STK::FuzzyInit::run(), STK::FullStrategy::run(), STK::SimpleStrategy::run(), STK::XemStrategy::run(), STK::StrategyFacade::run(), STK::LearnFacade::run(), STK::CsvToArray< Array, Type >::run(), STK::AdditiveBSplineCoefficients< Array >::run(), STK::Stat::Multivariate< Array, Real >::run(), STK::Stat::Multivariate< Array, Real >::run(), STK::LinearAAModel< Array >::run(), STK::LinearAAModel< Array >::run(), STK::TReadWriteCsv< Type >::setName(), STK::MultiLaw::Normal< RowVector >::setParameters(), STK::ReadWritePages::write(), STK::TReadWriteCsv< Type >::write(), and STK::ReadWritePages::write().

run()

virtual bool STK::IRunnerBase::run ( )

pure virtual

run the computations.

Returns

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

Implemented in STK::LinearAAModel< Array >, STK::ILeastSquare< Derived >, STK::ILeastSquare< MultiLeastSquare< ArrayB, ArrayA > >, STK::IQr< Derived >, STK::IQr< Qr >, STK::ISvd< Derived >, STK::ISvd< Svd >, STK::ISvd< Svd< Array > >, STK::ISvd< WeightedSvd< Array, WRows, WCols > >, STK::ISymEigen< Derived >, STK::ISymEigen< SymEigen< Array2DSquare< Real > > >, STK::ISymEigen< SymEigen< SquareArray > >, STK::WeightedSvd< Array, WRows, WCols >, STK::IClassification< YArray_, XArray_, Weights_ >, STK::EMAlgo, STK::CEMAlgo, STK::SEMAlgo, STK::SemiSEMAlgo, STK::ImputeAlgo, STK::SimulAlgo, STK::EMPredict, STK::SemiSEMPredict, STK::AICMixtureCriterion, STK::BICMixtureCriterion, STK::ICLMixtureCriterion, STK::MLMixtureCriterion, STK::RandomInit, STK::ClassInit, STK::FuzzyInit, STK::FullStrategy, STK::SimpleStrategy, STK::XemStrategy, STK::FullStrategy, STK::SimpleStrategy, STK::XemStrategy, STK::StrategyFacade, STK::LearnFacade, STK::CsvToArray< Array, Type >, STK::CvHandler, STK::ImportFromCsv, STK::PartitionHandler, STK::ILinearReduct< Array, Weights >, STK::ILinearReduct< Array, VectorX >, STK::AdditiveBSplineCoefficients< Array >, STK::AdditiveBSplineCoefficients< XArray >, STK::BSplineCoefficients< Data >, STK::BSplineCoefficients< XVector >, STK::ChebyshevCoefficients< Data, Coefs >, STK::CosinesCoefficients< Data, Coefs >, STK::IRegression< YArray, XArray, Weights >, STK::IRegression< Array, Array, Weight >, STK::IRegression< YArray, XArray, VectorX >, STK::IRegression< YArray, XVector, VectorX >, STK::SinesCoefficients< Data, Coefs >, STK::TrigonometricCoefficients< Data, Coefs >, STK::Kernel::IKernelBase< Array >, STK::Stat::Factor< Array >, STK::Stat::MultiFactor< Array >, STK::Stat::Multivariate< Array, WColVector, Type >, STK::Stat::Multivariate< Array, Real >, STK::IUnivStatModel< ColVector, WColVector, UnivariateLaw >, STK::IUnivStatModel< Array, WColVector, Law::Bernoulli >, STK::AICCriterion, STK::BICCriterion, STK::IRunnerUnsupervised< Array, Weights_ >, STK::IRunnerUnsupervised< Array, hidden::Traits< Array >::Col >, STK::IRunnerUnsupervised< Array, VectorX >, STK::IRunnerUnsupervised< Array, WColVector >, STK::IRunnerUnsupervised< Array, Weights >, STK::IRunnerUnsupervised< ColVector, WColVector >, STK::IRunnerSupervised< YArray_, XArray_, Weights_ >, STK::IRunnerSupervised< Array, Array, Weight >, STK::IRunnerSupervised< YArray, XArray, VectorX >, STK::IRunnerSupervised< YArray, XArray, Weights >, and STK::IRunnerSupervised< YArray, XVector, VectorX >.

Referenced by STK::FullStrategy::initStep(), STK::FullStrategy::run(), STK::SimpleStrategy::run(), STK::XemStrategy::run(), STK::StrategyFacade::run(), STK::LearnFacade::run(), STK::lapack::SymEigen< SquareArray >::runImpl(), and STK::IMixtureInit::runInitAlgo().

update()

virtual void STK::IRunnerBase::update ( )

inlineprotectedvirtual

update the runner.

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

Reimplemented in STK::LocalVariance< Array >, STK::ProjectedVariance< Array >, STK::IBasis< Data, Coefs >, STK::IBasis< Data, ArrayXX >, STK::IBasis< XVector, ArrayXX >, STK::IRunnerSupervised< YArray_, XArray_, Weights_ >, STK::IRunnerSupervised< Array, Array, Weight >, STK::IRunnerSupervised< YArray, XArray, VectorX >, STK::IRunnerSupervised< YArray, XArray, Weights >, STK::IRunnerSupervised< YArray, XVector, VectorX >, STK::Stat::Factor< Array >, STK::Stat::MultiFactor< Array >, STK::Stat::Multivariate< Array, Real >, STK::IUnivStatModel< ColVector, WColVector, UnivariateLaw >, and STK::IUnivStatModel< Array, WColVector, Law::Bernoulli >.

Definition at line 94 of file STK_IRunner.h.

{}

Referenced by STK::IRunnerWithData< Array >::setData(), STK::IRunnerUnsupervised< Array, Weights_ >::setData(), STK::IRunnerWithData< Array >::setData(), STK::IRunnerUnsupervised< Array, Weights_ >::setData(), STK::BSplineCoefficients< Data >::setData(), STK::BSplineCoefficients< Data >::setDegree(), STK::BSplineCoefficients< Data >::setNbControlPoints(), STK::BSplineCoefficients< Data >::setParameters(), and STK::BSplineCoefficients< Data >::setPosition().

Member Data Documentation

hasRun_

bool STK::IRunnerBase::hasRun_

protected

true if run has been used, false otherwise

Definition at line 98 of file STK_IRunner.h.

Referenced by STK::BSplineCoefficients< Data >::extrapolate(), STK::CvHandler::getKFold(), STK::CvHandler::getKFold(), STK::PartitionHandler::getPartitions(), STK::PartitionHandler::getPartitions(), STK::IClassification< YArray_, XArray_, Weights_ >::run(), STK::CvHandler::run(), STK::PartitionHandler::run(), STK::BSplineCoefficients< Data >::run(), STK::ChebyshevCoefficients< Data, Coefs >::run(), STK::CosinesCoefficients< Data, Coefs >::run(), STK::IRegression< YArray, XArray, Weights >::run(), STK::SinesCoefficients< Data, Coefs >::run(), STK::TrigonometricCoefficients< Data, Coefs >::run(), STK::IRegression< YArray, XArray, Weights >::run(), STK::IClassification< YArray_, XArray_, Weights_ >::run(), STK::IRunnerWithData< Array >::setData(), STK::IRunnerUnsupervised< Array, Weights_ >::setData(), STK::IRunnerWithData< Array >::setData(), STK::ISymEigen< Derived >::setData(), STK::CvHandler::setData(), STK::PartitionHandler::setData(), STK::IRunnerSupervised< YArray_, XArray_, Weights_ >::setData(), STK::IRunnerSupervised< YArray_, XArray_, Weights_ >::setX(), STK::IRunnerSupervised< YArray_, XArray_, Weights_ >::setY(), and STK::IBasis< Data, Coefs >::update().

msg_error_

String STK::IRunnerBase::msg_error_

protected

String with the last error message.

Definition at line 96 of file STK_IRunner.h.

Referenced by STK::ImportFromCsv::asNumeric(), STK::ImportFromCsv::asOnlyNumeric(), STK::ImportFromCsv::asString(), STK::IMixtureAlgoPredict::burnStep(), STK::BSplineCoefficients< Data >::computeKnots(), STK::lapack::Qr::computeQr(), STK::lapack::Svd::computeSvd(), STK::SymEigen< SquareArray >::diagonalize(), error(), STK::CvHandler::getKFold(), STK::CvHandler::getKFold(), STK::PartitionHandler::getPartitions(), STK::PartitionHandler::getPartitions(), STK::AdditiveBSplineRegression< YArray, XArray, Weights >::initializeStep(), STK::IBasis< Data, Coefs >::initializeStep(), STK::FullStrategy::initStep(), STK::TReadWriteCsv< Type >::operator=(), STK::IMixtureAlgoPredict::predictBayesClassifier(), STK::TReadWriteCsv< Type >::read(), STK::AdditiveBSplineRegression< YArray, XArray, Weights >::regressionStep(), STK::AdditiveBSplineRegression< YArray, XArray, Weights >::regressionStep(), STK::LinearAAModel< Array >::run(), STK::IClassification< YArray_, XArray_, Weights_ >::run(), STK::EMAlgo::run(), STK::CEMAlgo::run(), STK::SEMAlgo::run(), STK::SemiSEMAlgo::run(), STK::ImputeAlgo::run(), STK::SimulAlgo::run(), STK::EMPredict::run(), STK::SemiSEMPredict::run(), STK::AICMixtureCriterion::run(), STK::BICMixtureCriterion::run(), STK::ICLMixtureCriterion::run(), STK::MLMixtureCriterion::run(), STK::RandomInit::run(), STK::ClassInit::run(), STK::FuzzyInit::run(), STK::FullStrategy::run(), STK::SimpleStrategy::run(), STK::XemStrategy::run(), STK::StrategyFacade::run(), STK::LearnFacade::run(), STK::CsvToArray< Array, Type >::run(), STK::ImportFromCsv::run(), STK::ILinearReduct< Array, Weights >::run(), STK::AdditiveBSplineCoefficients< Array >::run(), STK::BSplineCoefficients< Data >::run(), STK::ChebyshevCoefficients< Data, Coefs >::run(), STK::CosinesCoefficients< Data, Coefs >::run(), STK::SinesCoefficients< Data, Coefs >::run(), STK::TrigonometricCoefficients< Data, Coefs >::run(), STK::Stat::Multivariate< Array, WColVector, Type >::run(), STK::Stat::Multivariate< Array, Real >::run(), STK::IUnivStatModel< ColVector, WColVector, UnivariateLaw >::run(), STK::AICCriterion::run(), STK::BICCriterion::run(), STK::Stat::Multivariate< Array, Real >::run(), STK::LinearAAModel< Array >::run(), STK::Stat::Multivariate< Array, WColVector, Type >::run(), STK::IUnivStatModel< ColVector, WColVector, UnivariateLaw >::run(), STK::ILinearReduct< Array, Weights >::run(), STK::IClassification< YArray_, XArray_, Weights_ >::run(), STK::lapack::Svd::runImpl(), STK::SymEigen< SquareArray >::runImpl(), and STK::IMixtureInit::runInitAlgo().

---

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

• STK_IRunner.h