aGrUM  0.20.3
a C++ library for (probabilistic) graphical models
gum::aggregator::Median< GUM_SCALAR > Class Template Reference

median aggregator More...

#include <agrum/tools/multidim/aggregators/median.h>

+ Inheritance diagram for gum::aggregator::Median< GUM_SCALAR >:
+ Collaboration diagram for gum::aggregator::Median< GUM_SCALAR >:

Public Member Functions

 Median ()
 
 Median (const Median< GUM_SCALAR > &from)
 
virtual ~Median ()
 
virtual std::string aggregatorName () const
 
virtual MultiDimContainer< GUM_SCALAR > * newFactory () const
 This method creates a clone of this object, withouth its content (including variable), you must use this method if you want to ensure that the generated object has the same type than the object containing the called newFactory() More...
 
Accessors / Modifiers
virtual GUM_SCALAR get (const Instantiation &i) const override
 
std::string toString () const override
 
std::string toString (const gum::Instantiation *i) const override
 
void changeNotification (const gum::Instantiation &, const gum::DiscreteVariable *const, gum::Idx, gum::Idx) override
 
void setFirstNotification (const gum::Instantiation &) override
 
void setLastNotification (const gum::Instantiation &) override
 
void setIncNotification (const gum::Instantiation &) override
 
void setDecNotification (const gum::Instantiation &) override
 
void setChangeNotification (const gum::Instantiation &) override
 
Size realSize () const override
 
const std::string & name () const override
 Returns the real name of the multiDimArray. More...
 
void copyFrom (const MultiDimContainer< GUM_SCALAR > &src) const override
 Copy of a multiDimICIModel. More...
 
bool isDecomposable () const
 
Copy methods.
virtual void copyFrom (const MultiDimContainer< GUM_SCALAR > &src, Instantiation *p_i) const
 Basic copy of a MultiDimContainer. More...
 
virtual void extractFrom (const MultiDimContainer< GUM_SCALAR > &src, const Instantiation &mask)
 Basic extraction of a MultiDimContainer. More...
 
virtual MultiDimAdressablegetMasterRef ()
 In order to insure the dereference for decorators, we need to virtualize the access to master pointer. More...
 
virtual const MultiDimAdressablegetMasterRef () const
 In order to insure the dereference for decorators, we need to virtualize the access to master pointer. More...
 
virtual void copy (const MultiDimContainer< GUM_SCALAR > &src)
 Removes all variables in this MultiDimContainer and copy the content of src, variables included. More...
 
Accessors / Modifiers
virtual void set (const Instantiation &i, const GUM_SCALAR &value) const
 
virtual void fill (const GUM_SCALAR &) const
 
Accessors / Modifiers
const std::string & basename () const
 Returns the base class name of this MultiDimImplementation. More...
 
float compressionRate () const
 The compression ratio of the table (depending on the type of implementation). More...
 
MultiDimInterface implementation
virtual Idx nbrDim () const override
 Returns the number of vars in the multidimensional container. More...
 
virtual Size domainSize () const override
 Returns the product of the variables domain size. More...
 
virtual void add (const DiscreteVariable &v) override
 Adds a new var to the variables of the multidimensional matrix. More...
 
virtual void erase (const DiscreteVariable &v) override
 Removes a var from the variables of the multidimensional matrix. More...
 
virtual const Sequence< const DiscreteVariable *> & variablesSequence () const override
 Returns a const ref to the sequence of DiscreteVariable*. More...
 
const DiscreteVariablevariable (Idx i) const override
 Returns a const ref to the ith var. More...
 
const DiscreteVariablevariable (const std::string &name) const override
 Returns the variable with the name. More...
 
virtual Idx pos (const DiscreteVariable &v) const override
 Returns the index of a variable. More...
 
virtual bool contains (const DiscreteVariable &v) const override
 Returns true if var is in *this. More...
 
virtual bool empty () const override
 Returns true if no var is in *this. More...
 
MultiDimAdressable implementation
virtual bool registerSlave (Instantiation &slave) override
 Register i as a slave of this MultiDimAdressable. More...
 
virtual bool unregisterSlave (Instantiation &slave) override
 Unregister i as a slave of this MultiDimAdressable. More...
 
MultiDimContainer implementation
void beginMultipleChanges () override
 Call this method before doing important changes in this MultiDimContainer. More...
 
void endMultipleChanges () override
 Call this method after doing important changes in this MultiDimContainer. More...
 
void endMultipleChanges (const GUM_SCALAR &) override
 Call this method after doing important changes in this MultiDimContainer. More...
 
Accessors / Modifiers
GUM_SCALAR operator[] (const Instantiation &i) const
 An [] operator using a Instantiation as argument. More...
 
virtual void populate (const std::vector< GUM_SCALAR > &v) const
 Automatically fills this MultiDimContainer with the values in v. More...
 
virtual void populate (std::initializer_list< GUM_SCALAR > l) const
 Automatically fills this MultiDimContainer with the values in l. More...
 
Various methods.
bool operator== (const MultiDimContainer< GUM_SCALAR > &p) const
 Test if this MultiDimContainer is equal to p. More...
 
bool operator!= (const MultiDimContainer< GUM_SCALAR > &p) const
 Test if this MultiDimContainer is different of p. More...
 
virtual void apply (std::function< GUM_SCALAR(GUM_SCALAR) > f) const
 Apply a function on every element of the container. More...
 
virtual GUM_SCALAR reduce (std::function< GUM_SCALAR(GUM_SCALAR, GUM_SCALAR) > f, GUM_SCALAR base) const
 compute lfold for this container More...
 
Accessors / Modifiers
void replace (const DiscreteVariable &x, const DiscreteVariable &y)
 Replace variables in this multidim. More...
 

Protected Attributes

bool decomposable_
 decomposable_ indicates if the aggregator can be decomposed More...
 

Protected Member Functions

virtual Idx buildValue_ (const gum::Instantiation &i) const
 by default, buildValue_ uses a "fold" scheme and the user has to implement neutralElt_ and fold_ but if necessary (as for Median), buildValue_ can be reimplemented. More...
 
virtual Idx neutralElt_ () const
 neutralElt_() is the result value for the first application of fold_ More...
 
virtual Idx fold_ (const DiscreteVariable &v, Idx i1, Idx i2, bool &stop_iteration) const
 fold_ is applied on value i1 for variable v. the actual result for precedent applications is i2. More...
 
virtual GUM_SCALAR & get_ (const Instantiation &i) const
 
virtual const MultiDimImplementation< GUM_SCALAR > * content () const final
 Returns the implementation for this object (may be *this). More...
 
virtual MultiDimImplementation< GUM_SCALAR > * content () final
 Returns the implementation for this object (may be *this). More...
 
Fast large modifications in structures
virtual void commitMultipleChanges_ ()
 Synchronize content after MultipleChanges. More...
 
virtual void commitMultipleChanges_ (const GUM_SCALAR &value)
 Synchronize content after MultipleChanges. More...
 
bool isInMultipleChangeMethod_ () const
 Get the actual change method of this MultiDimImplementation. More...
 
bool isCommitNeeded_ () const
 Get the actual state of *this. More...
 
const List< Instantiation *> & slaves_ () const
 Returns a constant reference over the list of slaved instantiations. More...
 
virtual void replace_ (const DiscreteVariable *x, const DiscreteVariable *y) override
 Replace variable x by y. More...
 
virtual void invert_ (Idx p1, Idx p2)
 Inverts variables at position p1 and p2. More...
 

Detailed Description

template<typename GUM_SCALAR>
class gum::aggregator::Median< GUM_SCALAR >

median aggregator

See also
MultiDimAggregator for more details of implementations

Median needs to have the same domain than its parent.

