PRMFactory.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005 by Christophe GONZALES and Pierre-Henri WUILLEMIN  *
 *   {prenom.nom}_at_lip6.fr                                               *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifndef GUM_PRM_FACTORY_H
#define GUM_PRM_FACTORY_H

#include <iostream>
#include <limits>
#include <sstream>
#include <string>
#include <vector>

#include <agrum/agrum.h>
#include <agrum/core/list.h>

#include <agrum/multidim/implementations/multiDimSparse.h>
#include <agrum/variables/discreteVariable.h>

#include <agrum/PRM/IPRMFactory.h>
#include <agrum/PRM/PRM.h>
#include <agrum/PRM/utils_prm.h>

namespace gum {

  namespace prm {
    // ==========================================================================
    template < typename GUM_SCALAR >
    class PRMFactory : public IPRMFactory {
      public:
      // ======================================================================
      // ======================================================================

      PRMFactory();

      PRMFactory(PRM< GUM_SCALAR >* prm);

      PRMFactory(const PRMFactory& from) = delete;

      PRMFactory& operator=(const PRMFactory& from) = delete;
      virtual ~PRMFactory();

      // ========================================================================
      // ========================================================================

      PRM< GUM_SCALAR >* prm() const;

      virtual PRMObject::prm_type currentType() const override;

      virtual PRMObject*       getCurrent() override;
      virtual const PRMObject* getCurrent() const override;

      virtual PRMObject* closeCurrent() override;

      virtual std::string currentPackage() const override;

      PRMClass< GUM_SCALAR >& retrieveClass(const std::string& name);

      PRMType& retrieveType(const std::string& name);


      /* @brief Retrieve the common PRMType of a vector of
       *PRMClassElement<GUM_SCALAR>.
       *
       * The vector elts must only contains PRMClassElement<GUM_SCALAR> with a
       *PRMType, i.e.
       * PRMAttribute<GUM_SCALAR>, PRMAggregate and PRMSlotChain<GUM_SCALAR>. If
       *not, a
       *WrongClassElement is
       * raised.
       *
       * A common PRMType is PRMType t such as
       *t.isSuperTypeOf(elts[i]) for
       * 0 < i < elts.size(), where elts is a PRMType container.
       *
       * @param elts A vector of PRMClassElement<GUM_SCALAR>.
       * @return the common super PRMType of all
       *PRMClassElement<GUM_SCALAR> un elts.
       *
       * @throw WrongClassElement Raised if elts contains a
       *PRMClassElement<GUM_SCALAR>
       *                          without a PRMType.
       * @throw NotFound Raised if there exists no common super type of all
       *                 PRMClassElement<GUM_SCALAR> in elts.
       */
      PRMType& retrieveCommonType(
         const std::vector< PRMClassElement< GUM_SCALAR >* >& elts);

      // ======================================================================
      // ======================================================================

      virtual void pushPackage(const std::string& name) override;

      virtual std::string popPackage() override;

      // ======================================================================
      // ======================================================================

      virtual void addImport(const std::string& name) override;

      // ======================================================================
      // ======================================================================

      virtual void startDiscreteType(const std::string& name,
                                     std::string        super = "") override;

      virtual void addLabel(const std::string& l, std::string ext = "") override;

      virtual void endDiscreteType() override;

      virtual void startDiscretizedType(const std::string& name) override;

      virtual void addTick(double tick) override;

      virtual void endDiscretizedType() override;

      virtual void
         addRangeType(const std::string& name, long minVal, long maxVal) override;

      virtual bool isClassOrInterface(const std::string& type) const override;
      virtual bool isArrayInCurrentSystem(const std::string& name) const override;



      virtual void startClass(const std::string&        c,
                              const std::string&        ext = "",
                              const Set< std::string >* implements = nullptr,
                              bool delayInheritance = false) override;

      virtual void continueClass(const std::string& c) override;

      virtual void endClass(bool checkImplementations = true) override;

      // ======================================================================
      // ======================================================================

      virtual void startInterface(const std::string& i,
                                  const std::string& ext = "",
                                  bool delayInheritance = false) override;

      virtual void continueInterface(const std::string& name) override;

      virtual void addAttribute(const std::string& type,
                                const std::string& name) override;

      virtual void endInterface() override;

      // ======================================================================
      // ======================================================================

      virtual void addAttribute(PRMAttribute< GUM_SCALAR >* attr);

      virtual void startAttribute(const std::string& type,
                                  const std::string& name,
                                  bool scalar_atttr = false) override;

      virtual void continueAttribute(const std::string& name) override;

      virtual void addParent(const std::string& name) override;

      void setRawCPFByLines(const std::vector< GUM_SCALAR >& array);

      void setRawCPFByColumns(const std::vector< GUM_SCALAR >& array);

      virtual void setCPFByRule(const std::vector< std::string >& labels,
                                const std::vector< GUM_SCALAR >&  values);

      virtual void setCPFByRule(const std::vector< std::string >& labels,
                                const std::vector< std::string >& values) override;

      virtual void
         setRawCPFByFloatLines(const std::vector< float >& array) override;

      virtual void
         setRawCPFByFloatColumns(const std::vector< float >& array) override;

      virtual void
         setRawCPFByColumns(const std::vector< std::string >& array) override;

