multiDimInterface.h

Go to the documentation of this file.

#ifndef GUM_MULTIDIM_INTERFACE_H
#define GUM_MULTIDIM_INTERFACE_H

#include <iostream>
#include <vector>

#include <agrum/agrum.h>

#include <agrum/core/list.h>
#include <agrum/core/sequence.h>

#include <agrum/variables/discreteVariable.h>

namespace gum {

#ifndef DOXYGEN_SHOULD_SKIP_THIS
  // Forward declaration.
  class Instantiation;
#endif

  // ==========================================================================
  // ===                    MULTIDIM INTERFACE                              ===
  // ==========================================================================
  class MultiDimInterface {
    public:
    virtual ~MultiDimInterface(){};

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

    virtual Idx nbrDim() const = 0;

    virtual Size domainSize() const = 0;

    virtual void add(const DiscreteVariable& v) = 0;

    virtual void erase(const DiscreteVariable& v) = 0;

    virtual const Sequence< const DiscreteVariable* >&
       variablesSequence() const = 0;

    virtual const DiscreteVariable& variable(Idx i) const = 0;

    virtual const DiscreteVariable& variable(const std::string& name) const = 0;

    virtual Idx pos(const DiscreteVariable& v) const = 0;

    virtual bool contains(const DiscreteVariable& v) const = 0;

    virtual bool empty() const = 0;

    void replace(const DiscreteVariable& x, const DiscreteVariable& y);


    protected:
    virtual void _replace(const DiscreteVariable* x,
                          const DiscreteVariable* y) = 0;
  };

  MultiDimInterface& operator<<(MultiDimInterface& c, const DiscreteVariable& v);

  MultiDimInterface& operator>>(MultiDimInterface& c, const DiscreteVariable& v);

} /* namespace gum */

#ifndef GUM_NO_INLINE
#  include <agrum/multidim/implementations/multiDimInterface_inl.h>
#endif   // GUM_NO_INLINE

#endif /* GUM_MULTIDIM_INTERFACE_H */