#include <scheduleProjection.h>

Inheritance diagram for gum::ScheduleProjection< GUM_SCALAR >:

Public Member Functions
Constructors / Destructors
	ScheduleProjection ()
	default constructor More...

	ScheduleProjection (const ScheduleProjection< GUM_SCALAR > &)
	copy constructor More...

virtual	~ScheduleProjection ()
	destructor More...

virtual ScheduleProjection< GUM_SCALAR > *	newFactory () const =0
	virtual constructor More...

Accessors/Modifiers
virtual ScheduleMultiDim< GUM_SCALAR >	project (const ScheduleMultiDim< GUM_SCALAR > &table, const Set< const DiscreteVariable * > &del_vars, Schedule< GUM_SCALAR > &schedule)=0
	creates and returns the projection of the table over a subset of its vars More...

ScheduleMultiDim< GUM_SCALAR >	project (const MultiDimImplementation< GUM_SCALAR > &table, const Set< const DiscreteVariable * > &del_vars, Schedule< GUM_SCALAR > &schedule)
	creates and returns the projection of the table over a subset of its vars More...

template<template< typename > class TABLE>
ScheduleMultiDim< GUM_SCALAR >	project (const TABLE< GUM_SCALAR > &table, const Set< const DiscreteVariable * > &del_vars, Schedule< GUM_SCALAR > &schedule)
	creates and returns the projection of the table over a subset of its vars More...

virtual void	setProjectFunction (MultiDimImplementation< GUM_SCALAR > (proj)(const MultiDimImplementation< GUM_SCALAR > &, const Set< const DiscreteVariable * > &))=0
	changes the function used for projecting tables More...

virtual MultiDimImplementation< GUM_SCALAR > ()(const MultiDimImplementation< GUM_SCALAR > &, const Set< const DiscreteVariable *> &)	projectFunction ()
	returns the projection function currently used by the projector More...

virtual float	nbOperations (const ScheduleMultiDim< GUM_SCALAR > &table, const Set< const DiscreteVariable * > &del_vars, const Schedule< GUM_SCALAR > &schedule)=0
	returns a rough estimate of the number of operations that will be performed to compute the projection More...

float	nbOperations (const MultiDimImplementation< GUM_SCALAR > &table, const Set< const DiscreteVariable * > &del_vars, const Schedule< GUM_SCALAR > &schedule)
	creates and returns the projection of the table over a subset of its vars More...

template<template< typename > class TABLE>
float	nbOperations (const TABLE< GUM_SCALAR > &set, const Set< const DiscreteVariable * > &del_vars, const Schedule< GUM_SCALAR > &schedule)
	creates and returns the projection of the table over a subset of its vars More...

virtual std::pair< long, long >	memoryUsage (const ScheduleMultiDim< GUM_SCALAR > &table, const Set< const DiscreteVariable * > &del_vars, const Schedule< GUM_SCALAR > &schedule)=0
	returns the memory consumption used during the projection More...

std::pair< long, long >	memoryUsage (const MultiDimImplementation< GUM_SCALAR > &table, const Set< const DiscreteVariable * > &del_vars, const Schedule< GUM_SCALAR > &schedule)
	creates and returns the projection of the table over a subset of its vars More...

template<template< typename > class TABLE>
std::pair< long, long >	memoryUsage (const TABLE< GUM_SCALAR > &table, const Set< const DiscreteVariable * > &del_vars, const Schedule< GUM_SCALAR > &schedule)
	creates and returns the projection of the table over a subset of its vars More...

Detailed Description

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

Definition at line 76 of file scheduleProjection.h.

Constructor & Destructor Documentation

◆ ScheduleProjection() [1/2]

template<typename GUM_SCALAR >

gum::ScheduleProjection< GUM_SCALAR >::ScheduleProjection ( )

default constructor

◆ ScheduleProjection() [2/2]

template<typename GUM_SCALAR >

gum::ScheduleProjection< GUM_SCALAR >::ScheduleProjection ( const ScheduleProjection< GUM_SCALAR > & )

copy constructor

◆ ~ScheduleProjection()

template<typename GUM_SCALAR >

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

