libstdc++-v3/testsuite/util/regression/rand/priority_queue/rand_regression_test.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 rand_regression_test.hpp
  44  * Contains a random-operation test.
  45  */
  46
  47 #include <iostream>
  48 #include <vector>
  49 #include <regression/rand/priority_queue/container_rand_regression_test.hpp>
  50 #include <io/verified_cmd_line_input.hpp>
  51 #include <common_type/priority_queue/common_type.hpp>
  52 #include <regression/basic_type.hpp>
  53 #include <regression/priority_queue/common_type.hpp>
  54
  55 namespace pb_ds
  56 {
  57 namespace test
  58 {
  59 namespace detail
  60 {
  61 #ifndef PB_DS_REGRESSION
  62 #error "Must define PB_DS_REGRESSION"
  63 #endif
  64
  65   struct rand_reg_test
  66   {
  67   public:
  68     rand_reg_test(size_t seed, size_t n, size_t m, double tp, double ip,
  69                   double dp, double ep, double cp, double mp, bool d)
  70     : m_sd(seed), m_n(n), m_m(m), m_tp(tp), m_ip(ip), m_dp(dp), m_ep(ep),
  71       m_cp(cp), m_mp(mp), m_disp(d)
  72     { }
  73
  74     template<typename Cntnr>
  75     void
  76     operator()(pb_ds::detail::type_to_type<Cntnr>)
  77     {
  78       unsigned long ul = static_cast<unsigned long>(m_sd);
  79       container_rand_regression_test<Cntnr> t(ul, m_n, m_n, m_tp, m_ip, m_dp,
  80                                               m_ep, m_cp, m_mp, m_disp);
  81       t();
  82     }
  83
  84   private:
  85     const size_t m_sd;
  86     const size_t m_n;
  87     const size_t m_m;
  88     const double m_tp;
  89     const double m_ip;
  90     const double m_dp;
  91     const double m_ep;
  92     const double m_cp;
  93     const double m_mp;
  94     const bool m_disp;
  95   };
  96
  97   void
  98   usage(const std::string& r_name);
  99
 100   void
 101   verify_params(size_t&, size_t&, size_t&,
 102                 double&, double&, double&, double&, double&, double&, bool&);
 103 } // namespace detail
 104
 105   template<typename TL>
 106   int
 107   rand_regression_test(size_t iter, size_t keys, const std::string name, TL tl)
 108   {
 109     // Sane defaults.
 110     size_t n = iter;
 111     size_t m = keys;
 112     size_t sd = 0; // 0 = time-determined arbitrary
 113     double tp = 0.2;
 114     double ip = 0.6;
 115     double dp = 0.1;
 116     double ep = 0.2;
 117     double cp = 0.001;
 118     double mp = 0.25;
 119     bool disp = false; // show progress
 120
 121     try
 122       {
 123         detail::verify_params(sd, n, m, tp, ip, dp, ep, cp, mp, disp);
 124       }
 125     catch(pb_ds::test::illegal_input_error&)
 126       {
 127         detail::usage(name);
 128         return -1;
 129       }
 130     catch(...)
 131       {
 132         return -2;
 133       };
 134
 135     xml_test_rand_regression_formatter* p_fmt = NULL;
 136     if (sd == 0)
 137       sd = twister_rand_gen::get_time_determined_seed();
 138     if (disp)
 139       p_fmt = new xml_test_rand_regression_formatter(sd, n, m, tp, ip, dp,
 140                                                      ep, cp, mp);
 141
 142     try
 143       {
 144         detail::rand_reg_test tst(sd, n, m, tp, ip, dp, ep, cp, mp, disp);
 145         pb_ds::detail::typelist_apply(tst, tl);
 146       }
 147     catch(...)
 148       {
 149         std::cerr << "Test failed with seed " << sd << std::endl;
 150         if (disp)
 151           delete p_fmt;
 152         return -1;
 153       }
 154
 155     if (disp)
 156       delete p_fmt;
 157     return 0;
 158   }
 159
 160 namespace detail
 161 {
 162   void
 163   usage(const std::string& name)
 164   {
 165     using namespace std;
 166     cerr << "usage: " << name << " <sd> <n> <m> <tp> <ip> <dp> <ep> <cp> <mp> ['t' | 'f']" <<
 167       endl << endl;
 168
 169     cerr << "This test performs basic regression tests on various priority queues."
 170       "For each container, it performs a sequence of operations. At each iteration, it does "
 171       "the following: " << endl;
 172     cerr << "*  Performs an operation on the container " << endl;
 173     cerr << "*  Performs the same operation on an cntnr object" << endl;
 174     cerr << "*  Possibly compares the container to the cntnr object" << endl;
 175     cerr << "*  Checks that exceptions (thrown by an allocator) "
 176       "do not violate exception guarantees";
 177
 178     cerr << endl << endl;
 179
 180     cerr << "sd = seed for random-number generator; 0 = "
 181       "time determined value" << endl;
 182     cerr << "n = number of iterations" << endl;
 183     cerr << "m = number of distinct values" << endl;
 184     cerr << "tp = probability that an exception will be actively thrown" << endl;
 185     cerr << "ip = probability that an operation will be insert" << endl;
 186     cerr << "dp = probability that an operation will be modify" << endl;
 187     cerr << "ep = probability that an operation will be erase" << endl;
 188     cerr << "cp = probability that an operation will be clear" << endl;
 189     cerr << "(therefore, 1 - (ip + dp + ep + cp) = probability of any other operation)" << endl;
 190     cerr << "mp = probability that the container will be compared to the cntnr object" << endl;
 191     cerr << "'t' or 'f' determine whether progress will be displayed" << endl;
 192   }
 193
 194   void
 195   verify_params(size_t& r_seed, size_t& r_n,
 196                 size_t& r_m, double& r_tp, double& r_ip, double& r_dp,
 197                 double& r_ep, double& r_cp, double& r_mp, bool& r_d)
 198   {
 199     verify_prob(r_tp);
 200     verify_prob(r_ip);
 201     verify_prob(r_dp);
 202     verify_prob(r_ep);
 203     verify_prob(r_cp);
 204     verify_prob(r_mp);
 205     verify_prob(r_ip + r_dp + r_ep + r_cp);
 206   }
 207 } // namespace detail
 208 } // namespace test
 209 } // namespace pb_ds
 210