sum.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_SUM_AGGREGATOR_H
#define GUM_SUM_AGGREGATOR_H
 
#include <agrum/base/multidim/aggregators/multiDimAggregator.h>
 
namespace gum::aggregator {
  // =========================================================================
  // ===                     GUM_SUM_AGGREGATOR                            ===
  // =========================================================================

  template < GUM_Numeric GUM_SCALAR >
  class Sum final: public MultiDimAggregator< GUM_SCALAR > {
    public:
    Sum();
    Sum(const Sum< GUM_SCALAR >& from);
    ~Sum() override;

    [[nodiscard]] MultiDimContainer< GUM_SCALAR >* newFactory() const final;
 
    std::string aggregatorName() const final;
 
    protected:
    Idx neutralElt_() const final;
    [[nodiscard]] Idx
        fold_(const DiscreteVariable& v, Idx i1, Idx i2, bool& stop_iteration) const final;
 
    private:
    Idx _value_;
  };
 
 
#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
  extern template class Sum< double >;
#endif
 
 
}   // namespace gum::aggregator
 
#include <agrum/base/multidim/aggregators/sum_tpl.h>
 
#endif   // GUM_SUM_AGGREGATOR_H