#include <scheduleCombine.h>

Inheritance diagram for gum::ScheduleCombine< GUM_SCALAR >:

Collaboration diagram for gum::ScheduleCombine< GUM_SCALAR >:

Public Member Functions
Constructors / Destructors
	ScheduleCombine (const ScheduleMultiDim< GUM_SCALAR > &table1, const ScheduleMultiDim< GUM_SCALAR > &table2, MultiDimImplementation< GUM_SCALAR > (combine)(const MultiDimImplementation< GUM_SCALAR > &, const MultiDimImplementation< GUM_SCALAR > &))
	default constructor More...

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

virtual ScheduleCombine< GUM_SCALAR > *	newFactory () const
	virtual copy constructor: creates a clone of the operation More...

	~ScheduleCombine ()
	destructor More...

Operators
ScheduleCombine< GUM_SCALAR > &	operator= (const ScheduleCombine< GUM_SCALAR > &)
	copy operator More...

INLINE bool	operator== (const ScheduleOperation< GUM_SCALAR > &) const
	operator == More...

INLINE bool	operator!= (const ScheduleOperation< GUM_SCALAR > &) const
	operator != More...

Accessors/Modifiers
void	execute ()
	executes the operation More...

float	nbOperations () const
	returns an estimation of the number of elementary operations needed to perform the ScheduleOperation More...

std::pair< long, long >	memoryUsage () const
	returns the memory consumption used during the operation More...

INLINE const ScheduleMultiDim< GUM_SCALAR > &	result () const
	returns the scheduleMultidim resulting from the execution of the operation More...

const Sequence< const ScheduleMultiDim< GUM_SCALAR > *> &	multiDimArgs () const
	returns the set of multidims passed in argument to the operation More...

const Sequence< const ScheduleMultiDim< GUM_SCALAR > *> &	multiDimResults () const
	returns the set of multidims that should be the result of the operation More...

std::string	toString () const
	displays the content of the operation More...

Accessors/Modifiers
Type	type () const
	returns the name of the operation More...

Idx	id () const
	returns the id of the operation More...

Public Types
enum	Type : char { Type::COMBINE_MULTIDIM, Type::PROJECT_MULTIDIM, Type::DELETE_MULTIDIM, Type::CLIQUE_STORE_MULTIDIM, Type::SEPARATOR_STORE_MULTIDIM }
	the currently supported types of operations More...

Detailed Description

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

Definition at line 43 of file scheduleCombine.h.

Member Enumeration Documentation

◆ Type

template<typename GUM_SCALAR >

enum gum::ScheduleOperation::Type : char

stronginherited

the currently supported types of operations

Enumerator
COMBINE_MULTIDIM	combine 2 ScheduleMultiDims
PROJECT_MULTIDIM	project a ScheduleMultiDim over a subset of its variables
DELETE_MULTIDIM	delete a MultiDim from memory
CLIQUE_STORE_MULTIDIM	store a Multidim into a clique
SEPARATOR_STORE_MULTIDIM	store a multidim into a separator

Definition at line 44 of file scheduleOperation.h.

                     : char
     {
       COMBINE_MULTIDIM,
       PROJECT_MULTIDIM,
       DELETE_MULTIDIM,
       CLIQUE_STORE_MULTIDIM,
       SEPARATOR_STORE_MULTIDIM
     };

Constructor & Destructor Documentation

◆ ScheduleCombine() [1/2]

template<typename GUM_SCALAR >

gum::ScheduleCombine< GUM_SCALAR >::ScheduleCombine	(	const ScheduleMultiDim< GUM_SCALAR > &	table1,
		const ScheduleMultiDim< GUM_SCALAR > &	table2,
		MultiDimImplementation< GUM_SCALAR > ()(const MultiDimImplementation< GUM_SCALAR > &, const MultiDimImplementation< GUM_SCALAR > &)	combine
	)

default constructor

Warning: tables 1 and 2 are stored by copy into the ScheduleCombine. This is actually compulsory for the appropriate use of ScheduleCombination classes

◆ ScheduleCombine() [2/2]

template<typename GUM_SCALAR >

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

copy constructor

◆ ~ScheduleCombine()

template<typename GUM_SCALAR >

gum::ScheduleCombine< GUM_SCALAR >::~ScheduleCombine ( )

destructor

Member Function Documentation

◆ execute()

template<typename GUM_SCALAR >

void gum::ScheduleCombine< GUM_SCALAR >::execute ( )

virtual

executes the operation

Implements gum::ScheduleOperation< GUM_SCALAR >.

◆ id()

template<typename GUM_SCALAR >

Idx gum::ScheduleOperation< GUM_SCALAR >::id ( ) const

inherited

returns the id of the operation

◆ memoryUsage()

template<typename GUM_SCALAR >

std::pair< long, long > gum::ScheduleCombine< GUM_SCALAR >::memoryUsage ( ) const

virtual

returns the memory consumption used during the operation

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

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

Implements gum::ScheduleOperation< GUM_SCALAR >.

◆ multiDimArgs()

template<typename GUM_SCALAR >

