mrpt::math::CMonteCarlo< T, NUM, OTHER > Class Template Reference

Detailed Description

template<typename T, typename NUM, typename OTHER>
class mrpt::math::CMonteCarlo< T, NUM, OTHER >

Montecarlo simulation for experiments in 1D.

Template arguments are:

• T: base type, i.e., if an experiment needs to generate random points, then T may be a TPoint3D, and so on.
• NUM: the numeric type used to represent the error. Usually, double.
• OTHER: an intermediate type, used especially when testing inverse functions. Leave as int or double if you don't use it.

HOW TO USE THIS CLASS:

• Create an instance of the class.
• Refill the "valueGenerator" member with an appropriate function.
• If your experiment calculates the error directly from the base value, then refill the "errorFun1" member.
• Otherwise, if your experiment involves the calculation of some value whom with the experimental function is compared, refill "intermediateFun" and "errorFun2".
• Refill only on of the alternatives.

Definition at line 43 of file CMonteCarlo.h.

#include <mrpt/math/CMonteCarlo.h>

Classes
class	CStatisticalAnalyzer

Public Member Functions
	CMonteCarlo ()
NUM	doExperiment (size_t N, double &time, bool showInWindow=false)

Public Attributes
T(*	valueGenerator )(mrpt::random::CRandomGenerator &)
NUM(*	errorFun1 )(const T &)
OTHER(*	intermediateFun )(const T &)
NUM(*	errorFun2 )(const T &, const OTHER &)

Private Attributes
mrpt::random::CRandomGenerator	gen

Constructor & Destructor Documentation

CMonteCarlo()

template<typename T , typename NUM , typename OTHER >

mrpt::math::CMonteCarlo< T, NUM, OTHER >::CMonteCarlo ( )

inline

Definition at line 98 of file CMonteCarlo.h.

Member Function Documentation

doExperiment()

template<typename T , typename NUM , typename OTHER >

NUM mrpt::math::CMonteCarlo< T, NUM, OTHER >::doExperiment ( size_t  N, double &  time, bool  showInWindow = false  )

inline

Definition at line 106 of file CMonteCarlo.h.

References mrpt::math::CMonteCarlo< T, NUM, OTHER >::errorFun1, mrpt::math::CMonteCarlo< T, NUM, OTHER >::errorFun2, mrpt::math::CMonteCarlo< T, NUM, OTHER >::gen, mrpt::math::CMonteCarlo< T, NUM, OTHER >::CStatisticalAnalyzer::getDistribution(), mrpt::math::CMonteCarlo< T, NUM, OTHER >::intermediateFun, mrpt::gui::CBaseGUIWindow::isOpen(), mrpt::gui::CDisplayWindowPlots::plot(), mrpt::system::CTicTac::Tac(), mrpt::system::CTicTac::Tic(), and mrpt::math::CMonteCarlo< T, NUM, OTHER >::valueGenerator.

Member Data Documentation

errorFun1

template<typename T , typename NUM , typename OTHER >

NUM(* mrpt::math::CMonteCarlo< T, NUM, OTHER >::errorFun1) (const T &)

Definition at line 94 of file CMonteCarlo.h.

Referenced by mrpt::math::CMonteCarlo< T, NUM, OTHER >::doExperiment().

errorFun2

template<typename T , typename NUM , typename OTHER >

NUM(* mrpt::math::CMonteCarlo< T, NUM, OTHER >::errorFun2) (const T &, const OTHER &)

Definition at line 97 of file CMonteCarlo.h.

Referenced by mrpt::math::CMonteCarlo< T, NUM, OTHER >::doExperiment().

gen

template<typename T , typename NUM , typename OTHER >

mrpt::random::CRandomGenerator mrpt::math::CMonteCarlo< T, NUM, OTHER >::gen

private

Definition at line 46 of file CMonteCarlo.h.

Referenced by mrpt::math::CMonteCarlo< T, NUM, OTHER >::doExperiment().

intermediateFun

template<typename T , typename NUM , typename OTHER >

OTHER(* mrpt::math::CMonteCarlo< T, NUM, OTHER >::intermediateFun) (const T &)

Definition at line 96 of file CMonteCarlo.h.

Referenced by mrpt::math::CMonteCarlo< T, NUM, OTHER >::doExperiment().

valueGenerator

template<typename T , typename NUM , typename OTHER >

T(* mrpt::math::CMonteCarlo< T, NUM, OTHER >::valueGenerator) (mrpt::random::CRandomGenerator &)

Definition at line 92 of file CMonteCarlo.h.

Referenced by mrpt::math::CMonteCarlo< T, NUM, OTHER >::doExperiment().