gum::MultiDimBucket< GUM_ELEMENT > Class Template Reference

A multidim implementation for buckets. More...

#include <agrum/base/multidim/multiDimBucket.h>

Inheritance diagram for gum::MultiDimBucket< GUM_ELEMENT >:

Collaboration diagram for gum::MultiDimBucket< GUM_ELEMENT >:

Public Member Functions
const HashTable< const MultiDimContainer< GUM_ELEMENT > *, Instantiation * > &	multidims () const
	Returns the MultiDimContainer and their respective Instantiation.
Constructor & destructor.
	MultiDimBucket (Size bufferSize=INT_MAX)
	Default constructor.
	MultiDimBucket (const MultiDimBucket< GUM_ELEMENT > &source)
	Copy constructor.
	~MultiDimBucket () override
	Destructor.
Bucket methods
void	add (const MultiDimContainer< GUM_ELEMENT > &impl)
	Add a MultiDimContainer in the bucket.
void	add (const MultiDimContainer< GUM_ELEMENT > *impl)
	Add a MultiDimContainer in the bucket.
void	erase (const MultiDimContainer< GUM_ELEMENT > &impl)
	Remove a MultiDimContainer from this bucket.
void	erase (const MultiDimContainer< GUM_ELEMENT > *impl)
	Remove a MultiDimContainer from this bucket.
bool	contains (const MultiDimContainer< GUM_ELEMENT > &impl) const
	Returns true if the MultiDimContainer is in this bucket.
const gum::VariableSet &	allVariables () const
	Returns the sequence of all the variables contained in the bucket.
Size	bucketSize () const
	Returns the number of MultiDimContainer in this bucket.
bool	isBucketEmpty () const
	Returns true if this bucket is empty.
bool	bucketChanged () const
	Returns true if the bucket need re-computation since the last computation.
const MultiDimArray< GUM_ELEMENT > &	bucket () const
	Returns the MultiDimArray used by this MultiDimBucket.
Size	bufferSize () const
	Returns the amount of memory allowed for this bucket.
void	setBufferSize (Size amount)
	Changes the amount of memory allowed for this bucket.
void	compute (bool force=false) const
	This method computes the final table of this bucket.
Inherited methods
MultiDimContainer< GUM_ELEMENT > *	newFactory () const override
	Default constructor.
const std::string &	name () const override
	Returns the real name of the multiDim implementation.
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.
Size	realSize () const override
	Returns the real number of parameters used for this table.
bool	contains (const DiscreteVariable &v) const override
	Returns true if var is in *this.
GUM_ELEMENT	get (const Instantiation &i) const override
	Returns the value pointed by i.
void	changeNotification (const Instantiation &i, const DiscreteVariable *const var, Idx oldval, Idx newval) override
	Listen to changes in a given Instantiation.
void	setFirstNotification (const Instantiation &i) override
	Listen to setFirst in a given Instantiation.
void	setLastNotification (const Instantiation &i) override
	Listen to setLast in a given Instantiation.
void	setIncNotification (const Instantiation &i) override
	Listen to increment in a given Instantiation.
void	setDecNotification (const Instantiation &i) override
	Listen to increment in each recorded Instantiation.
void	setChangeNotification (const Instantiation &i) override
	Listen to an assignment of a value in a Instantiation.
bool	registerSlave (Instantiation &i) override
	Register i as a slave of this MultiDimAdressable.
bool	unregisterSlave (Instantiation &i) override
	Unregister i as a slave of this MultiDimAdressable.
MultiDimAdressable &	getMasterRef () override
	In order to insure the dereference for decorators, we need to virtualize the access to master pointer.
const MultiDimAdressable &	getMasterRef () const override
	In order to insure the dereference for decorators, we need to virtualize the access to master pointer.
std::string	toString (const Instantiation *i) const override
	Display the internal representation of i.
Accessors / Modifiers
void	set (const Instantiation &i, const GUM_ELEMENT &value) const override
void	fill (const GUM_ELEMENT &) const override
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_ELEMENT *	data () const noexcept
	Returns a pointer to the contiguous data buffer, or nullptr if the implementation does not store data contiguously.
virtual GUM_ELEMENT *	data () noexcept
	Returns a mutable 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.
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.
const DiscreteVariable &	variable (std::string_view name) const override
	Returns the variable with the name.
Idx	pos (const DiscreteVariable &v) const override
	Returns the index of a variable.
bool	empty () const override
	Returns true if no var is in *this.
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.
void	endMultipleChanges (const GUM_ELEMENT &) override
	Call this method after doing important changes in this MultiDimContainer.
Accessors / Modifiers
GUM_ELEMENT	operator[] (const Instantiation &i) const
	An [] operator using a Instantiation as argument.
virtual void	populate (const std::vector< GUM_ELEMENT > &v) const
	Automatically fills this MultiDimContainer with the values in v.
virtual void	populate (std::initializer_list< GUM_ELEMENT > l) const
	Automatically fills this MultiDimContainer with the values in l.
Copy methods.
virtual void	copyFrom (const MultiDimContainer< GUM_ELEMENT > &src) const
	Basic copy of a MultiDimContainer.
virtual void	copyFrom (const MultiDimContainer< GUM_ELEMENT > &src, Instantiation *p_i) const
	Basic copy of a MultiDimContainer.
virtual void	extractFrom (const MultiDimContainer< GUM_ELEMENT > &src, const Instantiation &mask)
	Basic extraction of a MultiDimContainer.
virtual void	copy (const MultiDimContainer< GUM_ELEMENT > &src)
	Removes all variables in this MultiDimContainer and copy the content of src, variables included.
Various methods.
virtual std::string	toString () const
	Returns a representation of this MultiDimContainer.
bool	operator== (const MultiDimContainer< GUM_ELEMENT > &p) const
	Test if this MultiDimContainer is equal to p.
virtual void	apply (std::function< GUM_ELEMENT(GUM_ELEMENT) > f) const
	Apply a function on every element of the container.
virtual GUM_ELEMENT	reduce (std::function< GUM_ELEMENT(GUM_ELEMENT, GUM_ELEMENT) > f, GUM_ELEMENT base) const
	compute lfold for this container
Accessors / Modifiers
void	replace (const DiscreteVariable &x, const DiscreteVariable &y)
	Replace variables in this multidim.

Protected Member Functions
void	commitMultipleChanges_ () override
	Synchronize content after MultipleChanges.
GUM_ELEMENT &	get_ (const Instantiation &i) const override
void	replace_ (const DiscreteVariable *x, const DiscreteVariable *y) override
	This is called by MultiDimContainer::replace() to proceed with the replacing between x and y.
const MultiDimImplementation< GUM_ELEMENT > *	content () const final
	Returns the implementation for this object (may be *this).
MultiDimImplementation< GUM_ELEMENT > *	content () final
	Returns the implementation for this object (may be *this).
Fast large modifications in structures
virtual void	commitMultipleChanges_ (const GUM_ELEMENT &value)
	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.
virtual void	invert_ (Idx p1, Idx p2)
	Inverts variables at position p1 and p2.

Private Types
enum class	_InternalChangeMethod_ : char { DIRECT_CHANGE , MULTIPLE_CHANGE }
	Used to represent in which change method this MultiDimImplementation is. More...
enum class	_InternalChangeState_ : char { NO_CHANGE , NOT_COMMITTED_CHANGE }
	Used to represent in which change state this MultiDimImplementation is. More...

Private Member Functions
void	_addVariable_ (const DiscreteVariable *var)
	Add a variable to allVariables, and do nothing if var is already in the set.
void	_eraseVariable_ (const DiscreteVariable *var)
	Erase a variable from allVariables if no other multidimensional table uses it in this bucket.
void	_initializeBuffer_ ()
	Initialize the internal buffer.
void	_eraseBuffer_ ()
	Clean the buffer and switch it's instantiation to this bucket.
GUM_ELEMENT	_computeValue_ (const Instantiation &value) const
	Compute the value of the final table of this bucket given i.
void	_setNotCommitedChange_ ()
	Change the internalChangeState to NOT_COMMITTED_CHANGE.

Private Attributes
Size	_bufferSize_
	The number of element allowed in bucket.
Bijection< Instantiation *, Instantiation * >	_instantiations_
	Bijection between instantiations registered on this and their equivalent on bucket.
MultiDimArray< GUM_ELEMENT > *	_bucket_
	The result table of this bucket.
HashTable< const MultiDimContainer< GUM_ELEMENT > *, Instantiation * >	_multiDims_
	The set of MultiDimContainer in this bucket.
gum::VariableSet	_allVariables_
	The set of all variables of the multidims in this bucket.
Instantiation	_allVarsInst_
	Instantiation over all variable in this.
bool	_changed_
	Flag used to know if changes has occurred in the bucket since last computation.
HashTable< const Instantiation *, GUM_ELEMENT >	_slavesValue_
	This table is used to keep the last value computed for an instantiation when the value are computed on the fly.