      virtual void
         setRawCPFByLines(const std::vector< std::string >& array) override;

      virtual void setCPFByFloatRule(const std::vector< std::string >& labels,
                                     const std::vector< float >& values) override;

      virtual void endAttribute() override;

      // ======================================================================
      // ======================================================================

      void addParameter(const std::string& type,
                        const std::string& name,
                        double             value) override;
      // ======================================================================
      // ======================================================================

      virtual void addAggregator(const std::string&                name,
                                 const std::string&                agg_type,
                                 const std::vector< std::string >& chains,
                                 const std::vector< std::string >& params,
                                 std::string type = "") override;

      void startAggregator(const std::string&                name,
                           const std::string&                agg_type,
                           const std::string&                rv_type,
                           const std::vector< std::string >& params);

      void continueAggregator(const std::string& name);


      void endAggregator();

      virtual void
         addNoisyOrCompound(const std::string&                name,
                            const std::vector< std::string >& chains,
                            const std::vector< float >&       numbers,
                            float                             leak,
                            const std::vector< std::string >& label) override;
      // ======================================================================
      // ======================================================================

      virtual void addReferenceSlot(const std::string& type,
                                    const std::string& name,
                                    bool               isArray) override;

      // ======================================================================
      // ======================================================================

      virtual void startSystem(const std::string& name) override;

      virtual void endSystem() override;

      virtual void addInstance(const std::string& type,
                               const std::string& name) override;

      void addInstance(const std::string&                      type,
                       const std::string&                      name,
                       const HashTable< std::string, double >& params) override;

      virtual void addArray(const std::string& type,
                            const std::string& name,
                            Size               size) override;

      virtual void incArray(const std::string& l_i,
                            const std::string& r_i) override;

      virtual void setReferenceSlot(const std::string& left_instance,
                                    const std::string& left_reference,
                                    const std::string& right_instance) override;

      virtual void setReferenceSlot(const std::string& l_i,
                                    const std::string& r_i) override;


      private:
      void __fill_sc_in_vector(std::vector< std::string >& v,
                               const std::string&          str);

      // ======================================================================
      // ======================================================================

      std::string __addPrefix(const std::string& str) const;

      //                             current declaration.
      PRMObject* __checkStack(Idx i, PRMObject::prm_type obj_type);

      PRMClassElement< GUM_SCALAR >* __checkStack(
         Idx i, typename PRMClassElement< GUM_SCALAR >::ClassElementType obj_type);

      PRMClassElementContainer< GUM_SCALAR >* __checkStackContainter(Idx i);

      // ======================================================================
      // ======================================================================

      PRMType* __retrieveType(const std::string& name) const;

      PRMClass< GUM_SCALAR >* __retrieveClass(const std::string& name) const;

      PRMInterface< GUM_SCALAR >*
         __retrieveInterface(const std::string& name) const;

      // ======================================================================
      // ======================================================================

      PRMSlotChain< GUM_SCALAR >*
         __buildSlotChain(PRMClassElementContainer< GUM_SCALAR >* start,
                          const std::string&                      name);

      bool __retrieveInputs(PRMClass< GUM_SCALAR >*                        c,
                            const std::vector< std::string >&              chains,
                            std::vector< PRMClassElement< GUM_SCALAR >* >& inputs);

      //
      PRMType* __retrieveCommonType(
         const std::vector< PRMClassElement< GUM_SCALAR >* >& elts);

      int __typeDepth(const PRMType* t);

      void __checkInterfaceImplementation(PRMClass< GUM_SCALAR >* c);

      void __addParent(PRMClassElementContainer< GUM_SCALAR >* c,
                       PRMAttribute< GUM_SCALAR >*             agg,
                       const std::string&                      name);

      void __addParent(PRMClass< GUM_SCALAR >*     c,
                       PRMAggregate< GUM_SCALAR >* agg,
                       const std::string&          name);
      // ======================================================================
      // ======================================================================

      void __addInstance(PRMClass< GUM_SCALAR >* type, const std::string& name);

      void __buildSlotChains(PRMSystem< GUM_SCALAR >* model);

      void __buildAggregateCPF(PRMSystem< GUM_SCALAR >* model);

      void __instantiateSlotChain(PRMSystem< GUM_SCALAR >*        model,
                                  PRMInstance< GUM_SCALAR >*      inst,
                                  PRMReferenceSlot< GUM_SCALAR >* ref,
                                  PRMSlotChain< GUM_SCALAR >*     sc);

      std::string
         __retrieveInstanceSequence(PRMInstance< GUM_SCALAR >*              inst,
                                    Sequence< PRMInstance< GUM_SCALAR >* >& seq,
                                    PRMSlotChain< GUM_SCALAR >*             sc);

      // ======================================================================
      // ======================================================================

      std::vector< std::string > __packages;

      std::vector< List< std::string >* > __namespaces;

      PRM< GUM_SCALAR >* __prm;

      std::vector< PRMObject* > __stack;

      HashTable< PRMAggregate< GUM_SCALAR >*, std::vector< std::string > >
         __agg_params;

    };
  } /* namespace prm */
} /* namespace gum */

#include <agrum/PRM/PRMFactory_tpl.h>

#endif /* GUM_PRM_FACTORY_H */