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

Builds gum::prm::PRMSystem from gum::prm::o3prm::O3System. More...

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

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

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

Detailed Description

template<typename GUM_SCALAR>
class gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >

Builds gum::prm::PRMSystem from gum::prm::o3prm::O3System.

Template Parameters

GUM_SCALAR

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

Definition at line 57 of file O3SystemFactory.h.

Constructor & Destructor Documentation

O3SystemFactory() [1/3]

template<typename GUM_SCALAR >

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

Definition at line 37 of file O3SystemFactory_tpl.h.

                                             :
          prm__(&prm),
          o3_prm__(&o3_prm), solver__(&solver), errors__(&errors) {
        GUM_CONSTRUCTOR(O3SystemFactory);
      }

O3SystemFactory() [2/3]

template<typename GUM_SCALAR >

INLINE gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::O3SystemFactory

(

const O3SystemFactory< GUM_SCALAR > &

src

)

Definition at line 48 of file O3SystemFactory_tpl.h.

                                                   :
          prm__(src.prm__),
          o3_prm__(src.o3_prm__), solver__(src.solver__), errors__(src.errors__),
          nameMap__(src.nameMap__) {
        GUM_CONS_CPY(O3SystemFactory);
      }

O3SystemFactory() [3/3]

template<typename GUM_SCALAR >

INLINE gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::O3SystemFactory

(

O3SystemFactory< GUM_SCALAR > &&

src

)

Definition at line 57 of file O3SystemFactory_tpl.h.

                                              :
          prm__(std::move(src.prm__)),
          o3_prm__(std::move(src.o3_prm__)), solver__(std::move(src.solver__)),
          errors__(std::move(src.errors__)), nameMap__(std::move(src.nameMap__)) {
        GUM_CONS_MOV(O3SystemFactory);
      }

~O3SystemFactory()

template<typename GUM_SCALAR >

INLINE gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::~O3SystemFactory

(

)

Definition at line 66 of file O3SystemFactory_tpl.h.

                                                             {
        GUM_DESTRUCTOR(O3SystemFactory);
      }

Member Function Documentation

addAssignments__()

template<typename GUM_SCALAR >

INLINE void gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::addAssignments__ ( PRMFactory< GUM_SCALAR > &  factory, O3System &  sys  )

private

Definition at line 143 of file O3SystemFactory_tpl.h.

                                        {
        const auto& real_sys = prm__->getSystem(sys.name().label());

        for (auto& ass: sys.assignments()) {
          auto leftInstance  = ass.leftInstance().label();
          auto leftReference = ass.leftReference().label();
          auto rightInstance = ass.rightInstance().label();

          if (ass.leftIndex().value() > -1 && real_sys.isArray(leftInstance)) {
            std::stringstream sBuff;
            sBuff << leftInstance << "[" << ass.leftIndex().value() << "]";
            leftInstance = sBuff.str();
          }

          if (ass.rightIndex().value() > -1 && real_sys.isArray(rightInstance)) {
            std::stringstream sBuff;
            sBuff << rightInstance << "[" << ass.rightIndex().value() << "]";
            rightInstance = sBuff.str();
          }

          factory.setReferenceSlot(leftInstance, leftReference, rightInstance);
        }
      }

addIncrements__()

template<typename GUM_SCALAR >

INLINE void gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::addIncrements__ ( PRMFactory< GUM_SCALAR > &  factory, O3System &  sys  )

private

Definition at line 170 of file O3SystemFactory_tpl.h.

                                        {
        const auto& real_sys = prm__->getSystem(sys.name().label());
        for (auto& inc: sys.increments()) {
          auto leftInstance  = inc.leftInstance().label();
          auto leftReference = inc.leftReference().label();
          auto rightInstance = inc.rightInstance().label();

          if (inc.leftIndex().value() > -1 && real_sys.isArray(leftInstance)) {
            std::stringstream sBuff;
            sBuff << leftInstance << "[" << inc.leftIndex().value() << "]";
            leftInstance = sBuff.str();
          }

          if (inc.rightIndex().value() > -1 && real_sys.isArray(rightInstance)) {
            std::stringstream sBuff;
            sBuff << rightInstance << "[" << inc.rightIndex().value() << "]";
            rightInstance = sBuff.str();
          }

          factory.setReferenceSlot(leftInstance, leftReference, rightInstance);
        }
      }

addInstances__()

template<typename GUM_SCALAR >