std::string	_name_
	The class name.
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<typename GUM_ELEMENT>
class gum::MultiDimBucket< GUM_ELEMENT >

A multidim implementation for buckets.

This class behaves in two different ways, depending on the value of memory allowed and the size of the resulting multidimensional table. If the table is above the allowed amount of memory then value are computed when demanded, having a cache for each registered instantiation to not compute several times in a row the same value.

If the memory allowed is enough to contain the bucket's table, then the resulting table is computed when a value is demanded for the first time.

Since a MultiDimArray is used as a buffer, an instantiation real master will be the internal buffer of a MultiDimBucket. This is why you should always call the Instantiation::isMaster() method with the reference retuned by MultiDimBucket::getMasterRef().

TODO handle slave switch between buffer and hashtable.

Template Parameters

GUM_ELEMENT

The type of scalars stored in this multidimensional table.

Definition at line 90 of file multiDimBucket.h.

Member Enumeration Documentation

_InternalChangeMethod_

template<typename GUM_ELEMENT>

enum class gum::MultiDimImplementation::_InternalChangeMethod_ : char

strongprivateinherited

Used to represent in which change method this MultiDimImplementation is.

Enumerator
DIRECT_CHANGE
MULTIPLE_CHANGE

Definition at line 317 of file multiDimImplementation.h.

: char { DIRECT_CHANGE, MULTIPLE_CHANGE };

_InternalChangeState_

template<typename GUM_ELEMENT>

enum class gum::MultiDimImplementation::_InternalChangeState_ : char

strongprivateinherited

Used to represent in which change state this MultiDimImplementation is.

Enumerator
NO_CHANGE
NOT_COMMITTED_CHANGE

Definition at line 320 of file multiDimImplementation.h.

: char { NO_CHANGE, NOT_COMMITTED_CHANGE };

Constructor & Destructor Documentation

MultiDimBucket() [1/2]

template<typename GUM_SCALAR>

gum::MultiDimBucket< GUM_SCALAR >::MultiDimBucket ( Size bufferSize = INT_MAX )

explicit

Default constructor.

The default amount of memory available for a bucket is 2^16 (65536) elements in the table.

Parameters

bufferSize

The amount of memory allowed for this bucket.

Definition at line 57 of file multiDimBucket_tpl.h.

                                                              :
      MultiDimReadOnly< GUM_SCALAR >(), _bufferSize_(bufferSize), _bucket_(0), _changed_(false),
      _name_("MultiDimBucket") {
    GUM_CONSTRUCTOR(MultiDimBucket);
  }

References MultiDimBucket(), gum::MultiDimReadOnly< GUM_ELEMENT >::MultiDimReadOnly(), _bucket_, _bufferSize_, _changed_, _name_, and bufferSize().

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

Here is the call graph for this function:

Here is the caller graph for this function:

MultiDimBucket() [2/2]

template<typename GUM_ELEMENT>

gum::MultiDimBucket< GUM_ELEMENT >::MultiDimBucket

(

const MultiDimBucket< GUM_ELEMENT > &

source

)

Copy constructor.

Parameters

source

The MultiDimBucket to copy.

References MultiDimBucket().

Here is the call graph for this function:

~MultiDimBucket()

template<typename GUM_SCALAR>

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

override

Destructor.

Definition at line 72 of file multiDimBucket_tpl.h.

                                                {
    GUM_DESTRUCTOR(MultiDimBucket);
    using BiIter = Bijection< Instantiation*, Instantiation* >::iterator_safe;
 
    for (BiIter iter = _instantiations_.beginSafe(); iter != _instantiations_.endSafe(); ++iter) {
      delete iter.second();
    }
 
    if (_bucket_) { delete _bucket_; }
 
    for (HashTableIteratorSafe< const MultiDimContainer< GUM_SCALAR >*, Instantiation* > iter
         = _multiDims_.beginSafe();
         iter != _multiDims_.endSafe();
         ++iter) {
      delete iter.val();
    }
  }

References MultiDimBucket(), _bucket_, _instantiations_, and _multiDims_.

Here is the call graph for this function:

Member Function Documentation

_addVariable_()

template<typename GUM_SCALAR>

void gum::MultiDimBucket< GUM_SCALAR >::_addVariable_ ( const DiscreteVariable * var )

private

Add a variable to allVariables, and do nothing if var is already in the set.

Parameters

var	The DiscreteVariable to add.

Definition at line 419 of file multiDimBucket_tpl.h.

                                                                              {
    try {
      _allVariables_.insert(var);
      _allVarsInst_.add(*var);
    } catch (DuplicateElement const&) {
      // Nothing to do then!
    }
  }

References _allVariables_, and _allVarsInst_.

Referenced by commitMultipleChanges_().

Here is the caller graph for this function:

_computeValue_()

template<typename GUM_SCALAR>

GUM_SCALAR gum::MultiDimBucket< GUM_SCALAR >::_computeValue_ ( const Instantiation & value ) const

private

Compute the value of the final table of this bucket given i.

If i variables are a subset of this bucket, then the missing values are supposed to be at 0.

Parameters

value

The value to compute.

Exceptions

SizeError

Raised if the bucket is empty.

Definition at line 493 of file multiDimBucket_tpl.h.

                                                                                          {
    if (_multiDims_.empty()) { GUM_ERROR(SizeError, "This MultiDimBucket is empty.") }
 
    GUM_SCALAR sum = (GUM_SCALAR)0;
    GUM_SCALAR current;
    _allVarsInst_.setVals(value);
 
    for (_allVarsInst_.setFirstOut(value); !_allVarsInst_.end(); _allVarsInst_.incOut(value)) {
      current = (GUM_SCALAR)1;
 
      for (HashTableIteratorSafe< const MultiDimContainer< GUM_SCALAR >*, Instantiation* > iter
           = _multiDims_.beginSafe();
           iter != _multiDims_.endSafe();
           ++iter) {
        (iter.val())->setVals(_allVarsInst_);
        current *= iter.key()->get(*(iter.val()));
      }
 
      sum += current;
    }
 
    return sum;
  }

References _allVarsInst_, _multiDims_, and GUM_ERROR.

Referenced by compute(), and get().

Here is the caller graph for this function:

_eraseBuffer_()

template<typename GUM_SCALAR>

void gum::MultiDimBucket< GUM_SCALAR >::_eraseBuffer_ ( )

private

Clean the buffer and switch it's instantiation to this bucket.

Definition at line 480 of file multiDimBucket_tpl.h.

                                                   {
    if (_bucket_) {
      for (auto iter = _instantiations_.beginSafe(); iter != _instantiations_.endSafe(); ++iter) {
        delete iter.second();
      }
 
      _instantiations_.clear();
      delete _bucket_;
      _bucket_ = 0;
    }
  }

References _bucket_, and _instantiations_.

Referenced by add(), commitMultipleChanges_(), and setBufferSize().

Here is the caller graph for this function:

_eraseVariable_()

template<typename GUM_SCALAR>

void gum::MultiDimBucket< GUM_SCALAR >::_eraseVariable_ ( const DiscreteVariable * var )

private

Erase a variable from allVariables if no other multidimensional table uses it in this bucket.

Parameters

var	The DiscreteVariable to remove.

Definition at line 429 of file multiDimBucket_tpl.h.

                                                                                {
    bool found = false;
 
    for (HashTableIteratorSafe< const MultiDimContainer< GUM_SCALAR >*, Instantiation* > iter
         = _multiDims_.beginSafe();
         iter != _multiDims_.endSafe();
         ++iter) {
      if (iter.key()->contains(*var)) {
        found = true;
        break;
      }
    }
 
    // No one use it, we can safely remove it
    if (!found) {
      _allVariables_.erase(var);
      _allVarsInst_.erase(*var);
    }
  }

References _allVariables_, _allVarsInst_, and _multiDims_.

_initializeBuffer_()

template<typename GUM_SCALAR>

void gum::MultiDimBucket< GUM_SCALAR >::_initializeBuffer_ ( )

private

Initialize the internal buffer.

This method delete bucket after saving it's slave instantiations.

Definition at line 450 of file multiDimBucket_tpl.h.

                                                        {
    if (_bucket_) {
      for (auto iter = _instantiations_.beginSafe(); iter != _instantiations_.endSafe(); ++iter) {
        delete iter.second();
      }
 
      _instantiations_.clear();
      delete _bucket_;
      _bucket_ = 0;
    }
 
    // Creating the table.
    _bucket_ = new MultiDimArray< GUM_SCALAR >();
 
    for (auto var: this->variablesSequence()) {
      _bucket_->add(*var);
    }
 
    if (!this->slaves_().empty()) {
      for (List< Instantiation* >::const_iterator_safe iter = this->slaves_().cbeginSafe();
           iter != this->slaves_().cendSafe();
           ++iter) {
        _instantiations_.insert(*iter, new Instantiation(*_bucket_));
      }
    }
 
    _changed_ = true;
  }

