max aggregator More...

#include <agrum/base/multidim/aggregators/max.h>

Inheritance diagram for gum::aggregator::Max< GUM_SCALAR >:

Collaboration diagram for gum::aggregator::Max< GUM_SCALAR >:

Public Member Functions
	Max ()
	Max (const Max< GUM_SCALAR > &from)
	~Max () override
MultiDimContainer< GUM_SCALAR > *	newFactory () const override
	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().
std::string	aggregatorName () const override
Accessors / Modifiers
GUM_SCALAR	get (const Instantiation &i) const override
std::string	toString () 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.
void	copyFrom (const MultiDimContainer< GUM_SCALAR > &src) const override
	Copy of a multiDimICIModel.
bool	isDecomposable () const
Slave management and extension due to slave management
virtual std::string	toString (const Instantiation *i) const =0
	Return a string representation of internal data about i in this.
virtual const MultiDimAdressable &	getMasterRef () const =0
	In order to insure the dereference for decorators, we need to virtualize the access to master pointer.
Accessors / Modifiers
void	set (const Instantiation &i, const GUM_SCALAR &value) const override
void	fill (const GUM_SCALAR &) const override
Accessors / Modifiers
virtual void	fill (const GUM_SCALAR &d) const=0
	Fill the table with d.
GUM_SCALAR	operator[] (const Instantiation &i) const
	An [] operator using a Instantiation as argument.
virtual void	populate (const std::vector< GUM_SCALAR > &v) const
	Automatically fills this MultiDimContainer with the values in v.
Accessors / Modifiers
const std::string &	basename () const
	Returns the base class name of this MultiDimImplementation.
float	compressionRate () const
	The compression ratio of the table (depending on the type of implementation).
virtual const GUM_SCALAR *	data () const noexcept
	Returns a pointer to the contiguous data buffer, or nullptr if the implementation does not store data contiguously.
MultiDimInterface implementation
Idx	nbrDim () const override
	Returns the number of vars in the multidimensional container.
Size	domainSize () const override
	Returns the product of the variables domain size.
void	add (const DiscreteVariable &v) override
	Adds a new var to the variables of the multidimensional matrix.
void	erase (const DiscreteVariable &v) override
	Removes a var from the variables of the multidimensional matrix.
const Sequence< const DiscreteVariable * > &	variablesSequence () const override
	Returns a const ref to the sequence of DiscreteVariable*.
const DiscreteVariable &	variable (Idx i) const override
	Returns a const ref to the ith var.
Idx	pos (const DiscreteVariable &v) const override
	Returns the index of a variable.
bool	contains (const DiscreteVariable &v) const override
	Returns true if var is in *this.
bool	empty () const override
	Returns true if no var is in *this.
Accessors / Modifiers
virtual const DiscreteVariable &	variable (std::string_view name) const =0
	Returns the variable with the name.
void	replace (const DiscreteVariable &x, const DiscreteVariable &y)
	Replace variables in this multidim.
MultiDimAdressable implementation
bool	registerSlave (Instantiation &slave) override
	Register i as a slave of this MultiDimAdressable.
bool	unregisterSlave (Instantiation &slave) override
	Unregister i as a slave of this MultiDimAdressable.
MultiDimContainer implementation
void	beginMultipleChanges () override
	Call this method before doing important changes in this MultiDimContainer.
void	endMultipleChanges () override
	Call this method after doing important changes in this MultiDimContainer.
Copy methods.
virtual void	extractFrom (const MultiDimContainer< GUM_SCALAR > &src, const Instantiation &mask)
	Basic extraction of a MultiDimContainer.
MultiDimAdressable &	getMasterRef () override
	In order to insure the dereference for decorators, we need to virtualize the access to master pointer.
virtual void	copy (const MultiDimContainer< GUM_SCALAR > &src)
	Removes all variables in this MultiDimContainer and copy the content of src, variables included.
Various methods.
bool	operator== (const MultiDimContainer< GUM_SCALAR > &p) const
	Test if this MultiDimContainer is equal to p.
virtual void	apply (std::function< GUM_SCALAR(GUM_SCALAR) > f) const
	Apply a function on every element of the container.
virtual GUM_SCALAR	reduce (std::function< GUM_SCALAR(GUM_SCALAR, GUM_SCALAR) > f, GUM_SCALAR base) const
	compute lfold for this container

Protected Member Functions
Idx	neutralElt_ () const override
	neutralElt_() is the result value for the first application of fold_
