libs/math/test/float128/log1p_expm1_test.cpp

   1 ///////////////////////////////////////////////////////////////
   2 //  Copyright Christopher Kormanyos 2002 - 2011.
   3 //  Copyright 2011 John Maddock. Distributed under the Boost
   4 //  Software License, Version 1.0. (See accompanying file
   5 //  LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_
   6 //
   7 // This work is based on an earlier work:
   8 // "Algorithm 910: A Portable C++ Multiple-Precision System for Special-Function Calculations",
   9 // in ACM TOMS, {VOL 37, ISSUE 4, (February 2011)} (C) ACM, 2011. http://doi.acm.org/10.1145/1916461.1916469
  10
  11 #include "setup.hpp"
  12 #include <boost/math/special_functions/log1p.hpp>
  13 #include <boost/math/special_functions/expm1.hpp>
  14
  15 #include "table_type.hpp"
  16
  17 #include "libs/math/test/log1p_expm1_test.hpp"
  18
  19 //
  20 // DESCRIPTION:
  21 // ~~~~~~~~~~~~
  22 //
  23 // This file tests the functions log1p and expm1.  The accuracy tests
  24 // use values generated with NTL::RR at 1000-bit precision
  25 // and our generic versions of these functions.
  26 //
  27 // Note that when this file is first run on a new platform many of
  28 // these tests will fail: the default accuracy is 1 epsilon which
  29 // is too tight for most platforms.  In this situation you will
  30 // need to cast a human eye over the error rates reported and make
  31 // a judgement as to whether they are acceptable.  Either way please
  32 // report the results to the Boost mailing list.  Acceptable rates of
  33 // error are marked up below as a series of regular expressions that
  34 // identify the compiler/stdlib/platform/data-type/test-data/test-function
  35 // along with the maximum expected peek and RMS mean errors for that
  36 // test.
  37 //
  38
  39 void expected_results()
  40 {
  41    //
  42    // Define the max and mean errors expected for
  43    // various compilers and platforms.
  44    //
  45
  46    //
  47    // Catch all cases come last:
  48    //
  49    add_expected_result(
  50       ".*",                          // compiler
  51       ".*",                          // stdlib
  52       ".*",                          // platform
  53       ".*",                          // test type(s)
  54       ".*",                          // test data group
  55       ".*",                          // test function
  56       8,                             // Max Peek error
  57       5);                            // Max mean error
  58
  59    //
  60    // Finish off by printing out the compiler/stdlib/platform names,
  61    // we do this to make it easier to mark up expected error rates.
  62    //
  63    std::cout << "Tests run with " << BOOST_COMPILER << ", "
  64       << BOOST_STDLIB << ", " << BOOST_PLATFORM << std::endl;
  65 }
  66
  67
  68 BOOST_AUTO_TEST_CASE( test_main )
  69 {
  70    expected_results();
  71    //
  72    // Test at:
  73    // 18 decimal digits: tests 80-bit long double approximations
  74    // 30 decimal digits: tests 128-bit long double approximations
  75    // 35 decimal digits: tests arbitrary precision code
  76    //
  77    ALL_TESTS
  78 }
  79