References _bucket_, _changed_, _instantiations_, gum::MultiDimImplementation< GUM_ELEMENT >::empty(), gum::MultiDimImplementation< GUM_ELEMENT >::slaves_(), and gum::MultiDimImplementation< GUM_ELEMENT >::variablesSequence().

Referenced by add(), commitMultipleChanges_(), erase(), and setBufferSize().

Here is the call graph for this function:

Here is the caller graph for this function:

_setNotCommitedChange_()

template<typename GUM_ELEMENT>

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

privateinherited

Change the internalChangeState to NOT_COMMITTED_CHANGE.

Definition at line 286 of file multiDimImplementation_tpl.h.

                                                                     {
    _internalChangeState_ = _InternalChangeState_::NOT_COMMITTED_CHANGE;
  }

References _internalChangeState_, and NOT_COMMITTED_CHANGE.

add() [1/3]

template<typename GUM_SCALAR>

void gum::MultiDimBucket< GUM_SCALAR >::add ( const DiscreteVariable & v )

overridevirtual

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 192 of file multiDimBucket_tpl.h.

                                                                  {
    MultiDimImplementation< GUM_SCALAR >::add(v);
 
    if (!MultiDimImplementation< GUM_SCALAR >::isInMultipleChangeMethod_()) {
      if (this->domainSize() <= _bufferSize_) {
        if (_bucket_) _bucket_->add(v);
        else _initializeBuffer_();
      } else if (_bucket_) {
        _eraseBuffer_();
      }
    }
  }

References _bucket_, _bufferSize_, _eraseBuffer_(), _initializeBuffer_(), gum::MultiDimImplementation< GUM_ELEMENT >::add(), gum::MultiDimImplementation< GUM_ELEMENT >::domainSize(), and gum::MultiDimImplementation< GUM_ELEMENT >::isInMultipleChangeMethod_().

Here is the call graph for this function:

add() [2/3]

template<typename GUM_ELEMENT>

void gum::MultiDimBucket< GUM_ELEMENT >::add

(

const MultiDimContainer< GUM_ELEMENT > &

impl

)

Add a MultiDimContainer in the bucket.

Parameters

impl	The MultiDimContainer to copy.

Exceptions

DuplicateElement

Raised if impl is already in the bucket.

Referenced by gum::prm::SVE< GUM_SCALAR >::_eliminateDelayedVariables_().

Here is the caller graph for this function:

add() [3/3]

template<typename GUM_ELEMENT>

void gum::MultiDimBucket< GUM_ELEMENT >::add

(

const MultiDimContainer< GUM_ELEMENT > *

impl

)

Add a MultiDimContainer in the bucket.

Parameters

impl	The MultiDimContainer to add.

Exceptions

DuplicateElement

Raised if impl is already in the bucket.

allVariables()

template<typename GUM_SCALAR>

const gum::VariableSet & gum::MultiDimBucket< GUM_SCALAR >::allVariables

(

)

const

Returns the sequence of all the variables contained in the bucket.

Returns

Returns the sequence of all the variables contained in the bucket.

Definition at line 135 of file multiDimBucket_tpl.h.

                                                                         {
    return _allVariables_;
  }

References _allVariables_.

Referenced by gum::prm::SVE< GUM_SCALAR >::_eliminateDelayedVariables_().

Here is the caller graph for this function:

apply()

template<typename GUM_ELEMENT>

void gum::MultiDimContainer< GUM_ELEMENT >::apply ( std::function< GUM_ELEMENT(GUM_ELEMENT) > f ) const

virtualinherited

Apply a function on every element of the container.

Parameters

f	the function to apply

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

Definition at line 200 of file multiDimContainer_tpl.h.

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

References gum::Instantiation::end(), get(), set(), and gum::Instantiation::setFirst().

Here is the call graph for this function:

basename()

template<typename GUM_ELEMENT>

const std::string & gum::MultiDimImplementation< GUM_ELEMENT >::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 298 of file multiDimImplementation_tpl.h.

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

beginMultipleChanges()

template<typename GUM_ELEMENT>

void gum::MultiDimImplementation< GUM_ELEMENT >::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_ELEMENT >.

Definition at line 232 of file multiDimImplementation_tpl.h.

                                                                   {
    _internalChangeMethod_ = _InternalChangeMethod_::MULTIPLE_CHANGE;
  }

References _internalChangeMethod_, and MULTIPLE_CHANGE.

bucket()

template<typename GUM_SCALAR>

const MultiDimArray< GUM_SCALAR > & gum::MultiDimBucket< GUM_SCALAR >::bucket

(

)

const

Returns the MultiDimArray used by this MultiDimBucket.

Returns

Returns the MultiDimArray used by this MultiDimBucket.

Exceptions

OperationNotAllowed

Raised if the bucket has not been built.

Definition at line 523 of file multiDimBucket_tpl.h.

                                                                                {
    if (_bucket_) {
      return *_bucket_;
    } else {
      GUM_ERROR(OperationNotAllowed, "bucket not used.")
    }
  }

References _bucket_, and GUM_ERROR.

bucketChanged()

template<typename GUM_SCALAR>

bool gum::MultiDimBucket< GUM_SCALAR >::bucketChanged

(

)

const

Returns true if the bucket need re-computation since the last computation.

Returns

Returns true if the bucket need re-computation since the last computation.

Definition at line 150 of file multiDimBucket_tpl.h.

                                                         {
    return _changed_;
  }

References _changed_.

bucketSize()

template<typename GUM_SCALAR>

Size gum::MultiDimBucket< GUM_SCALAR >::bucketSize

(

)

const

Returns the number of MultiDimContainer in this bucket.

Returns

Returns the number of MultiDimContainer in this bucket.

Definition at line 140 of file multiDimBucket_tpl.h.

                                                      {
    return _multiDims_.size();
  }

References _multiDims_.

bufferSize()

template<typename GUM_SCALAR>

Size gum::MultiDimBucket< GUM_SCALAR >::bufferSize

(

)

const

Returns the amount of memory allowed for this bucket.

Returns

Returns the amount of memory allowed for this bucket.

Definition at line 155 of file multiDimBucket_tpl.h.

                                                      {
    return _bufferSize_;
  }

References _bufferSize_.

Referenced by MultiDimBucket().

Here is the caller graph for this function:

changeNotification()

template<typename GUM_SCALAR>

void gum::MultiDimBucket< GUM_SCALAR >::changeNotification ( const Instantiation & i, const DiscreteVariable *const var, Idx oldval, Idx newval )

overridevirtual

Listen to changes in a given Instantiation.

Parameters

i	The Instantiation to listen.
var	The changed dim.
oldval	The old value.
newval	The changed value.

Implements gum::MultiDimAdressable.

Definition at line 249 of file multiDimBucket_tpl.h.

                                                                                              {
    if (_bucket_) {
      if (_instantiations_.existsFirst(const_cast< Instantiation* >(&i))) {
        _bucket_->changeNotification(*(_instantiations_).second(const_cast< Instantiation* >(&i)),
                                     var,
                                     oldval,
                                     newval);
      }
      // else i is not a slave of this
    } else {
      _slavesValue_.erase(&i);
    }
  }

References _bucket_, _instantiations_, and _slavesValue_.

commitMultipleChanges_() [1/2]

template<typename GUM_SCALAR>

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

overrideprotectedvirtual

Synchronize content after MultipleChanges.

Reimplemented from gum::MultiDimImplementation< GUM_ELEMENT >.

Definition at line 387 of file multiDimBucket_tpl.h.

                                                            {
    MultiDimImplementation< GUM_SCALAR >::commitMultipleChanges_();
 
    if (this->domainSize() <= _bufferSize_) {
      _initializeBuffer_();
    } else {
      _eraseBuffer_();
    }
 
    _allVariables_.clear();
 
    while (!_allVarsInst_.empty()) {
      _allVarsInst_.erase(**(_allVarsInst_.variablesSequence().beginSafe()));
    }
 
    for (   // HashTableIteratorSafe<const MultiDimContainer<GUM_SCALAR>*,
            // Instantiation*>
        auto iter = _multiDims_.beginSafe(); iter != _multiDims_.endSafe(); ++iter) {
      for (auto var: iter.key()->variablesSequence()) {
        _addVariable_(var);
      }
    }
 
    _changed_ = true;
  }

References _addVariable_(), _allVariables_, _allVarsInst_, _bufferSize_, _changed_, _eraseBuffer_(), _initializeBuffer_(), _multiDims_, gum::MultiDimImplementation< GUM_ELEMENT >::commitMultipleChanges_(), and gum::MultiDimImplementation< GUM_ELEMENT >::domainSize().

Here is the call graph for this function:

commitMultipleChanges_() [2/2]

template<typename GUM_ELEMENT>