Warning
if the number of parent is even, the median (with the same type as its parents) is not well defined : the median of [1,1,3,3] is 2. But what is the median of [1,1,2,2] ? The mathematical response is 1.5 which is not in the range of the variables. In that case, we choose (arbitrarilly by excess) the value 2.

Definition at line 59 of file median.h.

Constructor & Destructor Documentation

◆ Median() [1/2]

template<typename GUM_SCALAR >
INLINE gum::aggregator::Median< GUM_SCALAR >::Median ( )

Definition at line 41 of file median_tpl.h.

41  : MultiDimAggregator< GUM_SCALAR >() {
42  GUM_CONSTRUCTOR(Median);
43  }

◆ Median() [2/2]

template<typename GUM_SCALAR >
INLINE gum::aggregator::Median< GUM_SCALAR >::Median ( const Median< GUM_SCALAR > &  from)

Definition at line 46 of file median_tpl.h.

46  :
47  MultiDimAggregator< GUM_SCALAR >(from) {
48  GUM_CONS_CPY(Median);
49  }

◆ ~Median()

template<typename GUM_SCALAR >
INLINE gum::aggregator::Median< GUM_SCALAR >::~Median ( )
virtual

Definition at line 52 of file median_tpl.h.

52  {
53  GUM_DESTRUCTOR(Median);
54  }

Member Function Documentation

◆ add()

template<typename GUM_SCALAR >
INLINE void gum::MultiDimImplementation< GUM_SCALAR >::add ( const DiscreteVariable v)
overridevirtualinherited

Adds a new var to the variables of the multidimensional matrix.

See also
operator<<(MultiDimInterface& c, const DiscreteVariable& v)
Warning
Note that the variable passed in argument is not duplicated, that is, only a pointer toward the variable is kept by the MultiDimInterface.
Parameters
vThe new var.
Exceptions
DuplicateElementRaised if the variable already belongs to the sequence of variables.
OperationNotAllowedRaised if this object is non mutable.

Implements gum::MultiDimInterface.

Reimplemented in gum::MultiDimBucket< GUM_SCALAR >, gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >, gum::MultiDimFunctionGraph< Size >, gum::MultiDimFunctionGraph< double >, gum::MultiDimFunctionGraph< GUM_SCALAR >, gum::MultiDimFunctionGraph< double, ExactTerminalNodePolicy >, gum::MultiDimFunctionGraph< Size, ExactTerminalNodePolicy >, gum::MultiDimFunctionGraph< GUM_SCALAR, ExactTerminalNodePolicy >, gum::MultiDimFunctionGraph< gum::ActionSet, gum::SetTerminalNodePolicy >, gum::MultiDimFunctionGraph< bool >, gum::MultiDimFunctionGraph< bool, ExactTerminalNodePolicy >, gum::MultiDimArray< GUM_SCALAR >, gum::MultiDimBijArray< GUM_SCALAR >, gum::MultiDimSparse< GUM_SCALAR >, and gum::MultiDimWithOffset< GUM_SCALAR >.

Definition at line 73 of file multiDimImplementation_tpl.h.

73  {
74  // check if the variable already belongs to the tuple of variables
75  // of the Instantiation
76  if (_vars_.exists(&v)) {
77  GUM_ERROR(DuplicateElement, "Var " << v.name() << " already exists in this instantiation")
78  }
79  for (const auto& w: _vars_) {
80  if (w->name() == v.name())
81  GUM_ERROR(DuplicateElement,
82  "A var with name '" << v.name() << "' already exists in this instantiation");
83  }
84 
85  _domainSize_ *= v.domainSize();
86 
87  _vars_.insert(&v);
88 
89  // informs all the slaves that they have to update themselves
91  iter != _slaveInstantiations_.endSafe();
92  ++iter) {
93  (*iter)->addWithMaster(this, v);
94  }
95 
97  }
void _setNotCommitedChange_()
Change the internalChangeState to NOT_COMMITTED_CHANGE.
Sequence< const DiscreteVariable *> _vars_
List of discrete variables (dimensions).
ListIteratorSafe< Val > iterator_safe
Types for STL compliance.
Definition: list.h:386
Size _domainSize_
This MultiDimImplementation domain size.
bool isInMultipleChangeMethod_() const
Get the actual change method of this MultiDimImplementation.
List< Instantiation *> _slaveInstantiations_
List of instantiations of the tuples (sequences) of variables.
#define GUM_ERROR(type, msg)
Definition: exceptions.h:51

◆ aggregatorName()

template<typename GUM_SCALAR >
INLINE std::string gum::aggregator::Median< GUM_SCALAR >::aggregatorName ( ) const
virtual
Returns
the real number of parameters used for this table.

This function is used for compute

See also
compressionRatio()

Implements gum::aggregator::MultiDimAggregator< GUM_SCALAR >.

Definition at line 57 of file median_tpl.h.

57  {
58  std::stringstream ss;
59  ss << "median";
60  return ss.str();
61  }

◆ apply()

template<typename GUM_SCALAR >
void gum::MultiDimContainer< GUM_SCALAR >::apply ( std::function< GUM_SCALAR(GUM_SCALAR) >  f) const
virtualinherited

Apply a function on every element of the container.

Parameters
fthe function to apply

Reimplemented in gum::MultiDimDecorator< GUM_SCALAR >, and gum::MultiDimArray< GUM_SCALAR >.

Definition at line 188 of file multiDimContainer_tpl.h.

References gum::Set< Key, Alloc >::emplace().

188  {
189  Instantiation i(*this);
190  for (i.setFirst(); !i.end(); ++i) {
191  set(i, f(get(i)));
192  }
193  }
+ Here is the call graph for this function:

◆ basename()

template<typename GUM_SCALAR >
const std::string & gum::MultiDimImplementation< GUM_SCALAR >::basename ( ) const
inherited

Returns the base class name of this MultiDimImplementation.

This method is used for chosing a proposer operator when no specialized operator have been defined.

Definition at line 273 of file multiDimImplementation_tpl.h.

273  {
274  static const std::string str = "MultiDimImplementation";
275  return str;
276  }

◆ beginMultipleChanges()

template<typename GUM_SCALAR >
INLINE void gum::MultiDimImplementation< GUM_SCALAR >::beginMultipleChanges ( )
overridevirtualinherited

Call this method before doing important changes in this MultiDimContainer.

Warning
Remember to call endMultipleChanges() when you finish your changes.

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 207 of file multiDimImplementation_tpl.h.

◆ buildValue_()

template<typename GUM_SCALAR >
Idx gum::aggregator::Median< GUM_SCALAR >::buildValue_ ( const gum::Instantiation i) const
protectedvirtual

by default, buildValue_ uses a "fold" scheme and the user has to implement neutralElt_ and fold_ but if necessary (as for Median), buildValue_ can be reimplemented.

Reimplemented from gum::aggregator::MultiDimAggregator< GUM_SCALAR >.

Definition at line 69 of file median_tpl.h.

69  {
70  if (i.nbrDim() < 2) return i.nbrDim() / 2; // arbitrary. Guess = (max-min)/2 .
71 
72  // we assume that every (parent) variable has the same domainSize
73  Idx maxVal = i.variable(1).domainSize();
74 
75  std::vector< Idx > cum(maxVal, 0);
76 
77  for (Idx j = 1; j < this->nbrDim(); j++)
78  cum[i.val(j)]++;
79 
80  Idx half = (this->nbrDim() + 1) / 2; // 50% of the population
81 
82  Idx max = maxVal;
83  for (Idx j = 0, sumcum = 0; j < maxVal; j++)
84  if ((sumcum += cum[j]) >= half) {
85  max = j;
86  break;
87  }
88  Idx maxR = maxVal;
89  for (Idx j = maxVal - 1, jj = 0, sumcum = 0; jj < maxVal; jj++, j--)
90  if ((sumcum += cum[j]) >= half) {
91  maxR = j;
92  break;
93  }
94 
95  // multiDimAggregator::get will truncate if needed.
96  return (maxR + max) / 2;
97  }
Idx nbrDim() const final
Returns the number of variables in the Instantiation.
Idx val(Idx i) const
Returns the current value of the variable at position i.
virtual Size domainSize() const =0
virtual Idx nbrDim() const override
Returns the number of vars in the multidimensional container.
const DiscreteVariable & variable(Idx i) const final
Returns the variable at position i in the tuple.

