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

   1 // -*- C++ -*-
   2
   3 // Copyright (C) 2005, 2006 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 2, 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 COPYING.  If not, write to
  18 // the Free Software Foundation, 59 Temple Place - Suite 330, Boston,
  19 // MA 02111-1307, USA.
  20
  21 // As a special exception, you may use this file as part of a free
  22 // software library without restriction.  Specifically, if other files
  23 // instantiate templates or use macros or inline functions from this
  24 // file, or you compile this file and link it with other files to
  25 // produce an executable, this file does not by itself cause the
  26 // resulting executable to be covered by the GNU General Public
  27 // License.  This exception does not however invalidate any other
  28 // reasons why the executable file might be covered by the GNU General
  29 // Public License.
  30
  31 // Copyright (C) 2004 Ami Tavory and Vladimir Dreizin, IBM-HRL.
  32
  33 // Permission to use, copy, modify, sell, and distribute this software
  34 // is hereby granted without fee, provided that the above copyright
  35 // notice appears in all copies, and that both that copyright notice
  36 // and this permission notice appear in supporting documentation. None
  37 // of the above authors, nor IBM Haifa Research Laboratories, make any
  38 // representation about the suitability of this software for any
  39 // purpose. It is provided "as is" without express or implied
  40 // warranty.
  41
  42 /**
  43  * @file result_recorder.hpp
  44  * Contains a class for recording results
  45  */
  46
  47 #ifndef PB_DS_RES_RECORDER_HPP
  48 #define PB_DS_RES_RECORDER_HPP
  49
  50 #include <statistic/sample_mean.hpp>
  51 #include <statistic/sample_variance.hpp>
  52 #include <statistic/sample_mean_confidence_checker.hpp>
  53
  54 namespace __gnu_pbds
  55 {
  56   namespace test
  57   {
  58     namespace detail
  59     {
  60       /*
  61        * Records results until the probability that the sample mean is 10% away
  62        * from the true mean is ~ 0.05.
  63        */
  64       template<typename Value_Type>
  65       class result_recorder
  66       {
  67       public:
  68         typedef Value_Type value_type;
  69
  70         result_recorder()
  71         : m_sample_mean(value_type()), m_sample_var(value_type())
  72         { }
  73
  74         bool
  75         add_result(value_type res);
  76
  77         inline value_type
  78         get_sample_mean() const
  79         { return m_sample_mean; }
  80
  81       private:
  82         typedef std::list<value_type> list_type;
  83
  84         list_type m_l;
  85         value_type m_sample_mean;
  86         value_type m_sample_var;
  87       };
  88
  89
  90       template<typename Value_Type>
  91       bool
  92       result_recorder<Value_Type>::
  93       add_result(value_type res)
  94       {
  95         m_l.push_back(res);
  96         m_sample_mean = sample_mean(m_l.begin(), m_l.end());
  97         m_sample_var = sample_variance(m_l.begin(), m_l.end(), m_sample_mean);
  98
  99         size_t dist = std::distance(m_l.begin(), m_l.end());
 100         return sample_mean_confidence_checker(m_sample_mean, m_sample_var,
 101                                               dist, 0.1);
 102       }
 103     } // namespace detail
 104   } // namespace test
 105 } // namespace __gnu_pbds
 106
 107 #endif
 108