void gum::MultiDimImplementation< GUM_ELEMENT >::commitMultipleChanges_ ( const GUM_ELEMENT & value )

protectedvirtualinherited

Synchronize content after MultipleChanges.

Parameters

value

Default value for uninitialized values.

Reimplemented in gum::MultiDimArray< GUM_ELEMENT >.

Definition at line 262 of file multiDimImplementation_tpl.h.

                                                                                       {
    // empty!
  }

compressionRate()

template<typename GUM_ELEMENT>

float gum::MultiDimImplementation< GUM_ELEMENT >::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 292 of file multiDimImplementation_tpl.h.

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

References domainSize(), and realSize().

Here is the call graph for this function:

compute()

template<typename GUM_SCALAR>

void gum::MultiDimBucket< GUM_SCALAR >::compute

(

bool

force = false

)

const

This method computes the final table of this bucket.

A flag is used to prevent unnecessary computation if the table has already been computed.

If the size of the final table is above the amount of authorized memory, an OperationNotAllowed is raised.

Remember that this method is constant because the content of a multidimensional table is mutable.

Parameters

force

If true (default set at false) then the final table is re-computed.

Exceptions

OperationNotAllowed	Raised if the size of the final table is above the authorized amount of memory.
SizeError	Raised if the bucket is empty.

Definition at line 171 of file multiDimBucket_tpl.h.

                                                             {
    if ((_bucket_) && (_changed_ || force)) {
      Instantiation values(*_bucket_);
 
      for (values.setFirst(); !values.end(); values.inc()) {
        _bucket_->set(values, _computeValue_(values));
      }
    } else if ((_bucket_ == 0) && _changed_) {
      _slavesValue_.clear();
      _changed_ = false;
    }
 
    _changed_ = false;
  }

References _bucket_, _changed_, _computeValue_(), _slavesValue_, gum::Instantiation::end(), gum::Instantiation::inc(), and gum::Instantiation::setFirst().

Referenced by get().

Here is the call graph for this function:

Here is the caller graph for this function:

contains() [1/2]

template<typename GUM_SCALAR>

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

overridevirtual

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 225 of file multiDimBucket_tpl.h.

                                                                             {
    return MultiDimImplementation< GUM_SCALAR >::contains(v);
  }

References gum::MultiDimImplementation< GUM_ELEMENT >::contains().

Here is the call graph for this function:

contains() [2/2]

template<typename GUM_ELEMENT>

bool gum::MultiDimBucket< GUM_ELEMENT >::contains

(

const MultiDimContainer< GUM_ELEMENT > &

impl

)

const

Returns true if the MultiDimContainer is in this bucket.

Parameters

impl	The impl to test for existence.

Returns

Returns true if the MultiDimContainer is in this bucket.

content() [1/2]

template<typename GUM_ELEMENT>

const MultiDimImplementation< GUM_ELEMENT > * gum::MultiDimImplementation< GUM_ELEMENT >::content ( ) const

finalprotectedvirtualinherited

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

Implements gum::MultiDimContainer< GUM_ELEMENT >.

Definition at line 335 of file multiDimImplementation_tpl.h.

                                                           {
    return this;
  }

content() [2/2]

template<typename GUM_ELEMENT>

MultiDimImplementation< GUM_ELEMENT > * gum::MultiDimImplementation< GUM_ELEMENT >::content ( )

finalprotectedvirtualinherited

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

Implements gum::MultiDimContainer< GUM_ELEMENT >.

Definition at line 328 of file multiDimImplementation_tpl.h.

                                                                                        {
    return this;
  }

References MultiDimImplementation().

Here is the call graph for this function:

copy()

template<typename GUM_ELEMENT>

void gum::MultiDimContainer< GUM_ELEMENT >::copy ( const MultiDimContainer< GUM_ELEMENT > & src )

virtualinherited

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

Parameters

src	The MultiDimContainer to copy.

Reimplemented in gum::MultiDimFunctionGraph< GUM_ELEMENT, TerminalNodePolicy >, gum::MultiDimFunctionGraph< bool >, gum::MultiDimFunctionGraph< bool, ExactTerminalNodePolicy >, gum::MultiDimFunctionGraph< double >, gum::MultiDimFunctionGraph< double, ExactTerminalNodePolicy >, gum::MultiDimFunctionGraph< gum::ActionSet, gum::SetTerminalNodePolicy >, gum::MultiDimFunctionGraph< GUM_ELEMENT, ExactTerminalNodePolicy >, gum::MultiDimFunctionGraph< Size >, and gum::MultiDimFunctionGraph< Size, ExactTerminalNodePolicy >.

Definition at line 284 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);
  }

References MultiDimContainer(), gum::MultiDimInterface::add(), beginMultipleChanges(), endMultipleChanges(), gum::MultiDimInterface::erase(), gum::MultiDimInterface::nbrDim(), and gum::MultiDimInterface::variable().

Referenced by gum::TreeRegress< GUM_ELEMENT, COMBINEOPERATOR, PROJECTOPERATOR, TerminalNodePolicy >::compute().

Here is the call graph for this function:

Here is the caller graph for this function:

copyFrom() [1/2]

template<typename GUM_ELEMENT>

void gum::MultiDimContainer< GUM_ELEMENT >::copyFrom ( const MultiDimContainer< GUM_ELEMENT > & src ) const

virtualinherited

Basic copy of a MultiDimContainer.

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

Parameters

src	The MultiDimContainer src which values are copied. This is a full copy with no verification of dimensions.

Exceptions

OperationNotAllowed

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

Reimplemented in gum::aggregator::MultiDimAggregator< GUM_ELEMENT >, gum::aggregator::MultiDimAggregator< GUM_SCALAR >, gum::MultiDimArray< GUM_ELEMENT >, gum::MultiDimICIModel< GUM_ELEMENT >, and gum::MultiDimICIModel< GUM_SCALAR >.

Definition at line 266 of file multiDimContainer_tpl.h.

                                                         {
    if (src.domainSize() != domainSize()) {
      GUM_ERROR(OperationNotAllowed,
                "Domain sizes do not fit : " << src.domainSize() << "!=" << domainSize());
    }
 
    Instantiation i_dest(*this);
    Instantiation i_src(src);
 
    for (i_dest.setFirst(), i_src.setFirst(); !i_dest.end(); ++i_dest, ++i_src) {
      set(i_dest, src[i_src]);
    }
  }

References MultiDimContainer(), gum::MultiDimInterface::domainSize(), gum::Instantiation::end(), GUM_ERROR, set(), and gum::Instantiation::setFirst().

Referenced by gum::Tensor< GUM_SCALAR >::Tensor(), gum::MultiDimArray< GUM_ELEMENT >::copyFrom(), and gum::MultiDimICIModel< GUM_SCALAR >::externalWeight().

Here is the call graph for this function:

Here is the caller graph for this function:

copyFrom() [2/2]

template<typename GUM_ELEMENT>

void gum::MultiDimContainer< GUM_ELEMENT >::copyFrom ( const MultiDimContainer< GUM_ELEMENT > & src, Instantiation * p_i ) const

virtualinherited

Basic copy of a MultiDimContainer.

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

Parameters

src	The MultiDimContainer src which values are copied.
p_i	Give the order to iterate in this MultiDimContainer during the copy (nullptr will correctly copy if this is a reorganization of src).

Exceptions

OperationNotAllowed

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

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

Definition at line 220 of file multiDimContainer_tpl.h.

                                                                            {
    if (src.domainSize() != domainSize()) {
      GUM_ERROR(OperationNotAllowed,
                "Domain sizes do not fit : " << src.domainSize() << "!=" << domainSize());
    }
 
    if (p_i == nullptr) {   // if null, we just follow the same order
      Instantiation i(src);
      for (i.setFirst(); !i.end(); ++i) {
        set(i, src[i]);
      }
    } else {
      Instantiation i_dest(*this);
      Instantiation i_src(src);
      for (i_dest.setFirst(), i_src.setFirst(); !i_dest.end(); i_dest.incIn(*p_i), ++i_src) {
        set(i_dest, src[i_src]);
      }
    }
  }

References MultiDimContainer(), gum::MultiDimInterface::domainSize(), gum::Instantiation::end(), GUM_ERROR, and gum::Instantiation::setFirst().

Here is the call graph for this function:

data() [1/2]

template<typename GUM_ELEMENT>

const GUM_ELEMENT * gum::MultiDimImplementation< GUM_ELEMENT >::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.

Reimplemented in gum::MultiDimArray< GUM_ELEMENT >.

Definition at line 340 of file multiDimImplementation_tpl.h.

                                                                                {
    return nullptr;
  }

data() [2/2]

template<typename GUM_ELEMENT>

GUM_ELEMENT * gum::MultiDimImplementation< GUM_ELEMENT >::data ( )

virtualnoexceptinherited

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

Returns

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

Reimplemented in gum::MultiDimArray< GUM_ELEMENT >.

