gum::MultiDimBucket< GUM_SCALAR > Class Template Reference

A multidim implementation for buckets. More...

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

Inheritance diagram for gum::MultiDimBucket< GUM_SCALAR >:

Collaboration diagram for gum::MultiDimBucket< GUM_SCALAR >:

Public Member Functions
const HashTable< const MultiDimContainer< GUM_SCALAR > *, Instantiation *> &	multidims () const
	Returns the MultiDimContainer and their respective Instantiation. More...
Constructor & destructor.
	MultiDimBucket (Size bufferSize=INT_MAX)
	Default constructor. More...
	MultiDimBucket (const MultiDimBucket< GUM_SCALAR > &source)
	Copy constructor. More...
virtual	~MultiDimBucket ()
	Destructor. More...
Bucket methods
void	add (const MultiDimContainer< GUM_SCALAR > &impl)
	Add a MultiDimContainer in the bucket. More...
void	add (const MultiDimContainer< GUM_SCALAR > *impl)
	Add a MultiDimContainer in the bucket. More...
void	erase (const MultiDimContainer< GUM_SCALAR > &impl)
	Remove a MultiDimContainer from this bucket. More...
void	erase (const MultiDimContainer< GUM_SCALAR > *impl)
	Remove a MultiDimContainer from this bucket. More...
bool	contains (const MultiDimContainer< GUM_SCALAR > &impl) const
	Returns true if the MultiDimContainer is in this bucket. More...
const Set< const DiscreteVariable *> &	allVariables () const
	Returns the sequence of all the variables contained in the bucket. More...
Size	bucketSize () const
	Returns the number of MultiDimContainer in in this bukcet. More...
bool	isBucketEmpty () const
	Returns true if this bucket is empty. More...
bool	bucketChanged () const
	Returns true if the bucket need re-computation since the last computation. More...
const MultiDimArray< GUM_SCALAR > &	bucket () const
	Returns the MultiDimArray used by this MultiDimBucket. More...
Size	bufferSize () const
	Returns the amount of memory allowed for this bucket. More...
void	setBufferSize (Size amount)
	Changes the amount of memory allowed for this bucket. More...
void	compute (bool force=false) const
	This method computes the final table of this bucket. More...
Inherited methods
virtual MultiDimContainer< GUM_SCALAR > *	newFactory () const override
	Default constructor. More...
const std::string &	name () const override
	Returns the real name of the multiDim implementation. More...
virtual void	add (const DiscreteVariable &v) override
	Adds a new var to the variables of the multidimensional matrix. More...
virtual void	erase (const DiscreteVariable &v) override
	Removes a var from the variables of the multidimensional matrix. More...
virtual Size	realSize () const override
	Returns the real number of parameters used for this table. More...
bool	contains (const DiscreteVariable &v) const override
	Returns true if var is in *this. More...
virtual GUM_SCALAR	get (const Instantiation &i) const override
	Returns the value pointed by i. More...
virtual void	changeNotification (const Instantiation &i, const DiscreteVariable *const var, Idx oldval, Idx newval) override
	Listen to changes in a given Instantiation. More...
virtual void	setFirstNotification (const Instantiation &i) override
	Listen to setFirst in a given Instantiation. More...
virtual void	setLastNotification (const Instantiation &i) override
	Listen to setLast in a given Instantiation. More...
virtual void	setIncNotification (const Instantiation &i) override
	Listen to increment in a given Instantiation. More...
virtual void	setDecNotification (const Instantiation &i) override
	Listen to increment in each recorded Instantiation. More...
virtual void	setChangeNotification (const Instantiation &i) override
	Listen to an assignment of a value in a Instantiation. More...
virtual bool	registerSlave (Instantiation &i) override
	Register i as a slave of this MultiDimAdressable. More...
virtual bool	unregisterSlave (Instantiation &i) override
	Unregister i as a slave of this MultiDimAdressable. More...
virtual MultiDimAdressable &	getMasterRef () override
	In order to insure the dereference for decorators, we need to virtualize the access to master pointer. More...
virtual const MultiDimAdressable &	getMasterRef () const override
	In order to insure the dereference for decorators, we need to virtualize the access to master pointer. More...
virtual std::string	toString (const Instantiation *i) const override
	Display the internal representation of i. More...
Accessors / Modifiers
virtual void	set (const Instantiation &i, const GUM_SCALAR &value) const
virtual void	fill (const GUM_SCALAR &) const
Accessors / Modifiers
const std::string &	basename () const
	Returns the base class name of this MultiDimImplementation. More...
float	compressionRate () const
	The compression ratio of the table (depending on the type of implementation). More...
MultiDimInterface implementation
virtual Idx	nbrDim () const override
	Returns the number of vars in the multidimensional container. More...
