multiDimBijArray.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_MULTIDIMBIJARRAY_H
#define GUM_MULTIDIMBIJARRAY_H
 
#include <agrum/base/core/bijection.h>
#include <agrum/base/multidim/implementations/multiDimArray.h>
 
#include <initializer_list>
 
namespace gum {

  template < typename GUM_SCALAR >
  class MultiDimBijArray final: public MultiDimWithOffset< GUM_SCALAR > {
    public:
    using VarBijection = Bijection< const DiscreteVariable*, const DiscreteVariable* >;
 
    // =========================================================================
    // =========================================================================

    MultiDimBijArray(const VarBijection& bijection, const MultiDimArray< GUM_SCALAR >& array);

    MultiDimBijArray(const VarBijection& bijection, const MultiDimBijArray< GUM_SCALAR >& array);

    MultiDimBijArray(const MultiDimBijArray< GUM_SCALAR >& from);

    virtual ~MultiDimBijArray();

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

    MultiDimBijArray< GUM_SCALAR >& operator=(const MultiDimBijArray< GUM_SCALAR >& from);

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

    virtual void add(const DiscreteVariable& v);

    virtual void erase(const DiscreteVariable& v);

    virtual void fill(const GUM_SCALAR& d) const;

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

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

    // ========================================================================
    // ========================================================================
 
    virtual const std::string& name() const;
 
    virtual GUM_SCALAR get(const Instantiation& i) const;
 
    virtual Size realSize() const;
 
    virtual MultiDimBijArray< GUM_SCALAR >* newFactory() const;

 
    protected:
    virtual GUM_SCALAR& get_(const Instantiation& i) const;
 
    virtual void commitMultipleChanges_();
 
    virtual void replace_(const DiscreteVariable* x, const DiscreteVariable* y);
 
    private:
    const MultiDimArray< GUM_SCALAR >& _array_;

    std::string _name_;
  };
 
 
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
  extern template class MultiDimBijArray< double >;
#endif
 
}   // namespace gum
 
#include <agrum/base/multidim/implementations/multiDimBijArray_tpl.h>
 
#endif   // GUM_MULTIDIMBIJARRAY_H