Definition at line 345 of file multiDimImplementation_tpl.h.

                                                                    {
    return nullptr;
  }

domainSize()

template<typename GUM_ELEMENT>

Size gum::MultiDimImplementation< GUM_ELEMENT >::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 187 of file multiDimImplementation_tpl.h.

                                                               {
    return _domainSize_;
  }

References _domainSize_.

Referenced by gum::MultiDimArray< GUM_ELEMENT >::add(), gum::MultiDimBucket< GUM_ELEMENT >::add(), gum::MultiDimWithOffset< GUM_ELEMENT >::add(), gum::MultiDimWithOffset< GUM_ELEMENT >::changeNotification(), gum::MultiDimArray< GUM_ELEMENT >::commitMultipleChanges_(), gum::MultiDimBucket< GUM_ELEMENT >::commitMultipleChanges_(), compressionRate(), gum::MultiDimWithOffset< GUM_ELEMENT >::computeInstantiationValue_(), gum::MultiDimArray< GUM_ELEMENT >::erase(), gum::MultiDimBucket< GUM_ELEMENT >::erase(), gum::MultiDimArray< GUM_ELEMENT >::realSize(), gum::MultiDimBucket< GUM_ELEMENT >::setBufferSize(), gum::MultiDimWithOffset< GUM_ELEMENT >::setIncNotification(), and gum::MultiDimWithOffset< GUM_ELEMENT >::setLastNotification().

Here is the caller graph for this function:

empty()

template<typename GUM_ELEMENT>

bool gum::MultiDimImplementation< GUM_ELEMENT >::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 226 of file multiDimImplementation_tpl.h.

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

References _vars_, and isCommitNeeded_().

Referenced by gum::MultiDimBucket< GUM_ELEMENT >::_initializeBuffer_(), and gum::MultiDimArray< GUM_ELEMENT >::fill().

Here is the call graph for this function:

Here is the caller graph for this function:

endMultipleChanges() [1/2]

template<typename GUM_ELEMENT>

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

overridevirtualinherited

Call this method after doing important changes in this MultiDimContainer.

Implements gum::MultiDimContainer< GUM_ELEMENT >.

Definition at line 237 of file multiDimImplementation_tpl.h.

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

References _internalChangeMethod_, _internalChangeState_, commitMultipleChanges_(), DIRECT_CHANGE, NO_CHANGE, and NOT_COMMITTED_CHANGE.

Here is the call graph for this function:

endMultipleChanges() [2/2]

template<typename GUM_ELEMENT>

void gum::MultiDimImplementation< GUM_ELEMENT >::endMultipleChanges ( const GUM_ELEMENT & v )

overridevirtualinherited

Call this method after doing important changes in this MultiDimContainer.

Implements gum::MultiDimContainer< GUM_ELEMENT >.

Definition at line 247 of file multiDimImplementation_tpl.h.

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

erase() [1/3]

template<typename GUM_SCALAR>

void gum::MultiDimBucket< GUM_SCALAR >::erase ( const DiscreteVariable & v )

overridevirtual

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 206 of file multiDimBucket_tpl.h.

                                                                    {
    MultiDimImplementation< GUM_SCALAR >::erase(v);
 
    if ((!MultiDimImplementation< GUM_SCALAR >::isInMultipleChangeMethod_())
        && (this->domainSize() <= _bufferSize_)) {
      if (_bucket_) {
        _bucket_->erase(v);
      } else {
        _initializeBuffer_();
      }
    }
  }

References _bucket_, _bufferSize_, _initializeBuffer_(), gum::MultiDimImplementation< GUM_ELEMENT >::domainSize(), gum::MultiDimImplementation< GUM_ELEMENT >::erase(), and gum::MultiDimImplementation< GUM_ELEMENT >::isInMultipleChangeMethod_().

Here is the call graph for this function:

erase() [2/3]

template<typename GUM_ELEMENT>

void gum::MultiDimBucket< GUM_ELEMENT >::erase

(

const MultiDimContainer< GUM_ELEMENT > &

impl

)

Remove a MultiDimContainer from this bucket.

Parameters

impl	The MultiDimContainer to remove.

erase() [3/3]

template<typename GUM_ELEMENT>

void gum::MultiDimBucket< GUM_ELEMENT >::erase

(

const MultiDimContainer< GUM_ELEMENT > *

impl

)

Remove a MultiDimContainer from this bucket.

Parameters

impl	The MultiDimContainer to remove.

extractFrom()

template<typename GUM_ELEMENT>

void gum::MultiDimContainer< GUM_ELEMENT >::extractFrom ( const MultiDimContainer< GUM_ELEMENT > & 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 242 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]);
  }

References MultiDimContainer(), beginMultipleChanges(), gum::MultiDimInterface::erase(), gum::MultiDimInterface::nbrDim(), and gum::MultiDimInterface::variable().

Here is the call graph for this function:

fill()

template<typename GUM_ELEMENT>

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

overridevirtualinherited

Warning

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

Implements gum::MultiDimContainer< GUM_ELEMENT >.

Definition at line 87 of file multiDimReadOnly_tpl.h.

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

References GUM_ERROR.

get()

template<typename GUM_SCALAR>

GUM_SCALAR gum::MultiDimBucket< GUM_SCALAR >::get ( const Instantiation & i ) const

overridevirtual

Returns the value pointed by i.

Warning

If i variables set is disjoint with this MultiDimContainer then 0 is assumed for dimensions (i.e. variables) not present in the instantiation.

Parameters

i	An Instantiation of this MultiDimContainer.

Returns

Returns the value pointe by i.

Reimplemented from gum::MultiDimContainer< GUM_ELEMENT >.

Definition at line 230 of file multiDimBucket_tpl.h.

                                                                           {
    compute();
 
    if (_bucket_) {
      if (_instantiations_.existsFirst(const_cast< Instantiation* >(&i))) {
        return _bucket_->get(*(_instantiations_.second(const_cast< Instantiation* >(&i))));
      } else {
        return _bucket_->get(i);
      }
    } else if (i.isMaster(this)) {
      if (!_slavesValue_.exists(&i)) { _slavesValue_.insert(&i, _computeValue_(i)); }
 
      return _slavesValue_[&i];
    } else {
      return _computeValue_(i);
    }
  }

References _bucket_, _computeValue_(), _instantiations_, _slavesValue_, compute(), and gum::Instantiation::isMaster().

Referenced by toString().

Here is the call graph for this function:

Here is the caller graph for this function:

get_()

template<typename GUM_SCALAR>

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

overrideprotectedvirtual

Warning

This will raise en exception, you should directly use the get() and operator[]() methods.

Implements gum::MultiDimContainer< GUM_ELEMENT >.

Definition at line 414 of file multiDimBucket_tpl.h.

                                                                             {
    GUM_ERROR(OperationNotAllowed, "a MultiDimBucket is a read only MultiDim")
  }

References GUM_ERROR.

getMasterRef() [1/2]

template<typename GUM_SCALAR>

const MultiDimAdressable & gum::MultiDimBucket< GUM_SCALAR >::getMasterRef ( ) const

overridevirtual

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.

Definition at line 371 of file multiDimBucket_tpl.h.

                                                                             {
    if (_bucket_) {
      return *_bucket_;
    } else {
      return *this;
    }
  }

References _bucket_.

getMasterRef() [2/2]

template<typename GUM_SCALAR>

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

overridevirtual

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.

Definition at line 362 of file multiDimBucket_tpl.h.

                                                                 {
    if (_bucket_) {
      return *_bucket_;
    } else {
      return *this;
    }
  }

References _bucket_.

invert_()

template<typename GUM_ELEMENT>

void gum::MultiDimImplementation< GUM_ELEMENT >::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 316 of file multiDimImplementation_tpl.h.

                                                                    {
    _vars_.swap(p1, p2);
  }

References _vars_.

isBucketEmpty()

template<typename GUM_SCALAR>

bool gum::MultiDimBucket< GUM_SCALAR >::isBucketEmpty

(

)

const

Returns true if this bucket is empty.

Returns

Returns true if this bucket is empty.

Definition at line 145 of file multiDimBucket_tpl.h.

                                                         {
    return _multiDims_.empty();
  }

References _multiDims_.

isCommitNeeded_()

template<typename GUM_ELEMENT>

bool gum::MultiDimImplementation< GUM_ELEMENT >::isCommitNeeded_ ( ) const

protectedinherited

Get the actual state of *this.

Returns

Returns true if a commit is needed.

Definition at line 274 of file multiDimImplementation_tpl.h.

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

References _internalChangeState_, and NOT_COMMITTED_CHANGE.

Referenced by MultiDimImplementation(), and empty().

Here is the caller graph for this function:

isInMultipleChangeMethod_()

template<typename GUM_ELEMENT>

bool gum::MultiDimImplementation< GUM_ELEMENT >::isInMultipleChangeMethod_ ( ) const

protectedinherited

