PRMInstance.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_INSTANCE_H
#define GUM_INSTANCE_H
 
#include <set>
#include <utility>
 
#include <agrum/PRM/elements/PRMClass.h>
 
namespace gum {
  namespace prm {
 

    template < typename GUM_SCALAR >
    class PRMInstance: public PRMObject {
      public:
      // ========================================================================
      // ========================================================================

      PRMInstance(const std::string& name, PRMClass< GUM_SCALAR >& type);

      virtual ~PRMInstance();

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

      virtual prm_type obj_type() const;

      PRMClass< GUM_SCALAR >& type();

      const PRMClass< GUM_SCALAR >& type() const;

      bool exists(NodeId id) const;

      bool exists(const std::string& name) const;

      PRMAttribute< GUM_SCALAR >& get(NodeId id);

      PRMAttribute< GUM_SCALAR >& get(const std::string& name);

      const PRMAttribute< GUM_SCALAR >& get(NodeId id) const;

      const PRMAttribute< GUM_SCALAR >& get(const std::string& name) const;

      Size size() const;

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

      void instantiate();

      const Bijection< const DiscreteVariable*, const DiscreteVariable* >& bijection() const;

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

      void add(NodeId id, PRMInstance< GUM_SCALAR >& instance);

      const PRMInstance< GUM_SCALAR >& getInstance(NodeId id) const;

      const Set< PRMInstance< GUM_SCALAR >* >& getInstances(NodeId id) const;

      bool hasRefAttr(NodeId id) const;

      std::vector< std::pair< PRMInstance< GUM_SCALAR >*, std::string > >& getRefAttr(NodeId id);

      const std::vector< std::pair< PRMInstance< GUM_SCALAR >*, std::string > >&
          getRefAttr(NodeId id) const;

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

      using iterator = typename NodeProperty< PRMAttribute< GUM_SCALAR >* >::iterator;

      iterator begin();

      const iterator& end();

      using const_iterator = typename NodeProperty< PRMAttribute< GUM_SCALAR >* >::const_iterator;

      const_iterator begin() const;

      const const_iterator& end() const;

      class RefIterator {
        public:
        explicit RefIterator(Set< PRMInstance< GUM_SCALAR >* >& set);
 
        RefIterator(const RefIterator& from);
 
        ~RefIterator();
 
        RefIterator& operator=(const RefIterator& from);
 
        RefIterator& operator++();
 
        bool isEnd() const;
 
        bool operator!=(const RefIterator& from) const;
 
        bool operator==(const RefIterator& from) const;
 
        PRMInstance< GUM_SCALAR >& operator*() const;
        PRMInstance< GUM_SCALAR >* operator->() const;
 
        private:
        Set< PRMInstance< GUM_SCALAR >* >&                   _set_;
        typename Set< PRMInstance< GUM_SCALAR >* >::iterator _iter_;
      };

      RefIterator begin(NodeId id);

      class RefConstIterator {
        public:
        explicit RefConstIterator(const Set< PRMInstance< GUM_SCALAR >* >& set);
 
        RefConstIterator(const RefConstIterator& from);
 
        ~RefConstIterator();
 
        RefConstIterator& operator=(const RefConstIterator& from);
 
        RefConstIterator& operator++();
 
        bool isEnd() const;
 
        bool operator!=(const RefConstIterator& from) const;
 
        bool operator==(const RefConstIterator& from) const;
 
        const PRMInstance< GUM_SCALAR >& operator*() const;
        const PRMInstance< GUM_SCALAR >* operator->() const;
 
        private:
        const Set< PRMInstance< GUM_SCALAR >* >&                   _set_;
        typename Set< PRMInstance< GUM_SCALAR >* >::const_iterator _iter_;
      };

      RefConstIterator begin(NodeId id) const;
 
      using InvRefIterator = typename NodeProperty<
          std::vector< std::pair< PRMInstance< GUM_SCALAR >*, std::string > >* >::iterator;
      using InvRefConstIterator = typename NodeProperty<
          std::vector< std::pair< PRMInstance< GUM_SCALAR >*, std::string > >* >::const_iterator;
 
      InvRefIterator        beginInvRef();
      const InvRefIterator& endInvRef();
 
      InvRefConstIterator        beginInvRef() const;
      const InvRefConstIterator& endInvRef() const;

 
      private:
      PRMInstance(const PRMInstance< GUM_SCALAR >& source);

      PRMInstance< GUM_SCALAR >& operator=(const PRMClass< GUM_SCALAR >& from);
 
      // ========================================================================
      // ========================================================================

      void _copyAggregates_(PRMAggregate< GUM_SCALAR >* source);

      void _copyAttribute_(PRMAttribute< GUM_SCALAR >* source);

      void _doInstantiate_();

      void _instantiateSlotChain_(PRMSlotChain< GUM_SCALAR >* sc);

      void _copyAttributeCPF_(PRMAttribute< GUM_SCALAR >* attr);

      void _addReferingInstance_(PRMSlotChain< GUM_SCALAR >* sc, PRMInstance< GUM_SCALAR >* i);

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

      bool _instantiated_;

      PRMClass< GUM_SCALAR >* _type_;

      NodeProperty< PRMAttribute< GUM_SCALAR >* > _nodeIdMap_;

      NodeProperty< Set< PRMInstance< GUM_SCALAR >* >* > _referenceMap_;

      using pair = std::pair< PRMInstance< GUM_SCALAR >*, std::string >;

      NodeProperty< std::vector< pair >* > _referingAttr_;

      Bijection< const DiscreteVariable*, const DiscreteVariable* > _bijection_;

    };
 
 
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
    extern template class PRMInstance< double >;
#endif
 
 
  } /* namespace prm */
} /* namespace gum */
 
#include <agrum/PRM/elements/PRMInstance_tpl.h>
 
#endif /* GUM_INSTANCE_H */