INLINE void gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::addInstances__ ( PRMFactory< GUM_SCALAR > &  factory, O3System &  sys  )

private

Definition at line 119 of file O3SystemFactory_tpl.h.

                                        {
        for (auto& i: sys.instances()) {
          if (i.parameters().size() > 0) {
            auto params = HashTable< std::string, double >();
            for (auto& p: i.parameters()) {
              params.insert(p.name().label(), (double)p.value().value());
            }
            factory.addInstance(i.type().label(), i.name().label(), params);

          } else {
            if (i.size().value() > 1) {
              factory.addArray(i.type().label(),
                               i.name().label(),
                               i.size().value());
            } else {
              factory.addInstance(i.type().label(), i.name().label());
            }
          }
        }
      }

build()

template<typename GUM_SCALAR >

INLINE void gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::build

(

)

Definition at line 95 of file O3SystemFactory_tpl.h.

                                                       {
        PRMFactory< GUM_SCALAR > factory(prm__);

        for (auto& sys: o3_prm__->systems()) {
          // Reseting name map for each system
          nameMap__ = HashTable< std::string, O3Instance* >();

          if (checkSystem__(*sys)) {
            factory.startSystem(sys->name().label());

            addInstances__(factory, *sys);
            addAssignments__(factory, *sys);
            addIncrements__(factory, *sys);

            try {
              factory.endSystem();
            } catch (FatalError&) {
              O3PRM_SYSTEM_INSTANTIATION_FAILED(*sys, *errors__);
            }
          }
        }
      }

checkAssignments__()

template<typename GUM_SCALAR >

INLINE bool gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::checkAssignments__ ( O3System &  sys )

private

Definition at line 273 of file O3SystemFactory_tpl.h.

                                                                        {
        for (auto& ass: sys.assignments()) {
          // if ( ass.leftInstance().label() == ass.leftReference().label() ) {
          //  O3PRM_SYSTEM_INVALID_LEFT_VALUE( ass.leftInstance(), *errors__ );
          //  return false;
          //}

          if (!nameMap__.exists(ass.leftInstance().label())) {
            O3PRM_SYSTEM_INSTANCE_NOT_FOUND(ass.leftInstance(), *errors__);
            return false;
          }

          auto        i    = nameMap__[ass.leftInstance().label()];
          const auto& type = prm__->getClass(i->type().label());
          const auto& ref  = ass.leftReference().label();

          if (!(type.exists(ass.leftReference().label())
                && PRMClassElement< GUM_SCALAR >::isReferenceSlot(
                   type.get(ref)))) {
            O3PRM_SYSTEM_REFERENCE_NOT_FOUND(ass.leftReference(),
                                             type.name(),
                                             *errors__);
            return false;
          }

          const auto& real_ref
             = static_cast< const PRMReferenceSlot< GUM_SCALAR >& >(type.get(ref));

          if (!nameMap__.exists(ass.rightInstance().label())) {
            O3PRM_SYSTEM_INSTANCE_NOT_FOUND(ass.rightInstance(), *errors__);
            return false;
          }

          if (real_ref.isArray()
              && nameMap__[ass.rightInstance().label()]->size().value() == 0) {
            O3PRM_SYSTEM_NOT_AN_ARRAY(ass.rightInstance(), *errors__);
            return false;
          }

          if ((!real_ref.isArray())
              && nameMap__[ass.rightInstance().label()]->size().value() > 0
              && ass.rightIndex().value() == -1) {
            O3PRM_SYSTEM_NOT_AN_ARRAY(ass.leftReference(), *errors__);
            return false;
          }
        }
        return true;
      }

checkIncrements__()

template<typename GUM_SCALAR >

INLINE bool gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::checkIncrements__ ( O3System &  sys )

private

Definition at line 323 of file O3SystemFactory_tpl.h.

                                                                                {
        for (auto& inc: sys.increments()) {
          // if ( inc.leftInstance().label() == inc.leftReference().label() ) {
          //  O3PRM_SYSTEM_INVALID_LEFT_VALUE( inc.leftInstance(), *errors__ );
          //  return false;
          //}

          if (!nameMap__.exists(inc.leftInstance().label())) {
            O3PRM_SYSTEM_INSTANCE_NOT_FOUND(inc.leftInstance(), *errors__);
            return false;
          }

          auto        i    = nameMap__[inc.leftInstance().label()];
          const auto& type = prm__->getClass(i->type().label());
          const auto& ref  = inc.leftReference().label();

          if (!(type.exists(inc.leftReference().label())
                && PRMClassElement< GUM_SCALAR >::isReferenceSlot(
                   type.get(ref)))) {
            O3PRM_SYSTEM_REFERENCE_NOT_FOUND(inc.leftReference(),
                                             type.name(),
                                             *errors__);
            return false;
          }

          const auto& real_ref
             = static_cast< const PRMReferenceSlot< GUM_SCALAR >& >(type.get(ref));

          if (!real_ref.isArray()) {
            O3PRM_SYSTEM_NOT_AN_ARRAY(inc.leftReference(), *errors__);
            return false;
          }
        }

        return true;
      }