Idx	fold_ (const DiscreteVariable &v, Idx i1, Idx i2, bool &stop_iteration) const override
	fold_ is applied on value i1 for variable v. the actual result for precedent applications is i2.
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.
GUM_SCALAR &	get_ (const Instantiation &i) const override
const MultiDimImplementation< GUM_SCALAR > *	content () const final
	Returns the implementation for this object (may be *this).
Fast large modifications in structures
virtual void	commitMultipleChanges_ ()
	Synchronize content after MultipleChanges.
bool	isInMultipleChangeMethod_ () const
	Get the actual change method of this MultiDimImplementation.
bool	isCommitNeeded_ () const
	Get the actual state of *this.
const List< Instantiation * > &	slaves_ () const
	Returns a constant reference over the list of slaved instantiations.
void	replace_ (const DiscreteVariable x, const DiscreteVariable y) override
	Replace variable x by y.
virtual void	invert_ (Idx p1, Idx p2)
	Inverts variables at position p1 and p2.

Protected Attributes
bool	decomposable_
	decomposable_ indicates if the aggregator can be decomposed

Private Types
enum	_InternalChangeMethod_
	Used to represent in which change method this MultiDimImplementation is. More...
enum	_InternalChangeState_
	Used to represent in which change state this MultiDimImplementation is. More...

Private Member Functions
void	_setNotCommitedChange_ ()
	Change the internalChangeState to NOT_COMMITTED_CHANGE.

Private Attributes
Sequence< const DiscreteVariable * >	_vars_
	List of discrete variables (dimensions).
List< Instantiation * >	_slaveInstantiations_
	List of instantiations of the tuples (sequences) of variables.
_InternalChangeMethod_	_internalChangeMethod_
	The current change method.
_InternalChangeState_	_internalChangeState_
	The current change state.
Size	_domainSize_
	This MultiDimImplementation domain size.

Detailed Description

template<GUM_Numeric GUM_SCALAR>
class gum::aggregator::Max< GUM_SCALAR >

max aggregator

See also: MultiDimAggregator for more details of implementations

Note that a Max aggregator with a binary aggregator variable is the \( \exists \neq 0\) aggregator.

Definition at line 73 of file max.h.

Member Enumeration Documentation

◆ _InternalChangeMethod_

enum gum::MultiDimImplementation::_InternalChangeMethod_ : char

strongprivateinherited

Used to represent in which change method this MultiDimImplementation is.

Definition at line 317 of file multiDimImplementation.h.

317: char { DIRECT_CHANGE, MULTIPLE_CHANGE };

◆ _InternalChangeState_

enum gum::MultiDimImplementation::_InternalChangeState_ : char

strongprivateinherited

Used to represent in which change state this MultiDimImplementation is.

Definition at line 320 of file multiDimImplementation.h.

320: char { NO_CHANGE, NOT_COMMITTED_CHANGE };

Constructor & Destructor Documentation

◆ Max() [1/2]

template<GUM_Numeric GUM_SCALAR>

gum::aggregator::Max< GUM_SCALAR >::Max ( )

Definition at line 58 of file max_tpl.h.

                           : MultiDimAggregator< GUM_SCALAR >() {
      this->decomposable_ = true;
      GUM_CONSTRUCTOR(Max);
    }

References Max(), gum::aggregator::MultiDimAggregator< GUM_SCALAR >::MultiDimAggregator(), and gum::aggregator::MultiDimAggregator< GUM_SCALAR >::decomposable_.

Referenced by Max(), Max(), ~Max(), and newFactory().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Max() [2/2]

template<GUM_Numeric GUM_SCALAR>

gum::aggregator::Max< GUM_SCALAR >::Max ( const Max< GUM_SCALAR > & from )

Definition at line 64 of file max_tpl.h.

                                                        : MultiDimAggregator< GUM_SCALAR >(from) {
      GUM_CONS_CPY(Max);
    }

References Max(), and gum::aggregator::MultiDimAggregator< GUM_SCALAR >::MultiDimAggregator().

Here is the call graph for this function:

◆ ~Max()

template<GUM_Numeric GUM_SCALAR>

gum::aggregator::Max< GUM_SCALAR >::~Max ( )

override

Definition at line 69 of file max_tpl.h.

                            {
      GUM_DESTRUCTOR(Max);
    }

References Max().

Here is the call graph for this function:

Member Function Documentation

◆ _setNotCommitedChange_()

void gum::MultiDimImplementation< GUM_SCALAR >::_setNotCommitedChange_ ( )

privateinherited

Change the internalChangeState to NOT_COMMITTED_CHANGE.

Definition at line 334 of file multiDimImplementation_tpl.h.

                                                                     {
    _internalChangeState_ = _InternalChangeState_::NOT_COMMITTED_CHANGE;
  }

