aGrUM  0.14.2
scheduleCliqueStoreMultiDim.h
Go to the documentation of this file.
1 /***************************************************************************
2  * Copyright (C) 2005 by Pierre-Henri WUILLEMIN et Christophe GONZALES *
3  * {prenom.nom}_at_lip6.fr *
4  * *
5  * This program is free software; you can redistribute it and/or modify *
6  * it under the terms of the GNU General Public License as published by *
7  * the Free Software Foundation; either version 2 of the License, or *
8  * (at your option) any later version. *
9  * *
10  * This program is distributed in the hope that it will be useful, *
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13  * GNU General Public License for more details. *
14  * *
15  * You should have received a copy of the GNU General Public License *
16  * along with this program; if not, write to the *
17  * Free Software Foundation, Inc., *
18  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
19  ***************************************************************************/
26 #ifndef GUM_SCHEDULE_CLIQUE_STORE_MULTI_DIM_H
27 #define GUM_SCHEDULE_CLIQUE_STORE_MULTI_DIM_H
28 
29 #include <string>
30 
31 #include <agrum/agrum.h>
32 
33 #include <agrum/core/sequence.h>
38 
39 namespace gum {
40 
41  template < typename GUM_SCALAR >
42 
43  class ScheduleCliqueStoreMultiDim : public ScheduleOperation< GUM_SCALAR > {
44  public:
45  // ############################################################################
47  // ############################################################################
49 
52  const ScheduleMultiDim< GUM_SCALAR >& table,
54  clique_tables,
55  NodeId clique);
56 
59 
62 
65 
67 
68  // ############################################################################
70  // ############################################################################
72 
76 
78 
81 
83 
86 
88 
89  // ############################################################################
91  // ############################################################################
93 
95  void execute();
96 
99  float nbOperations() const;
100 
102 
110  std::pair< long, long > memoryUsage() const;
111 
114 
117  multiDimResults() const;
118 
120  std::string toString() const;
121 
123 
124  private:
125  // the table to store into the clique
127 
128  // a mapping assigning to each clique a set of tables
130 
131  // the clique into which the table will be stored
133 
136  };
137 
138 } /* namespace gum */
139 
140 // always include the template implementation
142 
143 #endif /* GUM_SCHEDULE_CLIQUE_STORE_MULTI_DIM_H */
bool operator!=(const ScheduleOperation< GUM_SCALAR > &) const
operator !=
ScheduleCliqueStoreMultiDim(const ScheduleMultiDim< GUM_SCALAR > &table, NodeProperty< Set< const MultiDimImplementation< GUM_SCALAR > * > > &clique_tables, NodeId clique)
default constructor
a MultiDimImplementation Wrapper used for scheduling inferences
Header file of gum::Sequence, a class for storing (ordered) sequences of objects. ...
a MultiDimImplementation Wrapper used for scheduling inferences
The generic class for storing (ordered) sequences of objects.
Definition: sequence.h:1019
bool operator==(const ScheduleOperation< GUM_SCALAR > &) const
operator ==
std::pair< long, long > memoryUsage() const
returns the memory consumption used during the operation
void execute()
executes the operation
gum is the global namespace for all aGrUM entities
Definition: agrum.h:25
Sequence< const ScheduleMultiDim< GUM_SCALAR > *> * __args
the set of ScheduleMultidims passed in arguments
Headers of gum::MultiDimImplementation.
The class for generic Hash Tables.
Definition: hashTable.h:676
virtual ~ScheduleCliqueStoreMultiDim()
destructor
Representation of a setA Set is a structure that contains arbitrary elements.
Definition: set.h:162
an operator used by scheduled inferences to store tables into cliques
NodeProperty< Set< const MultiDimImplementation< GUM_SCALAR > *> > * __tableSet
float nbOperations() const
returns an estimation of the number of elementary operations needed to perform the ScheduleOperation ...
const Sequence< const ScheduleMultiDim< GUM_SCALAR > *> & multiDimArgs() const
returns the set of multidims passed in argument to the operation
virtual ScheduleCliqueStoreMultiDim< GUM_SCALAR > * newFactory() const
virtual copy constructor: creates a clone of the operation
the base operation class used to schedule inferences
ScheduleCliqueStoreMultiDim< GUM_SCALAR > & operator=(const ScheduleCliqueStoreMultiDim< GUM_SCALAR > &)
copy operator
ScheduleMultiDim< GUM_SCALAR > __table
const Sequence< const ScheduleMultiDim< GUM_SCALAR > *> & multiDimResults() const
returns the set of multidims that should be the result of the operation
<agrum/multidim/multiDimImplementation.h>
std::string toString() const
displays the content of the operation
Size NodeId
Type for node ids.
Definition: graphElements.h:97
some utils for topology : NodeId, Edge, Arc and consorts ...