Get the actual change method of this MultiDimImplementation.

Returns

Returns true if in multiple changes.

Definition at line 268 of file multiDimImplementation_tpl.h.

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

References _internalChangeMethod_, and MULTIPLE_CHANGE.

Referenced by gum::MultiDimArray< GUM_ELEMENT >::add(), gum::MultiDimBucket< GUM_ELEMENT >::add(), gum::MultiDimArray< GUM_ELEMENT >::erase(), and gum::MultiDimBucket< GUM_ELEMENT >::erase().

Here is the caller graph for this function:

multidims()

template<typename GUM_SCALAR>

const HashTable< const MultiDimContainer< GUM_SCALAR > *, Instantiation * > & gum::MultiDimBucket< GUM_SCALAR >::multidims

(

)

const

Returns the MultiDimContainer and their respective Instantiation.

Returns

Returns the MultiDimContainer and their respective Instantiation.

Definition at line 549 of file multiDimBucket_tpl.h.

                                                    {
    return _multiDims_;
  }

References _multiDims_.

name()

template<typename GUM_SCALAR>

const std::string & gum::MultiDimBucket< GUM_SCALAR >::name ( ) const

overridevirtual

Returns the real name of the multiDim implementation.

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.

Returns

Returns the real name of the multiDim implementation

Implements gum::MultiDimImplementation< GUM_ELEMENT >.

Definition at line 187 of file multiDimBucket_tpl.h.

                                                            {
    return _name_;
  }

References _name_.

nbrDim()

template<typename GUM_ELEMENT>

Idx gum::MultiDimImplementation< GUM_ELEMENT >::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 182 of file multiDimImplementation_tpl.h.

                                                          {
    return _vars_.size();
  }

References _vars_.

Referenced by gum::aggregator::MultiDimAggregator< GUM_ELEMENT >::buildValue_(), gum::MultiDimWithOffset< GUM_ELEMENT >::computeInstantiationValue_(), gum::aggregator::MultiDimAggregator< GUM_ELEMENT >::get(), gum::MultiDimICIModel< GUM_ELEMENT >::realSize(), gum::aggregator::MultiDimAggregator< GUM_ELEMENT >::toString(), and gum::MultiDimICIModel< GUM_ELEMENT >::toString().

Here is the caller graph for this function:

newFactory()

template<typename GUM_SCALAR>

MultiDimContainer< GUM_SCALAR > * gum::MultiDimBucket< GUM_SCALAR >::newFactory ( ) const

nodiscardoverridevirtual

Default constructor.

Implements gum::MultiDimReadOnly< GUM_ELEMENT >.

Definition at line 518 of file multiDimBucket_tpl.h.

                                                                                  {
    return new MultiDimBucket< GUM_SCALAR >;
  }

References MultiDimBucket().

Here is the call graph for this function:

operator==()

template<typename GUM_ELEMENT>

bool gum::MultiDimContainer< GUM_ELEMENT >::operator== ( const MultiDimContainer< GUM_ELEMENT > & 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 148 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;
  }

References MultiDimContainer(), gum::MultiDimInterface::domainSize(), gum::MultiDimInterface::nbrDim(), and gum::MultiDimInterface::variablesSequence().

Here is the call graph for this function:

operator[]()

template<typename GUM_ELEMENT>

GUM_ELEMENT gum::MultiDimContainer< GUM_ELEMENT >::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 103 of file multiDimContainer_tpl.h.

                                                                                       {
    return get(i);
  }

References get().

Here is the call graph for this function:

populate() [1/2]

template<typename GUM_ELEMENT>

void gum::MultiDimContainer< GUM_ELEMENT >::populate ( const std::vector< GUM_ELEMENT > & 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::MultiDimBijArray< GUM_ELEMENT >, gum::MultiDimDecorator< GUM_ELEMENT >, gum::MultiDimDecorator< GUM_SCALAR >, gum::MultiDimFunctionGraph< GUM_ELEMENT, TerminalNodePolicy >, gum::MultiDimFunctionGraph< bool >, gum::MultiDimFunctionGraph< bool, ExactTerminalNodePolicy >, gum::MultiDimFunctionGraph< double >, gum::MultiDimFunctionGraph< double, ExactTerminalNodePolicy >, gum::MultiDimFunctionGraph< gum::ActionSet, gum::SetTerminalNodePolicy >, gum::MultiDimFunctionGraph< GUM_ELEMENT, ExactTerminalNodePolicy >, gum::MultiDimFunctionGraph< Size >, and gum::MultiDimFunctionGraph< Size, ExactTerminalNodePolicy >.

Definition at line 172 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]);
  }

Referenced by gum::prm::PRMFactory< GUM_SCALAR >::setRawCPFByLines().

Here is the caller graph for this function:

populate() [2/2]

template<typename GUM_ELEMENT>

