aGrUM  0.16.0
multiDimBijArray.h
Go to the documentation of this file.
1 
31 #ifndef GUM_MULTIDIMBIJARRAY_H
32 #define GUM_MULTIDIMBIJARRAY_H
33 
34 #include <initializer_list>
35 
36 #include <agrum/core/bijection.h>
37 
40 
41 namespace gum {
42 
53  template < typename GUM_SCALAR >
54  class MultiDimBijArray : public MultiDimWithOffset< GUM_SCALAR > {
55  public:
56  using VarBijection =
58 
59  // =========================================================================
61  // =========================================================================
63 
71  MultiDimBijArray(const VarBijection& bijection,
72  const MultiDimArray< GUM_SCALAR >& array);
73 
81  MultiDimBijArray(const VarBijection& bijection,
82  const MultiDimBijArray< GUM_SCALAR >& array);
83 
93 
97  virtual ~MultiDimBijArray();
98 
100  // ========================================================================
102  // ========================================================================
104 
111 
117  virtual void set(const Instantiation& i, const GUM_SCALAR& value) const;
118 
125  virtual void add(const DiscreteVariable& v);
126 
133  virtual void erase(const DiscreteVariable& v);
134 
140  virtual void fill(const GUM_SCALAR& d) const;
141 
148  virtual void populate(const std::vector< GUM_SCALAR >& v) const;
149 
156  virtual void populate(std::initializer_list< GUM_SCALAR > l) const;
157 
159  // ========================================================================
161  // ========================================================================
163 
164  virtual const std::string& name() const;
165 
166  virtual GUM_SCALAR get(const Instantiation& i) const;
167 
168  virtual Size realSize() const;
169 
171 
173 
174  protected:
175  virtual GUM_SCALAR& _get(const Instantiation& i) const;
176 
177  virtual void _commitMultipleChanges();
178 
179  virtual void _replace(const DiscreteVariable* x, const DiscreteVariable* y);
180 
181  private:
184 
186  std::string __name;
187  };
188 
189 
190 #ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
191  extern template class MultiDimBijArray< double >;
192 #endif
193 
194 } // namespace gum
195 
197 
198 #endif // GUM_MULTIDIMBIJARRAY_H
virtual GUM_SCALAR & _get(const Instantiation &i) const
Return a data, given a Instantiation.
const MultiDimArray< GUM_SCALAR > & __array
The true data.
Decorator of a MultiDimArray, using a bijection over the variables.
Definition: multiDimArray.h:39
virtual const std::string & name() const
Returns the real name of the multiDim implementation.
MultiDimBijArray< GUM_SCALAR > & operator=(const MultiDimBijArray< GUM_SCALAR > &from)
virtual void fill(const GUM_SCALAR &d) const
This will raise an exception: you can&#39;t change the data.
virtual Size realSize() const
Returns the real number of parameters used for this table.
Copyright 2005-2019 Pierre-Henri WUILLEMIN et Christophe GONZALES (LIP6) {prenom.nom}_at_lip6.fr.
std::string __name
The class name.
Base class for discrete random variable.
Copyright 2005-2019 Pierre-Henri WUILLEMIN et Christophe GONZALES (LIP6) {prenom.nom}_at_lip6.fr.
Definition: agrum.h:25
virtual void _commitMultipleChanges()
Synchronize content after MultipleChanges.
Bijection< const DiscreteVariable *, const DiscreteVariable *> VarBijection
virtual MultiDimBijArray< GUM_SCALAR > * newFactory() const
Class constructor.
MultiDimBijArray(const VarBijection &bijection, const MultiDimArray< GUM_SCALAR > &array)
Class constructor.
virtual void populate(const std::vector< GUM_SCALAR > &v) const
This will raise an exception: you can&#39;t change the variables in a MultiDimBijArray.
Multidimensional matrix stored as an array in memory.
Definition: multiDimArray.h:54
Set of pairs of elements with fast search for both elements.
Definition: bijection.h:1805
virtual void add(const DiscreteVariable &v)
This will raise an exception: you can&#39;t change the variables in a MultiDimBijArray.
Class for assigning/browsing values to tuples of discrete variables.
Definition: instantiation.h:83
virtual ~MultiDimBijArray()
Class destructor.
virtual void erase(const DiscreteVariable &v)
This will raise an exception: you can&#39;t change the variables in a MultiDimBijArray.
std::size_t Size
In aGrUM, hashed values are unsigned long int.
Definition: types.h:48
Copyright 2005-2019 Pierre-Henri WUILLEMIN et Christophe GONZALES (LIP6) {prenom.nom}_at_lip6.fr.
Copyright 2005-2019 Pierre-Henri WUILLEMIN et Christophe GONZALES (LIP6) {prenom.nom}_at_lip6.fr.
Copyright 2005-2019 Pierre-Henri WUILLEMIN et Christophe GONZALES (LIP6) {prenom.nom}_at_lip6.fr.
virtual void _replace(const DiscreteVariable *x, const DiscreteVariable *y)
Replace variable x by y.