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 ()

Detailed Description

template<typename 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 59 of file O3InterfaceFactory.h.

Constructor & Destructor Documentation

◆ O3InterfaceFactory() [1/3]

template<typename GUM_SCALAR >

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

Definition at line 38 of file O3InterfaceFactory_tpl.h.

                                              :
           __prm(&prm),
           __o3_prm(&o3_prm), __solver(&solver), __errors(&errors) {
         GUM_CONSTRUCTOR(O3InterfaceFactory);
       }

◆ O3InterfaceFactory() [2/3]

template<typename GUM_SCALAR >

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

Definition at line 49 of file O3InterfaceFactory_tpl.h.

                                                       :
           __prm(src.__prm),
           __o3_prm(src.__o3_prm), __solver(src.__solver), __errors(src.__errors) {
         GUM_CONS_CPY(O3InterfaceFactory);
       }

◆ O3InterfaceFactory() [3/3]

template<typename GUM_SCALAR >

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

Definition at line 57 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);
       }

◆ ~O3InterfaceFactory()

template<typename GUM_SCALAR >

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

Definition at line 66 of file O3InterfaceFactory_tpl.h.

References gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::operator=().

                                                                    {
         GUM_DESTRUCTOR(O3InterfaceFactory);
       }

Here is the call graph for this function:

Member Function Documentation

◆ __addArcs2Dag()

template<typename GUM_SCALAR >

INLINE bool gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__addArcs2Dag ( )

private

Definition at line 133 of file O3InterfaceFactory_tpl.h.

References gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__dag, gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__errors, gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__nameMap, gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__o3_prm, gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__solver, gum::DAG::addArc(), and gum::prm::o3prm::O3PRM::interfaces().

Referenced by gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__checkO3Interfaces().

                                                                   {
         // 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&) {
               // Cyclic inheritance
               O3PRM_INTERFACE_CYCLIC_INHERITANCE(
                  i->name(), i->superLabel(), *__errors);
               return false;
             }
           }
         }
         return true;
       }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __addInterface2Dag()

template<typename GUM_SCALAR >

INLINE bool gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__addInterface2Dag ( )

private

Definition at line 114 of file O3InterfaceFactory_tpl.h.

References gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__dag, gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__errors, gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__interfaceMap, gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__nameMap, gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__nodeMap, gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__o3_prm, gum::NodeGraphPart::addNode(), gum::HashTable< Key, Val, Alloc >::insert(), and gum::prm::o3prm::O3PRM::interfaces().

Referenced by gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__checkO3Interfaces().

                                                                        {
         // 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&) {
             // Raised if duplicate type names
             O3PRM_INTERFACE_DUPLICATE(i->name(), *__errors);
             return false;
           }
         }
         return true;
       }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __checkAttributeOverloadLegality()

template<typename GUM_SCALAR >

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

private

Definition at line 234 of file O3InterfaceFactory_tpl.h.

References gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__errors, gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__prm, gum::prm::o3prm::O3Label::label(), gum::prm::o3prm::O3InterfaceElement::name(), gum::prm::o3prm::O3Interface::name(), and gum::prm::o3prm::O3InterfaceElement::type().

Referenced by gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__checkOverloadLegality().

                                                      {
         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;
       }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __checkCyclicReference()

template<typename GUM_SCALAR >

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

private

Definition at line 288 of file O3InterfaceFactory_tpl.h.

References gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__errors, gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__prm, gum::prm::o3prm::O3Label::label(), gum::prm::o3prm::O3Interface::name(), and gum::prm::o3prm::O3InterfaceElement::type().

Referenced by gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__checkInterfaceElement().

                                                   {
         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;
       }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __checkInterfaceElement()

template<typename GUM_SCALAR >

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

private

Definition at line 195 of file O3InterfaceFactory_tpl.h.

Referenced by gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::buildElements().

                                                   {
         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;
       }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __checkO3Interfaces()

template<typename GUM_SCALAR >

INLINE bool gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__checkO3Interfaces ( )

private

Definition at line 109 of file O3InterfaceFactory_tpl.h.

References gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__addArcs2Dag(), and gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__addInterface2Dag().

Referenced by gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::buildInterfaces().

                                                                         {
         return __addInterface2Dag() && __addArcs2Dag();
       }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __checkOverloadLegality()

template<typename GUM_SCALAR >

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

private

Definition at line 216 of file O3InterfaceFactory_tpl.h.

References gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__checkAttributeOverloadLegality(), gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__checkReferenceOverloadLegality(), gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__prm, gum::prm::o3prm::O3Label::label(), gum::prm::o3prm::O3InterfaceElement::name(), and gum::prm::o3prm::O3Interface::name().

Referenced by gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__checkInterfaceElement().

                                                   {
         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;
       }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __checkReferenceOverloadLegality()

template<typename GUM_SCALAR >

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

private

Definition at line 257 of file O3InterfaceFactory_tpl.h.

References gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__errors, gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__prm, gum::prm::o3prm::O3Label::label(), gum::prm::o3prm::O3InterfaceElement::name(), gum::prm::o3prm::O3Interface::name(), and gum::prm::o3prm::O3InterfaceElement::type().

Referenced by gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__checkOverloadLegality().

                                                      {
         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;
       }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __setO3InterfaceCreationOrder()

template<typename GUM_SCALAR >

INLINE void gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__setO3InterfaceCreationOrder ( )

private

Definition at line 158 of file O3InterfaceFactory_tpl.h.

References gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__dag, gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__nodeMap, gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__o3Interface, and gum::DiGraph::topologicalOrder().

Referenced by gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::buildInterfaces().

                                                                          {
         auto topo_order = __dag.topologicalOrder();
         for (auto id = topo_order.rbegin(); id != topo_order.rend(); --id) {
           __o3Interface.push_back(__nodeMap[*id]);
         }
       }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildElements()

template<typename GUM_SCALAR >

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

Definition at line 166 of file O3InterfaceFactory_tpl.h.

References gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__checkInterfaceElement(), gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__errors, gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__o3Interface, gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__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().

                                                                   {
         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&) {
                 // Duplicate or Wrong overload
                 O3PRM_INTERFACE_DUPLICATE_ELEMENT(elt, *__errors);
               }
             }
           }
           factory.endInterface();
         }
       }

Here is the call graph for this function:

◆ buildInterfaces()

template<typename GUM_SCALAR >

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

Definition at line 93 of file O3InterfaceFactory_tpl.h.

References gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__checkO3Interfaces(), gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__o3Interface, gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__prm, gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__setO3InterfaceCreationOrder(), gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__solver, gum::prm::PRMFactory< GUM_SCALAR >::endInterface(), and gum::prm::PRMFactory< GUM_SCALAR >::startInterface().

                                                                     {
         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();
             }
           }
         }
       }

Here is the call graph for this function:

◆ operator=() [1/2]

template<typename GUM_SCALAR >

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

Definition at line 72 of file O3InterfaceFactory_tpl.h.

References gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__errors, gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__o3_prm, gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__prm, and gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__solver.

Referenced by gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::~O3InterfaceFactory().

                                                                                                       {
         if (this == &src) { return *this; }
         __prm = src.__prm;
         __o3_prm = src.__o3_prm;
         __solver = src.__solver;
         __errors = src.__errors;
         return *this;
       }

Here is the caller graph for this function:

◆ operator=() [2/2]

template<typename GUM_SCALAR >

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

Definition at line 83 of file O3InterfaceFactory_tpl.h.

References gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__errors, gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__o3_prm, gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__prm, and gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::__solver.

                                                                                                  {
         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;
       }