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

Montecarlo simulation for experiments in 1D. More...

#include <mrpt/math/CMonteCarlo.h>

Collaboration diagram for mrpt::math::CMonteCarlo< T, NUM, OTHER >:

[legend]

List of all members.

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

---

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 57 of file CMonteCarlo.h.

---

Constructor & Destructor Documentation

template<typename T , typename NUM , typename OTHER >

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

(

)

[inline]

Definition at line 94 of file CMonteCarlo.h.

---

Member Function Documentation

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 95 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 >::intermediateFun, mrpt::utils::CTicTac::Tac(), mrpt::utils::CTicTac::Tic(), and mrpt::math::CMonteCarlo< T, NUM, OTHER >::valueGenerator.

---

Member Data Documentation

template<typename T , typename NUM , typename OTHER >

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

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

template<typename T , typename NUM , typename OTHER >

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

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

template<typename T , typename NUM , typename OTHER >

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

Definition at line 59 of file CMonteCarlo.h.

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

template<typename T , typename NUM , typename OTHER >

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

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

template<typename T , typename NUM , typename OTHER >

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

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