◆ add()

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

v	The new var.

Exceptions

DuplicateElement	Raised if the variable already belongs to the sequence of variables.
OperationNotAllowed	Raised if this object is non mutable.

Implements gum::MultiDimInterface.

Definition at line 195 of file multiDimImplementation_tpl.h.

                                                                           {
    // check if the variable already belongs to the tuple of variables
    // of the Instantiation
    if (_vars_.exists(&v)) {
      GUM_ERROR(DuplicateElement, "Var " << v.name() << " already exists in this instantiation")
    }
    for (const auto& w: _vars_) {
      if (w->name() == v.name())
        GUM_ERROR(DuplicateElement,
                  "A var with name '" << v.name() << "' already exists in this instantiation");
    }
 
    if (_domainSize_ > std::numeric_limits< Size >::max() / v.domainSize()) {
      GUM_ERROR(OutOfBounds, "adding variable '" << v.name() << "' would overflow domainSize")
    }
    _domainSize_ *= v.domainSize();
 
    _vars_.insert(&v);
 
    // informs all the slaves that they have to update themselves
    for (List< Instantiation* >::iterator_safe iter = _slaveInstantiations_.beginSafe();
         iter != _slaveInstantiations_.endSafe();
         ++iter) {
      (*iter)->addWithMaster(this, v);
    }
 
    if (isInMultipleChangeMethod_()) _setNotCommitedChange_();
  }

◆ aggregatorName()

template<GUM_Numeric GUM_SCALAR>

std::string gum::aggregator::Max< GUM_SCALAR >::aggregatorName ( ) const

overridevirtual

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 87 of file max_tpl.h.

                                                      {
      return "max";
    }

◆ apply()

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

f	the function to apply

Reimplemented in gum::MultiDimDecorator< GUM_SCALAR >.

Definition at line 365 of file multiDimContainer_tpl.h.

                                                                                              {
    Instantiation i(*this);
    for (i.setFirst(); !i.end(); ++i) {
      set(i, f(get(i)));
    }
  }

◆ basename()

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 135 of file multiDimImplementation_tpl.h.

                                                                         {
    static const std::string str = "MultiDimImplementation";
    return str;
  }

◆ beginMultipleChanges()

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 230 of file multiDimImplementation_tpl.h.

                                                                   {
    _internalChangeMethod_ = _InternalChangeMethod_::MULTIPLE_CHANGE;
  }

◆ buildValue_()

Idx gum::aggregator::MultiDimAggregator< GUM_SCALAR >::buildValue_ ( const gum::Instantiation & i ) const

protectedvirtualinherited

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 in gum::aggregator::Amplitude< GUM_SCALAR >, and gum::aggregator::Median< GUM_SCALAR >.

Definition at line 197 of file multiDimAggregator_tpl.h.

                                                                                  {
      if (this->nbrDim() == 1) return neutralElt_();
 
      // is i equal to f(f(f(f...(j_,neutral_elt))))
      Idx current = neutralElt_();
 
      bool stop_iteration = false;
 
      for (Idx j = 1; j < this->nbrDim(); j++) {
        current = fold_(this->variable(j), i.val(this->variable(j)), current, stop_iteration);
 
        if (stop_iteration) break;
      }
 
      return current;
    }

◆ changeNotification()

void gum::aggregator::MultiDimAggregator< GUM_SCALAR >::changeNotification	(	const gum::Instantiation &	,
		const gum::DiscreteVariable * const	,
		gum::Idx	,
		gum::Idx	)

overridevirtualinherited

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 137 of file multiDimAggregator_tpl.h.

163 {}

◆ commitMultipleChanges_()

void gum::MultiDimImplementation< GUM_SCALAR >::commitMultipleChanges_ ( )

protectedvirtualinherited

Synchronize content after MultipleChanges.

Definition at line 247 of file multiDimImplementation_tpl.h.

                                                                     {
    // empty!
  }

◆ compressionRate()

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 ratio, 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 162 of file multiDimImplementation_tpl.h.

                                                                     {
    return ((float)1) - (float)realSize() / (float)domainSize();
  }

◆ contains()

bool gum::MultiDimImplementation< GUM_SCALAR >::contains ( const DiscreteVariable & v ) const

overridevirtualinherited

Returns true if var is in *this.

Parameters

v	A DiscreteVariable.

Returns: Returns true if var is in *this.

Implements gum::MultiDimInterface.

Definition at line 206 of file multiDimImplementation_tpl.h.

                                                                                      {
    return _vars_.exists(&v);
  }

