libstdc++-v3/testsuite/util/statistic/sample_mean.hpp

   1 // -*- C++ -*-
   2
   3 // Copyright (C) 2005-2024 Free Software Foundation, Inc.
   4 //
   5 // This file is part of the GNU ISO C++ Library.  This library is free
   6 // software; you can redistribute it and/or modify it under the terms
   7 // of the GNU General Public License as published by the Free Software
   8 // Foundation; either version 3, or (at your option) any later
   9 // version.
  10
  11 // This library is distributed in the hope that it will be useful, but
  12 // WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // General Public License for more details.
  15
  16 // You should have received a copy of the GNU General Public License
  17 // along with this library; see the file COPYING3.  If not see
  18 // <http://www.gnu.org/licenses/>.
  19
  20
  21 // Copyright (C) 2004 Ami Tavory and Vladimir Dreizin, IBM-HRL.
  22
  23 // Permission to use, copy, modify, sell, and distribute this software
  24 // is hereby granted without fee, provided that the above copyright
  25 // notice appears in all copies, and that both that copyright notice
  26 // and this permission notice appear in supporting documentation. None
  27 // of the above authors, nor IBM Haifa Research Laboratories, make any
  28 // representation about the suitability of this software for any
  29 // purpose. It is provided "as is" without express or implied
  30 // warranty.
  31
  32 /**
  33  * @file sample_mean.hpp
  34  * Contains a function for calculating a sample mean
  35  */
  36
  37 #ifndef PB_DS_SAMPLE_MEAN_HPP
  38 #define PB_DS_SAMPLE_MEAN_HPP
  39
  40 #include <list>
  41 #include <numeric>
  42 #include <math.h>
  43 #include <iterator>
  44
  45 namespace __gnu_pbds
  46 {
  47   namespace test
  48   {
  49     namespace detail
  50     {
  51 #define PB_DS_VTYPE typename std::iterator_traits<It>::value_type
  52
  53       template<typename It>
  54       PB_DS_VTYPE
  55       sample_mean(It b, It e)
  56       {
  57         const PB_DS_VTYPE total = std::accumulate(b, e, PB_DS_VTYPE(0));
  58         const size_t num = std::distance(b, e);
  59         return total / num;
  60       }
  61
  62 #undef PB_DS_VTYPE
  63
  64     } // namespace detail
  65   } // namespace test
  66 } // namespace __gnu_pbds
  67
  68 #endif
  69