instantiation.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_INSTANTIATION_H
#define GUM_INSTANTIATION_H
 
#include <ostream>
#include <sstream>
 
#include <agrum/agrum.h>
 
#include <agrum/base/multidim/implementations/multiDimInterface.h>
 
namespace gum {
 
  class MultiDimAdressable;
 
  // =========================================================================
  // ===                           GUM_INSTANTIATION                       ===
  // =========================================================================
 
  class Instantiation final: public MultiDimInterface {
    public:
    // =========================================================================
    // =========================================================================

    Instantiation();

    Instantiation(const Instantiation& aI, const bool notifyMaster = true);

    Instantiation& operator=(const Instantiation& aI);

    Instantiation(MultiDimAdressable& aMD);

    Instantiation(const MultiDimAdressable& aMD);

    Instantiation(MultiDimAdressable* aMD);

    Instantiation(const MultiDimAdressable* aMD);

    ~Instantiation();

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

    Idx nbrDim() const final;

    void add(const DiscreteVariable& v) final;

    void erase(const DiscreteVariable& v) final;
    void erase(const std::string& name);

    void clear();

    Size domainSize() const final;

    Idx pos(const DiscreteVariable& v) const final;

    Idx val(Idx i) const;

    Idx val(const DiscreteVariable& var) const;
    Idx val(const std::string& name) const;

    Idx valFromPtr(const DiscreteVariable* pvar) const;

    const DiscreteVariable& variable(Idx i) const final;

    const DiscreteVariable& variable(const std::string& name) const final;

    Instantiation& chgVal(const DiscreteVariable& v, Idx newval);

    Instantiation& chgVal(Idx varPos, Idx newval);

    Instantiation& chgVal(const std::string& var, Idx newval);

    Instantiation& chgVal(const std::string& var, const std::string& newval);

    Instantiation& setVals(const Instantiation& i);

    void setValsFrom(const HashTable< const DiscreteVariable*, const DiscreteVariable* >& map,
                     const Instantiation&                                                 external);

    bool contains(const DiscreteVariable& v) const final;
    bool contains(const std::string& name) const;

    bool contains(const DiscreteVariable* v) const;

    const Sequence< const DiscreteVariable* >& variablesSequence() const final;

    virtual bool empty() const final;

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

    bool inOverflow() const;

 
    void unsetOverflow();

    void unsetEnd();

    bool end() const;

    bool rend() const;

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

    void inc();

    void dec();

    void incIn(const Instantiation& i);

    void decIn(const Instantiation& i);

    void incOut(const Instantiation& i);

    void decOut(const Instantiation& i);

    void incNotVar(const DiscreteVariable& v);

    void decNotVar(const DiscreteVariable& v);

 
    void incVar(const DiscreteVariable& v);

 
    void decVar(const DiscreteVariable& v);

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

    void setFirst();

    void setLast();

    void setFirstIn(const Instantiation& i);

    void setLastIn(const Instantiation& i);

 
    void setFirstOut(const Instantiation& i);

    void setLastOut(const Instantiation& i);

 
    void setFirstNotVar(const DiscreteVariable& v);

    void setLastNotVar(const DiscreteVariable& v);

    void setFirstVar(const DiscreteVariable& v);

    void setLastVar(const DiscreteVariable& v);

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

    bool actAsSlave(MultiDimAdressable& aMD);

    bool forgetMaster();

    bool isSlave() const;

    bool isMaster(const MultiDimAdressable* m) const;

    bool isMaster(const MultiDimAdressable& m) const;

    void synchronizeWithMaster(const MultiDimAdressable* m);

    void addWithMaster(const MultiDimAdressable* m, const DiscreteVariable& v);

    void eraseWithMaster(const MultiDimAdressable* m, const DiscreteVariable& v);

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

    bool operator==(const Instantiation& other) const;

    Instantiation& operator++();

    Instantiation& operator--();

    Instantiation& operator+=(Size depl);

    Instantiation& operator-=(Size depl);

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

    Idx hamming() const;

    std::string toString() const;

    void reorder(const Sequence< const DiscreteVariable* >& v);

    void reorder(const Instantiation& i);

 
    protected:
    virtual void replace_(const DiscreteVariable* x, const DiscreteVariable* y) final;
 
    private:
    MultiDimAdressable* _master_;

    Sequence< const DiscreteVariable* > _vars_;

    std::vector< Idx > _vals_;

    bool _overflow_;

    void _swap_(Idx i, Idx j);

    void _chgVal_(Idx varPos, Idx newVal);

    void _add_(const DiscreteVariable& v);

    void _erase_(const DiscreteVariable& v);

    void _notifiedDimChanged_(const Sequence< const DiscreteVariable* >& v);

    void _init_(MultiDimAdressable* master);

    void _reorder_(const Sequence< const DiscreteVariable* >& v);
 
    void _masterChangeNotification_(Idx varPos, Idx newVal, Idx oldVal) const;
    void _masterFirstNotification_() const;
    void _masterIncNotification_() const;
    void _masterLastNotification_() const;
    void _masterDecNotification_() const;
  };

  std::ostream& operator<<(std::ostream&, const Instantiation&);

  template <>
  // class HashFunc< Instantiation > : public HashFuncBase< Instantiation > {
  class HashFunc< Instantiation >: public HashFuncBase< Instantiation > {
    public:
    static Size castToSize(const Instantiation& key);

    virtual Size operator()(const Instantiation& key) const override final;
  };
} /* namespace gum */
 
#ifndef GUM_NO_INLINE
#  include <agrum/base/multidim/instantiation_inl.h>
#endif /* GUM_NO_INLINE */
 
#endif /* GUM_INSTANTIATION_H */