◆ changeNotification()

template<typename GUM_SCALAR>
void gum::aggregator::MultiDimAggregator< GUM_SCALAR >::changeNotification ( const gum::Instantiation ,
const gum::DiscreteVariable const,
gum::Idx  ,
gum::Idx   
)
inlineoverridevirtualinherited
Returns
the real number of parameters used for this table.

This function is used for compute

See also
compressionRatio()

Implements gum::MultiDimAdressable.

Definition at line 117 of file multiDimAggregator.h.

120  {};

◆ commitMultipleChanges_() [1/2]

template<typename GUM_SCALAR >
INLINE void gum::MultiDimImplementation< GUM_SCALAR >::commitMultipleChanges_ ( )
protectedvirtualinherited

Synchronize content after MultipleChanges.

Reimplemented in gum::MultiDimBucket< GUM_SCALAR >, gum::MultiDimArray< GUM_SCALAR >, gum::MultiDimBijArray< GUM_SCALAR >, and gum::MultiDimSparse< GUM_SCALAR >.

Definition at line 232 of file multiDimImplementation_tpl.h.

232  {
233  // empty!
234  }

◆ commitMultipleChanges_() [2/2]

template<typename GUM_SCALAR>
INLINE void gum::MultiDimImplementation< GUM_SCALAR >::commitMultipleChanges_ ( const GUM_SCALAR &  value)
protectedvirtualinherited

Synchronize content after MultipleChanges.

Parameters
valueDefault value for uninitialized values.

Reimplemented in gum::MultiDimArray< GUM_SCALAR >.

Definition at line 237 of file multiDimImplementation_tpl.h.

237  {
238  // empty!
239  }

◆ compressionRate()

template<typename GUM_SCALAR >
INLINE float gum::MultiDimImplementation< GUM_SCALAR >::compressionRate ( ) const
inherited

The compression ratio of the table (depending on the type of implementation).

This method uses domainSize() and realSize() to compute the ration, both methods are virtual and should be surcharge if a subclass has a special policies about memory management.

Warning
This compression ratio is not exactly the memory compression ratio. It is computed in terms of number of parameters.
Returns
Returns the compression ration of the table.

Definition at line 267 of file multiDimImplementation_tpl.h.

267  {
268  return ((float)1) - (float)realSize() / (float)domainSize();
269  }
virtual Size realSize() const =0
Returns the real number of parameters used for this table.
virtual Size domainSize() const override
Returns the product of the variables domain size.

◆ contains()

template<typename GUM_SCALAR >
INLINE bool gum::MultiDimImplementation< GUM_SCALAR >::contains ( const DiscreteVariable v) const
overridevirtualinherited

Returns true if var is in *this.

Parameters
vA DiscreteVariable.
Returns
Returns true if var is in *this.

Implements gum::MultiDimInterface.

Reimplemented in gum::MultiDimBucket< GUM_SCALAR >.

Definition at line 187 of file multiDimImplementation_tpl.h.

187  {
188  return _vars_.exists(&v);
189  }
Sequence< const DiscreteVariable *> _vars_
List of discrete variables (dimensions).

◆ content() [1/2]

template<typename GUM_SCALAR >
INLINE const MultiDimImplementation< GUM_SCALAR > * gum::MultiDimImplementation< GUM_SCALAR >::content ( ) const
finalprotectedvirtualinherited

Returns the implementation for this object (may be *this).

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 312 of file multiDimImplementation_tpl.h.

312  {
313  return this;
314  }

◆ content() [2/2]

template<typename GUM_SCALAR >
INLINE MultiDimImplementation< GUM_SCALAR > * gum::MultiDimImplementation< GUM_SCALAR >::content ( )
finalprotectedvirtualinherited

Returns the implementation for this object (may be *this).

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 305 of file multiDimImplementation_tpl.h.

305  {
306  return this;
307  }

◆ copy()

template<typename GUM_SCALAR >
void gum::MultiDimContainer< GUM_SCALAR >::copy ( const MultiDimContainer< GUM_SCALAR > &  src)
virtualinherited

Removes all variables in this MultiDimContainer and copy the content of src, variables included.

Parameters
srcThe MultiDimContainer to copy.

Reimplemented in gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >, gum::MultiDimFunctionGraph< GUM_SCALAR >, and gum::MultiDimFunctionGraph< GUM_SCALAR, ExactTerminalNodePolicy >.

Definition at line 272 of file multiDimContainer_tpl.h.

References gum::Set< Key, Alloc >::emplace().

272  {
273  this->beginMultipleChanges();
274 
275  Size nbr = this->nbrDim();
276 
277  for (Idx i = 0; i < nbr; i++) {
278  this->erase(this->variable(0));
279  }
280 
281  for (Idx i = 0; i < src.nbrDim(); i++) {
282  this->add(src.variable(i));
283  }
284 
285  this->endMultipleChanges();
286  this->copyFrom(src);
287  }
virtual void endMultipleChanges()=0
Call this method after doing important changes in this MultiDimContainer.
virtual void add(const DiscreteVariable &v)=0
Adds a new var to the variables of the multidimensional matrix.
virtual Idx nbrDim() const =0
Returns the number of vars in the multidimensional container.
virtual const DiscreteVariable & variable(Idx i) const =0
Returns a const ref to the ith var.
virtual void beginMultipleChanges()=0
Call this method before doing important changes in this MultiDimContainer.
virtual void copyFrom(const MultiDimContainer< GUM_SCALAR > &src) const
Basic copy of a MultiDimContainer.
virtual void erase(const DiscreteVariable &v)=0
Removes a var from the variables of the multidimensional matrix.
std::size_t Size
In aGrUM, hashed values are unsigned long int.
Definition: types.h:47
+ Here is the call graph for this function:

◆ copyFrom() [1/2]

template<typename GUM_SCALAR >
void gum::aggregator::MultiDimAggregator< GUM_SCALAR >::copyFrom ( const MultiDimContainer< GUM_SCALAR > &  src) const
overridevirtualinherited

Copy of a multiDimICIModel.

This method is virtual because it should be optimized in certain MultiDimContainer.

Exceptions
OperationNotAllowedRaised if src does not have the same domain size than this MultiDimContainer.

Reimplemented from gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 106 of file multiDimAggregator_tpl.h.

References gum::aggregator::operator<<().

107  {
108  auto p = dynamic_cast< const MultiDimAggregator< GUM_SCALAR >* >(&src);
109  if (p == nullptr) {
111  } else {
112  if (p->name() != this->name()) {
113  GUM_ERROR(OperationNotAllowed,
114  "Can not copy from a " << p->name() << " to a " << this->name());
115  }
116  }
117  // it the types aree consistant, nothing to do...
118  }
const std::string & name() const override
Returns the real name of the multiDimArray.
virtual void copyFrom(const MultiDimContainer< GUM_SCALAR > &src) const
Basic copy of a MultiDimContainer.
#define GUM_ERROR(type, msg)
Definition: exceptions.h:51
+ Here is the call graph for this function:

◆ copyFrom() [2/2]

template<typename GUM_SCALAR >
void gum::MultiDimContainer< GUM_SCALAR >::copyFrom ( const MultiDimContainer< GUM_SCALAR > &  src,
Instantiation p_i 
) const
virtualinherited

