multiDimWithOffset.h

Go to the documentation of this file.

#ifndef GUM_MULTI_DIM_WITH_OFFSET_H
#define GUM_MULTI_DIM_WITH_OFFSET_H

#include <agrum/agrum.h>
#include <agrum/multidim/implementations/multiDimImplementation.h>
#include <vector>

namespace gum {
  // ==========================================================================
  // ===                    GUM_MULTI_DIM_WITH_OFFSET === */
  // ==========================================================================
  template < typename GUM_SCALAR >
  class MultiDimWithOffset : public MultiDimImplementation< GUM_SCALAR > {
    public:
    // =========================================================================
    // =========================================================================

    MultiDimWithOffset();

    MultiDimWithOffset(const MultiDimWithOffset< GUM_SCALAR >& from);

    virtual ~MultiDimWithOffset();

    MultiDimWithOffset< GUM_SCALAR >&
       operator=(const MultiDimWithOffset< GUM_SCALAR >& from);

    virtual MultiDimContainer< GUM_SCALAR >* newFactory() const = 0;

    // =========================================================================
    // =========================================================================

    virtual void add(const DiscreteVariable& v);

    virtual void erase(const DiscreteVariable& v);

    virtual void fill(const GUM_SCALAR& d) const = 0;

    virtual const std::string toString(const Instantiation* i) const;

    virtual void changeNotification(const Instantiation&          i,
                                    const DiscreteVariable* const var,
                                    Idx                           oldval,
                                    Idx                           newval);

    virtual void setChangeNotification(const Instantiation& i);

    virtual void setFirstNotification(const Instantiation& i);

    virtual void setLastNotification(const Instantiation& i);

    void setIncNotification(const Instantiation& i);

    void setDecNotification(const Instantiation& i);

    virtual bool registerSlave(Instantiation& i);

    virtual bool unregisterSlave(Instantiation& i);

    // =========================================================================
    // =========================================================================


    Size toOffset(const Instantiation& i) const;

    Instantiation& fromOffset(Instantiation& i, Size offset) const;


    protected:
    Size _getOffs(const Instantiation& i) const;

    HashTable< const DiscreteVariable*, Size > _gaps;

    HashTable< const Instantiation*, Size > _offsets;

    void _computeInstantiationValue(Instantiation& result, Size indice) const;

    virtual GUM_SCALAR& _get(const Instantiation& i) const = 0;
  };
} /* namespace gum */

#include <agrum/multidim/implementations/multiDimWithOffset_tpl.h>

#endif /* GUM_MULTI_DIM_WITH_OFFSET_H */