void gum::MultiDimContainer< GUM_ELEMENT >::populate ( std::initializer_list< GUM_ELEMENT > 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

l	contains the data.

Exceptions

SizeError

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

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

Definition at line 186 of file multiDimContainer_tpl.h.

                                                                                            {
    if (domainSize() != l.size()) {
      GUM_ERROR(SizeError, "Sizes do not match : " << domainSize() << "!=" << l.size())
    }
 
    Instantiation i(*this);
    // insert all the elements
    for (const auto& elt: l) {
      set(i, elt);
      ++i;
    }
  }

References gum::MultiDimInterface::domainSize(), GUM_ERROR, and set().

Here is the call graph for this function:

pos()

template<typename GUM_ELEMENT>

Idx gum::MultiDimImplementation< GUM_ELEMENT >::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 207 of file multiDimImplementation_tpl.h.

                                                                                {
    return _vars_.pos(&v);
  }

Referenced by gum::MultiDimArray< GUM_ELEMENT >::erase(), and gum::MultiDimWithOffset< GUM_ELEMENT >::erase().

Here is the caller graph for this function:

realSize()

template<typename GUM_SCALAR>

Size gum::MultiDimBucket< GUM_SCALAR >::realSize ( ) const

overridevirtual

Returns the real number of parameters used for this table.

This function is used by the MultiDimImplementation::compressionRate() method.

See also

MultiDimImplementation::compressionRate()

Returns

Returns the real number of parameters used for this table.

Implements gum::MultiDimImplementation< GUM_ELEMENT >.

Definition at line 220 of file multiDimBucket_tpl.h.

                                                    {
    return (_bucket_) ? _bucket_->realSize() : (Size)0;
  }

References _bucket_.

reduce()

template<typename GUM_ELEMENT>

GUM_ELEMENT gum::MultiDimContainer< GUM_ELEMENT >::reduce ( std::function< GUM_ELEMENT(GUM_ELEMENT, GUM_ELEMENT) > f, GUM_ELEMENT base ) const

virtualinherited

compute lfold for this container

Parameters

f	the function to apply
base	the initial value

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

Definition at line 208 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()

template<typename GUM_SCALAR>

bool gum::MultiDimBucket< GUM_SCALAR >::registerSlave ( Instantiation & i )

overridevirtual

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 329 of file multiDimBucket_tpl.h.

                                                                   {
    if (_bucket_) {
      try {
        _instantiations_.insert(&i, new Instantiation(*_bucket_));
      } catch (DuplicateElement const&) { return false; }
    }
 
    return MultiDimImplementation< GUM_SCALAR >::registerSlave(i);
  }

References _bucket_, _instantiations_, and gum::MultiDimImplementation< GUM_ELEMENT >::registerSlave().

Here is the call graph for this function:

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

template<typename GUM_SCALAR>

void gum::MultiDimBucket< GUM_SCALAR >::replace_ ( const DiscreteVariable * x, const DiscreteVariable * y )

overrideprotectedvirtual

This is called by MultiDimContainer::replace() to proceed with the replacing between x and y.

This is called only when everything have been checked.

Parameters

x	The variable to replace in
y	The second variable to swap.

Implements gum::MultiDimInterface.

Definition at line 532 of file multiDimBucket_tpl.h.

                                                                         {
    MultiDimImplementation< GUM_SCALAR >::replace_(x, y);
    for (auto iter = _instantiations_.beginSafe(); iter != _instantiations_.endSafe(); ++iter) {
      iter.first()->replace(*x, *y);
      iter.second()->replace(*x, *y);
    }
 
    if (_bucket_) _bucket_->replace(*x, *y);
 
    _allVariables_.erase(x);
    _allVariables_.insert(y);
    _allVarsInst_.replace(*x, *y);
  }

References _allVariables_, _allVarsInst_, _bucket_, _instantiations_, and gum::MultiDimImplementation< GUM_ELEMENT >::replace_().

Here is the call graph for this function:

set()

template<typename GUM_ELEMENT>

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

overridevirtualinherited

Warning

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

Reimplemented from gum::MultiDimContainer< GUM_ELEMENT >.

Definition at line 79 of file multiDimReadOnly_tpl.h.

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

References GUM_ERROR.

setBufferSize()

template<typename GUM_SCALAR>

void gum::MultiDimBucket< GUM_SCALAR >::setBufferSize

(

Size

amount

)

Changes the amount of memory allowed for this bucket.

If the new amount is not enough for the current size of this bucket, then internal buffer is deleted. In the other case, the internal buffer is created but not computed.

Parameters

amount

The amount of memory allowed for this bucket.

Definition at line 160 of file multiDimBucket_tpl.h.

                                                               {
    _bufferSize_ = ammount;
 
    if ((this->domainSize() > _bufferSize_) && (_bucket_ != 0)) {
      _eraseBuffer_();
    } else if (_bucket_ == 0) {
      _initializeBuffer_();
    }
  }

References _bucket_, _bufferSize_, _eraseBuffer_(), _initializeBuffer_(), and gum::MultiDimImplementation< GUM_ELEMENT >::domainSize().

Here is the call graph for this function:

setChangeNotification()

template<typename GUM_SCALAR>

void gum::MultiDimBucket< GUM_SCALAR >::setChangeNotification ( const Instantiation & i )

overridevirtual

Listen to an assignment of a value in a Instantiation.

Parameters

i	The Instantiation to listen.

Implements gum::MultiDimAdressable.

Definition at line 316 of file multiDimBucket_tpl.h.

                                                                                 {
    if (_bucket_) {
      if (_instantiations_.existsFirst(const_cast< Instantiation* >(&i))) {
        _bucket_->setChangeNotification(
            *(_instantiations_.second(const_cast< Instantiation* >(&i))));
      }
      // else i is not a slave of this
    } else {
      _slavesValue_.erase(&i);
    }
  }

References _bucket_, _instantiations_, and _slavesValue_.

setDecNotification()

template<typename GUM_SCALAR>

void gum::MultiDimBucket< GUM_SCALAR >::setDecNotification ( const Instantiation & i )

overridevirtual

Listen to increment in each recorded Instantiation.

Parameters

i	The Instantiation to listen.

Implements gum::MultiDimAdressable.

Definition at line 304 of file multiDimBucket_tpl.h.

                                                                              {
    if (_bucket_) {
      if (_instantiations_.existsFirst(const_cast< Instantiation* >(&i))) {
        _bucket_->setDecNotification(*(_instantiations_.second(const_cast< Instantiation* >(&i))));
      }
      // else i is not a slave of this
    } else {
      _slavesValue_.erase(&i);
    }
  }

References _bucket_, _instantiations_, and _slavesValue_.

setFirstNotification()

template<typename GUM_SCALAR>

void gum::MultiDimBucket< GUM_SCALAR >::setFirstNotification ( const Instantiation & i )

overridevirtual

Listen to setFirst in a given Instantiation.

Parameters

i	The Instantiation to listen.

Implements gum::MultiDimAdressable.

Definition at line 267 of file multiDimBucket_tpl.h.

                                                                                {
    if (_bucket_) {
      if (_instantiations_.existsFirst(const_cast< Instantiation* >(&i))) {
        _bucket_->setFirstNotification(
            *(_instantiations_).second(const_cast< Instantiation* >(&i)));
      }
      // else i is not a slave of this
    } else {
      _slavesValue_.erase(&i);
    }
  }

References _bucket_, _instantiations_, and _slavesValue_.

setIncNotification()

template<typename GUM_SCALAR>

void gum::MultiDimBucket< GUM_SCALAR >::setIncNotification ( const Instantiation & i )

overridevirtual

Listen to increment in a given Instantiation.

Parameters

i	The Instantiation to listen.

Implements gum::MultiDimAdressable.

Definition at line 292 of file multiDimBucket_tpl.h.

                                                                              {
    if (_bucket_) {
      if (_instantiations_.existsFirst(const_cast< Instantiation* >(&i))) {
        _bucket_->setIncNotification(*(_instantiations_.second(const_cast< Instantiation* >(&i))));
      }
      // else i is not a slave of this
    } else {
      _slavesValue_.erase(&i);
    }
  }

References _bucket_, _instantiations_, and _slavesValue_.

setLastNotification()

template<typename GUM_SCALAR>

void gum::MultiDimBucket< GUM_SCALAR >::setLastNotification ( const Instantiation & i )

overridevirtual

Listen to setLast in a given Instantiation.

Parameters

i	The Instantiation to listen.

Implements gum::MultiDimAdressable.

Definition at line 280 of file multiDimBucket_tpl.h.

                                                                               {
    if (_bucket_) {
      if (_instantiations_.existsFirst(const_cast< Instantiation* >(&i))) {
        _bucket_->setLastNotification(*(_instantiations_).second(const_cast< Instantiation* >(&i)));
      }
      // else i is not a slave of this
    } else {
      _slavesValue_.erase(&i);
    }
  }

References _bucket_, _instantiations_, and _slavesValue_.

slaves_()

template<typename GUM_ELEMENT>

const List< Instantiation * > & gum::MultiDimImplementation< GUM_ELEMENT >::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 280 of file multiDimImplementation_tpl.h.

                                                                                     {
    return _slaveInstantiations_;
  }

References _slaveInstantiations_.

Referenced by gum::MultiDimBucket< GUM_ELEMENT >::_initializeBuffer_().

Here is the caller graph for this function:

toString() [1/2]

template<typename GUM_SCALAR>

std::string gum::MultiDimBucket< GUM_SCALAR >::toString ( const Instantiation * i ) const

overridevirtual

Display the internal representation of i.

Returns

Returns an internal representation of i.

Implements gum::MultiDimContainer< GUM_ELEMENT >.

Definition at line 380 of file multiDimBucket_tpl.h.

                                                                               {
    std::stringstream sBuff;
    sBuff << (*i) << " = " << get(*i);
    return sBuff.str();
  }

References get().

Here is the call graph for this function:

toString() [2/2]

template<typename GUM_ELEMENT>

std::string gum::MultiDimContainer< GUM_ELEMENT >::toString ( ) const

virtualinherited

Returns a representation of this MultiDimContainer.

Returns

Returns a representation of this MultiDimContainer.

Reimplemented in gum::aggregator::MultiDimAggregator< GUM_ELEMENT >, gum::aggregator::MultiDimAggregator< GUM_SCALAR >, gum::MultiDimDecorator< GUM_ELEMENT >, gum::MultiDimICIModel< GUM_ELEMENT >, gum::MultiDimICIModel< GUM_SCALAR >, gum::MultiDimLogit< GUM_SCALAR >, gum::MultiDimNoisyAND< GUM_SCALAR >, gum::MultiDimNoisyORCompound< GUM_SCALAR >, gum::MultiDimNoisyORNet< GUM_SCALAR >, gum::Tensor< GUM_SCALAR >, and gum::Tensor< GUM_ELEMENT >.

Definition at line 125 of file multiDimContainer_tpl.h.

                                                             {
    // we create a new instantiation and iterate over it to display the whole
    // content of the array
    if (this->nbrDim() == 0) { return "[]"; }
 
    std::stringstream ss;
    Instantiation     inst(const_cast< MultiDimContainer* >(this));
 
    bool first = true;
 
    for (inst.setFirst(); !inst.end(); ++inst) {
      if (!first) { ss << " /"; }
      first = false;
 
      ss << inst << " :: " << get(inst);
    }
 
    return ss.str();
  }

References gum::MultiDimInterface::nbrDim().

Referenced by gum::MultiDimContainer< double >::copy().

Here is the call graph for this function:

Here is the caller graph for this function:

unregisterSlave()

template<typename GUM_SCALAR>

bool gum::MultiDimBucket< GUM_SCALAR >::unregisterSlave ( Instantiation & i )

overridevirtual

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 340 of file multiDimBucket_tpl.h.

                                                                     {
    MultiDimReadOnly< GUM_SCALAR >::unregisterSlave(i);
 
    if (_bucket_) {
      if (_instantiations_.existsFirst(&i)) {
        delete _instantiations_.second(&i);
        _instantiations_.eraseFirst(&i);
        return true;
      } else {
        return false;
      }
    } else {
      if (_slavesValue_.exists(&i)) {
        _slavesValue_.erase(&i);
        return true;
      } else {
        return false;
      }
    }
  }

References _bucket_, _instantiations_, _slavesValue_, and gum::MultiDimAdressable::unregisterSlave().

Here is the call graph for this function:

variable() [1/2]

template<typename GUM_ELEMENT>

const DiscreteVariable & gum::MultiDimImplementation< GUM_ELEMENT >::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 192 of file multiDimImplementation_tpl.h.

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

Referenced by gum::aggregator::MultiDimAggregator< GUM_ELEMENT >::buildValue_(), gum::MultiDimWithOffset< GUM_ELEMENT >::computeInstantiationValue_(), gum::aggregator::MultiDimAggregator< GUM_ELEMENT >::get(), gum::aggregator::MultiDimAggregator< GUM_ELEMENT >::toString(), gum::MultiDimICIModel< GUM_ELEMENT >::toString(), gum::MultiDimNoisyAND< GUM_SCALAR >::toString(), gum::MultiDimNoisyORCompound< GUM_SCALAR >::toString(), and gum::MultiDimNoisyORNet< GUM_SCALAR >::toString().

Here is the caller graph for this function:

variable() [2/2]

template<typename GUM_ELEMENT>

const DiscreteVariable & gum::MultiDimImplementation< GUM_ELEMENT >::variable ( std::string_view name ) const

overridevirtualinherited

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.

Implements gum::MultiDimInterface.

Definition at line 198 of file multiDimImplementation_tpl.h.

                                                                               {
    for (const auto& v: _vars_) {
      if (v->name() == name) return *v;
    }
 
    GUM_ERROR(NotFound, "'" << name << "' can not be found in the multidim structure.")
  }

References name().

Here is the call graph for this function:

variablesSequence()

template<typename GUM_ELEMENT>

const Sequence< const DiscreteVariable * > & gum::MultiDimImplementation< GUM_ELEMENT >::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 220 of file multiDimImplementation_tpl.h.

                                                                     {
    return _vars_;
  }

References _vars_.

Referenced by gum::MultiDimBijArray< GUM_ELEMENT >::MultiDimBijArray(), gum::MultiDimBijArray< GUM_ELEMENT >::MultiDimBijArray(), gum::MultiDimBijArray< GUM_ELEMENT >::MultiDimBijArray(), gum::MultiDimFunctionGraphOperator< GUM_ELEMENT, FUNCTOR, TerminalNodePolicy >::_distance_(), gum::MultiDimFunctionGraphOperator< GUM_ELEMENT, FUNCTOR, TerminalNodePolicy >::_findRetrogradeVariables_(), gum::Regress< GUM_ELEMENT, COMBINEOPERATOR, PROJECTOPERATOR, TerminalNodePolicy >::_findRetrogradeVariables_(), gum::MultiDimBucket< GUM_ELEMENT >::_initializeBuffer_(), gum::MultiDimFunctionGraph< GUM_ELEMENT, TerminalNodePolicy >::add(), gum::MultiDimFunctionGraph< GUM_ELEMENT, TerminalNodePolicy >::clear(), gum::prm::copyTensor(), gum::MultiDimArray< GUM_ELEMENT >::erase(), gum::MultiDimWithOffset< GUM_ELEMENT >::erase(), gum::MultiDimFunctionGraphGenerator::generate(), gum::MDDOperatorStrategy< GUM_ELEMENT >::lastVar_(), gum::StructuredPlaner< GUM_ELEMENT >::makeArgMax_(), gum::TreeOperatorStrategy< GUM_ELEMENT >::regress(), and gum::MultiDimFunctionGraph< GUM_ELEMENT, TerminalNodePolicy >::varNodeListe().

Here is the caller graph for this function:

Member Data Documentation

_allVariables_

template<typename GUM_ELEMENT>

gum::VariableSet gum::MultiDimBucket< GUM_ELEMENT >::_allVariables_

private

The set of all variables of the multidims in this bucket.

Definition at line 309 of file multiDimBucket.h.

Referenced by _addVariable_(), _eraseVariable_(), allVariables(), commitMultipleChanges_(), and replace_().

_allVarsInst_

template<typename GUM_ELEMENT>

Instantiation gum::MultiDimBucket< GUM_ELEMENT >::_allVarsInst_

mutableprivate

Instantiation over all variable in this.

Definition at line 312 of file multiDimBucket.h.

Referenced by _addVariable_(), _computeValue_(), _eraseVariable_(), commitMultipleChanges_(), and replace_().

_bucket_

template<typename GUM_ELEMENT>

MultiDimArray< GUM_ELEMENT >* gum::MultiDimBucket< GUM_ELEMENT >::_bucket_

private

The result table of this bucket.

Definition at line 303 of file multiDimBucket.h.

Referenced by MultiDimBucket(), ~MultiDimBucket(), _eraseBuffer_(), _initializeBuffer_(), add(), bucket(), changeNotification(), compute(), erase(), get(), getMasterRef(), getMasterRef(), realSize(), registerSlave(), replace_(), setBufferSize(), setChangeNotification(), setDecNotification(), setFirstNotification(), setIncNotification(), setLastNotification(), and unregisterSlave().

_bufferSize_

template<typename GUM_ELEMENT>

Size gum::MultiDimBucket< GUM_ELEMENT >::_bufferSize_

private

The number of element allowed in bucket.

Definition at line 296 of file multiDimBucket.h.

Referenced by MultiDimBucket(), add(), bufferSize(), commitMultipleChanges_(), erase(), and setBufferSize().

_changed_

template<typename GUM_ELEMENT>

bool gum::MultiDimBucket< GUM_ELEMENT >::_changed_

mutableprivate

Flag used to know if changes has occurred in the bucket since last computation.

Definition at line 355 of file multiDimBucket.h.

Referenced by MultiDimBucket(), _initializeBuffer_(), bucketChanged(), commitMultipleChanges_(), and compute().

_domainSize_

template<typename GUM_ELEMENT>

Size gum::MultiDimImplementation< GUM_ELEMENT >::_domainSize_

privateinherited

This MultiDimImplementation domain size.

Definition at line 329 of file multiDimImplementation.h.

Referenced by MultiDimImplementation(), MultiDimImplementation(), domainSize(), and erase().

_instantiations_

template<typename GUM_ELEMENT>

Bijection< Instantiation*, Instantiation* > gum::MultiDimBucket< GUM_ELEMENT >::_instantiations_

private

Bijection between instantiations registered on this and their equivalent on bucket.

Definition at line 300 of file multiDimBucket.h.

Referenced by ~MultiDimBucket(), _eraseBuffer_(), _initializeBuffer_(), changeNotification(), get(), registerSlave(), replace_(), setChangeNotification(), setDecNotification(), setFirstNotification(), setIncNotification(), setLastNotification(), and unregisterSlave().

_internalChangeMethod_

template<typename GUM_ELEMENT>

_InternalChangeMethod_ gum::MultiDimImplementation< GUM_ELEMENT >::_internalChangeMethod_

privateinherited

The current change method.

Definition at line 323 of file multiDimImplementation.h.

Referenced by MultiDimImplementation(), MultiDimImplementation(), beginMultipleChanges(), endMultipleChanges(), and isInMultipleChangeMethod_().

_internalChangeState_

template<typename GUM_ELEMENT>

_InternalChangeState_ gum::MultiDimImplementation< GUM_ELEMENT >::_internalChangeState_

privateinherited

The current change state.

Definition at line 326 of file multiDimImplementation.h.

Referenced by MultiDimImplementation(), MultiDimImplementation(), _setNotCommitedChange_(), endMultipleChanges(), and isCommitNeeded_().

_multiDims_

template<typename GUM_ELEMENT>

HashTable< const MultiDimContainer< GUM_ELEMENT >*, Instantiation* > gum::MultiDimBucket< GUM_ELEMENT >::_multiDims_

mutableprivate

The set of MultiDimContainer in this bucket.

Definition at line 306 of file multiDimBucket.h.

Referenced by ~MultiDimBucket(), _computeValue_(), _eraseVariable_(), bucketSize(), commitMultipleChanges_(), isBucketEmpty(), and multidims().

_name_

template<typename GUM_ELEMENT>

std::string gum::MultiDimBucket< GUM_ELEMENT >::_name_

private

The class name.

Definition at line 362 of file multiDimBucket.h.

Referenced by MultiDimBucket(), and name().

_slaveInstantiations_

template<typename GUM_ELEMENT>

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

privateinherited

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

Definition at line 314 of file multiDimImplementation.h.

Referenced by MultiDimImplementation(), ~MultiDimImplementation(), slaves_(), and unregisterSlave().

_slavesValue_

template<typename GUM_ELEMENT>

HashTable< const Instantiation*, GUM_ELEMENT > gum::MultiDimBucket< GUM_ELEMENT >::_slavesValue_

mutableprivate

This table is used to keep the last value computed for an instantiation when the value are computed on the fly.

Definition at line 359 of file multiDimBucket.h.

Referenced by changeNotification(), compute(), get(), setChangeNotification(), setDecNotification(), setFirstNotification(), setIncNotification(), setLastNotification(), and unregisterSlave().

_vars_

template<typename GUM_ELEMENT>

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

privateinherited

List of discrete variables (dimensions).

Definition at line 311 of file multiDimImplementation.h.

Referenced by MultiDimImplementation(), MultiDimImplementation(), add(), contains(), empty(), erase(), invert_(), nbrDim(), registerSlave(), replace_(), and variablesSequence().

---

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

• agrum/base/multidim/implementations/multiDimBucket.h
• agrum/base/multidim/implementations/multiDimBucket_tpl.h