libs/multiprecision/test/math/powm1_sqrtp1m1_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 https://www.boost.org/LICENSE_1_0.txt
   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 #define BOOST_TEST_MAIN
  13 #include <boost/test/unit_test.hpp>
  14 #include <boost/test/floating_point_comparison.hpp>
  15 #include <boost/math/special_functions/math_fwd.hpp>
  16
  17 #include "table_type.hpp"
  18
  19 #include "libs/math/test/powm1_sqrtp1m1_test.hpp"
  20
  21 //
  22 // DESCRIPTION:
  23 // ~~~~~~~~~~~~
  24 //
  25 // This file tests the functions log1p and expm1.  The accuracy tests
  26 // use values generated with NTL::RR at 1000-bit precision
  27 // and our generic versions of these functions.
  28 //
  29 // Note that when this file is first run on a new platform many of
  30 // these tests will fail: the default accuracy is 1 epsilon which
  31 // is too tight for most platforms.  In this situation you will
  32 // need to cast a human eye over the error rates reported and make
  33 // a judgement as to whether they are acceptable.  Either way please
  34 // report the results to the Boost mailing list.  Acceptable rates of
  35 // error are marked up below as a series of regular expressions that
  36 // identify the compiler/stdlib/platform/data-type/test-data/test-function
  37 // along with the maximum expected peek and RMS mean errors for that
  38 // test.
  39 //
  40
  41 void expected_results()
  42 {
  43    //
  44    // Define the max and mean errors expected for
  45    // various compilers and platforms.
  46    //
  47
  48    //
  49    // Catch all cases come last:
  50    //
  51    add_expected_result(
  52        ".*",                         // compiler
  53        ".*",                         // stdlib
  54        ".*",                         // platform
  55        ".*mpfr_float_backend<18>.*", // test type(s)
  56        ".*",                         // test data group
  57        ".*",                         // test function
  58        300,                          // Max Peek error
  59        50);                          // Max mean error
  60    add_expected_result(
  61        ".*", // compiler
  62        ".*", // stdlib
  63        ".*", // platform
  64        ".*", // test type(s)
  65        ".*", // test data group
  66        ".*", // test function
  67        15,   // Max Peek error
  68        5);   // Max mean error
  69
  70    //
  71    // Finish off by printing out the compiler/stdlib/platform names,
  72    // we do this to make it easier to mark up expected error rates.
  73    //
  74    std::cout << "Tests run with " << BOOST_COMPILER << ", "
  75              << BOOST_STDLIB << ", " << BOOST_PLATFORM << std::endl;
  76 }
  77
  78 template <class T>
  79 void test(T t, const char* p)
  80 {
  81    test_powm1_sqrtp1m1(t, p);
  82 }
  83
  84 BOOST_AUTO_TEST_CASE(test_main)
  85 {
  86    using namespace boost::multiprecision;
  87    expected_results();
  88    //
  89    // We test two different precisions:
  90    // 18 decimal digits triggers Boost.Math's 64-bit long double support.
  91    // 30 decimal digits triggers Boost.Math's 128-bit long double support.
  92    // 35 decimal digits triggers true arbitrary precision support.
  93    //
  94    ALL_SMALL_TESTS
  95 }