multiDimAggregator.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2026 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-2026                            *
 *       - 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_MULTI_DIM_AGGREGATOR_H
#define GUM_MULTI_DIM_AGGREGATOR_H
 
#include <agrum/base/multidim/implementations/multiDimReadOnly.h>
#include <optional>
 
namespace gum {
  namespace aggregator {
    // =========================================================================
    // ===                       GUM_MULTI_DIM_AGGREGATOR                    ===
    // =========================================================================

    template < typename GUM_ELEMENT >
    class MultiDimAggregator: public MultiDimReadOnly< GUM_ELEMENT > {
      public:
      // =======================================================================
      // =======================================================================

      MultiDimAggregator();

      MultiDimAggregator(const MultiDimAggregator< GUM_ELEMENT >& from);

      ~MultiDimAggregator() override;


      [[nodiscard]] MultiDimContainer< GUM_ELEMENT >* newFactory() const override = 0;
 
      // =======================================================================
      // =======================================================================
 
      public:
      GUM_ELEMENT get(const Instantiation& i) const override;
 
      virtual std::string aggregatorName() const = 0;

      virtual std::optional< Idx > value() const;
      std::string toString() const override;
 
      void changeNotification(const gum::Instantiation&,
                              const gum::DiscreteVariable* const,
                              gum::Idx,
                              gum::Idx) override;
 
      void setFirstNotification(const gum::Instantiation&) override;
 
      void setLastNotification(const gum::Instantiation&) override;
 
      void setIncNotification(const gum::Instantiation&) override;
 
      void setDecNotification(const gum::Instantiation&) override;
 
      void setChangeNotification(const gum::Instantiation&) override;
 
      std::string toString(const gum::Instantiation* i) const override;

      Size realSize() const override;

      const std::string& name() const override;

      void copyFrom(const MultiDimContainer< GUM_ELEMENT >& src) const override;

      bool isDecomposable() const;

 
      protected:
      virtual Idx buildValue_(const gum::Instantiation& i) const;

      bool decomposable_;

      virtual Idx neutralElt_() const = 0;

      virtual Idx fold_(const DiscreteVariable& v, Idx i1, Idx i2, bool& stop_iteration) const = 0;
    };
 
 
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
    extern template class MultiDimAggregator< double >;
#endif

    template < typename GUM_ELEMENT >
    std::ostream& operator<<(std::ostream& s, const MultiDimAggregator< GUM_ELEMENT >& ag);
 
  } /* namespace aggregator */
} /* namespace gum */
 
#include <agrum/base/multidim/aggregators/multiDimAggregator_tpl.h>
 
#endif /* GUM_MULTI_DIM_AGGREGATOR_H */