multiDimContainer.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_MULTIDIM_CONTAINER_H
#define GUM_MULTIDIM_CONTAINER_H
 
#include <functional>
#include <iostream>
#include <vector>
 
#include <agrum/agrum.h>
 
#include <agrum/base/multidim/implementations/multiDimAdressable.h>
 
#include <agrum/base/core/math/math_utils.h>
#include <initializer_list>
 
namespace gum {
  // needed for content()
  template < typename GUM_SCALAR >
  class MultiDimImplementation;
 
  // ==========================================================================
  // ===                             GUM_MULTI_DIM                          ===
  // ==========================================================================
  template < typename GUM_SCALAR >
  class MultiDimContainer: public MultiDimAdressable {
    public:
    // =========================================================================
    // =========================================================================

    MultiDimContainer();

    MultiDimContainer(const MultiDimContainer< GUM_SCALAR >& src);
 
    MultiDimContainer& operator=(const MultiDimContainer< GUM_SCALAR >& src);

    MultiDimContainer(MultiDimContainer< GUM_SCALAR >&&);
 
    MultiDimContainer& operator=(MultiDimContainer< GUM_SCALAR >&& src);

    virtual ~MultiDimContainer();

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

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

    virtual GUM_SCALAR get(const Instantiation& i) const;

    GUM_SCALAR operator[](const Instantiation& i) const;

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

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

    virtual void populate(std::initializer_list< GUM_SCALAR > l) const;

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

    virtual void copyFrom(const MultiDimContainer< GUM_SCALAR >& src) const;

    virtual void copyFrom(const MultiDimContainer< GUM_SCALAR >& src, Instantiation* p_i) const;

    virtual void extractFrom(const MultiDimContainer< GUM_SCALAR >& src, const Instantiation& mask);

    virtual const MultiDimImplementation< GUM_SCALAR >* content() const = 0;

    virtual MultiDimImplementation< GUM_SCALAR >* content() = 0;

    virtual MultiDimAdressable& getMasterRef();

    virtual const MultiDimAdressable& getMasterRef() const;
 

    virtual void copy(const MultiDimContainer< GUM_SCALAR >& src);

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

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

    virtual std::string toString() const;

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

    bool operator==(const MultiDimContainer< GUM_SCALAR >& p) const;

    bool operator!=(const MultiDimContainer< GUM_SCALAR >& p) const;

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

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

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

    virtual void beginMultipleChanges() = 0;

    virtual void endMultipleChanges() = 0;

    virtual void endMultipleChanges(const GUM_SCALAR& v) = 0;

 
    protected:
    virtual GUM_SCALAR& get_(const Instantiation& i) const = 0;
  };
} /* namespace gum */
 
#include <agrum/base/multidim/implementations/multiDimContainer_tpl.h>
 
#endif /* GUM_MULTIDIM_CONTAINER_H */