virtual Size	domainSize () const override
	Returns the product of the variables domain size. More...
virtual const Sequence< const DiscreteVariable *> &	variablesSequence () const override
	Returns a const ref to the sequence of DiscreteVariable*. More...
const DiscreteVariable &	variable (Idx i) const override
	Returns a const ref to the ith var. More...
const DiscreteVariable &	variable (const std::string &name) const override
	Returns the variable with the name. More...
virtual Idx	pos (const DiscreteVariable &v) const override
	Returns the index of a variable. More...
virtual bool	empty () const override
	Returns true if no var is in *this. More...
MultiDimContainer implementation
void	beginMultipleChanges () override
	Call this method before doing important changes in this MultiDimContainer. More...
void	endMultipleChanges () override
	Call this method after doing important changes in this MultiDimContainer. More...
void	endMultipleChanges (const GUM_SCALAR &) override
	Call this method after doing important changes in this MultiDimContainer. More...
Accessors / Modifiers
GUM_SCALAR	operator[] (const Instantiation &i) const
	An [] operator using a Instantiation as argument. More...
virtual void	populate (const std::vector< GUM_SCALAR > &v) const
	Automatically fills this MultiDimContainer with the values in v. More...
virtual void	populate (std::initializer_list< GUM_SCALAR > l) const
	Automatically fills this MultiDimContainer with the values in l. More...
Copy methods.
virtual void	copyFrom (const MultiDimContainer< GUM_SCALAR > &src) const
	Basic copy of a MultiDimContainer. More...
virtual void	copyFrom (const MultiDimContainer< GUM_SCALAR > &src, Instantiation *p_i) const
	Basic copy of a MultiDimContainer. More...
virtual void	extractFrom (const MultiDimContainer< GUM_SCALAR > &src, const Instantiation &mask)
	Basic extraction of a MultiDimContainer. More...
virtual void	copy (const MultiDimContainer< GUM_SCALAR > &src)
	Removes all variables in this MultiDimContainer and copy the content of src, variables included. More...
Various methods.
virtual std::string	toString () const
	Returns a representation of this MultiDimContainer. More...
bool	operator== (const MultiDimContainer< GUM_SCALAR > &p) const
	Test if this MultiDimContainer is equal to p. More...
bool	operator!= (const MultiDimContainer< GUM_SCALAR > &p) const
	Test if this MultiDimContainer is different of p. More...
virtual void	apply (std::function< GUM_SCALAR(GUM_SCALAR) > f) const
	Apply a function on every element of the container. More...
virtual GUM_SCALAR	reduce (std::function< GUM_SCALAR(GUM_SCALAR, GUM_SCALAR) > f, GUM_SCALAR base) const
	compute lfold for this container More...
Accessors / Modifiers
void	replace (const DiscreteVariable &x, const DiscreteVariable &y)
	Replace variables in this multidim. More...

Protected Member Functions
virtual void	commitMultipleChanges_ () override
	Synchronize content after MultipleChanges. More...
virtual GUM_SCALAR &	get_ (const Instantiation &i) const override
virtual void	replace_ (const DiscreteVariable *x, const DiscreteVariable *y) override
	Replace variable x by y. More...
virtual const MultiDimImplementation< GUM_SCALAR > *	content () const final
	Returns the implementation for this object (may be *this). More...
virtual MultiDimImplementation< GUM_SCALAR > *	content () final
	Returns the implementation for this object (may be *this). More...
Fast large modifications in structures
virtual void	commitMultipleChanges_ (const GUM_SCALAR &value)
	Synchronize content after MultipleChanges. More...
bool	isInMultipleChangeMethod_ () const
	Get the actual change method of this MultiDimImplementation. More...
bool	isCommitNeeded_ () const
	Get the actual state of *this. More...
const List< Instantiation *> &	slaves_ () const
	Returns a constant reference over the list of slaved instantiations. More...
virtual void	invert_ (Idx p1, Idx p2)
	Inverts variables at position p1 and p2. More...

Detailed Description

template<typename GUM_SCALAR>
class gum::MultiDimBucket< GUM_SCALAR >

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_SCALAR

The type of scalars stored in this multidimensional table.

Definition at line 74 of file multiDimBucket.h.

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

                                                              :
      MultiDimReadOnly< GUM_SCALAR >(), bufferSize__(bufferSize), bucket__(0),
      changed__(false), name__("MultiDimBucket") {
    GUM_CONSTRUCTOR(MultiDimBucket);
  }

MultiDimBucket() [2/2]

template<typename GUM_SCALAR >

gum::MultiDimBucket< GUM_SCALAR >::MultiDimBucket

(

const MultiDimBucket< GUM_SCALAR > &

source

)

