PRMAggregate.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_AGGREGATE_H
#define GUM_AGGREGATE_H

#include <memory>
#include <string>

#include <agrum/multidim/aggregators/multiDimAggregator.h>
#include <agrum/multidim/implementations/multiDimImplementation.h>
#include <agrum/multidim/potential.h>

#include <agrum/PRM/elements/PRMType.h>
#include <agrum/PRM/elements/PRMClassElement.h>
#include <agrum/PRM/elements/PRMAttribute.h>
#include <agrum/PRM/elements/PRMAggregate.h>
#include <agrum/PRM/elements/PRMScalarAttribute.h>


namespace gum {
  namespace prm {

    template < typename GUM_SCALAR >
    class PRMAggregate : public PRMClassElement< GUM_SCALAR > {
      friend class PRMClass< GUM_SCALAR >;

      public:
      // ========================================================================
      // ========================================================================

      enum class AggregateType : char {
        MIN,
        MAX,
        COUNT,
        EXISTS,
        FORALL,
        OR,
        AND,
        AMPLITUDE,
        MEDIAN
      };

      static AggregateType str2enum(const std::string& str) {
        if (toLower(str) == "min") {
          return AggregateType::MIN;
        } else if (toLower(str) == "max") {
          return AggregateType::MAX;
        } else if (toLower(str) == "count") {
          return AggregateType::COUNT;
        } else if (toLower(str) == "exists") {
          return AggregateType::EXISTS;
        } else if (toLower(str) == "or") {
          return AggregateType::OR;
        } else if (toLower(str) == "and") {
          return AggregateType::AND;
        } else if (toLower(str) == "forall") {
          return AggregateType::FORALL;
        } else if (toLower(str) == "amplitude") {
          return AggregateType::AMPLITUDE;
        } else if (toLower(str) == "median") {
          return AggregateType::MEDIAN;
        } else {
          std::string msg = "Unknown aggregate: ";
          msg.append(str);
          GUM_ERROR(NotFound, msg);
        }
      }

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

      PRMAggregate(const std::string& name,
                   AggregateType      aggType,
                   const PRMType&     rvType);

      PRMAggregate(const std::string& name,
                   AggregateType      aggType,
                   const PRMType&     rvType,
                   Idx                label);

      virtual ~PRMAggregate();

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

      virtual typename PRMClassElement< GUM_SCALAR >::ClassElementType
         elt_type() const;

      AggregateType agg_type() const;

      Idx                label() const;
      const std::string& labelValue() const;

      std::shared_ptr< Idx > sharedLabel() const;

      void sharedLabel(std::shared_ptr< Idx > label);

      void setLabel(Idx idx);
      void setLabel(const std::string& label);

      bool hasLabel() const;

      virtual void addParent(const PRMClassElement< GUM_SCALAR >& elt);

      virtual void addChild(const PRMClassElement< GUM_SCALAR >& elt);

      virtual PRMType& type();

      virtual const PRMType& type() const;

      virtual Potential< GUM_SCALAR >& cpf();

      virtual const Potential< GUM_SCALAR >& cpf() const;

      MultiDimImplementation< GUM_SCALAR >* buildImpl() const;

      virtual PRMAttribute< GUM_SCALAR >* getCastDescendant() const;
      private:
      // ========================================================================
      // ========================================================================

      PRMAggregate< GUM_SCALAR >(const PRMAggregate< GUM_SCALAR >& source);

      PRMAggregate< GUM_SCALAR >&
         operator=(const PRMAggregate< GUM_SCALAR >& source);

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

      AggregateType __agg_type;

      PRMType* __type;

      std::shared_ptr< Idx > __label;
      // Idx* __label;
      std::string __label_value;

    };


#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
    extern template class PRMAggregate< double >;
#endif

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

#include <agrum/PRM/elements/PRMAggregate_tpl.h>

#endif /* GUM_AGGREGATE_H */