PRMSystem.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_SYSTEM_H
#define GUM_SYSTEM_H
 
#include <string>
#include <utility>
 
#include <agrum/base/variables/integerVariable.h>
#include <agrum/BN/BayesNetFactory.h>
#include <agrum/PRM/elements/PRMInstance.h>
 
namespace gum {
  namespace prm {

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

      explicit PRMSystem(const std::string& name);

      virtual ~PRMSystem();

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

      const DiGraph& skeleton() const;

      PRMInstance< GUM_SCALAR >& get(NodeId id);

      const PRMInstance< GUM_SCALAR >& get(NodeId id) const;
 
      NodeId get(const PRMInstance< GUM_SCALAR >& i) const;

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

      virtual PRMObject::prm_type obj_type() const;

      Size size() const;

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

      bool isInstantiated(const PRMClass< GUM_SCALAR >& c) const;

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

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

      void groundedBN(BayesNetFactory< GUM_SCALAR >& factory) const;

      void instantiate();

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

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

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

      const Set< PRMInstance< GUM_SCALAR >* >& get(const PRMClass< GUM_SCALAR >& type) const;

      NodeId add(PRMInstance< GUM_SCALAR >* i);

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

      const Sequence< PRMInstance< GUM_SCALAR >* >& getArray(const std::string& name) const;

      PRMClassElementContainer< GUM_SCALAR >& getArrayType(const std::string& name);

      const PRMClassElementContainer< GUM_SCALAR >& getArrayType(const std::string& name) const;

      NodeId add(const std::string& array, PRMInstance< GUM_SCALAR >* i);

      NodeId add(const std::string& array, PRMInstance< GUM_SCALAR >& i);

      void addArray(const std::string& array, PRMClassElementContainer< GUM_SCALAR >& type);

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

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

      iterator begin();

      const iterator& end();

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

      const_iterator begin() const;

      const const_iterator& end() const;

      using array_iterator = typename Sequence< PRMInstance< GUM_SCALAR >* >::iterator;

      array_iterator begin(const std::string& a);

      const array_iterator& end(const std::string& a);

      using const_array_iterator = typename Sequence< PRMInstance< GUM_SCALAR >* >::const_iterator;

      const_array_iterator begin(const std::string& a) const;

      const const_array_iterator& end(const std::string& a) const;

 
      protected:
      PRMSystem(const PRMSystem< GUM_SCALAR >& from);

      PRMSystem< GUM_SCALAR >& operator=(const PRMSystem< GUM_SCALAR >& from) = delete;
 
      // ========================================================================
      // ========================================================================

      DiGraph skeleton_;

      NodeProperty< PRMInstance< GUM_SCALAR >* > nodeIdMap_;

      HashTable< std::string, PRMInstance< GUM_SCALAR >* > nameMap_;

      HashTable< PRMClass< GUM_SCALAR >*, Set< PRMInstance< GUM_SCALAR >* >* > instanceMap_;

      using model_pair = std::pair< PRMClassElementContainer< GUM_SCALAR >*,
                                    Sequence< PRMInstance< GUM_SCALAR >* >* >;

      HashTable< std::string, model_pair > arrayMap_;

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

      void _groundRef_(const PRMInstance< GUM_SCALAR >& instance,
                       BayesNetFactory< GUM_SCALAR >&   factory) const;

      void _groundAttr_(const PRMInstance< GUM_SCALAR >& instance,
                        BayesNetFactory< GUM_SCALAR >&   factory) const;

      void _groundTensor_(const PRMInstance< GUM_SCALAR >&  instance,
                          const PRMAttribute< GUM_SCALAR >& attr,
                          BayesNetFactory< GUM_SCALAR >&    factory) const;

      void _groundAgg_(const PRMClassElement< GUM_SCALAR >& elt,
                       const std::string&                   name,
                       BayesNetFactory< GUM_SCALAR >&       factory) const;
    };
 
 
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
    extern template class PRMSystem< double >;
#endif
 
 
  } /* namespace prm */
 
} /* namespace gum */
 
#include <agrum/PRM/elements/PRMSystem_tpl.h>
 
#endif   // GUM_SYSTEM_H