Copy constructor.

Parameters

source

The MultiDimBucket to copy.

Definition at line 42 of file multiDimBucket_tpl.h.

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

                                                 :
      MultiDimReadOnly< GUM_SCALAR >(source),
      bufferSize__(source.bufferSize__), bucket__(0),
      multiDims__(source.multiDims__), allVariables__(source.allVariables__),
      allVarsInst__(source.allVarsInst__), changed__(source.changed__),
      name__("MultiDimBucket") {
    GUM_CONS_CPY(MultiDimBucket);
  }

Here is the call graph for this function:

~MultiDimBucket()

template<typename GUM_SCALAR >

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

virtual

Destructor.

Definition at line 53 of file multiDimBucket_tpl.h.

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

                                                {
    GUM_DESTRUCTOR(MultiDimBucket);
    typedef Bijection< Instantiation*, Instantiation* >::iterator_safe BiIter;

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

Here is the call graph for this function:

Member Function Documentation

add() [1/3]

template<typename GUM_SCALAR >

INLINE void gum::MultiDimBucket< GUM_SCALAR >::add

(

const MultiDimContainer< GUM_SCALAR > &

impl

)

Add a MultiDimContainer in the bucket.

Parameters

impl	The MultiDimContainer to copy.

Exceptions

DuplicateElement

Raised if impl is already in the bucket.

Definition at line 75 of file multiDimBucket_tpl.h.

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

                                                  {
    this->add(&impl);
  }

Here is the call graph for this function:

add() [2/3]

template<typename GUM_SCALAR >

void gum::MultiDimBucket< GUM_SCALAR >::add

(

const MultiDimContainer< GUM_SCALAR > *

impl

)

Add a MultiDimContainer in the bucket.

Parameters

impl	The MultiDimContainer to add.

Exceptions

DuplicateElement

Raised if impl is already in the bucket.

Definition at line 81 of file multiDimBucket_tpl.h.

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

                                                  {
    multiDims__.insert(impl, new Instantiation(*impl));

    if (!MultiDimImplementation< GUM_SCALAR >::isInMultipleChangeMethod_()) {
      for (const auto var: impl->variablesSequence()) {
        addVariable__(var);
      }
    }

    changed__ = true;
  }

Here is the call graph for this function:

add() [3/3]

template<typename GUM_SCALAR >

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

Reimplemented from gum::MultiDimImplementation< GUM_SCALAR >.

Definition at line 184 of file multiDimBucket_tpl.h.

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

                                                                         {
    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__();
      }
    }
  }

Here is the call graph for this function:

addVariable__()

template<typename GUM_SCALAR >

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

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

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

Here is the call graph for this function:

allVariables()

template<typename GUM_SCALAR >

INLINE const Set< const DiscreteVariable *> & 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 127 of file multiDimBucket_tpl.h.

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

                                                                {
    return allVariables__;
  }

Here is the call graph for this function:

apply()

template<typename GUM_SCALAR >

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

virtualinherited

Apply a function on every element of the container.

Parameters

f	the function to apply

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

Definition at line 199 of file multiDimContainer_tpl.h.

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

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

Here is the call graph for this function:

basename()

template<typename GUM_SCALAR >

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

inherited

Returns the base class name of this MultiDimImplementation.

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

Definition at line 295 of file multiDimImplementation_tpl.h.

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

beginMultipleChanges()

template<typename GUM_SCALAR >

INLINE void gum::MultiDimImplementation< GUM_SCALAR >::beginMultipleChanges ( )

overridevirtualinherited

Call this method before doing important changes in this MultiDimContainer.

Warning

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

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 225 of file multiDimImplementation_tpl.h.

                                                                         {
    internalChangeMethod__ = InternalChangeMethod__::MULTIPLE_CHANGE;
  }

bucket()

template<typename GUM_SCALAR >

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

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

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

Here is the call graph for this function:

bucketChanged()

template<typename GUM_SCALAR >

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

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

                                                                {
    return changed__;
  }

Here is the call graph for this function:

bucketSize()

template<typename GUM_SCALAR >

INLINE Size gum::MultiDimBucket< GUM_SCALAR >::bucketSize

(

)

const

Returns the number of MultiDimContainer in in this bukcet.

Returns

Returns the number of MultiDimContainer in in this bukcet.

Definition at line 132 of file multiDimBucket_tpl.h.

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

                                                             {
    return multiDims__.size();
  }

Here is the call graph for this function:

bufferSize()

template<typename GUM_SCALAR >

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

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

                                                             {
    return bufferSize__;
  }

Here is the call graph for this function:

changeNotification()