Basic copy of a MultiDimContainer.

This method is virtual because it should be optimized in certain MultiDimContainer.

Parameters
srcThe MultiDimContainer src which values are copied.
p_iGive the order to iterate in this MultiDimContainer during the copy (nullptr will correctly copy if this is a reorganization of src).
Exceptions
OperationNotAllowedRaised if src does not have the same domain size than this MultiDimContainer.

Reimplemented in gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >, gum::MultiDimFunctionGraph< GUM_SCALAR >, and gum::MultiDimFunctionGraph< GUM_SCALAR, ExactTerminalNodePolicy >.

Definition at line 209 of file multiDimContainer_tpl.h.

References gum::Set< Key, Alloc >::emplace().

210  {
211  if (src.domainSize() != domainSize()) {
212  GUM_ERROR(OperationNotAllowed,
213  "Domain sizes do not fit : " << src.domainSize() << "!=" << domainSize());
214  }
215 
216  if (p_i == nullptr) { // if null, we just follow the same order
217  Instantiation i(src);
218  for (i.setFirst(); !i.end(); ++i) {
219  set(i, src[i]);
220  }
221  } else {
222  Instantiation i_dest(*this);
223  Instantiation i_src(src);
224  for (i_dest.setFirst(), i_src.setFirst(); !i_dest.end(); i_dest.incIn(*p_i), ++i_src) {
225  set(i_dest, src[i_src]);
226  }
227  }
228  }
virtual Size domainSize() const =0
Returns the product of the variables domain size.
#define GUM_ERROR(type, msg)
Definition: exceptions.h:51
+ Here is the call graph for this function:

◆ domainSize()

template<typename GUM_SCALAR >
INLINE Size gum::MultiDimImplementation< GUM_SCALAR >::domainSize ( ) const
overridevirtualinherited

Returns the product of the variables domain size.

Returns
Returns the product of the variables domain size.

Implements gum::MultiDimInterface.

Definition at line 162 of file multiDimImplementation_tpl.h.

162  {
163  return _domainSize_;
164  }
Size _domainSize_
This MultiDimImplementation domain size.

◆ empty()

template<typename GUM_SCALAR >
INLINE bool gum::MultiDimImplementation< GUM_SCALAR >::empty ( ) const
overridevirtualinherited

Returns true if no var is in *this.

Returns
Returns true if no var is in *this.

Implements gum::MultiDimInterface.

Definition at line 201 of file multiDimImplementation_tpl.h.

201  {
202  GUM_ASSERT(!this->isCommitNeeded_());
203  return _vars_.empty();
204  }
Sequence< const DiscreteVariable *> _vars_
List of discrete variables (dimensions).
bool isCommitNeeded_() const
Get the actual state of *this.

◆ endMultipleChanges() [1/2]

template<typename GUM_SCALAR >
INLINE void gum::MultiDimImplementation< GUM_SCALAR >::endMultipleChanges ( )
overridevirtualinherited

◆ endMultipleChanges() [2/2]

template<typename GUM_SCALAR>
INLINE void gum::MultiDimImplementation< GUM_SCALAR >::endMultipleChanges ( const GUM_SCALAR &  v)
overridevirtualinherited

◆ erase()

template<typename GUM_SCALAR >
INLINE void gum::MultiDimImplementation< GUM_SCALAR >::erase ( const DiscreteVariable v)
overridevirtualinherited

Removes a var from the variables of the multidimensional matrix.

See also
operator>>(MultiDimInterface& c, const DiscreteVariable& v)
Exceptions
OperationNotAllowedRaised if this object is non mutable.
NotFoundRaised if v does not belong to this.

Implements gum::MultiDimInterface.

Reimplemented in gum::MultiDimBucket< GUM_SCALAR >, gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >, gum::MultiDimFunctionGraph< Size >, gum::MultiDimFunctionGraph< double >, gum::MultiDimFunctionGraph< GUM_SCALAR >, gum::MultiDimFunctionGraph< double, ExactTerminalNodePolicy >, gum::MultiDimFunctionGraph< Size, ExactTerminalNodePolicy >, gum::MultiDimFunctionGraph< GUM_SCALAR, ExactTerminalNodePolicy >, gum::MultiDimFunctionGraph< gum::ActionSet, gum::SetTerminalNodePolicy >, gum::MultiDimFunctionGraph< bool >, gum::MultiDimFunctionGraph< bool, ExactTerminalNodePolicy >, gum::MultiDimArray< GUM_SCALAR >, gum::MultiDimBijArray< GUM_SCALAR >, gum::MultiDimSparse< GUM_SCALAR >, and gum::MultiDimWithOffset< GUM_SCALAR >.

Definition at line 102 of file multiDimImplementation_tpl.h.

102  {
103  // check that the variable does actually belong to the
104  // MultiDimImplementation
105  if (!_vars_.exists(&v)) { GUM_ERROR(NotFound, "Var does not exist in this implementation") }
106 
107  _domainSize_ /= v.domainSize();
108 
109  _vars_.erase(&v);
110 
111  // informs all the slaves that they have to update themselves
113  iter != _slaveInstantiations_.endSafe();
114  ++iter) {
115  (*iter)->eraseWithMaster(this, v);
116  }
117 
119  }
void _setNotCommitedChange_()
Change the internalChangeState to NOT_COMMITTED_CHANGE.
Sequence< const DiscreteVariable *> _vars_
List of discrete variables (dimensions).
ListIteratorSafe< Val > iterator_safe
Types for STL compliance.
Definition: list.h:386
Size _domainSize_
This MultiDimImplementation domain size.
bool isInMultipleChangeMethod_() const
Get the actual change method of this MultiDimImplementation.
List< Instantiation *> _slaveInstantiations_
List of instantiations of the tuples (sequences) of variables.
#define GUM_ERROR(type, msg)
Definition: exceptions.h:51

◆ extractFrom()

template<typename GUM_SCALAR >
void gum::MultiDimContainer< GUM_SCALAR >::extractFrom ( const MultiDimContainer< GUM_SCALAR > &  src,
const Instantiation mask 
)
virtualinherited

Basic extraction of a MultiDimContainer.

This method is virtual because it should be optimized in certain MultiDimContainer.

Parameters
srcThe MultiDimContainer src which datas are copied.
maskpartial instantiation of variables of the Potential : the

extraction will concern every variable not in the instantiation and the copy of data will use the (relevant) values in this instantiation.

Definition at line 231 of file multiDimContainer_tpl.h.

References gum::Set< Key, Alloc >::emplace().

232  {
233  this->beginMultipleChanges();
234 
235  Size nbr = this->nbrDim();
236  for (Idx i = 0; i < nbr; i++) {
237  this->erase(this->variable(0));
238  }
239 
240  for (Idx i = 0; i < src.nbrDim(); i++) {
241  if (!imask.contains(src.variable(i))) this->add(src.variable(i));
242  }
243 
244  this->endMultipleChanges();
245 
246  if (this->nbrDim() == 0) { GUM_ERROR(FatalError, "Empty potential") }
247 
248  Instantiation inst(src);
249  inst.setVals(imask);
250  for (inst.setFirstOut(imask); !inst.end(); inst.incOut(imask))
251  set(inst, src[inst]);
252  }
virtual void endMultipleChanges()=0
Call this method after doing important changes in this MultiDimContainer.
virtual void add(const DiscreteVariable &v)=0
Adds a new var to the variables of the multidimensional matrix.
virtual Idx nbrDim() const =0
Returns the number of vars in the multidimensional container.
virtual const DiscreteVariable & variable(Idx i) const =0
Returns a const ref to the ith var.
virtual void beginMultipleChanges()=0
Call this method before doing important changes in this MultiDimContainer.
virtual void erase(const DiscreteVariable &v)=0
Removes a var from the variables of the multidimensional matrix.
std::size_t Size
In aGrUM, hashed values are unsigned long int.
Definition: types.h:47
#define GUM_ERROR(type, msg)
Definition: exceptions.h:51
+ Here is the call graph for this function:

