multiDimDecorator.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2025 by                                             *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *                                                                          *
 *   The aGrUM/pyAgrum library is free software; you can redistribute it    *
 *   and/or modify it under the terms of either :                           *
 *                                                                          *
 *    - the GNU Lesser General Public License as published by               *
 *      the Free Software Foundation, either version 3 of the License,      *
 *      or (at your option) any later version,                              *
 *    - the MIT license (MIT),                                              *
 *    - or both in dual license, as here.                                   *
 *                                                                          *
 *   (see https://agrum.gitlab.io/articles/dual-licenses-lgplv3mit.html)    *
 *                                                                          *
 *   This aGrUM/pyAgrum library is distributed in the hope that it will be  *
 *   useful, but WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,          *
 *   INCLUDING BUT NOT LIMITED TO THE WARRANTIES MERCHANTABILITY or FITNESS *
 *   FOR A PARTICULAR PURPOSE  AND NONINFRINGEMENT. IN NO EVENT SHALL THE   *
 *   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
 *   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,        *
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR  *
 *   OTHER DEALINGS IN THE SOFTWARE.                                        *
 *                                                                          *
 *   See LICENCES for more details.                                         *
 *                                                                          *
 *   SPDX-FileCopyrightText: Copyright 2005-2025                            *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *   SPDX-License-Identifier: LGPL-3.0-or-later OR MIT                      *
 *                                                                          *
 *   Contact  : info_at_agrum_dot_org                                       *
 *   homepage : http://agrum.gitlab.io                                      *
 *   gitlab   : https://gitlab.com/agrumery/agrum                           *
 *                                                                          *
 ****************************************************************************/
 

#ifndef GUM_MULTI_DIM_DECORATOR_H
#define GUM_MULTI_DIM_DECORATOR_H
 
#include <mutex>
 
#include <agrum/agrum.h>
 
#include <agrum/base/multidim/implementations/multiDimArray.h>
 
namespace gum {
  class DiscreteVariable;
 
  // ===========================================================================
  // ===                         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 void erase(const std::string& name) 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 std::string toString(const Instantiation* i) const;
 
    virtual 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/base/multidim/implementations/multiDimDecorator_tpl.h>
 
#endif /* GUM_MULTI_DIM_DECORATOR_H */