template<typename GUM_SCALAR >

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

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

                                           {
    if (bucket__) {
      try {
        bucket__->changeNotification(
           *(instantiations__).second(const_cast< Instantiation* >(&i)),
           var,
           oldval,
           newval);
      } catch (NotFound&) {
        // Then i is not a slave of this
      }
    } else {
      slavesValue__.erase(&i);
    }
  }

Here is the call graph for this function:

commitMultipleChanges_() [1/2]

template<typename GUM_SCALAR>

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

protectedvirtualinherited

Synchronize content after MultipleChanges.

Parameters

value

Default value for uninitialized values.

Reimplemented in gum::MultiDimArray< GUM_SCALAR >.

Definition at line 256 of file multiDimImplementation_tpl.h.

                        {
    // empty!
  }

commitMultipleChanges_() [2/2]

template<typename GUM_SCALAR >

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

overrideprotectedvirtual

Synchronize content after MultipleChanges.

Reimplemented from gum::MultiDimImplementation< GUM_SCALAR >.

Definition at line 400 of file multiDimBucket_tpl.h.

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

                                                            {
    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;
  }

Here is the call graph for this function:

compressionRate()

template<typename GUM_SCALAR >

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

inherited

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

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

Warning

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

Returns

Returns the compression ration of the table.

Definition at line 289 of file multiDimImplementation_tpl.h.

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

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

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

                                                             {
    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;
  }

Here is the call 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 519 of file multiDimBucket_tpl.h.

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

                                       {
    try {
      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;
    } catch (NotFound& e) {
      std::cerr << std::endl << e.errorContent() << std::endl;
      // This happens if the bucket is empty.
      GUM_ERROR(SizeError, "This MultiDimBucket is empty.");
    }
  }

Here is the call graph for this function:

contains() [1/2]

template<typename GUM_SCALAR >

INLINE bool gum::MultiDimBucket< GUM_SCALAR >::contains

(

const MultiDimContainer< GUM_SCALAR > &

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.

Definition at line 120 of file multiDimBucket_tpl.h.

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

                                                        {
    return multiDims__.exists(&impl);
  }

Here is the call graph for this function:

contains() [2/2]

template<typename GUM_SCALAR >

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

Reimplemented from gum::MultiDimImplementation< GUM_SCALAR >.

Definition at line 220 of file multiDimBucket_tpl.h.

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

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

Here is the call graph for this function:

content() [1/2]

template<typename GUM_SCALAR >

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

finalprotectedvirtualinherited

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

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 338 of file multiDimImplementation_tpl.h.

                                                                   {
    return this;
  }

content() [2/2]

template<typename GUM_SCALAR >

INLINE MultiDimImplementation< GUM_SCALAR > * gum::MultiDimImplementation< GUM_SCALAR >::content ( )

finalprotectedvirtualinherited

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

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 331 of file multiDimImplementation_tpl.h.

                                                       {
    return this;
  }

copy()

template<typename GUM_SCALAR >

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

virtualinherited

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

Parameters

src	The MultiDimContainer to copy.

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

Definition at line 290 of file multiDimContainer_tpl.h.

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

                                                 {
    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);
  }

Here is the call graph for this function:

copyFrom() [1/2]

template<typename GUM_SCALAR >

void gum::MultiDimContainer< GUM_SCALAR >::copyFrom ( const MultiDimContainer< GUM_SCALAR > &  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_SCALAR >, gum::MultiDimICIModel< GUM_SCALAR >, and gum::MultiDimArray< GUM_SCALAR >.

Definition at line 271 of file multiDimContainer_tpl.h.

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

                                                       {
    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]);
    }
  }

Here is the call graph for this function:

copyFrom() [2/2]

template<typename GUM_SCALAR >

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

virtualinherited

Basic copy of a MultiDimContainer.

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

Parameters

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_SCALAR, TerminalNodePolicy >, gum::MultiDimFunctionGraph< GUM_SCALAR >, and gum::MultiDimFunctionGraph< GUM_SCALAR, ExactTerminalNodePolicy >.

Definition at line 221 of file multiDimContainer_tpl.h.

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

                                                       {
    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]);
      }
    }
  }

Here is the call graph for this function:

domainSize()

template<typename GUM_SCALAR >

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

overridevirtualinherited

Returns the product of the variables domain size.

Returns

Returns the product of the variables domain size.

Implements gum::MultiDimInterface.

Definition at line 176 of file multiDimImplementation_tpl.h.

                                                                     {
    return domainSize__;
  }

empty()

template<typename GUM_SCALAR >

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

overridevirtualinherited

Returns true if no var is in *this.

Returns

Returns true if no var is in *this.

Implements gum::MultiDimInterface.

Definition at line 219 of file multiDimImplementation_tpl.h.

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

endMultipleChanges() [1/2]

