gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR > Class Template Reference

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 58 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 37 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 48 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 56 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 65 of file O3InterfaceFactory_tpl.h.

                                                                   {
        GUM_DESTRUCTOR(O3InterfaceFactory);
      }

Member Function Documentation

addArcs2Dag__()

template<typename GUM_SCALAR >

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

private

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

addInterface2Dag__()

template<typename GUM_SCALAR >

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

private

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

buildElements()

template<typename GUM_SCALAR >

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

(

)

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

buildInterfaces()

template<typename GUM_SCALAR >

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

(

)

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

checkAttributeOverloadLegality__()

template<typename GUM_SCALAR >

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

private

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

checkCyclicReference__()

template<typename GUM_SCALAR >

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

private

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

checkInterfaceElement__()

template<typename GUM_SCALAR >

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

private

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

checkO3Interfaces__()

template<typename GUM_SCALAR >

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

private

Definition at line 111 of file O3InterfaceFactory_tpl.h.

                                                                        {
        return addInterface2Dag__() && addArcs2Dag__();
      }

checkOverloadLegality__()

template<typename GUM_SCALAR >

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

private

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

checkReferenceOverloadLegality__()

template<typename GUM_SCALAR >

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

private

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

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

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.

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

setO3InterfaceCreationOrder__()

template<typename GUM_SCALAR >

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

private

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

Member Data Documentation

dag__

template<typename GUM_SCALAR >

DAG gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::dag__

private

Definition at line 86 of file O3InterfaceFactory.h.

eltName__

template<typename GUM_SCALAR >

HashTable< std::string, std::string > gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::eltName__

private

Definition at line 82 of file O3InterfaceFactory.h.

errors__

template<typename GUM_SCALAR >

ErrorsContainer* gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::errors__

private

Definition at line 80 of file O3InterfaceFactory.h.

interfaceMap__

template<typename GUM_SCALAR >

HashTable< std::string, O3Interface* > gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::interfaceMap__

private

Definition at line 84 of file O3InterfaceFactory.h.

nameMap__

template<typename GUM_SCALAR >

HashTable< std::string, gum::NodeId > gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::nameMap__

private

Definition at line 83 of file O3InterfaceFactory.h.

nodeMap__

template<typename GUM_SCALAR >

HashTable< NodeId, O3Interface* > gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::nodeMap__

private

Definition at line 85 of file O3InterfaceFactory.h.

o3_prm__

template<typename GUM_SCALAR >

O3PRM* gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::o3_prm__

private

Definition at line 78 of file O3InterfaceFactory.h.

o3Interface__

template<typename GUM_SCALAR >

std::vector< O3Interface* > gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::o3Interface__

private

Definition at line 87 of file O3InterfaceFactory.h.

prm__

template<typename GUM_SCALAR >

PRM< GUM_SCALAR >* gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::prm__

private

Definition at line 77 of file O3InterfaceFactory.h.

solver__

template<typename GUM_SCALAR >

O3NameSolver< GUM_SCALAR >* gum::prm::o3prm::O3InterfaceFactory< GUM_SCALAR >::solver__

private

Definition at line 79 of file O3InterfaceFactory.h.

---

The documentation for this class was generated from the following files:

• agrum/PRM/o3prm/O3InterfaceFactory.h
• agrum/PRM/o3prm/O3InterfaceFactory_tpl.h