◆ fill()

template<typename GUM_SCALAR >
void gum::MultiDimReadOnly< GUM_SCALAR >::fill ( const GUM_SCALAR &  ) const
virtualinherited
Warning
An OperationNotAllowed will be raised because this is a read only table.

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 66 of file multiDimReadOnly_tpl.h.

References gum::Set< Key, Alloc >::emplace().

66  {
67  GUM_ERROR(OperationNotAllowed, "Write access to an aggregator")
68  }
#define GUM_ERROR(type, msg)
Definition: exceptions.h:51
+ Here is the call graph for this function:

◆ fold_()

template<typename GUM_SCALAR >
INLINE Idx gum::aggregator::Median< GUM_SCALAR >::fold_ ( const DiscreteVariable v,
Idx  i1,
Idx  i2,
bool stop_iteration 
) const
protectedvirtual

fold_ is applied on value i1 for variable v. the actual result for precedent applications is i2.

Returns
the new result for applications up to v.

Implements gum::aggregator::MultiDimAggregator< GUM_SCALAR >.

Definition at line 100 of file median_tpl.h.

103  {
104  return 0;
105  }

◆ get()

template<typename GUM_SCALAR >
GUM_SCALAR gum::aggregator::MultiDimAggregator< GUM_SCALAR >::get ( const Instantiation i) const
overridevirtualinherited
Returns
the real number of parameters used for this table.

This function is used for compute

See also
compressionRatio()

Reimplemented from gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 76 of file multiDimAggregator_tpl.h.

References gum::aggregator::operator<<().

76  {
77  if (this->nbrDim() < 1) {
78  GUM_ERROR(OperationNotAllowed, "Not enough variable for an aggregator : " << *this)
79  }
80 
81  const DiscreteVariable& agg = this->variable((Idx)0);
82  auto current = buildValue_(i);
83 
84  // truncate to fit in aggreegator domain size
85  if (current >= agg.domainSize()) current = agg.domainSize() - 1;
86 
87  return (i.val(agg) == current) ? (GUM_SCALAR)1.0 : (GUM_SCALAR)0.0;
88  }
virtual Idx buildValue_(const gum::Instantiation &i) const
by default, buildValue_ uses a "fold" scheme and the user has to implement neutralElt_ and fold_ but ...
const DiscreteVariable & variable(Idx i) const override
Returns a const ref to the ith var.
virtual Idx nbrDim() const override
Returns the number of vars in the multidimensional container.
#define GUM_ERROR(type, msg)
Definition: exceptions.h:51
+ Here is the call graph for this function:

◆ get_()

template<typename GUM_SCALAR >
GUM_SCALAR & gum::MultiDimReadOnly< GUM_SCALAR >::get_ ( const Instantiation i) const
protectedvirtualinherited
Warning
An OperationNotAllowed will be raised because this is a read only table.

Implements gum::MultiDimContainer< GUM_SCALAR >.

Reimplemented in gum::MultiDimBucket< GUM_SCALAR >.

Definition at line 73 of file multiDimReadOnly_tpl.h.

References gum::Set< Key, Alloc >::emplace().

73  {
74  GUM_ERROR(OperationNotAllowed, "No (unconst) access to an aggregator")
75  }
#define GUM_ERROR(type, msg)
Definition: exceptions.h:51
+ Here is the call graph for this function:

◆ getMasterRef() [1/2]

template<typename GUM_SCALAR >
INLINE MultiDimAdressable & gum::MultiDimContainer< GUM_SCALAR >::getMasterRef ( )
virtualinherited

In order to insure the dereference for decorators, we need to virtualize the access to master pointer.

Returns
Returns the ref to content as MultiDimAdressable&

Implements gum::MultiDimAdressable.

Reimplemented in gum::MultiDimBucket< GUM_SCALAR >.

Definition at line 290 of file multiDimContainer_tpl.h.

References gum::Set< Key, Alloc >::emplace().

290  {
291  return static_cast< MultiDimAdressable& >(*content());
292  }
virtual const MultiDimImplementation< GUM_SCALAR > * content() const =0
Returns the implementation for this object (may be *this).
MultiDimAdressable()
Default constructor.
+ Here is the call graph for this function:

◆ getMasterRef() [2/2]

template<typename GUM_SCALAR >
INLINE const MultiDimAdressable & gum::MultiDimContainer< GUM_SCALAR >::getMasterRef ( ) const
virtualinherited

In order to insure the dereference for decorators, we need to virtualize the access to master pointer.

Returns
Returns the master of this MultiDimAdressable.

Implements gum::MultiDimAdressable.

Reimplemented in gum::MultiDimBucket< GUM_SCALAR >.

Definition at line 295 of file multiDimContainer_tpl.h.

References gum::Set< Key, Alloc >::emplace().

295  {
296  return static_cast< const MultiDimAdressable& >(*content());
297  }
virtual const MultiDimImplementation< GUM_SCALAR > * content() const =0
Returns the implementation for this object (may be *this).
MultiDimAdressable()
Default constructor.
+ Here is the call graph for this function:

◆ invert_()

template<typename GUM_SCALAR >
INLINE void gum::MultiDimImplementation< GUM_SCALAR >::invert_ ( Idx  p1,
Idx  p2 
)
protectedvirtualinherited

Inverts variables at position p1 and p2.

Call this from subclass when you want to invert position of two variables in the MultiDimImplementation.

Parameters
p1The first position.
p2The second position.

Definition at line 291 of file multiDimImplementation_tpl.h.

291  {
292  _vars_.swap(p1, p2);
293  }
Sequence< const DiscreteVariable *> _vars_
List of discrete variables (dimensions).

◆ isCommitNeeded_()

template<typename GUM_SCALAR >
INLINE bool gum::MultiDimImplementation< GUM_SCALAR >::isCommitNeeded_ ( ) const
protectedinherited

Get the actual state of *this.

Returns
Returns true if a commit is needed.

Definition at line 249 of file multiDimImplementation_tpl.h.

◆ isDecomposable()

template<typename GUM_SCALAR >
INLINE bool gum::aggregator::MultiDimAggregator< GUM_SCALAR >::isDecomposable ( ) const
inherited
Returns
true if the aggregator is decomposable.

Definition at line 121 of file multiDimAggregator_tpl.h.

References gum::aggregator::operator<<().

121  {
122  return decomposable_;
123  }
bool decomposable_
decomposable_ indicates if the aggregator can be decomposed
+ Here is the call graph for this function:

◆ isInMultipleChangeMethod_()

template<typename GUM_SCALAR >
INLINE bool gum::MultiDimImplementation< GUM_SCALAR >::isInMultipleChangeMethod_ ( ) const
protectedinherited

Get the actual change method of this MultiDimImplementation.

Returns
Returns true if in multiple changes.

Definition at line 243 of file multiDimImplementation_tpl.h.

◆ name()

template<typename GUM_SCALAR >
const std::string & gum::aggregator::MultiDimAggregator< GUM_SCALAR >::name ( ) const
overridevirtualinherited

Returns the real name of the multiDimArray.

In aGrUM, all the types of multi-dimensional arrays/functionals have a name that describes what they are in reality. For instance, a table stored in extension is a "MultiDimArray", one that stores only non zero elements is a "MultiDimSparseArray", and so on. These names are unique for each type of implementation and is used by the system to determine which is the best functions to use, say, when we wish to use operators such as operator+ on two MultiDimImplementations.