virtual

destructor

Member Function Documentation

◆ memoryUsage() [1/3]

template<typename GUM_SCALAR >

virtual std::pair< long, long > gum::ScheduleProjection< GUM_SCALAR >::memoryUsage	(	const ScheduleMultiDim< GUM_SCALAR > &	table,
		const Set< const DiscreteVariable * > &	del_vars,
		const Schedule< GUM_SCALAR > &	schedule
	)

pure virtual

returns the memory consumption used during the projection

Actually, this function does not return a precise account of the memory used by the multidimProjection but a rough estimate based on the size of the table involved in the projection.

Returns: a pair of memory consumption: the first one is the maximum amount of memory used during the combination and the second one is the amount of memory still used at the end of the function ( the memory used by the resulting table )

Implemented in gum::ScheduleProjectionBasic< GUM_SCALAR >.

◆ memoryUsage() [2/3]

template<typename GUM_SCALAR >

std::pair< long, long > gum::ScheduleProjection< GUM_SCALAR >::memoryUsage	(	const MultiDimImplementation< GUM_SCALAR > &	table,
		const Set< const DiscreteVariable * > &	del_vars,
		const Schedule< GUM_SCALAR > &	schedule
	)

creates and returns the projection of the table over a subset of its vars

Returns: a new freshly created ScheduleMultiDim which is the result of the projection of the table passed in argument over the set of variables NOT IN del_vars

Warning: If del_vars is precisely equal to the variables of table, the result is an empty table.

◆ memoryUsage() [3/3]

template<typename GUM_SCALAR >

template<template< typename > class TABLE>

std::pair< long, long > gum::ScheduleProjection< GUM_SCALAR >::memoryUsage	(	const TABLE< GUM_SCALAR > &	table,
		const Set< const DiscreteVariable * > &	del_vars,
		const Schedule< GUM_SCALAR > &	schedule
	)

creates and returns the projection of the table over a subset of its vars

Returns: a new freshly created ScheduleMultiDim which is the result of the projection of the table passed in argument over the set of variables NOT IN del_vars

Warning: If del_vars is precisely equal to the variables of table, the result is an empty table.

◆ nbOperations() [1/3]

template<typename GUM_SCALAR >

virtual float gum::ScheduleProjection< GUM_SCALAR >::nbOperations	(	const ScheduleMultiDim< GUM_SCALAR > &	table,
		const Set< const DiscreteVariable * > &	del_vars,
		const Schedule< GUM_SCALAR > &	schedule
	)

pure virtual

returns a rough estimate of the number of operations that will be performed to compute the projection

Implemented in gum::ScheduleProjectionBasic< GUM_SCALAR >.

◆ nbOperations() [2/3]

template<typename GUM_SCALAR >

float gum::ScheduleProjection< GUM_SCALAR >::nbOperations	(	const MultiDimImplementation< GUM_SCALAR > &	table,
		const Set< const DiscreteVariable * > &	del_vars,
		const Schedule< GUM_SCALAR > &	schedule
	)

creates and returns the projection of the table over a subset of its vars

Returns: a new freshly created ScheduleMultiDim which is the result of the projection of the table passed in argument over the set of variables NOT IN del_vars

Warning: If del_vars is precisely equal to the variables of table, the result is an empty table.

◆ nbOperations() [3/3]

template<typename GUM_SCALAR >

template<template< typename > class TABLE>

float gum::ScheduleProjection< GUM_SCALAR >::nbOperations	(	const TABLE< GUM_SCALAR > &	set,
		const Set< const DiscreteVariable * > &	del_vars,
		const Schedule< GUM_SCALAR > &	schedule
	)

creates and returns the projection of the table over a subset of its vars

Returns: a new freshly created ScheduleMultiDim which is the result of the projection of the table passed in argument over the set of variables NOT IN del_vars

Warning: If del_vars is precisely equal to the variables of table, the result is an empty table.

◆ newFactory()

template<typename GUM_SCALAR >

virtual ScheduleProjection< GUM_SCALAR >* gum::ScheduleProjection< GUM_SCALAR >::newFactory ( ) const

pure virtual

virtual constructor