◆ content()

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 302 of file multiDimImplementation_tpl.h.

                                                           {
    return this;
  }

◆ copy()

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

src	The MultiDimContainer to copy.

Definition at line 314 of file multiDimContainer_tpl.h.

                                                                                         {
    this->beginMultipleChanges();
 
    Size nbr = this->nbrDim();
 
    for (Idx i = 0; i < nbr; i++) {
      this->erase(this->variable(0));
    }
 
    for (Idx i = 0; i < src.nbrDim(); i++) {
      this->add(src.variable(i));
    }
 
    this->endMultipleChanges();
    this->copyFrom(src);
  }

◆ copyFrom()

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

OperationNotAllowed Raised if src does not have the same domain size than this MultiDimContainer.

Reimplemented from gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 183 of file multiDimAggregator_tpl.h.

                                                          {
      if (auto p = dynamic_cast< const MultiDimAggregator< GUM_SCALAR >* >(&src)) {
        if (p->name() != this->name()) {
          GUM_ERROR(OperationNotAllowed,
                    "Can not copy from a " << p->name() << " to a " << this->name());
        }
      } else {
        MultiDimReadOnly< GUM_SCALAR >::copyFrom(src);
      }
      // it the types aree consistant, nothing to do...
    }

◆ data()

const GUM_SCALAR * gum::MultiDimImplementation< GUM_SCALAR >::data ( ) const

virtualnoexceptinherited

Returns a pointer to the contiguous data buffer, or nullptr if the implementation does not store data contiguously.

Subclasses backed by a contiguous array (e.g. MultiDimArray) override this to expose direct memory access, enabling zero-copy interop with external libraries such as NumPy.

Returns: Pointer to the first element of the contiguous buffer, or nullptr.

Definition at line 175 of file multiDimImplementation_tpl.h.

                                                                                {
    return nullptr;
  }

◆ domainSize()

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 193 of file multiDimImplementation_tpl.h.

                                                               {
    return _domainSize_;
  }

◆ empty()

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 208 of file multiDimImplementation_tpl.h.

                                                          {
    GUM_ASSERT(!this->isCommitNeeded_());
    return _vars_.empty();
  }

◆ endMultipleChanges()

void gum::MultiDimImplementation< GUM_SCALAR >::endMultipleChanges ( )

overridevirtualinherited

Call this method after doing important changes in this MultiDimContainer.

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 232 of file multiDimImplementation_tpl.h.

                                                                 {
    if (_internalChangeState_ == _InternalChangeState_::NOT_COMMITTED_CHANGE) {
      commitMultipleChanges_();
      _internalChangeState_ = _InternalChangeState_::NO_CHANGE;
    }
 
    _internalChangeMethod_ = _InternalChangeMethod_::DIRECT_CHANGE;
  }

◆ erase()

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

OperationNotAllowed	Raised if this object is non mutable.
NotFound	Raised if v does not belong to this.

Implements gum::MultiDimInterface.

Definition at line 197 of file multiDimImplementation_tpl.h.

                                                                             {
    // check that the variable does actually belong to the
    // MultiDimImplementation
    if (!_vars_.exists(&v)) { GUM_ERROR(NotFound, "Var does not exist in this implementation") }
 
    _domainSize_ /= v.domainSize();
 
    _vars_.erase(&v);
 
    // informs all the slaves that they have to update themselves
    for (List< Instantiation* >::iterator_safe iter = _slaveInstantiations_.beginSafe();
         iter != _slaveInstantiations_.endSafe();
         ++iter) {
      (*iter)->eraseWithMaster(this, v);
    }
 
    if (isInMultipleChangeMethod_()) _setNotCommitedChange_();
  }

◆ extractFrom()

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

src	The MultiDimContainer src which datas are copied.
mask	partial instantiation of variables of the Tensor : 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 280 of file multiDimContainer_tpl.h.

                                                                                 {
    this->beginMultipleChanges();
 
    Size nbr = this->nbrDim();
    for (Idx i = 0; i < nbr; i++) {
      this->erase(this->variable(0));
    }
 
    for (Idx i = 0; i < src.nbrDim(); i++) {
      if (!imask.contains(src.variable(i))) this->add(src.variable(i));
    }
 
    this->endMultipleChanges();
 
    if (this->nbrDim() == 0) { GUM_ERROR(FatalError, "Empty tensor") }
 
    Instantiation inst(src);
    inst.setVals(imask);
    for (inst.setFirstOut(imask); !inst.end(); inst.incOut(imask))
      set(inst, src[inst]);
  }

◆ fill() [1/2]

