PRMType.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_RANDOM_VARIABLE_TYPE_H
#define GUM_RANDOM_VARIABLE_TYPE_H

#include <sstream>
#include <vector>

#include <agrum/agrum.h>

#include <agrum/multidim/implementations/multiDimArray.h>
#include <agrum/multidim/implementations/multiDimImplementation.h>
#include <agrum/variables/discreteVariable.h>
#include <agrum/variables/labelizedVariable.h>

#include <agrum/PRM/elements/PRMObject.h>
#include <agrum/PRM/utils_prm.h>

namespace gum {
  namespace prm {

    template < typename GUM_SCALAR >
    class PRMFactory;

    class PRMType : public PRMObject {
      public:
      // ==========================================================================
      // ==========================================================================

      template < typename GUM_SCALAR >
      friend class PRMFactory;

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

      static PRMType* boolean() {
        LabelizedVariable var("boolean", "Boolean variable", 0);
        var.addLabel("false");
        var.addLabel("true");
        return new PRMType(var);
      }

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

      explicit PRMType(const DiscreteVariable& var);

      PRMType(PRMType&                  super_type,
              const std::vector< Idx >& label_map,
              const DiscreteVariable&   var);

      PRMType(const PRMType& from);

      virtual ~PRMType();

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

      DiscreteVariable& variable();

      const DiscreteVariable& variable() const;

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

      DiscreteVariable& operator*();

      const DiscreteVariable& operator*() const;

      DiscreteVariable* operator->();

      DiscreteVariable const* operator->() const;

      bool operator==(const PRMObject& from) const;

      bool operator!=(const PRMObject& from) const;

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

      virtual prm_type obj_type() const;

      const std::string& name() const;

      bool isSubType() const;

      bool isSubTypeOf(const PRMType& super) const;

      bool isSuperTypeOf(const PRMType& t) const;

      PRMType& superType();

      const PRMType& superType() const;

      void setSuper(PRMType& t);

      const std::vector< Idx >& label_map() const;

      // ==========================================================================
      private:
      // ==========================================================================
      // ==========================================================================

      PRMType(PRMType&& from);

      PRMType& operator=(const PRMType& from);

      PRMType& operator=(PRMType&& from);

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

      bool __isValid() const;

      void __updateName();

      DiscreteVariable* __var;

      PRMType* __superType;

      std::vector< Idx >* __label_map;

    };

  } /* namespace prm */

} /* namespace gum */

#ifndef GUM_NO_INLINE
#  include <agrum/PRM/elements/PRMType_inl.h>
#endif   // GUM_NO_INLINE

#endif /* GUM_CLASS_H */