multiDimDecorator.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005 by Pierre-Henri WUILLEMIN et Christophe GONZALES   *
 *   {prenom.nom}_at_lip6.fr                                               *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifndef GUM_MULTI_DIM_DECORATOR_H
#define GUM_MULTI_DIM_DECORATOR_H

#include <agrum/agrum.h>

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

namespace gum {

  // ===========================================================================
  // ===                         MULTIDIM DECORATOR                          ===
  // ===========================================================================

  template < typename GUM_SCALAR >
  class MultiDimDecorator : public MultiDimContainer< GUM_SCALAR > {
    public:
    // =========================================================================
    // =========================================================================

    MultiDimDecorator(MultiDimImplementation< GUM_SCALAR >* aContent = nullptr,
                      GUM_SCALAR empty_value = (GUM_SCALAR)0);

    MultiDimDecorator(const MultiDimDecorator< GUM_SCALAR >& from);

    MultiDimDecorator< GUM_SCALAR >&
       operator=(const MultiDimDecorator& from) noexcept;

    MultiDimDecorator(MultiDimDecorator< GUM_SCALAR >&&) noexcept;

    MultiDimDecorator< GUM_SCALAR >& operator=(MultiDimDecorator&& from);

    ~MultiDimDecorator();

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

    virtual Idx nbrDim() const final;

    virtual Size domainSize() const final;

    virtual void add(const DiscreteVariable& v) final;

    virtual void erase(const DiscreteVariable& var) final;

    virtual const Sequence< const DiscreteVariable* >&
                                    variablesSequence() const final;
    virtual const DiscreteVariable& variable(Idx) const final;
    virtual const DiscreteVariable& variable(const std::string& name) const final;

    virtual Idx pos(const DiscreteVariable& var) const final;

    virtual bool contains(const DiscreteVariable& var) const final;

    virtual bool empty() const final;

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

    virtual bool unregisterSlave(Instantiation& i) final;

    virtual bool registerSlave(Instantiation& i) final;

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

    virtual void setChangeNotification(const Instantiation& i) final;

    virtual void setFirstNotification(const Instantiation& i) final;

    virtual void setLastNotification(const Instantiation& i) final;

    virtual void setIncNotification(const Instantiation& i) final;

    virtual void setDecNotification(const Instantiation& i) final;

    virtual void notifyChange() const final;

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

    virtual void set(const Instantiation& i, const GUM_SCALAR& value) const final;

    virtual GUM_SCALAR get(const Instantiation& i) const final;

    virtual void fill(const GUM_SCALAR& d) const final;

    virtual void populate(const std::vector< GUM_SCALAR >& v) const final;

    virtual void apply(std::function< GUM_SCALAR(GUM_SCALAR) > f) const final;

    virtual GUM_SCALAR
       reduce(std::function< GUM_SCALAR(GUM_SCALAR, GUM_SCALAR) > f,
              GUM_SCALAR base) const final;

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

    virtual void beginMultipleChanges() final;

    virtual void endMultipleChanges() final;

    virtual void endMultipleChanges(const GUM_SCALAR&) final;

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

    virtual const std::string toString() const;

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


    virtual const MultiDimImplementation< GUM_SCALAR >* content() const final;

    virtual MultiDimImplementation< GUM_SCALAR >* content() final;

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

    void _swapContent(MultiDimImplementation< GUM_SCALAR >* aContent) const;

    mutable MultiDimImplementation< GUM_SCALAR >* _content;

    GUM_SCALAR& _get(const Instantiation& i) const final;

    mutable GUM_SCALAR _empty_value;
  };

} /* namespace gum */

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

#endif /* GUM_MULTI_DIM_DECORATOR_H */