checkInstance__()

template<typename GUM_SCALAR >

INLINE bool gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::checkInstance__ ( O3System &  sys )

private

Definition at line 206 of file O3SystemFactory_tpl.h.

                                                                              {
        for (auto& i: sys.instances()) {
          if (!solver__->resolveClass(i.type())) { return false; }

          const auto& type = prm__->getClass(i.type().label());
          if (type.parameters().size() > 0) {
            if (!checkParameters__(type, i)) { return false; }
          }

          if (nameMap__.exists(i.name().label())) {
            O3PRM_SYSTEM_DUPLICATE_INSTANCE(i, *errors__);
            return false;
          }

          nameMap__.insert(i.name().label(), &i);
        }

        return true;
      }

checkParameters__()

template<typename GUM_SCALAR >

INLINE bool gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::checkParameters__ ( const PRMClass< GUM_SCALAR > &  type, const O3Instance &  inst  )

private

Definition at line 227 of file O3SystemFactory_tpl.h.

                                             {
        for (const auto& param: inst.parameters()) {
          if (!type.exists(param.name().label())) {
            O3PRM_SYSTEM_PARAMETER_NOT_FOUND(param, *errors__);
            return false;
          }

          if (!PRMClassElement< GUM_SCALAR >::isParameter(
                 type.get(param.name().label()))) {
            O3PRM_SYSTEM_NOT_A_PARAMETER(param, *errors__);
            return false;
          }

          const auto& type_param
             = static_cast< const PRMParameter< GUM_SCALAR >& >(
                type.get(param.name().label()));

          switch (type_param.valueType()) {
            case PRMParameter< GUM_SCALAR >::ParameterType::INT: {
              if (!param.isInteger()) {
                O3PRM_SYSTEM_PARAMETER_NOT_INT(param, *errors__);
                return false;
              }
              break;
            }

            case PRMParameter< GUM_SCALAR >::ParameterType::REAL: {
              if (param.isInteger()) {
                O3PRM_SYSTEM_PARAMETER_NOT_FLOAT(param, *errors__);
                return false;
              }
              break;
            }

            default: {
              GUM_ERROR(FatalError, "unknown parameter type");
            }
          }
        }
        return true;
      }

checkSystem__()

template<typename GUM_SCALAR >

INLINE bool gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::checkSystem__ ( O3System &  sys )

private

Definition at line 196 of file O3SystemFactory_tpl.h.

                                                                            {
        if (checkInstance__(sys) && checkAssignments__(sys)
            && checkIncrements__(sys)) {
          return true;
        }

        return false;
      }

operator=() [1/2]

template<typename GUM_SCALAR >

INLINE O3SystemFactory< GUM_SCALAR > & gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::operator=

(

const O3SystemFactory< GUM_SCALAR > &

src

)

Definition at line 72 of file O3SystemFactory_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 O3SystemFactory< GUM_SCALAR > & gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::operator=

(

O3SystemFactory< GUM_SCALAR > &&

src

)

Definition at line 84 of file O3SystemFactory_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;
      }

Member Data Documentation

errors__

template<typename GUM_SCALAR >

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

private

Definition at line 77 of file O3SystemFactory.h.

nameMap__

template<typename GUM_SCALAR >

HashTable< std::string, O3Instance* > gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::nameMap__

private

Definition at line 79 of file O3SystemFactory.h.

o3_prm__

template<typename GUM_SCALAR >

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

private

Definition at line 75 of file O3SystemFactory.h.

prm__

template<typename GUM_SCALAR >

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

private

Definition at line 74 of file O3SystemFactory.h.

solver__

template<typename GUM_SCALAR >

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

private

Definition at line 76 of file O3SystemFactory.h.

---

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

• agrum/PRM/o3prm/O3SystemFactory.h
• agrum/PRM/o3prm/O3SystemFactory_tpl.h