Implements gum::MultiDimImplementation< GUM_SCALAR >.

Definition at line 128 of file multiDimAggregator_tpl.h.

References gum::aggregator::operator<<().

128  {
129  static const std::string str = "MultiDimAggregator";
130  return str;
131  }
+ Here is the call graph for this function:

◆ nbrDim()

template<typename GUM_SCALAR >
INLINE Idx gum::MultiDimImplementation< GUM_SCALAR >::nbrDim ( ) const
overridevirtualinherited

Returns the number of vars in the multidimensional container.

Returns
Returns the number of vars in the multidimensional container.

Implements gum::MultiDimInterface.

Definition at line 157 of file multiDimImplementation_tpl.h.

157  {
158  return _vars_.size();
159  }
Sequence< const DiscreteVariable *> _vars_
List of discrete variables (dimensions).

◆ neutralElt_()

template<typename GUM_SCALAR >
virtual Idx gum::aggregator::Median< GUM_SCALAR >::neutralElt_ ( ) const
inlineprotectedvirtual

neutralElt_() is the result value for the first application of fold_

Implements gum::aggregator::MultiDimAggregator< GUM_SCALAR >.

Definition at line 90 of file median.h.

90 { return 0; };

◆ newFactory()

template<typename GUM_SCALAR >
INLINE MultiDimContainer< GUM_SCALAR > * gum::aggregator::Median< GUM_SCALAR >::newFactory ( ) const
virtual

This method creates a clone of this object, withouth its content (including variable), you must use this method if you want to ensure that the generated object has the same type than the object containing the called newFactory()

For example :

MultiDimArray<double> y;
MultiDimContainer<double>* x = y.newFactory();

Then x is a MultiDimArray<double>*

Warning
you must desallocate by yourself the memory
Returns
an empty clone of this object with the same type

Implements gum::aggregator::MultiDimAggregator< GUM_SCALAR >.

Definition at line 64 of file median_tpl.h.

64  {
65  return new Median< GUM_SCALAR >();
66  }

◆ operator!=()

template<typename GUM_SCALAR >
INLINE bool gum::MultiDimContainer< GUM_SCALAR >::operator!= ( const MultiDimContainer< GUM_SCALAR > &  p) const
inherited

Test if this MultiDimContainer is different of p.

Parameters
pThe MultiDimContainer to test for inequality.
Returns
Returns true if this MultiDimContainer is different of p.

Definition at line 154 of file multiDimContainer_tpl.h.

References gum::Set< Key, Alloc >::emplace().

154  {
155  return !operator==(p);
156  }
bool operator==(const MultiDimContainer< GUM_SCALAR > &p) const
Test if this MultiDimContainer is equal to p.
+ Here is the call graph for this function:

◆ operator==()

template<typename GUM_SCALAR >
bool gum::MultiDimContainer< GUM_SCALAR >::operator== ( const MultiDimContainer< GUM_SCALAR > &  p) const
inherited

Test if this MultiDimContainer is equal to p.

Parameters
pThe MultiDimContainer to test for equality.
Returns
Returns true if this MultiDimContainer is equal to p.

Definition at line 124 of file multiDimContainer_tpl.h.

References gum::Set< Key, Alloc >::emplace().

124  {
125  if ((nbrDim() == p.nbrDim()) && (domainSize() == p.domainSize())) {
126  if (nbrDim() == 0) return true;
127 
129 
130  for (var_iterator iter = variablesSequence().beginSafe();
131  iter != variablesSequence().endSafe();
132  ++iter) {
133  if (!p.variablesSequence().exists(*iter)) { return false; }
134  }
135  } else {
136  return false;
137  }
138 
139  Instantiation i(*this);
140 
141  AlmostDifferent< GUM_SCALAR > cmp;
142 
143  for (i.setFirst(); !i.end(); ++i) {
144  if (cmp(get(i), p.get(i))) { return false; }
145  }
146 
147  return true;
148  }
virtual Idx nbrDim() const =0
Returns the number of vars in the multidimensional container.
virtual Size domainSize() const =0
Returns the product of the variables domain size.
virtual const Sequence< const DiscreteVariable *> & variablesSequence() const =0
Returns a const ref to the sequence of DiscreteVariable*.
SequenceIteratorSafe< Key > const_iterator_safe
Types for STL compliance.
Definition: sequence.h:1032
+ Here is the call graph for this function:

◆ operator[]()

template<typename GUM_SCALAR >
INLINE GUM_SCALAR gum::MultiDimContainer< GUM_SCALAR >::operator[] ( const Instantiation i) const
inherited

An [] operator using a Instantiation as argument.

Warning
If i variables set is disjoint with this MultiDimContainer then 0 is assumed for dimensions (i.e. variables) not prensent in the instantiation.
Parameters
iAn Instantiation.
Returns
Returns the adressed (GUM_SCALAR) value.

Definition at line 79 of file multiDimContainer_tpl.h.

References gum::Set< Key, Alloc >::emplace().

79  {
80  return get(i);
81  }
+ Here is the call graph for this function:

◆ populate() [1/2]

template<typename GUM_SCALAR >
void gum::MultiDimContainer< GUM_SCALAR >::populate ( const std::vector< GUM_SCALAR > &  v) const
virtualinherited

Automatically fills this MultiDimContainer with the values in v.

The order used to fill this MultiDimContainer is the same as with an instantiation over it.

Size cpt = 0;
Instantiation i( *this );
for (i.setFirst(); !i.end(); ++i, ++cpt) {
set(i, v[cpt]);
}
Parameters
vVector of values.
Exceptions
SizeErrorRaised if v size's does not matches this MultiDimContainer domain size.

Reimplemented in gum::MultiDimDecorator< GUM_SCALAR >, gum::MultiDimBijArray< GUM_SCALAR >, gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >, gum::MultiDimFunctionGraph< GUM_SCALAR >, and gum::MultiDimFunctionGraph< GUM_SCALAR, ExactTerminalNodePolicy >.

Definition at line 160 of file multiDimContainer_tpl.h.

References gum::Set< Key, Alloc >::emplace().

160  {
161  if (domainSize() != v.size()) {
162  GUM_ERROR(SizeError, "Sizes do not match : " << domainSize() << "!=" << v.size())
163  }
164 
165  Size cpt = 0;
166 
167  Instantiation i(*this);
168 
169  for (i.setFirst(); !i.end(); ++i, ++cpt)
170  set(i, v[cpt]);
171  }
virtual Size domainSize() const =0
Returns the product of the variables domain size.
std::size_t Size
In aGrUM, hashed values are unsigned long int.
Definition: types.h:47
#define GUM_ERROR(type, msg)
Definition: exceptions.h:51
+ Here is the call graph for this function:

◆ populate() [2/2]

template<typename GUM_SCALAR >
void gum::MultiDimContainer< GUM_SCALAR >::populate ( std::initializer_list< GUM_SCALAR >  l) const
virtualinherited

Automatically fills this MultiDimContainer with the values in l.

The order used to fill this MultiDimContainer is the same as with an instantiation over it.

Size cpt = 0;
Instantiation i( *this );
for (i.setFirst(); !i.end(); ++i, ++cpt) {
set(i, v[cpt]);
}
Parameters
lcontains the data.
Exceptions
SizeErrorRaised if l size's does not matches this MultiDimContainer domain size.

Reimplemented in gum::MultiDimBijArray< GUM_SCALAR >, gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >, gum::MultiDimFunctionGraph< GUM_SCALAR >, and gum::MultiDimFunctionGraph< GUM_SCALAR, ExactTerminalNodePolicy >.

Definition at line 174 of file multiDimContainer_tpl.h.

References gum::Set< Key, Alloc >::emplace().