template<typename GUM_SCALAR >

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

                                                                       {
    if (internalChangeState__ == InternalChangeState__::NOT_COMMITTED_CHANGE) {
      commitMultipleChanges_();
      internalChangeState__ = InternalChangeState__::NO_CHANGE;
    }

    internalChangeMethod__ = InternalChangeMethod__::DIRECT_CHANGE;
  }

endMultipleChanges() [2/2]

template<typename GUM_SCALAR>

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

overridevirtualinherited

Call this method after doing important changes in this MultiDimContainer.

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 240 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 >

INLINE void gum::MultiDimBucket< GUM_SCALAR >::erase

(

const MultiDimContainer< GUM_SCALAR > &

impl

)

Remove a MultiDimContainer from this bucket.

Parameters

impl	The MultiDimContainer to remove.

Definition at line 95 of file multiDimBucket_tpl.h.

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

                                                  {
    this->erase(&impl);
  }

Here is the call graph for this function:

erase() [2/3]

template<typename GUM_SCALAR >

void gum::MultiDimBucket< GUM_SCALAR >::erase

(

const MultiDimContainer< GUM_SCALAR > *

impl

)

Remove a MultiDimContainer from this bucket.

Parameters

impl	The MultiDimContainer to remove.

Definition at line 101 of file multiDimBucket_tpl.h.

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

                                                  {
    try {
      delete multiDims__[impl];
      multiDims__.erase(impl);

      if (!MultiDimImplementation< GUM_SCALAR >::isInMultipleChangeMethod_()) {
        for (auto var: impl->variablesSequence()) {
          eraseVariable__(var);
        }
      }

      changed__ = true;
    } catch (NotFound&) {
      // Do nothing
    }
  }

Here is the call graph for this function:

erase() [3/3]

template<typename GUM_SCALAR >

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

Reimplemented from gum::MultiDimImplementation< GUM_SCALAR >.

Definition at line 200 of file multiDimBucket_tpl.h.

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

                                                                           {
    MultiDimImplementation< GUM_SCALAR >::erase(v);

    if ((!MultiDimImplementation< GUM_SCALAR >::isInMultipleChangeMethod_())
        && (this->domainSize() <= bufferSize__)) {
      if (bucket__) {
        bucket__->erase(v);
      } else {
        initializeBuffer__();
      }
    }
  }

Here is the call 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 502 of file multiDimBucket_tpl.h.

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

                                                   {
    if (bucket__) {
      typedef Bijection< Instantiation*, Instantiation* >::iterator_safe BiIter;

      for (BiIter iter = instantiations__.beginSafe();
           iter != instantiations__.endSafe();
           ++iter) {
        delete iter.second();
      }

      instantiations__.clear();
      delete bucket__;
      bucket__ = 0;
    }
  }

Here is the call 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 445 of file multiDimBucket_tpl.h.

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

                                                                                {
    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);
    }
  }

Here is the call graph for this function:

extractFrom()

template<typename GUM_SCALAR >

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

virtualinherited

Basic extraction of a MultiDimContainer.

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

Parameters

src	The MultiDimContainer src which datas are copied.
mask	partial instantiation of variables of the Potential : the

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

Definition at line 246 of file multiDimContainer_tpl.h.

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

                                                   {
    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 potential"); }

    Instantiation inst(src);
    inst.setVals(imask);
    for (inst.setFirstOut(imask); !inst.end(); inst.incOut(imask))
      set(inst, src[inst]);
  }

Here is the call graph for this function:

fill()

template<typename GUM_SCALAR >

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

virtualinherited

Warning

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

Implements gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 66 of file multiDimReadOnly_tpl.h.

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

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

Here is the call graph for this function:

get()

template<typename GUM_SCALAR >

INLINE 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_SCALAR >.

Definition at line 226 of file multiDimBucket_tpl.h.

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

                                                                   {
    compute();

    if (bucket__) {
      try {
        return bucket__->get(
           *(instantiations__.second(const_cast< Instantiation* >(&i))));
      } catch (NotFound&) { 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);
    }
  }

Here is the call graph for this function:

get_()

template<typename GUM_SCALAR >

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

Reimplemented from gum::MultiDimReadOnly< GUM_SCALAR >.

Definition at line 429 of file multiDimBucket_tpl.h.

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

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

Here is the call graph for this function:

getMasterRef() [1/2]

template<typename GUM_SCALAR >

INLINE 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 ref to content as MultiDimAdressable&

Reimplemented from gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 373 of file multiDimBucket_tpl.h.

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

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

Here is the call graph for this function:

getMasterRef() [2/2]

template<typename GUM_SCALAR >

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

Reimplemented from gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 383 of file multiDimBucket_tpl.h.

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

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

