multiDimDecorator.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2026 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-2026                            *
 *       - 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_ELEMENT >
  class MultiDimDecorator: public MultiDimContainer< GUM_ELEMENT > {
    public:
    // =========================================================================
    // =========================================================================

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

    MultiDimDecorator(const MultiDimDecorator< GUM_ELEMENT >& from);

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

    MultiDimDecorator(MultiDimDecorator< GUM_ELEMENT >&&) noexcept;

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

    ~MultiDimDecorator() override;

    // =========================================================================
    // =========================================================================
 
    Idx nbrDim() const final;
 
    Size domainSize() const final;
 
    void add(const DiscreteVariable& v) final;
 
    void         erase(const DiscreteVariable& var) final;
    virtual void erase(std::string_view name) final;
 
    const Sequence< const DiscreteVariable* >& variablesSequence() const final;
    const DiscreteVariable&                    variable(Idx) const final;
    const DiscreteVariable&                    variable(std::string_view name) const final;
 
    Idx pos(const DiscreteVariable& var) const final;
 
    bool contains(const DiscreteVariable& var) const final;
 
    bool empty() const final;

    // ========================================================================
    // ========================================================================
 
    bool unregisterSlave(Instantiation& i) final;
 
    bool registerSlave(Instantiation& i) final;
 
    void changeNotification(const Instantiation&          i,
                            const DiscreteVariable* const var,
                            Idx                           oldval,
                            Idx                           newval) final;
 
    void setChangeNotification(const Instantiation& i) final;
 
    void setFirstNotification(const Instantiation& i) final;
 
    void setLastNotification(const Instantiation& i) final;
 
    void setIncNotification(const Instantiation& i) final;
 
    void setDecNotification(const Instantiation& i) final;
 
    virtual void notifyChange() const final;

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

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

    GUM_ELEMENT get(const Instantiation& i) const final;
 
    void fill(const GUM_ELEMENT& d) const final;

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

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

    GUM_ELEMENT reduce(std::function< GUM_ELEMENT(GUM_ELEMENT, GUM_ELEMENT) > f,
                       GUM_ELEMENT                                            base) const final;
 
    [[nodiscard]] MultiDimDecorator< GUM_ELEMENT >* newFactory() const override = 0;
 
    void beginMultipleChanges() final;
 
    void endMultipleChanges() final;
 
    void endMultipleChanges(const GUM_ELEMENT&) final;
 
    std::string toString(const Instantiation* i) const override;
 
    std::string toString() const override;

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

    const MultiDimImplementation< GUM_ELEMENT >* content() const final;

    MultiDimImplementation< GUM_ELEMENT >* content() final;

 
    protected:
    void replace_(const DiscreteVariable* x, const DiscreteVariable* y) override;

    void swapContent_(MultiDimImplementation< GUM_ELEMENT >* aContent) const;

    mutable MultiDimImplementation< GUM_ELEMENT >* content_;

    GUM_ELEMENT& get_(const Instantiation& i) const final;

    mutable GUM_ELEMENT empty_value_;
  };
 
} /* namespace gum */
 
#include <agrum/base/multidim/implementations/multiDimDecorator_tpl.h>
 
#endif /* GUM_MULTI_DIM_DECORATOR_H */