virtual void gum::MultiDimContainer< GUM_SCALAR >::fill ( const GUM_SCALAR & d ) const

pure virtualinherited

Fill the table with d.

Parameters

d	The value used to fill this MultiDimContainer.

Implemented in gum::MultiDimDecorator< GUM_SCALAR >.

◆ fill() [2/2]

void gum::MultiDimReadOnly< GUM_SCALAR >::fill ( const GUM_SCALAR & ) const

overrideinherited

Warning: An OperationNotAllowed will be raised because this is a read only table.

Definition at line 107 of file multiDimReadOnly_tpl.h.

                                                                     {
    GUM_ERROR(OperationNotAllowed, "Write access to an aggregator")
  }

◆ fold_()

template<GUM_Numeric GUM_SCALAR>

Idx gum::aggregator::Max< GUM_SCALAR >::fold_	(	const DiscreteVariable &	v,
		Idx	i1,
		Idx	i2,
		bool &	stop_iteration ) const

overrideprotectedvirtual

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 79 of file max_tpl.h.

                                                                               {
      return (i1 > i2) ? i1 : i2;
    }

◆ get()

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 132 of file multiDimAggregator_tpl.h.

                                                                                 {
      if (this->nbrDim() < 1) {
        GUM_ERROR(OperationNotAllowed, "Not enough variable for an aggregator : " << *this)
      }
 
      const DiscreteVariable& agg     = this->variable((Idx)0);
      auto                    current = buildValue_(i);
 
      // truncate to fit in aggreegator domain size
      if (current >= agg.domainSize()) current = agg.domainSize() - 1;
 
      return (i.val(agg) == current) ? (GUM_SCALAR)1.0 : (GUM_SCALAR)0.0;
    }

◆ get_()

GUM_SCALAR & gum::MultiDimReadOnly< GUM_SCALAR >::get_ ( const Instantiation & i ) const

overrideprotectedvirtualinherited

Warning: An OperationNotAllowed will be raised because this is a read only table.

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 116 of file multiDimReadOnly_tpl.h.

                                                                                 {
    GUM_ERROR(OperationNotAllowed, "No (unconst) access to an aggregator")
  }

◆ getMasterRef() [1/2]

virtual const MultiDimAdressable & gum::MultiDimAdressable::getMasterRef ( ) const

pure 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.

Implemented in gum::MultiDimBucket< GUM_ELEMENT >, and gum::MultiDimContainer< GUM_ELEMENT >.

References MultiDimAdressable().

Here is the call graph for this function:

◆ getMasterRef() [2/2]

MultiDimAdressable & gum::MultiDimContainer< GUM_SCALAR >::getMasterRef ( )

overridevirtualinherited

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.

Definition at line 298 of file multiDimContainer_tpl.h.

                                                                     {
    return static_cast< MultiDimAdressable& >(*content());
  }

◆ invert_()

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

p1	The first position.
p2	The second position.

Definition at line 295 of file multiDimImplementation_tpl.h.

                                                                    {
    _vars_.swap(p1, p2);
  }

◆ isCommitNeeded_()

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 265 of file multiDimImplementation_tpl.h.

                                                                    {
    return (_internalChangeState_ == _InternalChangeState_::NOT_COMMITTED_CHANGE);
  }

◆ isDecomposable()

bool gum::aggregator::MultiDimAggregator< GUM_SCALAR >::isDecomposable ( ) const

inherited

Returns: true if the aggregator is decomposable.

Definition at line 188 of file multiDimAggregator_tpl.h.

                                                                {
      return decomposable_;
    }

◆ isInMultipleChangeMethod_()

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 259 of file multiDimImplementation_tpl.h.

                                                                              {
    return (_internalChangeMethod_ == _InternalChangeMethod_::MULTIPLE_CHANGE);
  }

◆ name()

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 172 of file multiDimAggregator_tpl.h.

                                                                  {
      static const std::string str = "MultiDimAggregator";
      return str;
    }

◆ nbrDim()

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 191 of file multiDimImplementation_tpl.h.

                                                          {
    return _vars_.size();
  }

◆ neutralElt_()

template<GUM_Numeric GUM_SCALAR>

Idx gum::aggregator::Max< GUM_SCALAR >::neutralElt_ ( ) const

overrideprotectedvirtual

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

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

Definition at line 74 of file max_tpl.h.

                                             {
      return (Idx)0;
    }

◆ newFactory()

template<GUM_Numeric GUM_SCALAR>

MultiDimContainer< GUM_SCALAR > * gum::aggregator::Max< GUM_SCALAR >::newFactory ( ) const

nodiscardoverridevirtual

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();