Here is the call graph for this function:

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

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

                                                        {
    if (bucket__) {
      typedef Bijection< Instantiation*, Instantiation* >::iterator_safe BiIter;

      for (BiIter 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;
  }

Here is the call graph for this function:

invert_()

template<typename GUM_SCALAR >

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

protectedvirtualinherited

Inverts variables at position p1 and p2.

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

Parameters

p1	The first position.
p2	The second position.

Definition at line 315 of file multiDimImplementation_tpl.h.

                                                                          {
    vars__.swap(p1, p2);
  }

isBucketEmpty()

template<typename GUM_SCALAR >

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

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

                                                                {
    return multiDims__.empty();
  }

Here is the call graph for this function:

isCommitNeeded_()

template<typename GUM_SCALAR >

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

protectedinherited

Get the actual state of *this.

Returns

Returns true if a commit is needed.

Definition at line 270 of file multiDimImplementation_tpl.h.

                                                                          {
    return (internalChangeState__ == InternalChangeState__::NOT_COMMITTED_CHANGE);
  }

isInMultipleChangeMethod_()

template<typename GUM_SCALAR >

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

protectedinherited

Get the actual change method of this MultiDimImplementation.

Returns

Returns true if in multiple changes.

Definition at line 264 of file multiDimImplementation_tpl.h.

                                                                           {
    return (internalChangeMethod__ == InternalChangeMethod__::MULTIPLE_CHANGE);
  }

multidims()

template<typename GUM_SCALAR >

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

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

                                                             {
    return multiDims__;
  }

Here is the call graph for this function:

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

Definition at line 179 of file multiDimBucket_tpl.h.

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

                                                            {
    return name__;
  }

Here is the call graph for this function:

nbrDim()

template<typename GUM_SCALAR >

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

overridevirtualinherited

Returns the number of vars in the multidimensional container.

Returns

Returns the number of vars in the multidimensional container.

Implements gum::MultiDimInterface.

Definition at line 171 of file multiDimImplementation_tpl.h.

                                                                {
    return vars__.size();
  }

newFactory()

template<typename GUM_SCALAR >

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

overridevirtual

Default constructor.

Implements gum::MultiDimReadOnly< GUM_SCALAR >.

Definition at line 552 of file multiDimBucket_tpl.h.

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

                                                        {
    return new MultiDimBucket< GUM_SCALAR >;
  }

Here is the call graph for this function:

operator!=()

template<typename GUM_SCALAR >

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

inherited

Test if this MultiDimContainer is different of p.

Parameters

p	The MultiDimContainer to test for inequality.

Returns

Returns true if this MultiDimContainer is different of p.

Definition at line 160 of file multiDimContainer_tpl.h.

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

                                                     {
    return !operator==(p);
  }

Here is the call graph for this function:

operator==()

template<typename GUM_SCALAR >

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

inherited

Test if this MultiDimContainer is equal to p.

Parameters

p	The MultiDimContainer to test for equality.

Returns

Returns true if this MultiDimContainer is equal to p.

Definition at line 129 of file multiDimContainer_tpl.h.

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

                                                     {
    if ((nbrDim() == p.nbrDim()) && (domainSize() == p.domainSize())) {
      if (nbrDim() == 0) return true;

      typedef Sequence< const DiscreteVariable* >::const_iterator_safe
         var_iterator;

      for (var_iterator iter = variablesSequence().beginSafe();
           iter != variablesSequence().endSafe();
           ++iter) {
        if (!p.variablesSequence().exists(*iter)) { return false; }
      }
    } else {
      return false;
    }

    Instantiation i(*this);

    AlmostDifferent< GUM_SCALAR > cmp;

    for (i.setFirst(); !i.end(); ++i) {
      if (cmp(get(i), p.get(i))) { return false; }
    }

    return true;
  }

Here is the call graph for this function:

operator[]()

template<typename GUM_SCALAR >

INLINE GUM_SCALAR gum::MultiDimContainer< GUM_SCALAR >::operator[] ( const Instantiation &  i ) const

inherited

An [] operator using a Instantiation as argument.

Warning

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

Parameters

i	An Instantiation.

Returns

Returns the adressed (GUM_SCALAR) value.

Definition at line 83 of file multiDimContainer_tpl.h.

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

                                                                             {
    return get(i);
  }

Here is the call graph for this function:

populate() [1/2]

template<typename GUM_SCALAR >

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

virtualinherited

Automatically fills this MultiDimContainer with the values in v.

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

Size cpt = 0;
Instantiation i( *this );
for (i.setFirst(); !i.end(); ++i, ++cpt) {
  set(i, v[cpt]);
}

Parameters

v	Vector of values.

Exceptions

SizeError

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

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

Definition at line 167 of file multiDimContainer_tpl.h.

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

                                             {
    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]);
  }