174  {
175  if (domainSize() != l.size()) {
176  GUM_ERROR(SizeError, "Sizes do not match : " << domainSize() << "!=" << l.size())
177  }
178 
179  Instantiation i(*this);
180  // insert all the elements
181  for (const auto& elt: l) {
182  set(i, elt);
183  ++i;
184  }
185  }
virtual Size domainSize() const =0
Returns the product of the variables domain size.
#define GUM_ERROR(type, msg)
Definition: exceptions.h:51
+ Here is the call graph for this function:

◆ pos()

template<typename GUM_SCALAR >
INLINE Idx gum::MultiDimImplementation< GUM_SCALAR >::pos ( const DiscreteVariable v) const
overridevirtualinherited

Returns the index of a variable.

Parameters
vThe variable for which the index is returned.
Returns
Returns the index of a variable.
Exceptions
NotFoundRaised if v is not in this multidimensional matrix.

Implements gum::MultiDimInterface.

Definition at line 182 of file multiDimImplementation_tpl.h.

182  {
183  return _vars_.pos(&v);
184  }
Sequence< const DiscreteVariable *> _vars_
List of discrete variables (dimensions).

◆ realSize()

template<typename GUM_SCALAR>
Size gum::aggregator::MultiDimAggregator< GUM_SCALAR >::realSize ( ) const
inlineoverridevirtualinherited
Returns
the real number of parameters used for this table.

This function is used for compute

See also
compressionRatio()

Implements gum::MultiDimImplementation< GUM_SCALAR >.

Definition at line 139 of file multiDimAggregator.h.

139 { return 0; };

◆ reduce()

template<typename GUM_SCALAR >
GUM_SCALAR gum::MultiDimContainer< GUM_SCALAR >::reduce ( std::function< GUM_SCALAR(GUM_SCALAR, GUM_SCALAR) >  f,
GUM_SCALAR  base 
) const
virtualinherited

compute lfold for this container

Parameters
fthe function to apply
basethe initial value

Reimplemented in gum::MultiDimDecorator< GUM_SCALAR >, and gum::MultiDimArray< GUM_SCALAR >.

Definition at line 197 of file multiDimContainer_tpl.h.

References gum::Set< Key, Alloc >::emplace().

198  {
199  GUM_SCALAR tmp = base;
200  Instantiation i(*this);
201  for (i.setFirst(); !i.end(); ++i) {
202  tmp = f(tmp, get(i));
203  }
204  return tmp;
205  }
+ Here is the call graph for this function:

◆ registerSlave()

template<typename GUM_SCALAR >
INLINE bool gum::MultiDimImplementation< GUM_SCALAR >::registerSlave ( Instantiation i)
overridevirtualinherited

Register i as a slave of this MultiDimAdressable.

Parameters
iThe Instantiation to enslave.
Returns
Returns true if i becomes a slave of this MultiDimAdressable.

Implements gum::MultiDimAdressable.

Reimplemented in gum::MultiDimBucket< GUM_SCALAR >, and gum::MultiDimWithOffset< GUM_SCALAR >.

Definition at line 132 of file multiDimImplementation_tpl.h.

132  {
133  // check that the Instantiation has the same variables as this
134  if (slave.nbrDim() != _vars_.size()) return false;
135 
137  iter != _vars_.endSafe();
138  ++iter)
139  if (!slave.contains(*iter)) return false;
140 
141  slave.synchronizeWithMaster(this);
142 
143  _slaveInstantiations_ += (&slave);
144 
145  return true;
146  }
Sequence< const DiscreteVariable *> _vars_
List of discrete variables (dimensions).
SequenceIteratorSafe< Key > iterator_safe
Types for STL compliance.
Definition: sequence.h:1031
List< Instantiation *> _slaveInstantiations_
List of instantiations of the tuples (sequences) of variables.

◆ replace()

INLINE void gum::MultiDimInterface::replace ( const DiscreteVariable x,
const DiscreteVariable y 
)
inherited

Replace variables in this multidim.

If x is in this MultiDim and y has the same domain size, then x will be replace by y in this MultiDim.

Parameters
xThe variable in this which will be replaced.
yThe variable replacing y.
Exceptions
NotFoundRaised if x does not belong to this MultiDim.
OperationNotAllowedIf y and x are not interchangeable.
DuplicateElementIf y is already in this MultiDim.

Definition at line 35 of file multiDimInterface_inl.h.

References gum::Set< Key, Alloc >::emplace().

35  {
36  if (!contains(x)) { GUM_ERROR(NotFound, "could not find the variable") }
37 
38  if (contains(y)) { GUM_ERROR(DuplicateElement, "variable " << y << " already in MultiDim") }
39 
40  if (x.domainSize() != y.domainSize()) {
41  GUM_ERROR(OperationNotAllowed, "incompatible variables")
42  }
43 
44  replace_(&x, &y);
45  }
virtual bool contains(const DiscreteVariable &v) const =0
Returns true if var is in *this.
virtual void replace_(const DiscreteVariable *x, const DiscreteVariable *y)=0
This is called by MultiDimContainer::replace() to proceed with the replacing between x and y...
#define GUM_ERROR(type, msg)
Definition: exceptions.h:51
+ Here is the call graph for this function:

◆ replace_()

template<typename GUM_SCALAR >
INLINE void gum::MultiDimImplementation< GUM_SCALAR >::replace_ ( const DiscreteVariable x,
const DiscreteVariable y 
)
overrideprotectedvirtualinherited

Replace variable x by y.

Technically this should be call by any subclass overloading this method to proceed with the changes in this class containers.

Parameters
xThe first variable to swap.
yThe second variable to swap.

Implements gum::MultiDimInterface.

Reimplemented in gum::MultiDimFunctionGraph< GUM_SCALAR, TerminalNodePolicy >, gum::MultiDimFunctionGraph< Size >, gum::MultiDimFunctionGraph< double >, gum::MultiDimFunctionGraph< GUM_SCALAR >, gum::MultiDimFunctionGraph< double, ExactTerminalNodePolicy >, gum::MultiDimFunctionGraph< Size, ExactTerminalNodePolicy >, gum::MultiDimFunctionGraph< GUM_SCALAR, ExactTerminalNodePolicy >, gum::MultiDimFunctionGraph< gum::ActionSet, gum::SetTerminalNodePolicy >, gum::MultiDimFunctionGraph< bool >, gum::MultiDimFunctionGraph< bool, ExactTerminalNodePolicy >, gum::MultiDimBucket< GUM_SCALAR >, gum::MultiDimArray< GUM_SCALAR >, gum::MultiDimBijArray< GUM_SCALAR >, gum::MultiDimICIModel< GUM_SCALAR >, and gum::MultiDimSparse< GUM_SCALAR >.

Definition at line 279 of file multiDimImplementation_tpl.h.

280  {
281  _vars_.setAtPos(_vars_.pos(x), y);
282 
284  iter != _slaveInstantiations_.endSafe();
285  ++iter) {
286  (**iter).replace(*x, *y);
287  }
288  }
Sequence< const DiscreteVariable *> _vars_
List of discrete variables (dimensions).
ListIteratorSafe< Val > iterator_safe
Types for STL compliance.
Definition: list.h:386
List< Instantiation *> _slaveInstantiations_
List of instantiations of the tuples (sequences) of variables.

◆ set()

template<typename GUM_SCALAR >
INLINE void gum::MultiDimReadOnly< GUM_SCALAR >::set ( const Instantiation i,
const GUM_SCALAR &  value 
) const
virtualinherited
Warning
An OperationNotAllowed will be raised because this is a read only table.

Reimplemented from gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 58 of file multiDimReadOnly_tpl.h.

References gum::Set< Key, Alloc >::emplace().

