Bulds gum::prm:PRMInterface from gum::prm::o3prm::O3Interface. More...

#include <agrum/PRM/o3prm/O3InterfaceFactory.h>

Collaboration diagram for gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >:

Public Member Functions
	O3InterfaceFactory (PRM< GUM_SCALAR > &prm, O3PRM &o3_prm, O3NameSolver< GUM_SCALAR > &solver, ErrorsContainer &errors)
	O3InterfaceFactory (const O3InterfaceFactory< GUM_SCALAR > &src)
	O3InterfaceFactory (O3InterfaceFactory< GUM_SCALAR > &&src)
	~O3InterfaceFactory ()
O3InterfaceFactory< GUM_SCALAR > &	operator= (const O3InterfaceFactory< GUM_SCALAR > &src)
O3InterfaceFactory< GUM_SCALAR > &	operator= (O3InterfaceFactory< GUM_SCALAR > &&src)
void	buildInterfaces ()
void	buildElements ()

Private Member Functions
bool	_addInterface2Dag_ ()
bool	_addArcs2Dag_ ()
void	_setO3InterfaceCreationOrder_ ()
bool	_checkO3Interfaces_ ()
bool	_checkInterfaceElement_ (O3Interface &i, O3InterfaceElement &elt)
bool	_checkOverloadLegality_ (O3Interface &i, O3InterfaceElement &elt)
bool	_checkAttributeOverloadLegality_ (O3Interface &i, O3InterfaceElement &elt)
bool	_checkReferenceOverloadLegality_ (O3Interface &i, O3InterfaceElement &elt)
bool	_checkCyclicReference_ (O3Interface &i, O3InterfaceElement &elt)

Private Attributes
PRM< GUM_SCALAR > *	_prm_
O3PRM *	_o3_prm_
O3NameSolver< GUM_SCALAR > *	_solver_
ErrorsContainer *	_errors_
HashTable< std::string, std::string >	_eltName_
HashTable< std::string, gum::NodeId >	_nameMap_
HashTable< std::string, O3Interface * >	_interfaceMap_
HashTable< NodeId, O3Interface * >	_nodeMap_
DAG	_dag_
std::vector< O3Interface * >	_o3Interface_

Detailed Description

template<GUM_Numeric GUM_SCALAR>
class gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >

Bulds gum::prm:PRMInterface from gum::prm::o3prm::O3Interface.

Template Parameters

GUM_SCALAR The scalar type used by the gum::prm::PRM.

Definition at line 73 of file O3InterfaceFactory.h.

Constructor & Destructor Documentation

◆ O3InterfaceFactory() [1/3]

template<GUM_Numeric GUM_SCALAR>

gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::O3InterfaceFactory	(	PRM< GUM_SCALAR > &	prm,
		O3PRM &	o3_prm,
		O3NameSolver< GUM_SCALAR > &	solver,
		ErrorsContainer &	errors )

Definition at line 59 of file O3InterfaceFactory_tpl.h.

                                                                                               :
          _prm_(&prm), _o3_prm_(&o3_prm), _solver_(&solver), _errors_(&errors) {
        GUM_CONSTRUCTOR(O3InterfaceFactory);
      }

References O3InterfaceFactory(), _errors_, _o3_prm_, _prm_, and _solver_.

