PRMClass.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_CLASS_H
#define GUM_CLASS_H
 
#include <utility>
 
#include <agrum/agrum.h>
 
#include <agrum/PRM/elements/PRMParameter.h>
#include <agrum/PRM/elements/PRMSlotChain.h>
 
namespace gum {
  namespace prm {
 
    template < typename GUM_SCALAR >
    class PRMInterface;

    template < typename GUM_SCALAR >
    class PRMClass: public PRMClassElementContainer< GUM_SCALAR > {
      friend class PRMInterface< GUM_SCALAR >;
 
      public:

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

      PRMClass(const std::string&      name,
               PRMClass< GUM_SCALAR >& super,
               bool                    delayInheritance = false);

      PRMClass(const std::string&                        name,
               const Set< PRMInterface< GUM_SCALAR >* >& set,
               bool                                      delayInheritance = false);

      PRMClass(const std::string&                        name,
               PRMClass< GUM_SCALAR >&                   super,
               const Set< PRMInterface< GUM_SCALAR >* >& set,
               bool                                      delayInheritance = false);

      PRMClass(const PRMClass< GUM_SCALAR >& source) = delete;

      PRMClass(const PRMClass< GUM_SCALAR >&& source) = delete;

      PRMClass< GUM_SCALAR >& operator=(const PRMClass< GUM_SCALAR >& source) = delete;

      PRMClass< GUM_SCALAR >& operator=(const PRMClass< GUM_SCALAR >&& source) = delete;

      virtual ~PRMClass();

      virtual PRMObject::prm_type obj_type() const;
      // ========================================================================
      // ========================================================================

      PRMClassElement< GUM_SCALAR >& get(NodeId id);

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

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

      virtual bool isOutputNode(const PRMClassElement< GUM_SCALAR >& elt) const;

      bool isCastDescendant(const std::string& safe_name) const;

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

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

      virtual NodeId add(PRMClassElement< GUM_SCALAR >* elt);

      virtual NodeId overload(PRMClassElement< GUM_SCALAR >* elt);

      virtual void addArc(const std::string& tail, const std::string& head);

      const Set< PRMAttribute< GUM_SCALAR >* >& attributes() const;

      const Set< PRMParameter< GUM_SCALAR >* >& parameters() const;

      HashTable< std::string, const PRMParameter< GUM_SCALAR >* > scope() const;

      const Set< PRMAggregate< GUM_SCALAR >* >& aggregates() const;

      const Set< PRMReferenceSlot< GUM_SCALAR >* >& referenceSlots() const;

      const Set< PRMSlotChain< GUM_SCALAR >* >& slotChains() const;

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

      virtual bool isSubTypeOf(const PRMClassElementContainer< GUM_SCALAR >& cec) const;

      const PRMClass< GUM_SCALAR >& super() const;

      const Set< PRMInterface< GUM_SCALAR >* >& implements() const;

      const Set< PRMClass< GUM_SCALAR >* >& extensions() const;

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

      PRMClassElement< GUM_SCALAR >& operator[](NodeId id);

      const PRMClassElement< GUM_SCALAR >& operator[](NodeId id) const;

      PRMClassElement< GUM_SCALAR >& operator[](const std::string& name);

      const PRMClassElement< GUM_SCALAR >& operator[](const std::string& name) const;


      void inheritReferenceSlots();
      void inheritParameters();
      void inheritAttributes();
      void inheritAggregates();
      void inheritSlotChains();
      void initializeInheritance();
      void completeInheritance(const std::string& attr);
 
      protected:
      virtual const DAG& dag_() const;

      virtual DAG& dag_();

      void findAllSubtypes_(Set< PRMClassElementContainer< GUM_SCALAR >* >& set);

      void updateDescendants_(const PRMClassElement< GUM_SCALAR >& elt);
 
      private:
      // void  _copyClass_<GUM_SCALAR>(const Class<GUM_SCALAR>& c);
 
      // ========================================================================
      // ========================================================================

      DAG _dag_;

      NodeProperty< PRMClassElement< GUM_SCALAR >* > _nodeIdMap_;

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

      HashTable< std::string, PRMClassElement< GUM_SCALAR >* > _nameMap_;

      Set< PRMAttribute< GUM_SCALAR >* > _attributes_;

      Set< PRMReferenceSlot< GUM_SCALAR >* > _referenceSlots_;

      Set< PRMAggregate< GUM_SCALAR >* > _aggregates_;

      Set< PRMSlotChain< GUM_SCALAR >* > _slotChains_;

      Set< PRMParameter< GUM_SCALAR >* > _parameters_;

      void _addCastDescendants_(PRMClassElement< GUM_SCALAR >* attr);

      void _addCastDescendants_(PRMAttribute< GUM_SCALAR >* start, PRMAttribute< GUM_SCALAR >* end);

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

      PRMClass< GUM_SCALAR >* _superClass_;

      Set< PRMInterface< GUM_SCALAR >* >* _implements_;

      Set< PRMClass< GUM_SCALAR >* > _extensions_;

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

      HashFunc< PRMClassElementContainer< GUM_SCALAR >* > _dummy_hashfunc_;
 

      void _inheritClass_(const PRMClass< GUM_SCALAR >& c);

      void _implementInterfaces_(bool delayInheritance);

      void _checkInterfaces_(PRMClassElement< GUM_SCALAR >* elt);

      void _checkInterface_(PRMClassElement< GUM_SCALAR >* elt, PRMInterface< GUM_SCALAR >* i);

      void _checkRefInterfaces_(PRMReferenceSlot< GUM_SCALAR >* elt);

      void _checkRefInterface_(PRMReferenceSlot< GUM_SCALAR >* elt, PRMInterface< GUM_SCALAR >* i);

      void _addIOInterfaceFlags_(PRMClassElement< GUM_SCALAR >* elt);

      void _addExtension_(PRMClass< GUM_SCALAR >* c);

      bool _checkOverloadLegality_(const PRMClassElement< GUM_SCALAR >* overloaded,
                                   const PRMClassElement< GUM_SCALAR >* overloader);

      void _overloadAttribute_(PRMAttribute< GUM_SCALAR >* overloader,
                               PRMAttribute< GUM_SCALAR >* overloaded);

      void _overloadAggregate_(PRMAggregate< GUM_SCALAR >*    overloader,
                               PRMClassElement< GUM_SCALAR >* overloaded);

      void _overloadReference_(PRMReferenceSlot< GUM_SCALAR >* overloader,
                               PRMReferenceSlot< GUM_SCALAR >* overloaded);

      void _overloadParameter_(PRMParameter< GUM_SCALAR >* overloader,
                               PRMParameter< GUM_SCALAR >* overloaded);

    };
 
 
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
    extern template class PRMClass< double >;
#endif
 
 
  } /* namespace prm */
 
}   // namespace gum
 
#include <agrum/PRM/elements/PRMClass_tpl.h>
 
namespace gum {
 
  namespace prm {} /* namespace prm */
 
}   // namespace gum
 
 
#endif /* GUM_CLASS_H */