const Sequence< const ScheduleMultiDim< GUM_SCALAR >* >& gum::ScheduleCombine< GUM_SCALAR >::multiDimArgs ( ) const

virtual

returns the set of multidims passed in argument to the operation

Implements gum::ScheduleOperation< GUM_SCALAR >.

◆ multiDimResults()

template<typename GUM_SCALAR >

const Sequence< const ScheduleMultiDim< GUM_SCALAR >* >& gum::ScheduleCombine< GUM_SCALAR >::multiDimResults ( ) const

virtual

returns the set of multidims that should be the result of the operation

Implements gum::ScheduleOperation< GUM_SCALAR >.

◆ nbOperations()

template<typename GUM_SCALAR >

float gum::ScheduleCombine< GUM_SCALAR >::nbOperations ( ) const

virtual

returns an estimation of the number of elementary operations needed to perform the ScheduleOperation

Implements gum::ScheduleOperation< GUM_SCALAR >.

◆ newFactory()

template<typename GUM_SCALAR >

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

virtual

virtual copy constructor: creates a clone of the operation

Implements gum::ScheduleOperation< GUM_SCALAR >.

◆ operator!=()

template<typename GUM_SCALAR >

INLINE bool gum::ScheduleCombine< GUM_SCALAR >::operator!= ( const ScheduleOperation< GUM_SCALAR > & ) const

virtual

operator !=

Two operations are identical if and only if they have the same arguments and their types are identical (combine, project, etc)

Implements gum::ScheduleOperation< GUM_SCALAR >.

◆ operator=()

template<typename GUM_SCALAR >

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

copy operator

◆ operator==()

template<typename GUM_SCALAR >

INLINE bool gum::ScheduleCombine< GUM_SCALAR >::operator== ( const ScheduleOperation< GUM_SCALAR > & ) const

virtual

operator ==

Two operations are identical if and only if they have the same arguments and their types are identical (combine, project, etc)

Implements gum::ScheduleOperation< GUM_SCALAR >.

◆ result()

template<typename GUM_SCALAR >

INLINE const ScheduleMultiDim< GUM_SCALAR >& gum::ScheduleCombine< GUM_SCALAR >::result ( ) const

returns the scheduleMultidim resulting from the execution of the operation

◆ toString()

template<typename GUM_SCALAR >

std::string gum::ScheduleCombine< GUM_SCALAR >::toString ( ) const

virtual

displays the content of the operation

Implements gum::ScheduleOperation< GUM_SCALAR >.

◆ type()

template<typename GUM_SCALAR >

Type gum::ScheduleOperation< GUM_SCALAR >::type ( ) const

inherited

returns the name of the operation

Member Data Documentation

◆ _args_

template<typename GUM_SCALAR >

Sequence< const ScheduleMultiDim< GUM_SCALAR >* >* gum::ScheduleCombine< GUM_SCALAR >::_args_

mutableprivate

the set of ScheduleMultidims passed in arguments

Definition at line 141 of file scheduleCombine.h.

◆ _combine_

template<typename GUM_SCALAR >

MultiDimImplementation< GUM_SCALAR >*(* gum::ScheduleCombine< GUM_SCALAR >::_combine_) (const MultiDimImplementation< GUM_SCALAR > &, const MultiDimImplementation< GUM_SCALAR > &)

private

the function actually used to perform the combination

Definition at line 147 of file scheduleCombine.h.

◆ _result_

template<typename GUM_SCALAR >

ScheduleMultiDim< GUM_SCALAR >* gum::ScheduleCombine< GUM_SCALAR >::_result_

private

the result of the operation

the result is allocated and deallocated by ScheduleCombine

Definition at line 138 of file scheduleCombine.h.

◆ _results_

template<typename GUM_SCALAR >

Sequence< const ScheduleMultiDim< GUM_SCALAR >* >* gum::ScheduleCombine< GUM_SCALAR >::_results_

mutableprivate

the set of ScheduleMultidims resulting from the operation

Definition at line 144 of file scheduleCombine.h.

◆ _table1_

template<typename GUM_SCALAR >

ScheduleMultiDim< GUM_SCALAR > gum::ScheduleCombine< GUM_SCALAR >::_table1_

private

the first table to combine

Definition at line 131 of file scheduleCombine.h.

◆ _table2_

template<typename GUM_SCALAR >

ScheduleMultiDim< GUM_SCALAR > gum::ScheduleCombine< GUM_SCALAR >::_table2_

private

the second table to combine with

Definition at line 134 of file scheduleCombine.h.

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

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

Public Member Functions

Public Types

Detailed Description

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

Member Enumeration Documentation

◆ Type

Constructor & Destructor Documentation

◆ ScheduleCombine() [1/2]

◆ ScheduleCombine() [2/2]

◆ ~ScheduleCombine()

Member Function Documentation

◆ execute()

◆ id()

◆ memoryUsage()

◆ multiDimArgs()

◆ multiDimResults()

◆ nbOperations()

◆ newFactory()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ result()

◆ toString()

◆ type()

Member Data Documentation

◆ _args_

◆ _combine_

◆ _result_

◆ _results_

◆ _table1_

◆ _table2_

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