multiDimArray.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_ARRAY_H
#define GUM_MULTI_DIM_ARRAY_H
 
#include <vector>
 
#include <agrum/agrum.h>
 
#include <agrum/base/multidim/implementations/multiDimWithOffset.h>
 
namespace gum {
 
  template < typename GUM_ELEMENT >
  class MultiDimBijArray;
 
  // ===========================================================================
  // ===                          GUM_MULTI_DIM_ARRAY                        ===
  // ===========================================================================
  template < typename GUM_ELEMENT >
  class MultiDimArray final: public MultiDimWithOffset< GUM_ELEMENT > {
    public:
    template < typename GUM_ELEMENTBIS >
    friend class MultiDimBijArray;
    // =========================================================================
    // =========================================================================

    MultiDimArray();

    MultiDimArray(const MultiDimArray< GUM_ELEMENT >& src);


    ~MultiDimArray() override;
 
    [[nodiscard]] MultiDimContainer< GUM_ELEMENT >* newFactory() const override;

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

    void copyFrom(const MultiDimContainer< GUM_ELEMENT >& src) const override;

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

    GUM_ELEMENT reduce(std::function< GUM_ELEMENT(GUM_ELEMENT, GUM_ELEMENT) > f,
                       GUM_ELEMENT                                            base) const override;

    void add(const DiscreteVariable& v) override;

    void erase(const DiscreteVariable& v) override;

    Size realSize() const override;

    void fill(const GUM_ELEMENT& d) const override;

    const std::string& name() const override;

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

    const GUM_ELEMENT& unsafeGet(Idx offset) const;

    const GUM_ELEMENT& getByOffset(Idx offset) const;

    void unsafeSet(Idx offset, const GUM_ELEMENT& val);

    void setByOffset(Idx offset, const GUM_ELEMENT& val);

    const GUM_ELEMENT* data() const noexcept override;

    GUM_ELEMENT* data() noexcept override;

 
    protected:
    mutable std::vector< GUM_ELEMENT > values_;
 
    void commitMultipleChanges_() final;
 
    void commitMultipleChanges_(const GUM_ELEMENT&) final;
 
    GUM_ELEMENT& get_(const Instantiation& i) const final;
 
    void replace_(const DiscreteVariable* x, const DiscreteVariable* y) final;
  };
 
 
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
  extern template class MultiDimArray< double >;
#endif
 
 
} /* namespace gum */
 
#include <agrum/base/multidim/implementations/multiDimArray_tpl.h>
 
#endif /* GUM_MULTI_DIM_ARRAY_H */