PRMClassElementContainer.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2026 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-2026                            *
 *       - 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_ELEMENT_CONTAINER_H
#define GUM_CLASS_ELEMENT_CONTAINER_H
 
 
#include <agrum/PRM/utils_prm.h>
 
namespace gum {
  namespace prm {
 
    template < GUM_Numeric GUM_SCALAR >
    class PRMClass;
    template < GUM_Numeric GUM_SCALAR >
    class PRMInterface;
    class PRMClassElementContainterIterator;
    class PRMClassElementContainterConstIterator;

    template < GUM_Numeric GUM_SCALAR >
    class PRMClassElementContainer: public PRMObject {
      friend class PRMClassElementContainterIterator;
      friend class PRMClassElementContainterConstIterator;
 
      public:
      // ========================================================================
      // ========================================================================

      PRMClassElementContainer(std::string_view name);

      ~PRMClassElementContainer() override;

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

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

      virtual bool exists(std::string_view name) const;

      virtual PRMClassElement< GUM_SCALAR >& get(std::string_view name) = 0;

      virtual const PRMClassElement< GUM_SCALAR >& get(std::string_view name) const = 0;

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

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

      virtual void addArc(std::string_view tail, std::string_view head) = 0;

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

      virtual void setInputNode(const PRMClassElement< GUM_SCALAR >& elt, bool b);

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

      virtual void setOutputNode(const PRMClassElement< GUM_SCALAR >& elt, bool b);

      virtual bool isInnerNode(const PRMClassElement< GUM_SCALAR >& elt) const;
      // ========================================================================
      // ========================================================================

      virtual const DAG& containerDag() const;

      virtual bool exists(NodeId id) const;

      virtual PRMClassElement< GUM_SCALAR >& get(NodeId id) = 0;

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

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

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

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

      virtual PRMClassElement< GUM_SCALAR >& operator[](std::string_view name) = 0;

      virtual const PRMClassElement< GUM_SCALAR >& operator[](std::string_view name) const = 0;

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

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

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

 
      protected:
      PRMClassElementContainer< GUM_SCALAR >&
          operator=(const PRMClassElementContainer< GUM_SCALAR >& source);

      PRMClassElementContainer(const PRMClassElementContainer< GUM_SCALAR >& source);
 
      virtual const DAG& dag_() const = 0;

      virtual DAG& dag_() = 0;

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

      virtual std::pair< bool, bool >& getIOFlag_(const PRMClassElement< GUM_SCALAR >& elt);

      virtual const std::pair< bool, bool >&
          getIOFlag_(const PRMClassElement< GUM_SCALAR >& elt) const;

      virtual void setIOFlag_(const PRMClassElement< GUM_SCALAR >& elt,
                              const std::pair< bool, bool >&       flags);

      virtual void copyIOFlags_(const PRMClassElementContainer< GUM_SCALAR >& c);

      virtual void updateDescendants_(const PRMClassElement< GUM_SCALAR >& elt) = 0;
 
      private:
      HashTable< std::string, std::pair< bool, bool > > _IOFlags_;
    };
 
 
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
    extern template class PRMClassElementContainer< double >;
#endif
 
 
  } /* namespace prm */
 
}   // namespace gum

template < gum::GUM_Numeric GUM_SCALAR >
std::ostream& operator<<(std::ostream&                                           output,
                         const gum::prm::PRMClassElementContainer< GUM_SCALAR >& container);
 
#include <agrum/PRM/elements/PRMClassElementContainer_tpl.h>
 
#endif /* GUM_CLASS_ELEMENT_CONTAINER_H */