Returns: a new fresh ScheduleCombinator with the same projection function.

Implemented in gum::ScheduleProjectionBasic< GUM_SCALAR >.

◆ operator=()

template<typename GUM_SCALAR >

ScheduleProjection< GUM_SCALAR >& gum::ScheduleProjection< GUM_SCALAR >::operator= ( const ScheduleProjection< GUM_SCALAR > & )

private

to be coherent with combinations, forbid copy operators

◆ project() [1/3]

template<typename GUM_SCALAR >

virtual ScheduleMultiDim< GUM_SCALAR > gum::ScheduleProjection< GUM_SCALAR >::project	(	const ScheduleMultiDim< GUM_SCALAR > &	table,
		const Set< const DiscreteVariable * > &	del_vars,
		Schedule< GUM_SCALAR > &	schedule
	)

pure virtual

creates and returns the projection of the table over a subset of its vars

Returns: a new freshly created ScheduleMultiDim which is the result of the projection of the table passed in argument over the set of variables NOT IN del_vars

Warning: If del_vars is precisely equal to the variables of table, the result is an empty table.

Implemented in gum::ScheduleProjectionBasic< GUM_SCALAR >.

◆ project() [2/3]

template<typename GUM_SCALAR >

ScheduleMultiDim< GUM_SCALAR > gum::ScheduleProjection< GUM_SCALAR >::project	(	const MultiDimImplementation< GUM_SCALAR > &	table,
		const Set< const DiscreteVariable * > &	del_vars,
		Schedule< GUM_SCALAR > &	schedule
	)

creates and returns the projection of the table over a subset of its vars

Returns: a new freshly created ScheduleMultiDim which is the result of the projection of the table passed in argument over the set of variables NOT IN del_vars

Warning: If del_vars is precisely equal to the variables of table, the result is an empty table.

◆ project() [3/3]

template<typename GUM_SCALAR >

template<template< typename > class TABLE>

ScheduleMultiDim< GUM_SCALAR > gum::ScheduleProjection< GUM_SCALAR >::project	(	const TABLE< GUM_SCALAR > &	table,
		const Set< const DiscreteVariable * > &	del_vars,
		Schedule< GUM_SCALAR > &	schedule
	)

creates and returns the projection of the table over a subset of its vars

Returns: a new freshly created ScheduleMultiDim which is the result of the projection of the table passed in argument over the set of variables NOT IN del_vars

Warning: If del_vars is precisely equal to the variables of table, the result is an empty table.

◆ projectFunction()

template<typename GUM_SCALAR >

virtual MultiDimImplementation< GUM_SCALAR >*(*)( const MultiDimImplementation< GUM_SCALAR >&, const Set< const DiscreteVariable* >&) gum::ScheduleProjection< GUM_SCALAR >::projectFunction ( )

virtual

returns the projection function currently used by the projector

Reimplemented in gum::ScheduleProjectionBasic< GUM_SCALAR >.

◆ setProjectFunction()

template<typename GUM_SCALAR >

virtual void gum::ScheduleProjection< GUM_SCALAR >::setProjectFunction ( MultiDimImplementation< GUM_SCALAR > *(*)(const MultiDimImplementation< GUM_SCALAR > &, const Set< const DiscreteVariable * > &) proj )

pure virtual

changes the function used for projecting tables

Implemented in gum::ScheduleProjectionBasic< GUM_SCALAR >.

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

agrum/tools/graphicalModels/inference/scheduler/scheduleProjection.h

Public Member Functions

Detailed Description

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

Constructor & Destructor Documentation

◆ ScheduleProjection() [1/2]

◆ ScheduleProjection() [2/2]

◆ ~ScheduleProjection()

Member Function Documentation

◆ memoryUsage() [1/3]

◆ memoryUsage() [2/3]

◆ memoryUsage() [3/3]

◆ nbOperations() [1/3]

◆ nbOperations() [2/3]

◆ nbOperations() [3/3]

◆ newFactory()

◆ operator=()

◆ project() [1/3]

◆ project() [2/3]

◆ project() [3/3]

◆ projectFunction()

◆ setProjectFunction()

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