multiDimImplementation.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_IMPLEMENTATION_H
#define GUM_MULTI_DIM_IMPLEMENTATION_H
 
#include <vector>
 
#include <agrum/agrum.h>
 
#include <agrum/base/multidim/implementations/multiDimContainer.h>
 
namespace gum {
 
  // ===========================================================================
  // ===                    GUM_MULTI_DIM_IMPLEMENTATION                     ===
  // ===========================================================================
  template < typename GUM_SCALAR >
  class MultiDimImplementation: public MultiDimContainer< GUM_SCALAR > {
    public:
    // =========================================================================
    // =========================================================================

    MultiDimImplementation();

    MultiDimImplementation(const MultiDimImplementation< GUM_SCALAR >& from);

    virtual ~MultiDimImplementation();

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

    virtual const std::string& name() const = 0;

    const std::string& basename() const;

    virtual Size realSize() const = 0;

    float compressionRate() const;

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

    // =========================================================================
    // =========================================================================
 
    virtual bool registerSlave(Instantiation& slave) override;
 
    virtual bool unregisterSlave(Instantiation& slave) override;

    // =========================================================================
    // =========================================================================
 
    using MultiDimContainer< GUM_SCALAR >::get;
 
    virtual MultiDimContainer< GUM_SCALAR >* newFactory() const override = 0;
 
    void beginMultipleChanges() override;
 
    void endMultipleChanges() override;
 
    void endMultipleChanges(const GUM_SCALAR&) override;

 
    protected:
    // =========================================================================
    // =========================================================================

    virtual void commitMultipleChanges_();

    virtual void commitMultipleChanges_(const GUM_SCALAR& value);

    bool isInMultipleChangeMethod_() const;

    bool isCommitNeeded_() const;

    const List< Instantiation* >& slaves_() const;

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

    virtual void invert_(Idx p1, Idx p2);


    virtual const MultiDimImplementation< GUM_SCALAR >* content() const final;

    virtual MultiDimImplementation< GUM_SCALAR >* content() final;
 
    private:
    Sequence< const DiscreteVariable* > _vars_;

    List< Instantiation* > _slaveInstantiations_;

    enum class _InternalChangeMethod_ : char { DIRECT_CHANGE, MULTIPLE_CHANGE };

    enum class _InternalChangeState_ : char { NO_CHANGE, NOT_COMMITTED_CHANGE };

    _InternalChangeMethod_ _internalChangeMethod_;

    _InternalChangeState_ _internalChangeState_;

    Size _domainSize_;

    void _setNotCommitedChange_();
  };

  template < typename GUM_SCALAR >
  std::ostream& operator<<(std::ostream&, const MultiDimImplementation< GUM_SCALAR >&);
 
} /* namespace gum */
 
#include <agrum/base/multidim/implementations/multiDimImplementation_tpl.h>
 
#endif /* GUM_MULTI_DIM_IMPLEMENTATION_H */