gum::SchedulerBasic< GUM_SCALAR > Class Template Reference

#include <schedulerBasic.h>

Inheritance diagram for gum::SchedulerBasic< GUM_SCALAR >:

Collaboration diagram for gum::SchedulerBasic< GUM_SCALAR >:

Public Member Functions
Constructors / Destructors
	SchedulerBasic ()
	default constructor More...
	SchedulerBasic (const SchedulerBasic< GUM_SCALAR > &)
	copy constructor More...
virtual	~SchedulerBasic ()
	destructor More...
SchedulerBasic< GUM_SCALAR > *	newFactory () const
	virtual constructor More...
Accessors/Modifiers
bool	execute (Schedule< GUM_SCALAR > &)
	execute all the operations of a given schedule More...
bool	execute (Schedule< GUM_SCALAR > &, Size k)
	execute only k operations of a given schedule (default k = 1) More...
float	nbOperations (const Schedule< GUM_SCALAR > &) const
	returns an estimation of the number of elementary operations needed to perform a given schedule More...
float	nbOperations (const Schedule< GUM_SCALAR > &, Size k) const
	returns an estimation of the number of elementary operations needed to perform the k first ScheduleOperations of a given schedule More...
std::pair< long, long >	memoryUsage (const Schedule< GUM_SCALAR > &) const
	returns the memory consumption used during the execution of a schedule More...
std::pair< long, long >	memoryUsage (const Schedule< GUM_SCALAR > &, Size k) const
	returns the memory consumption used during the execution of the k first ScheduleOperations of a given schedule More...

Detailed Description

template<typename GUM_SCALAR>
class gum::SchedulerBasic< GUM_SCALAR >

Definition at line 36 of file schedulerBasic.h.

Constructor & Destructor Documentation

SchedulerBasic() [1/2]

template<typename GUM_SCALAR >

gum::SchedulerBasic< GUM_SCALAR >::SchedulerBasic

(

)

default constructor

SchedulerBasic() [2/2]

template<typename GUM_SCALAR >

gum::SchedulerBasic< GUM_SCALAR >::SchedulerBasic

(

const SchedulerBasic< GUM_SCALAR > &

)

copy constructor

~SchedulerBasic()

template<typename GUM_SCALAR >

virtual gum::SchedulerBasic< GUM_SCALAR >::~SchedulerBasic ( )

virtual

destructor

Member Function Documentation

execute() [1/2]

template<typename GUM_SCALAR >

bool gum::SchedulerBasic< GUM_SCALAR >::execute ( Schedule< GUM_SCALAR > &  )

virtual

execute all the operations of a given schedule

Returns

a Boolean indicating whether all the schedule was performed

Implements gum::Scheduler< GUM_SCALAR >.

execute() [2/2]

template<typename GUM_SCALAR >

bool gum::SchedulerBasic< GUM_SCALAR >::execute ( Schedule< GUM_SCALAR > &  , Size  k  )

virtual

execute only k operations of a given schedule (default k = 1)

If there are fewer than k operations in the schedule, then all those operations are performed

Returns

a Boolean indicating whether the k operations (or all the operations of the schedule) were performed

Implements gum::Scheduler< GUM_SCALAR >.

memoryUsage() [1/2]

template<typename GUM_SCALAR >

std::pair< long, long > gum::SchedulerBasic< GUM_SCALAR >::memoryUsage ( const Schedule< GUM_SCALAR > &  ) const

virtual

returns the memory consumption used during the execution of a schedule

Actually, this function does not return a precise account of the memory used to perform the schedule but a rough estimate based on the sizes of the tables involved in the schedule.

Returns

a pair of memory consumption: the first one is the maximum amount of memory used during the execution of the Schedule and the second one is the amount of memory still used at the end of the execution of the schedule

Implements gum::Scheduler< GUM_SCALAR >.

memoryUsage() [2/2]

template<typename GUM_SCALAR >

std::pair< long, long > gum::SchedulerBasic< GUM_SCALAR >::memoryUsage ( const Schedule< GUM_SCALAR > &  , Size  k  ) const

virtual

returns the memory consumption used during the execution of the k first ScheduleOperations of a given schedule

Actually, this function does not return a precise account of the memory used to perform the schedule but a rough estimate based on the sizes of the tables involved in the schedule. If there are fewer than k operations in the schedule, then all those operations are taken into account.

Returns

a pair of memory consumption: the first one is the maximum amount of memory used during the execution of the Schedule and the second one is the amount of memory still used at the end of the execution of k first operations of the schedule

Implements gum::Scheduler< GUM_SCALAR >.

nbOperations() [1/2]

template<typename GUM_SCALAR >

float gum::SchedulerBasic< GUM_SCALAR >::nbOperations ( const Schedule< GUM_SCALAR > &  ) const

virtual

returns an estimation of the number of elementary operations needed to perform a given schedule

Implements gum::Scheduler< GUM_SCALAR >.

nbOperations() [2/2]

template<typename GUM_SCALAR >

float gum::SchedulerBasic< GUM_SCALAR >::nbOperations ( const Schedule< GUM_SCALAR > &  , Size  k  ) const

virtual

returns an estimation of the number of elementary operations needed to perform the k first ScheduleOperations of a given schedule

If there are fewer than k operations in the schedule, then all those operations are taken into account

Implements gum::Scheduler< GUM_SCALAR >.

newFactory()

template<typename GUM_SCALAR >

SchedulerBasic< GUM_SCALAR >* gum::SchedulerBasic< GUM_SCALAR >::newFactory ( ) const

virtual

virtual constructor

Returns

a new fresh SchedulerBasic

Implements gum::Scheduler< GUM_SCALAR >.

---

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

• agrum/tools/graphicalModels/inference/scheduler/schedulerBasic.h