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 58 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 38 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 49 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 58 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 67 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 142 of file O3SystemFactory_tpl.h.

References gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::__prm, gum::prm::o3prm::O3System::assignments(), gum::prm::o3prm::O3Label::label(), gum::prm::o3prm::O3System::name(), and gum::prm::PRMFactory< GUM_SCALAR >::setReferenceSlot().

Referenced by gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::build().

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

Here is the call graph for this function:

Here is the caller graph for this function:

__addIncrements()

template<typename GUM_SCALAR >

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

private

Definition at line 168 of file O3SystemFactory_tpl.h.

References gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::__prm, gum::prm::o3prm::O3System::increments(), gum::prm::o3prm::O3Label::label(), gum::prm::o3prm::O3System::name(), and gum::prm::PRMFactory< GUM_SCALAR >::setReferenceSlot().

Referenced by gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::build().

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

Here is the call graph for this function:

Here is the caller graph for this function:

__addInstances()

template<typename GUM_SCALAR >

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

private

Definition at line 120 of file O3SystemFactory_tpl.h.

References gum::prm::PRMFactory< GUM_SCALAR >::addArray(), gum::prm::PRMFactory< GUM_SCALAR >::addInstance(), gum::HashTable< Key, Val, Alloc >::insert(), and gum::prm::o3prm::O3System::instances().

Referenced by gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::build().

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

Here is the call graph for this function:

Here is the caller graph for this function:

__checkAssignments()

template<typename GUM_SCALAR >

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

private

Definition at line 269 of file O3SystemFactory_tpl.h.

References gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::__errors, gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::__nameMap, gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::__prm, and gum::prm::o3prm::O3System::assignments().

Referenced by gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::__checkSystem().

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

Here is the call graph for this function:

Here is the caller graph for this function:

__checkIncrements()

template<typename GUM_SCALAR >

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

private

Definition at line 318 of file O3SystemFactory_tpl.h.

References gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::__errors, gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::__nameMap, gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::__prm, and gum::prm::o3prm::O3System::increments().

Referenced by gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::__checkSystem().

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

Here is the call graph for this function:

Here is the caller graph for this function:

__checkInstance()

template<typename GUM_SCALAR >

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

private

Definition at line 203 of file O3SystemFactory_tpl.h.

References gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::__checkParameters(), gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::__errors, gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::__nameMap, gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::__prm, gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::__solver, and gum::prm::o3prm::O3System::instances().

Referenced by gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::__checkSystem().

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

Here is the call graph for this function:

Here is the caller graph for this function:

__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 224 of file O3SystemFactory_tpl.h.

References gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::__errors, gum::prm::PRMClassElementContainer< GUM_SCALAR >::exists(), gum::prm::PRMClass< GUM_SCALAR >::get(), GUM_ERROR, and gum::prm::o3prm::O3Instance::parameters().

Referenced by gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::__checkInstance().

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

Here is the call graph for this function:

Here is the caller graph for this function:

__checkSystem()

template<typename GUM_SCALAR >

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

private

Definition at line 193 of file O3SystemFactory_tpl.h.

References gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::__checkAssignments(), gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::__checkIncrements(), and gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::__checkInstance().

Referenced by gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::build().

                                                                            {
        if (__checkInstance(sys) && __checkAssignments(sys)
            && __checkIncrements(sys)) {
          return true;
        }

        return false;
      }

Here is the call graph for this function:

Here is the caller graph for this function:

build()

template<typename GUM_SCALAR >

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

(

)

Definition at line 96 of file O3SystemFactory_tpl.h.

References gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::__addAssignments(), gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::__addIncrements(), gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::__addInstances(), gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::__checkSystem(), gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::__errors, gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::__nameMap, gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::__o3_prm, gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::__prm, gum::prm::PRMFactory< GUM_SCALAR >::endSystem(), gum::prm::PRMFactory< GUM_SCALAR >::startSystem(), and gum::prm::o3prm::O3PRM::systems().

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

Here is the call graph for this function:

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 73 of file O3SystemFactory_tpl.h.

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

                                                      {
        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 85 of file O3SystemFactory_tpl.h.

References gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::__errors, gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::__o3_prm, gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::__prm, and gum::prm::o3prm::O3SystemFactory< 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;
      }

Member Data Documentation

__errors

template<typename GUM_SCALAR>

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

private

Definition at line 78 of file O3SystemFactory.h.

Referenced by gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::__checkAssignments(), gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::__checkIncrements(), gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::__checkInstance(), gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::__checkParameters(), gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::build(), and gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::operator=().

__nameMap

template<typename GUM_SCALAR>

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

private

Definition at line 80 of file O3SystemFactory.h.

Referenced by gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::__checkAssignments(), gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::__checkIncrements(), gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::__checkInstance(), and gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::build().

__o3_prm

template<typename GUM_SCALAR>

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

private

Definition at line 76 of file O3SystemFactory.h.

Referenced by gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::build(), and gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::operator=().

__prm

template<typename GUM_SCALAR>

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

private

Definition at line 75 of file O3SystemFactory.h.

Referenced by gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::__addAssignments(), gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::__addIncrements(), gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::__checkAssignments(), gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::__checkIncrements(), gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::__checkInstance(), gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::build(), and gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::operator=().

__solver

template<typename GUM_SCALAR>

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

private

Definition at line 77 of file O3SystemFactory.h.

Referenced by gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::__checkInstance(), and gum::prm::o3prm::O3SystemFactory< GUM_SCALAR >::operator=().

---

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

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