Here is the call graph for this function:

populate() [2/2]

template<typename GUM_SCALAR >

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

virtualinherited

Automatically fills this MultiDimContainer with the values in l.

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

Size cpt = 0;
Instantiation i( *this );
for (i.setFirst(); !i.end(); ++i, ++cpt) {
  set(i, v[cpt]);
}

Parameters

l	contains the data.

Exceptions

SizeError

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

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

Definition at line 183 of file multiDimContainer_tpl.h.

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

                                                {
    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;
    }
  }

Here is the call graph for this function:

pos()

template<typename GUM_SCALAR >

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

overridevirtualinherited

Returns the index of a variable.

Parameters

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

                                                                              {
    return vars__.pos(&v);
  }

realSize()

template<typename GUM_SCALAR >

INLINE 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_SCALAR >.

Definition at line 214 of file multiDimBucket_tpl.h.

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

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

Here is the call graph for this function:

reduce()

template<typename GUM_SCALAR >

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

virtualinherited

compute lfold for this container

Parameters

f	the function to apply
base	the initial value

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

Definition at line 208 of file multiDimContainer_tpl.h.

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

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

Here is the call graph for this function:

registerSlave()

template<typename GUM_SCALAR >

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

Reimplemented from gum::MultiDimImplementation< GUM_SCALAR >.

Definition at line 342 of file multiDimBucket_tpl.h.

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

                                                                          {
    if (bucket__) {
      try {
        instantiations__.insert(&i, new Instantiation(*bucket__));
      } catch (DuplicateElement&) { return false; }
    }

    return MultiDimImplementation< GUM_SCALAR >::registerSlave(i);
  }

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 35 of file multiDimInterface_inl.h.

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

                                                             {
    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);
  }

Here is the call graph for this function:

replace_()

template<typename GUM_SCALAR >

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

overrideprotectedvirtual

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.

Reimplemented from gum::MultiDimImplementation< GUM_SCALAR >.

Definition at line 567 of file multiDimBucket_tpl.h.

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

                                                                                {
    MultiDimImplementation< GUM_SCALAR >::replace_(x, y);
    typedef Bijection< Instantiation*, Instantiation* >::iterator_safe Iter;

    for (Iter 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);
  }

Here is the call graph for this function:

set()

template<typename GUM_SCALAR >

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

virtualinherited

Warning

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

Reimplemented from gum::MultiDimContainer< GUM_SCALAR >.

Definition at line 58 of file multiDimReadOnly_tpl.h.

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

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

Here is the call graph for this function:

setBufferSize()

template<typename GUM_SCALAR >

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

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

                                                                      {
    bufferSize__ = ammount;

    if ((this->domainSize() > bufferSize__) && (bucket__ != 0)) {
      eraseBuffer__();
    } else if (bucket__ == 0) {
      initializeBuffer__();
    }
  }

Here is the call graph for this function:

setChangeNotification()

template<typename GUM_SCALAR >

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

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

                                                                               {
    if (bucket__) {
      try {
        bucket__->setChangeNotification(
           *(instantiations__.second(const_cast< Instantiation* >(&i))));
      } catch (NotFound&) {
        // Then i is not a slave of this
      }
    } else {
      slavesValue__.erase(&i);
    }
  }

Here is the call graph for this function:

setDecNotification()

template<typename GUM_SCALAR >

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

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

                                                                            {
    if (bucket__) {
      try {
        bucket__->setDecNotification(
           *(instantiations__.second(const_cast< Instantiation* >(&i))));
      } catch (NotFound&) {
        // Then i is not a slave of this
      }
    } else {
      slavesValue__.erase(&i);
    }
  }

Here is the call graph for this function:

setFirstNotification()

template<typename GUM_SCALAR >

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

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

                                                                              {
    if (bucket__) {
      try {
        bucket__->setFirstNotification(
           *(instantiations__).second(const_cast< Instantiation* >(&i)));
      } catch (NotFound&) {
        // Then i is not a slave of this
      }
    } else {
      slavesValue__.erase(&i);
    }
  }

Here is the call graph for this function:

setIncNotification()

template<typename GUM_SCALAR >

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

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

                                                                            {
    if (bucket__) {
      try {
        bucket__->setIncNotification(
           *(instantiations__.second(const_cast< Instantiation* >(&i))));
      } catch (NotFound&) {
        // Then i is not a slave of this
      }
    } else {
      slavesValue__.erase(&i);
    }
  }

Here is the call graph for this function:

setLastNotification()

template<typename GUM_SCALAR >

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

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

                                                                             {
    if (bucket__) {
      try {
        bucket__->setLastNotification(
           *(instantiations__).second(const_cast< Instantiation* >(&i)));
      } catch (NotFound&) {
        // Then i is not a slave of this
      }
    } else {
      slavesValue__.erase(&i);
    }
  }