gum::MultiDimArray

Multidimensional matrix stored as an array in memory.

Definition multiDimArray.h:75

gum::MultiDimArray::newFactory

MultiDimContainer< GUM_ELEMENT > * newFactory() const override

Default constructor.

Definition multiDimArray_tpl.h:188

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 92 of file max_tpl.h.

                                                                         {
      return new Max< GUM_SCALAR >;
    }

References Max().

Here is the call graph for this function:

◆ operator==()

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

inherited

Test if this MultiDimContainer is equal to p.

Parameters

p	The MultiDimContainer to test for equality.

Returns: Returns true if this MultiDimContainer is equal to p.

Definition at line 359 of file multiDimContainer_tpl.h.

                                                       {
    if ((nbrDim() == p.nbrDim()) && (domainSize() == p.domainSize())) {
      if (nbrDim() == 0) return true;
 
      for (auto iter = variablesSequence().beginSafe(); iter != variablesSequence().endSafe();
           ++iter) {
        if (!p.variablesSequence().exists(*iter)) { return false; }
      }
    } else {
      return false;
    }
 
    Instantiation                  i(*this);
    AlmostDifferent< GUM_ELEMENT > cmp;
    for (i.setFirst(); !i.end(); ++i) {
      if (cmp(get(i), p.get(i))) { return false; }
    }
 
    return true;
  }

◆ operator[]()

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

i	An Instantiation.

Returns: Returns the adressed (GUM_ELEMENT) value.

Definition at line 184 of file multiDimContainer_tpl.h.

                                                                                       {
    return get(i);
  }

◆ populate()

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

v	Vector of values.

Exceptions

SizeError Raised if v size's does not matches this MultiDimContainer domain size.

Reimplemented in gum::MultiDimDecorator< GUM_SCALAR >.

Definition at line 210 of file multiDimContainer_tpl.h.

                                                                                         {
    if (domainSize() != v.size()) {
      GUM_ERROR(SizeError, "Sizes do not match : " << domainSize() << "!=" << v.size())
    }
 
    Size cpt = 0;
 
    Instantiation i(*this);
 
    for (i.setFirst(); !i.end(); ++i, ++cpt)
      set(i, v[cpt]);
  }

◆ pos()

Idx gum::MultiDimImplementation< GUM_SCALAR >::pos ( const DiscreteVariable & v ) const

overridevirtualinherited

Returns the index of a variable.

Parameters

v	The variable for which the index is returned.

Returns: Returns the index of a variable.

Exceptions

NotFound Raised if v is not in this multidimensional matrix.

Implements gum::MultiDimInterface.

Definition at line 204 of file multiDimImplementation_tpl.h.

                                                                                {
    return _vars_.pos(&v);
  }

◆ realSize()

Size gum::aggregator::MultiDimAggregator< GUM_SCALAR >::realSize ( ) const

overridevirtualinherited

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 159 of file multiDimAggregator_tpl.h.

                                                          {
      return 0;
    }

◆ reduce()

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

f	the function to apply
base	the initial value

Reimplemented in gum::MultiDimDecorator< GUM_SCALAR >.

Definition at line 372 of file multiDimContainer_tpl.h.

                                                                         {
    GUM_ELEMENT   tmp = base;
    Instantiation i(*this);
    for (i.setFirst(); !i.end(); ++i) {
      tmp = f(tmp, get(i));
    }
    return tmp;
  }

◆ registerSlave()

bool gum::MultiDimImplementation< GUM_SCALAR >::registerSlave ( Instantiation & slave )

overridevirtualinherited

Register i as a slave of this MultiDimAdressable.

Parameters

i	The Instantiation to enslave.

Returns: Returns true if i becomes a slave of this MultiDimAdressable.

Implements gum::MultiDimAdressable.

Definition at line 216 of file multiDimImplementation_tpl.h.

                                                                                {
    // check that the Instantiation has the same variables as this
    if (slave.nbrDim() != _vars_.size()) return false;
 
    for (Sequence< const DiscreteVariable* >::iterator_safe iter = _vars_.beginSafe();
         iter != _vars_.endSafe();
         ++iter)
      if (!slave.contains(*iter)) return false;
 
    slave.synchronizeWithMaster(this);
 
    _slaveInstantiations_ += (&slave);
 
    return true;
  }

◆ 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

x	The variable in this which will be replaced.
y	The variable replacing y.

Exceptions

NotFound	Raised if x does not belong to this MultiDim.
OperationNotAllowed	If y and x are not interchangeable.
DuplicateElement	If y is already in this MultiDim.