Referenced by O3InterfaceFactory(), O3InterfaceFactory(), O3InterfaceFactory(), ~O3InterfaceFactory(), operator=(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ O3InterfaceFactory() [2/3]

template<GUM_Numeric GUM_SCALAR>

gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::O3InterfaceFactory ( const O3InterfaceFactory< GUM_SCALAR > & src )

Definition at line 68 of file O3InterfaceFactory_tpl.h.

                                                       :
          _prm_(src._prm_), _o3_prm_(src._o3_prm_), _solver_(src._solver_), _errors_(src._errors_) {
        GUM_CONS_CPY(O3InterfaceFactory);
      }

References O3InterfaceFactory(), _errors_, _o3_prm_, _prm_, and _solver_.

Here is the call graph for this function:

◆ O3InterfaceFactory() [3/3]

template<GUM_Numeric GUM_SCALAR>

gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::O3InterfaceFactory ( O3InterfaceFactory< GUM_SCALAR > && src )

Definition at line 75 of file O3InterfaceFactory_tpl.h.

                                                                                                 :
          _prm_(std::move(src._prm_)), _o3_prm_(std::move(src._o3_prm_)),
          _solver_(std::move(src._solver_)), _errors_(std::move(src._errors_)) {
        GUM_CONS_MOV(O3InterfaceFactory);
      }

References O3InterfaceFactory(), _errors_, _o3_prm_, _prm_, and _solver_.

Here is the call graph for this function:

◆ ~O3InterfaceFactory()

template<GUM_Numeric GUM_SCALAR>

gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::~O3InterfaceFactory ( )

Definition at line 82 of file O3InterfaceFactory_tpl.h.

                                                            {
        GUM_DESTRUCTOR(O3InterfaceFactory);
      }

References O3InterfaceFactory().

Here is the call graph for this function:

Member Function Documentation

◆ _addArcs2Dag_()

template<GUM_Numeric GUM_SCALAR>

bool gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::_addArcs2Dag_ ( )

private

Definition at line 148 of file O3InterfaceFactory_tpl.h.

                                                           {
        // Adding arcs to the graph inheritance graph
        for (auto& i: _o3_prm_->interfaces()) {
          if (i->superLabel().label() != "") {
            if (!_solver_->resolveInterface(i->superLabel())) { return false; }
 
            auto head = _nameMap_[i->superLabel().label()];
            auto tail = _nameMap_[i->name().label()];
 
            try {
              _dag_.addArc(tail, head);
 
            } catch (InvalidDirectedCycle const&) {
              // Cyclic inheritance
              O3PRM_INTERFACE_CYCLIC_INHERITANCE(i->name(), i->superLabel(), *_errors_);
              return false;
            }
          }
        }
        return true;
      }

References _dag_, _errors_, _nameMap_, _o3_prm_, and _solver_.

Referenced by _checkO3Interfaces_().

Here is the caller graph for this function:

◆ _addInterface2Dag_()

template<GUM_Numeric GUM_SCALAR>

bool gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::_addInterface2Dag_ ( )

private

Definition at line 129 of file O3InterfaceFactory_tpl.h.

                                                                {
        // Adding nodes to the type inheritance graph
        for (auto& i: _o3_prm_->interfaces()) {
          auto id = _dag_.addNode();
          try {
            _nameMap_.insert(i->name().label(), id);
            _interfaceMap_.insert(i->name().label(), i.get());
            _nodeMap_.insert(id, i.get());
 
          } catch (DuplicateElement const&) {
            // Raised if duplicate type names
            O3PRM_INTERFACE_DUPLICATE(i->name(), *_errors_);
            return false;
          }
        }
        return true;
      }

References _dag_, _errors_, _interfaceMap_, _nameMap_, _nodeMap_, and _o3_prm_.

Referenced by _checkO3Interfaces_().

Here is the caller graph for this function:

◆ _checkAttributeOverloadLegality_()

template<GUM_Numeric GUM_SCALAR>

bool gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::_checkAttributeOverloadLegality_	(	O3Interface &	i,
		O3InterfaceElement &	elt )

private

Definition at line 245 of file O3InterfaceFactory_tpl.h.

                                   {
        const auto& real_i   = _prm_->getInterface(i.name().label());
        const auto& real_elt = real_i.get(elt.name().label());
 
        const auto& sub_type   = _prm_->type(elt.type().label());
        const auto& super_type = real_elt.type();
 
        if (!sub_type.isSubTypeOf(super_type)) {
          O3PRM_INTERFACE_ILLEGAL_OVERLOAD(elt, *_errors_);
          return false;
        }
 
        if (sub_type.name() == super_type.name()) {
          O3PRM_INTERFACE_DUPLICATE_ELEMENT(elt, *_errors_);
          return false;
        }
 
        return true;
      }

References _errors_, _prm_, gum::prm::o3prm::O3Label::label(), gum::prm::o3prm::O3Interface::name(), gum::prm::o3prm::O3InterfaceElement::name(), and gum::prm::o3prm::O3InterfaceElement::type().

Referenced by _checkOverloadLegality_().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _checkCyclicReference_()

template<GUM_Numeric GUM_SCALAR>

bool gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::_checkCyclicReference_	(	O3Interface &	i,
		O3InterfaceElement &	elt )

private

Definition at line 299 of file O3InterfaceFactory_tpl.h.

                                                                                             {
        if (_prm_->isInterface(elt.type().label()) || _prm_->isClass(elt.type().label())) {
          auto ref_type = (const PRMClassElementContainer< GUM_SCALAR >*)nullptr;
 
          if (_prm_->isInterface(elt.type().label())) {
            ref_type = &(_prm_->getInterface(elt.type().label()));
          } else {
            ref_type = &(_prm_->getClass(elt.type().label()));
          }
 
          const auto& real_i = _prm_->getInterface(i.name().label());
 
          if (&real_i == ref_type) {
            O3PRM_INTERFACE_SELF_REFERENCE(i, elt, *_errors_);
            return false;
          }
 
          if (ref_type->isSubTypeOf(real_i)) {
            O3PRM_INTERFACE_ILLEGAL_SUB_REFERENCE(i, elt, *_errors_);
            return false;
          }
        }
 
        return true;
      }

References _errors_, _prm_, gum::prm::o3prm::O3Label::label(), gum::prm::o3prm::O3Interface::name(), and gum::prm::o3prm::O3InterfaceElement::type().

Referenced by _checkInterfaceElement_().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _checkInterfaceElement_()

template<GUM_Numeric GUM_SCALAR>

bool gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::_checkInterfaceElement_	(	O3Interface &	i,
		O3InterfaceElement &	elt )

private

Definition at line 207 of file O3InterfaceFactory_tpl.h.

                                                                                              {
        if (!_solver_->resolveClassElement(elt.type())) { return false; }
 
        if (_prm_->isType(elt.type().label()) && elt.isArray()) {
          O3PRM_INTERFACE_ILLEGAL_ARRAY(elt.name(), *_errors_);
          return false;
        }
 
        const auto& real_i = _prm_->getInterface(i.name().label());
 
        if (real_i.exists(elt.name().label())) {
          if (!_checkOverloadLegality_(i, elt)) { return false; }
        }
 
        if (!_checkCyclicReference_(i, elt)) { return false; }
 
        return true;
      }

References _checkCyclicReference_(), _checkOverloadLegality_(), _errors_, _prm_, _solver_, gum::prm::o3prm::O3InterfaceElement::isArray(), gum::prm::o3prm::O3Label::label(), gum::prm::o3prm::O3Interface::name(), gum::prm::o3prm::O3InterfaceElement::name(), and gum::prm::o3prm::O3InterfaceElement::type().

Referenced by buildElements().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _checkO3Interfaces_()

template<GUM_Numeric GUM_SCALAR>

bool gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::_checkO3Interfaces_ ( )

private

Definition at line 124 of file O3InterfaceFactory_tpl.h.

                                                                 {
        return _addInterface2Dag_() && _addArcs2Dag_();
      }

References _addArcs2Dag_(), and _addInterface2Dag_().

Referenced by buildInterfaces().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _checkOverloadLegality_()

template<GUM_Numeric GUM_SCALAR>

bool gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::_checkOverloadLegality_	(	O3Interface &	i,
		O3InterfaceElement &	elt )

private

Definition at line 228 of file O3InterfaceFactory_tpl.h.

                                                                                              {
        const auto& real_i   = _prm_->getInterface(i.name().label());
        const auto& real_elt = real_i.get(elt.name().label());
 
        if (PRMClassElement< GUM_SCALAR >::isAttribute(real_elt)) {
          return _checkAttributeOverloadLegality_(i, elt);
        }
 
        if (PRMClassElement< GUM_SCALAR >::isReferenceSlot(real_elt)) {
          return _checkReferenceOverloadLegality_(i, elt);
        }
 
        return false;
      }

References _checkAttributeOverloadLegality_(), _checkReferenceOverloadLegality_(), _prm_, gum::prm::PRMClassElement< GUM_SCALAR >::isAttribute(), gum::prm::PRMClassElement< GUM_SCALAR >::isReferenceSlot(), gum::prm::o3prm::O3Label::label(), gum::prm::o3prm::O3Interface::name(), and gum::prm::o3prm::O3InterfaceElement::name().

Referenced by _checkInterfaceElement_().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _checkReferenceOverloadLegality_()

template<GUM_Numeric GUM_SCALAR>

bool gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::_checkReferenceOverloadLegality_	(	O3Interface &	i,
		O3InterfaceElement &	elt )

private

Definition at line 268 of file O3InterfaceFactory_tpl.h.

                                   {
        const auto& real_i = _prm_->getInterface(i.name().label());
        const auto& real_elt
            = static_cast< const PRMReferenceSlot< GUM_SCALAR >& >(real_i.get(elt.name().label()));
 
        auto sub_type = (const PRMClassElementContainer< GUM_SCALAR >*)nullptr;
 
        if (_prm_->isClass(elt.type().label())) {
          sub_type = &(_prm_->getClass(elt.type().label()));
        } else {
          sub_type = &(_prm_->getInterface(elt.type().label()));
        }
 
        auto super_type = &(real_elt.slotType());
 
        if (!sub_type->isSubTypeOf(*super_type)) {
          O3PRM_INTERFACE_ILLEGAL_OVERLOAD(elt, *_errors_);
          return false;
        }
 
        if (sub_type->name() == super_type->name()) {
          O3PRM_INTERFACE_DUPLICATE_ELEMENT(elt, *_errors_);
          return false;
        }
 
        return true;
      }

References _errors_, _prm_, gum::prm::o3prm::O3Label::label(), gum::prm::o3prm::O3Interface::name(), gum::prm::o3prm::O3InterfaceElement::name(), and gum::prm::o3prm::O3InterfaceElement::type().

Referenced by _checkOverloadLegality_().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _setO3InterfaceCreationOrder_()

template<GUM_Numeric GUM_SCALAR>

void gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::_setO3InterfaceCreationOrder_ ( )

private

Definition at line 171 of file O3InterfaceFactory_tpl.h.

                                                                           {
        auto topo_order = _dag_.topologicalOrder();
        for (auto id = topo_order.rbegin(); id != topo_order.rend(); --id) {
          _o3Interface_.push_back(_nodeMap_[*id]);
        }
      }

References _dag_, _nodeMap_, and _o3Interface_.

Referenced by buildInterfaces().

Here is the caller graph for this function:

◆ buildElements()

template<GUM_Numeric GUM_SCALAR>

void gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::buildElements ( )

Definition at line 179 of file O3InterfaceFactory_tpl.h.

                                                           {
        PRMFactory< GUM_SCALAR > factory(_prm_);
 
        for (auto i: _o3Interface_) {
          _prm_->getInterface(i->name().label()).inheritInterface();
 
          factory.continueInterface(i->name().label());
 
          for (auto& elt: i->elements()) {
            if (_checkInterfaceElement_(*i, elt)) {
              try {
                if (_prm_->isType(elt.type().label())) {
                  factory.addAttribute(elt.type().label(), elt.name().label());
                } else {
                  factory.addReferenceSlot(elt.type().label(), elt.name().label(), elt.isArray());
                }
 
              } catch (OperationNotAllowed const&) {
                // Duplicate or Wrong overload
                O3PRM_INTERFACE_DUPLICATE_ELEMENT(elt, *_errors_);
              }
            }
          }
          factory.endInterface();
        }
      }

References _checkInterfaceElement_(), _errors_, _o3Interface_, _prm_, gum::prm::PRMFactory< GUM_SCALAR >::addAttribute(), gum::prm::PRMFactory< GUM_SCALAR >::addReferenceSlot(), gum::prm::PRMFactory< GUM_SCALAR >::continueInterface(), and gum::prm::PRMFactory< GUM_SCALAR >::endInterface().

Here is the call graph for this function:

◆ buildInterfaces()

template<GUM_Numeric GUM_SCALAR>

void gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::buildInterfaces ( )

Definition at line 109 of file O3InterfaceFactory_tpl.h.

                                                             {
        PRMFactory< GUM_SCALAR > factory(_prm_);
        if (_checkO3Interfaces_()) {
          _setO3InterfaceCreationOrder_();
 
          for (auto i: _o3Interface_) {
            if (_solver_->resolveInterface(i->superLabel())) {
              factory.startInterface(i->name().label(), i->superLabel().label(), true);
              factory.endInterface();
            }
          }
        }
      }

References _checkO3Interfaces_(), _o3Interface_, _prm_, _setO3InterfaceCreationOrder_(), _solver_, gum::prm::PRMFactory< GUM_SCALAR >::endInterface(), and gum::prm::PRMFactory< GUM_SCALAR >::startInterface().

Here is the call graph for this function:

◆ operator=() [1/2]

template<GUM_Numeric GUM_SCALAR>

O3InterfaceFactory< GUM_SCALAR > & gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::operator= ( const O3InterfaceFactory< GUM_SCALAR > & src )

Definition at line 88 of file O3InterfaceFactory_tpl.h.

                                                                                               {
        if (this == &src) { return *this; }
        _prm_    = src._prm_;
        _o3_prm_ = src._o3_prm_;
        _solver_ = src._solver_;
        _errors_ = src._errors_;
        return *this;
      }

References O3InterfaceFactory(), _errors_, _o3_prm_, _prm_, and _solver_.

Here is the call graph for this function:

◆ operator=() [2/2]

template<GUM_Numeric GUM_SCALAR>

O3InterfaceFactory< GUM_SCALAR > & gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::operator= ( O3InterfaceFactory< GUM_SCALAR > && src )

Definition at line 99 of file O3InterfaceFactory_tpl.h.

                                                                                          {
        if (this == &src) { return *this; }
        _prm_    = std::move(src._prm_);
        _o3_prm_ = std::move(src._o3_prm_);
        _solver_ = std::move(src._solver_);
        _errors_ = std::move(src._errors_);
        return *this;
      }