setInst.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_SETINST_H
#define GUM_SETINST_H
 
#include <ostream>
 
#include <agrum/agrum.h>
 
#include <agrum/base/core/bijection.h>
#include <agrum/base/multidim/implementations/multiDimAdressable.h>
 
namespace gum {
 
  class MultiDimAdressable;
 
  class Instantiation;
 
  // ==========================================================================
  // ===                            GUM_SetInst                             ===
  // ==========================================================================
  class SetInst {
    public:
    // =========================================================================
    // =========================================================================

    SetInst();

    SetInst(const SetInst& aI);

    SetInst(const Instantiation& aI);

    SetInst& operator=(const SetInst& aI);

    SetInst(MultiDimAdressable& aMD);

    SetInst(const MultiDimAdressable& aMD);

    SetInst(MultiDimAdressable* aMD);

    SetInst(const MultiDimAdressable* aMD);

    ~SetInst();

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

    Idx nbrDim() const;

    void add(const DiscreteVariable& v);

    void erase(const DiscreteVariable& v);

    void clear();

    Size domainSize() const;

    Idx pos(const DiscreteVariable& v) const;

    Size vals(Idx i) const;

    Size vals(const DiscreteVariable& var) const;

    Size vals(const DiscreteVariable* var) const;

    Idx nbrOccurences(const DiscreteVariable& var) const;
 

    Idx val(Idx i) const;

    Idx val(const DiscreteVariable& var) const;

    Idx val(const DiscreteVariable* var) const;

    const DiscreteVariable& variable(Idx i) const;

    SetInst& chgVal(const DiscreteVariable& v, Idx newVal);

    SetInst& chgVal(const DiscreteVariable* v, Idx newVal);

    SetInst& chgVal(Idx varPos, Idx newVal);

    SetInst& chgVals(const DiscreteVariable& v, const Size newVal);

    SetInst& addVal(const DiscreteVariable& v, Idx newVal);

    SetInst& addVals(const DiscreteVariable& v, const Size newVal);

    SetInst& remVal(const DiscreteVariable& v, Idx newVal);

    SetInst& remVals(const DiscreteVariable& v, const Size newVal);

    SetInst& interVals(const DiscreteVariable& v, const Size newVal);

    SetInst& interVal(const DiscreteVariable& v, Idx newVal);

    SetInst& chgVals(const DiscreteVariable* v, const Size newVal);

    SetInst& addVal(const DiscreteVariable* v, Idx newVal);

    SetInst& addVals(const DiscreteVariable* v, const Size newVal);

    SetInst& remVal(const DiscreteVariable* v, Idx newVal);

    SetInst& remVals(const DiscreteVariable* v, const Size newVal);

    SetInst& interVals(const DiscreteVariable* v, const Size newVal);

    SetInst& interVal(const DiscreteVariable* v, Idx newVal);

    SetInst& chgVals(Idx varPos, const Size newVal);

    SetInst& addVal(Idx varPos, Idx newVal);

    SetInst& addVals(Idx varPos, const Size newVal);

    SetInst& remVal(Idx varPos, Idx newVal);

    SetInst& remVals(Idx varPos, const Size newVal);

    SetInst& interVals(Idx varPos, const Size newVal);

    SetInst& interVal(Idx varPos, Idx newVal);

    SetInst& chgDifVal(Idx varPos, const Size newVal);

    SetInst& chgValIn(const SetInst& i);

    bool contains(const DiscreteVariable& v) const;

    bool contains(const DiscreteVariable* v) const;

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

    virtual bool empty() const;

    std::string toString() const;

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

    void reorder(const SetInst& i);

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

    bool inOverflow() const;

    void unsetOverflow();

    void unsetEnd();

    bool end() const;

 
    bool rend() const;

 

 
    // ############################################################################
    // ############################################################################

    static void assign_values(Bijection< const DiscreteVariable*, const DiscreteVariable* >& bij,
                              const SetInst&                                                 i,
                              SetInst&                                                       j);

 
    protected:
    virtual void replace_(const DiscreteVariable* x, const DiscreteVariable* y);
 
    private:
    Sequence< const DiscreteVariable* > _vars_;

    std::vector< Size > _vals_;

    bool _overflow_;

    void _swap_(Idx i, Idx j);

    void _chgVal_(Idx varPos, Idx newVal);

    void _chgVals_(Idx varPos, const Size newVal);

    void _add_(const DiscreteVariable& v);

    void _erase_(const DiscreteVariable& v);

    void _init_(MultiDimAdressable* master);
  };

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

  gum::SetInst& operator<<(gum::SetInst& inst, const gum::DiscreteVariable& i);

  gum::SetInst& operator>>(gum::SetInst& inst, const gum::DiscreteVariable& i);
 
} /* namespace gum */
 
#ifndef GUM_NO_INLINE
#  include <agrum/base/multidim/setInst_inl.h>
#endif /* GUM_NO_INLINE */
 
#endif /* GUM_SetInst_H */