Definition at line 57 of file multiDimInterface_inl.h.

                                                                                      {
    if (!contains(x)) { GUM_ERROR(NotFound, "could not find the variable") }
 
    if (contains(y)) { GUM_ERROR(DuplicateElement, "variable " << y << " already in MultiDim") }
 
    if (x.domainSize() != y.domainSize()) {
      GUM_ERROR(OperationNotAllowed, "incompatible variables")
    }
 
    replace_(&x, &y);
  }

References contains(), gum::DiscreteVariable::domainSize(), GUM_ERROR, and replace_().

Here is the call graph for this function:

◆ replace_()

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

x	The first variable to swap.
y	The second variable to swap.

Implements gum::MultiDimInterface.

Definition at line 284 of file multiDimImplementation_tpl.h.

                                                                                  {
    _vars_.setAtPos(_vars_.pos(x), y);
 
    for (List< Instantiation* >::iterator_safe iter = _slaveInstantiations_.beginSafe();
         iter != _slaveInstantiations_.endSafe();
         ++iter) {
      (**iter).replace(*x, *y);
    }
  }

◆ set()

void gum::MultiDimReadOnly< GUM_SCALAR >::set	(	const Instantiation &	i,
		const GUM_SCALAR &	value ) const

overridevirtualinherited

Warning: An OperationNotAllowed will be raised because this is a read only table.

Reimplemented from gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 101 of file multiDimReadOnly_tpl.h.

                                                                              {
    GUM_ERROR(OperationNotAllowed, "Write access to an aggregator")
  }

◆ setChangeNotification()

void gum::aggregator::MultiDimAggregator< GUM_SCALAR >::setChangeNotification ( const gum::Instantiation & )

overridevirtualinherited

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 150 of file multiDimAggregator_tpl.h.

178{}

◆ setDecNotification()

void gum::aggregator::MultiDimAggregator< GUM_SCALAR >::setDecNotification ( const gum::Instantiation & )

overridevirtualinherited

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 148 of file multiDimAggregator_tpl.h.

175{}

◆ setFirstNotification()

void gum::aggregator::MultiDimAggregator< GUM_SCALAR >::setFirstNotification ( const gum::Instantiation & )

overridevirtualinherited

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 142 of file multiDimAggregator_tpl.h.

166{}

◆ setIncNotification()

void gum::aggregator::MultiDimAggregator< GUM_SCALAR >::setIncNotification ( const gum::Instantiation & )

overridevirtualinherited

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 146 of file multiDimAggregator_tpl.h.

172{}

◆ setLastNotification()

void gum::aggregator::MultiDimAggregator< GUM_SCALAR >::setLastNotification ( const gum::Instantiation & )

overridevirtualinherited

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 144 of file multiDimAggregator_tpl.h.

169{}

◆ slaves_()

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 273 of file multiDimImplementation_tpl.h.

                                                                                     {
    return _slaveInstantiations_;
  }

◆ toString() [1/2]

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 135 of file multiDimAggregator_tpl.h.

                                                               {
      std::stringstream s;
      s << this->variable(0) << "=" << aggregatorName() << "(";
 
      for (Idx i = 1; i < this->nbrDim(); i++) {
        if (i > 1) s << ",";
 
        s << this->variable(i);
      }
 
      s << ")";
 
      return s.str();
    }

◆ toString() [2/2]

virtual std::string gum::MultiDimAdressable::toString ( const Instantiation * i ) const

pure virtualinherited

Return a string representation of internal data about i in this.

Parameters

i	The Instantiation to represent.

Returns: Return a string representation of internal data about i in this.

◆ unregisterSlave()

bool gum::MultiDimImplementation< GUM_SCALAR >::unregisterSlave ( Instantiation & slave )

overridevirtualinherited

Unregister i as a slave of this MultiDimAdressable.

Parameters

i	The Instantiation to free.

Returns: Returns true, whatever happens.

Implements gum::MultiDimAdressable.

Definition at line 218 of file multiDimImplementation_tpl.h.

                                                                                  {
    _slaveInstantiations_.eraseByVal(&slave);
    return true;
  }

◆ variable() [1/2]

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

NotFound Raised if i does not reference a variable in this multidimensional matrix.

Implements gum::MultiDimInterface.

Definition at line 201 of file multiDimImplementation_tpl.h.

                                                                                     {
    return *(_vars_.atPos(i));
  }

◆ variable() [2/2]

virtual const DiscreteVariable & gum::MultiDimInterface::variable ( std::string_view name ) const

pure virtualinherited

Returns the variable with the name.

Parameters

name	The index of the variable

