PRMAggregate.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2025 by                                             *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *                                                                          *
 *   The aGrUM/pyAgrum library is free software; you can redistribute it    *
 *   and/or modify it under the terms of either :                           *
 *                                                                          *
 *    - the GNU Lesser General Public License as published by               *
 *      the Free Software Foundation, either version 3 of the License,      *
 *      or (at your option) any later version,                              *
 *    - the MIT license (MIT),                                              *
 *    - or both in dual license, as here.                                   *
 *                                                                          *
 *   (see https://agrum.gitlab.io/articles/dual-licenses-lgplv3mit.html)    *
 *                                                                          *
 *   This aGrUM/pyAgrum library is distributed in the hope that it will be  *
 *   useful, but WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,          *
 *   INCLUDING BUT NOT LIMITED TO THE WARRANTIES MERCHANTABILITY or FITNESS *
 *   FOR A PARTICULAR PURPOSE  AND NONINFRINGEMENT. IN NO EVENT SHALL THE   *
 *   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
 *   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,        *
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR  *
 *   OTHER DEALINGS IN THE SOFTWARE.                                        *
 *                                                                          *
 *   See LICENCES for more details.                                         *
 *                                                                          *
 *   SPDX-FileCopyrightText: Copyright 2005-2025                            *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *   SPDX-License-Identifier: LGPL-3.0-or-later OR MIT                      *
 *                                                                          *
 *   Contact  : info_at_agrum_dot_org                                       *
 *   homepage : http://agrum.gitlab.io                                      *
 *   gitlab   : https://gitlab.com/agrumery/agrum                           *
 *                                                                          *
 ****************************************************************************/
 

 
#ifndef GUM_AGGREGATE_H
#define GUM_AGGREGATE_H
 
#include <memory>
#include <string>
 
#include <agrum/PRM/elements/PRMScalarAttribute.h>
#include <agrum/PRM/elements/PRMType.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,
        SUM
      };

      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 if (toLower(str) == "sum") {
          return AggregateType::SUM;
        } 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;

      bool isDecomposable() 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 Tensor< GUM_SCALAR >& cpf();

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

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

      PRMAggregate(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 */