libs/math/test/log1p_expm1_test.cpp

   1 //  Copyright John Maddock 2005.
   2 //  Copyright Paul A. Bristow 2010
   3 //  Use, modification and distribution are subject to the
   4 //  Boost Software License, Version 1.0. (See accompanying file
   5 //  LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
   6
   7 #include <pch_light.hpp>
   8
   9 // Requires MS extensions permitted or fails to link.
  10
  11
  12 #define BOOST_MATH_OVERFLOW_ERROR_POLICY ignore_error
  13
  14 #include <boost/math/concepts/real_concept.hpp>
  15 #define BOOST_TEST_MAIN
  16 #include <boost/test/unit_test.hpp>
  17 #include <boost/test/tools/floating_point_comparison.hpp>
  18 #include <boost/math/special_functions/math_fwd.hpp>
  19 #include "log1p_expm1_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       ".*",                          // test type(s)
  56       ".*",                          // test data group
  57       ".*",                          // test function
  58       4,                             // Max Peek error
  59       3);                            // Max mean error
  60
  61    //
  62    // Finish off by printing out the compiler/stdlib/platform names,
  63    // we do this to make it easier to mark up expected error rates.
  64    //
  65    std::cout << "Tests run with " << BOOST_COMPILER << ", "
  66       << BOOST_STDLIB << ", " << BOOST_PLATFORM << std::endl;
  67 }
  68
  69
  70 BOOST_AUTO_TEST_CASE( test_main )
  71 {
  72    expected_results();
  73    BOOST_MATH_CONTROL_FP;
  74    test(float(0), "float");
  75    test(double(0), "double");
  76    //
  77    // The long double version of these tests fails on some platforms
  78    // due to poor std lib support (not enough digits returned from
  79    // std::log and std::exp):
  80    //
  81 #if !defined(BOOST_MATH_NO_LONG_DOUBLE_MATH_FUNCTIONS)
  82    test((long double)(0), "long double");
  83 #ifndef BOOST_MATH_NO_REAL_CONCEPT_TESTS
  84    test((boost::math::concepts::real_concept)(0), "real_concept");
  85 #endif
  86 #else
  87    std::cout << "<note>The long double tests have been disabled on this platform "
  88       "either because the long double overloads of the usual math functions are "
  89       "not available at all, or because they are too inaccurate for these tests "
  90       "to pass.</note>" << std::endl;
  91 #endif
  92 }
  93