median_tpl.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                           *
 *                                                                          *
 ****************************************************************************/
 
#pragma once
 

 
#include <vector>
 
// to ease parser in IDEs
#include <agrum/base/multidim/aggregators/median.h>
#include <agrum/base/multidim/aggregators/multiDimAggregator.h>
 
namespace gum {
 
  namespace aggregator {
    template < GUM_Numeric GUM_SCALAR >
    Median< GUM_SCALAR >::Median() : MultiDimAggregator< GUM_SCALAR >() {
      GUM_CONSTRUCTOR(Median);
    }
 
    template < GUM_Numeric GUM_SCALAR >
    Median< GUM_SCALAR >::Median(const Median< GUM_SCALAR >& from) :
        MultiDimAggregator< GUM_SCALAR >(from) {
      GUM_CONS_CPY(Median);
    }
 
    template < GUM_Numeric GUM_SCALAR >
    Median< GUM_SCALAR >::~Median() {
      GUM_DESTRUCTOR(Median);
    }
 
    template < GUM_Numeric GUM_SCALAR >
    std::string Median< GUM_SCALAR >::aggregatorName() const {
      return "median";
    }
 
    template < GUM_Numeric GUM_SCALAR >
    MultiDimContainer< GUM_SCALAR >* Median< GUM_SCALAR >::newFactory() const {
      return new Median< GUM_SCALAR >();
    }
 
    template < GUM_Numeric GUM_SCALAR >
    Idx Median< GUM_SCALAR >::buildValue_(const gum::Instantiation& i) const {
      if (i.nbrDim() < 2) return i.nbrDim() / 2;   // arbitrary. Guess = (max-min)/2 .
 
      // we assume that every (parent) variable has the same domainSize
      Idx maxVal = i.variable(1).domainSize();
 
      std::vector< Idx > cum(maxVal, 0);
 
      for (Idx j = 1; j < this->nbrDim(); j++)
        cum[i.val(j)]++;
 
      Idx half = (this->nbrDim() + 1) / 2;   // 50% of the population
 
      Idx max = maxVal;
      for (Idx j = 0, sumcum = 0; j < maxVal; j++)
        if ((sumcum += cum[j]) >= half) {
          max = j;
          break;
        }
      Idx maxR = maxVal;
      for (Idx j = maxVal - 1, jj = 0, sumcum = 0; jj < maxVal; jj++, j--)
        if ((sumcum += cum[j]) >= half) {
          maxR = j;
          break;
        }
 
      // multiDimAggregator::get will truncate if needed.
      return (maxR + max) / 2;
    }
 
    template < GUM_Numeric GUM_SCALAR >
    Idx Median< GUM_SCALAR >::fold_(const DiscreteVariable& v,
                                    Idx                     i1,
                                    Idx                     i2,
                                    bool&                   stop_iteration) const {
      return 0;
    }
 
    template < GUM_Numeric GUM_SCALAR >
    Idx Median< GUM_SCALAR >::neutralElt_() const {
      return 0;
    }
 
  }   // namespace aggregator
}   // namespace gum