Here is the call graph for this function:

slaves_()

template<typename GUM_SCALAR >

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

protectedinherited

Returns a constant reference over the list of slaved instantiations.

Returns

Returns a constant reference over the list of slaved instantiations.

Definition at line 277 of file multiDimImplementation_tpl.h.

                                                                   {
    return slaveInstantiations__;
  }

toString() [1/2]

template<typename GUM_SCALAR >

INLINE 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_SCALAR >.

Definition at line 393 of file multiDimBucket_tpl.h.

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

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

Here is the call graph for this function:

toString() [2/2]

template<typename GUM_SCALAR >

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

virtualinherited

Returns a representation of this MultiDimContainer.

Returns

Returns a representation of this MultiDimContainer.

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

Definition at line 106 of file multiDimContainer_tpl.h.

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

                                                            {
    // 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();
  }

Here is the call graph for this function:

unregisterSlave()

template<typename GUM_SCALAR >

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

Reimplemented from gum::MultiDimImplementation< GUM_SCALAR >.

Definition at line 353 of file multiDimBucket_tpl.h.

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

                                                                            {
    MultiDimReadOnly< GUM_SCALAR >::unregisterSlave(i);

    if (bucket__) {
      try {
        delete instantiations__.second(&i);
        instantiations__.eraseFirst(&i);
        return true;
      } catch (NotFound&) { return false; }
    } else {
      if (slavesValue__.exists(&i)) {
        slavesValue__.erase(&i);
        return true;
      } else {
        return false;
      }
    }
  }

Here is the call graph for this function:

variable() [1/2]

template<typename GUM_SCALAR >

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

overridevirtualinherited

Returns a const ref to the ith var.

param i An index of this multidimensional matrix.

Returns

Returns a const ref to the ith var.

Exceptions

NotFound

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

Implements gum::MultiDimInterface.

Definition at line 182 of file multiDimImplementation_tpl.h.

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

variable() [2/2]

template<typename GUM_SCALAR >

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

overridevirtualinherited

Returns the variable with the name.

Parameters

name	The index of the variable

Returns

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

Exceptions

NotFound

Raised if the element cannot be found.

Implements gum::MultiDimInterface.

Definition at line 187 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.")
  }

variablesSequence()

template<typename GUM_SCALAR >

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

overridevirtualinherited

Returns a const ref to the sequence of DiscreteVariable*.

Returns

Returns a const ref to the sequence of DiscreteVariable*.

Implements gum::MultiDimInterface.

Definition at line 213 of file multiDimImplementation_tpl.h.

                                                                             {
    return vars__;
  }

Member Data Documentation

allVariables__

template<typename GUM_SCALAR >

Set< const DiscreteVariable* > gum::MultiDimBucket< GUM_SCALAR >::allVariables__

private

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

Definition at line 296 of file multiDimBucket.h.

allVarsInst__

template<typename GUM_SCALAR >

Instantiation gum::MultiDimBucket< GUM_SCALAR >::allVarsInst__

mutableprivate

Instantiation over all variable in this.

Definition at line 299 of file multiDimBucket.h.

bucket__

template<typename GUM_SCALAR >

MultiDimArray< GUM_SCALAR >* gum::MultiDimBucket< GUM_SCALAR >::bucket__

private

The result table of this bucket.

Definition at line 289 of file multiDimBucket.h.

bufferSize__

template<typename GUM_SCALAR >

Size gum::MultiDimBucket< GUM_SCALAR >::bufferSize__

private

The number of element allowed in bucket__.

Definition at line 282 of file multiDimBucket.h.

changed__

template<typename GUM_SCALAR >

bool gum::MultiDimBucket< GUM_SCALAR >::changed__

mutableprivate

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

Definition at line 342 of file multiDimBucket.h.

instantiations__

template<typename GUM_SCALAR >

Bijection< Instantiation*, Instantiation* > gum::MultiDimBucket< GUM_SCALAR >::instantiations__

private

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

Definition at line 286 of file multiDimBucket.h.

multiDims__

template<typename GUM_SCALAR >

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

mutableprivate

The set of MultiDimContainer in this bucket.

Definition at line 293 of file multiDimBucket.h.

name__

template<typename GUM_SCALAR >

std::string gum::MultiDimBucket< GUM_SCALAR >::name__

private

The class name.

Definition at line 349 of file multiDimBucket.h.

slavesValue__

template<typename GUM_SCALAR >

HashTable< const Instantiation*, GUM_SCALAR > gum::MultiDimBucket< GUM_SCALAR >::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 346 of file multiDimBucket.h.

---

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

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