Returns: Returns the variable qith the name in the tuple. @warging This function is not O(1)

Exceptions

NotFound Raised if the element cannot be found.

Implemented in gum::Instantiation, gum::MultiDimDecorator< GUM_ELEMENT >, gum::MultiDimImplementation< GUM_ELEMENT >, gum::MultiDimImplementation< GUM_ELEMENT > *(*)(const MultiDimImplementation< GUM_ELEMENT > *, const HashTable< const DiscreteVariable *, Idx > &), gum::MultiDimImplementation< GUM_ELEMENT > *(*)(const MultiDimImplementation< GUM_ELEMENT > *, const MultiDimImplementation< GUM_ELEMENT > *), and gum::VariableSet &)< GUM_ELEMENT >.

◆ variablesSequence()

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 199 of file multiDimImplementation_tpl.h.

                                                                     {
    return _vars_;
  }

Member Data Documentation

◆ _domainSize_

Size gum::MultiDimImplementation< GUM_SCALAR >::_domainSize_

privateinherited

This MultiDimImplementation domain size.

Definition at line 329 of file multiDimImplementation.h.

◆ _internalChangeMethod_

_InternalChangeMethod_ gum::MultiDimImplementation< GUM_SCALAR >::_internalChangeMethod_

privateinherited

The current change method.

Definition at line 323 of file multiDimImplementation.h.

◆ _internalChangeState_

_InternalChangeState_ gum::MultiDimImplementation< GUM_SCALAR >::_internalChangeState_

privateinherited

The current change state.

Definition at line 326 of file multiDimImplementation.h.

◆ _slaveInstantiations_

List< Instantiation* > gum::MultiDimImplementation< GUM_SCALAR >::_slaveInstantiations_

privateinherited

List of instantiations of the tuples (sequences) of variables.

Definition at line 314 of file multiDimImplementation.h.

◆ _vars_

Sequence< const DiscreteVariable* > gum::MultiDimImplementation< GUM_SCALAR >::_vars_

privateinherited

List of discrete variables (dimensions).

Definition at line 311 of file multiDimImplementation.h.

◆ decomposable_

bool gum::aggregator::MultiDimAggregator< GUM_SCALAR >::decomposable_

protectedinherited

decomposable_ indicates if the aggregator can be decomposed

Definition at line 200 of file multiDimAggregator.h.

Referenced by gum::aggregator::And< GUM_SCALAR >::And(), gum::aggregator::Max< GUM_SCALAR >::Max(), gum::aggregator::Min< GUM_SCALAR >::Min(), gum::aggregator::Or< GUM_SCALAR >::Or(), and gum::aggregator::Sum< GUM_SCALAR >::Sum().

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

agrum/base/multidim/aggregators/max.h
agrum/base/multidim/aggregators/max_tpl.h

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ _InternalChangeMethod_

◆ _InternalChangeState_

Constructor & Destructor Documentation

◆ Max() [1/2]

◆ Max() [2/2]

◆ ~Max()

Member Function Documentation

◆ _setNotCommitedChange_()

◆ add()

◆ aggregatorName()

◆ apply()

◆ basename()

◆ beginMultipleChanges()

◆ buildValue_()

◆ changeNotification()

◆ commitMultipleChanges_()

◆ compressionRate()

◆ contains()

◆ content()

◆ copy()

◆ copyFrom()

◆ data()

◆ domainSize()

◆ empty()

◆ endMultipleChanges()

◆ erase()

◆ extractFrom()

◆ fill() [1/2]

◆ fill() [2/2]

◆ fold_()

◆ get()

◆ get_()

◆ getMasterRef() [1/2]

◆ getMasterRef() [2/2]

◆ invert_()

◆ isCommitNeeded_()

◆ isDecomposable()

◆ isInMultipleChangeMethod_()

◆ name()

◆ nbrDim()

◆ neutralElt_()

◆ newFactory()

◆ operator==()

◆ operator[]()

◆ populate()

◆ pos()

◆ realSize()

◆ reduce()

◆ registerSlave()

◆ replace()

◆ replace_()

◆ set()

◆ setChangeNotification()

◆ setDecNotification()

◆ setFirstNotification()

◆ setIncNotification()

◆ setLastNotification()

◆ slaves_()

◆ toString() [1/2]

◆ toString() [2/2]

◆ unregisterSlave()

◆ variable() [1/2]

◆ variable() [2/2]

◆ variablesSequence()

Member Data Documentation

◆ _domainSize_

◆ _internalChangeMethod_

◆ _internalChangeState_

◆ _slaveInstantiations_

◆ _vars_

◆ decomposable_