59  {
60  GUM_ERROR(OperationNotAllowed, "Write access to an aggregator")
61  }
#define GUM_ERROR(type, msg)
Definition: exceptions.h:51
+ Here is the call graph for this function:

◆ setChangeNotification()

template<typename GUM_SCALAR>
void gum::aggregator::MultiDimAggregator< GUM_SCALAR >::setChangeNotification ( const gum::Instantiation )
inlineoverridevirtualinherited
Returns
the real number of parameters used for this table.

This function is used for compute

See also
compressionRatio()

Implements gum::MultiDimAdressable.

Definition at line 130 of file multiDimAggregator.h.

130 {};

◆ setDecNotification()

template<typename GUM_SCALAR>
void gum::aggregator::MultiDimAggregator< GUM_SCALAR >::setDecNotification ( const gum::Instantiation )
inlineoverridevirtualinherited
Returns
the real number of parameters used for this table.

This function is used for compute

See also
compressionRatio()

Implements gum::MultiDimAdressable.

Definition at line 128 of file multiDimAggregator.h.

128 {};

◆ setFirstNotification()

template<typename GUM_SCALAR>
void gum::aggregator::MultiDimAggregator< GUM_SCALAR >::setFirstNotification ( const gum::Instantiation )
inlineoverridevirtualinherited
Returns
the real number of parameters used for this table.

This function is used for compute

See also
compressionRatio()

Implements gum::MultiDimAdressable.

Definition at line 122 of file multiDimAggregator.h.

122 {};

◆ setIncNotification()

template<typename GUM_SCALAR>
void gum::aggregator::MultiDimAggregator< GUM_SCALAR >::setIncNotification ( const gum::Instantiation )
inlineoverridevirtualinherited
Returns
the real number of parameters used for this table.

This function is used for compute

See also
compressionRatio()

Implements gum::MultiDimAdressable.

Definition at line 126 of file multiDimAggregator.h.

126 {};

◆ setLastNotification()

template<typename GUM_SCALAR>
void gum::aggregator::MultiDimAggregator< GUM_SCALAR >::setLastNotification ( const gum::Instantiation )
inlineoverridevirtualinherited
Returns
the real number of parameters used for this table.

This function is used for compute

See also
compressionRatio()

Implements gum::MultiDimAdressable.

Definition at line 124 of file multiDimAggregator.h.

124 {};

◆ slaves_()

template<typename GUM_SCALAR >
INLINE const List< Instantiation *> & gum::MultiDimImplementation< GUM_SCALAR >::slaves_ ( ) const
protectedinherited

Returns a constant reference over the list of slaved instantiations.

Returns
Returns a constant reference over the list of slaved instantiations.

Definition at line 255 of file multiDimImplementation_tpl.h.

255  {
256  return _slaveInstantiations_;
257  }
List< Instantiation *> _slaveInstantiations_
List of instantiations of the tuples (sequences) of variables.

◆ toString() [1/2]

template<typename GUM_SCALAR >
std::string gum::aggregator::MultiDimAggregator< GUM_SCALAR >::toString ( ) const
overridevirtualinherited
Returns
the real number of parameters used for this table.

This function is used for compute

See also
compressionRatio()

Reimplemented from gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 91 of file multiDimAggregator_tpl.h.

References gum::aggregator::operator<<().

91  {
92  std::stringstream s;
93  s << this->variable(0) << "=" << aggregatorName() << "(";
94 
95  for (Idx i = 1; i < this->nbrDim(); i++) {
96  if (i > 1) s << ",";
97 
98  s << this->variable(i);
99  }
100 
101  s << ")";
102 
103  return s.str();
104  }
virtual std::string aggregatorName() const =0
const DiscreteVariable & variable(Idx i) const override
Returns a const ref to the ith var.
virtual Idx nbrDim() const override
Returns the number of vars in the multidimensional container.
+ Here is the call graph for this function:

◆ toString() [2/2]

template<typename GUM_SCALAR>
std::string gum::aggregator::MultiDimAggregator< GUM_SCALAR >::toString ( const gum::Instantiation i) const
inlineoverridevirtualinherited
Returns
the real number of parameters used for this table.

This function is used for compute

See also
compressionRatio()

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 132 of file multiDimAggregator.h.

132 { return i->toString(); };
std::string toString() const
Give a string version of instantiation.

◆ unregisterSlave()

template<typename GUM_SCALAR >
INLINE bool gum::MultiDimImplementation< GUM_SCALAR >::unregisterSlave ( Instantiation i)
overridevirtualinherited

Unregister i as a slave of this MultiDimAdressable.

Parameters
iThe Instantiation to free.
Returns
Returns true, whatever happens.

Implements gum::MultiDimAdressable.

Reimplemented in gum::MultiDimBucket< GUM_SCALAR >, and gum::MultiDimWithOffset< GUM_SCALAR >.

Definition at line 151 of file multiDimImplementation_tpl.h.

151  {
152  _slaveInstantiations_.eraseByVal(&slave);
153  return true;
154  }
List< Instantiation *> _slaveInstantiations_
List of instantiations of the tuples (sequences) of variables.

◆ variable() [1/2]

template<typename GUM_SCALAR >
INLINE const DiscreteVariable & gum::MultiDimImplementation< GUM_SCALAR >::variable ( Idx  i) const
overridevirtualinherited

Returns a const ref to the ith var.

param i An index of this multidimensional matrix.

Returns
Returns a const ref to the ith var.
Exceptions
NotFoundRaised if i does not reference a variable in this multidimensional matrix.

Implements gum::MultiDimInterface.

Definition at line 167 of file multiDimImplementation_tpl.h.

167  {
168  return *(_vars_.atPos(i));
169  }
Sequence< const DiscreteVariable *> _vars_
List of discrete variables (dimensions).

◆ variable() [2/2]

template<typename GUM_SCALAR >
INLINE const DiscreteVariable & gum::MultiDimImplementation< GUM_SCALAR >::variable ( const std::string &  name) const
overridevirtualinherited

Returns the variable with the name.

Parameters
nameThe index of the variable
Returns
Returns the variable qith the name in the tuple. This function is not O(1)
Exceptions
NotFoundRaised if the element cannot be found.

Implements gum::MultiDimInterface.

Definition at line 173 of file multiDimImplementation_tpl.h.

173  {
174  for (const auto& v: _vars_) {
175  if (v->name() == name) return *v;
176  }
177 
178  GUM_ERROR(NotFound, "'" << name << "' can not be found in the multidim structure.")
179  }
Sequence< const DiscreteVariable *> _vars_
List of discrete variables (dimensions).
virtual const std::string & name() const =0
Returns the real name of the multiDim implementation.
#define GUM_ERROR(type, msg)
Definition: exceptions.h:51

◆ variablesSequence()

template<typename GUM_SCALAR >
INLINE const Sequence< const DiscreteVariable *> & gum::MultiDimImplementation< GUM_SCALAR >::variablesSequence ( ) const
overridevirtualinherited

Returns a const ref to the sequence of DiscreteVariable*.

Returns
Returns a const ref to the sequence of DiscreteVariable*.

Implements gum::MultiDimInterface.

Definition at line 195 of file multiDimImplementation_tpl.h.

195  {
196  return _vars_;
197  }
Sequence< const DiscreteVariable *> _vars_
List of discrete variables (dimensions).

Member Data Documentation

◆ _value_

template<typename GUM_SCALAR >
Idx gum::aggregator::Median< GUM_SCALAR >::_value_
private

Definition at line 94 of file median.h.

◆ decomposable_

template<typename GUM_SCALAR>
bool gum::aggregator::MultiDimAggregator< GUM_SCALAR >::decomposable_
protectedinherited

decomposable_ indicates if the aggregator can be decomposed

Definition at line 179 of file multiDimAggregator.h.


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