libs/math/test/test_expint.hpp

   1 // Copyright John Maddock 2006.
   2 // Copyright Paul A. Bristow 2007, 2009
   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 <boost/math/concepts/real_concept.hpp>
   8 #include <boost/math/special_functions/math_fwd.hpp>
   9 #define BOOST_TEST_MAIN
  10 #include <boost/test/unit_test.hpp>
  11 #include <boost/test/tools/floating_point_comparison.hpp>
  12 #include <boost/math/tools/stats.hpp>
  13 #include <boost/math/tools/test.hpp>
  14 #include <boost/math/constants/constants.hpp>
  15 #include <boost/type_traits/is_floating_point.hpp>
  16 #include <boost/array.hpp>
  17 #include "functor.hpp"
  18
  19 #include "handle_test_result.hpp"
  20 #include "table_type.hpp"
  21
  22 #ifndef SC_
  23 #define SC_(x) static_cast<typename table_type<T>::type>(BOOST_JOIN(x, L))
  24 #endif
  25
  26 template <class T>
  27 T expint_wrapper(T n, T z)
  28 {
  29 #ifdef EN_FUNCTION_TO_TEST
  30    return EN_FUNCTION_TO_TEST(
  31       boost::math::itrunc(n), z);
  32 #else
  33    return boost::math::expint(
  34       boost::math::itrunc(n), z);
  35 #endif
  36 }
  37
  38 template <class Real, class T>
  39 void do_test_expint(const T& data, const char* type_name, const char* test_name)
  40 {
  41 #if !(defined(ERROR_REPORTING_MODE) && !defined(EN_FUNCTION_TO_TEST))
  42    //
  43    // test En(T) against data:
  44    //
  45    using namespace std;
  46    typedef Real                   value_type;
  47
  48    std::cout << test_name << " with type " << type_name << std::endl;
  49
  50    typedef value_type (*pg)(value_type, value_type);
  51 #if defined(BOOST_MATH_NO_DEDUCED_FUNCTION_POINTERS)
  52    pg funcp = expint_wrapper<value_type>;
  53 #else
  54    pg funcp = expint_wrapper;
  55 #endif
  56
  57    boost::math::tools::test_result<value_type> result;
  58    //
  59    // test expint against data:
  60    //
  61    result = boost::math::tools::test_hetero<Real>(
  62       data,
  63       bind_func<Real>(funcp, 0, 1),
  64       extract_result<Real>(2));
  65    handle_test_result(result, data[result.worst()], result.worst(), type_name, "expint (En)", test_name);
  66    std::cout << std::endl;
  67 #endif
  68 }
  69
  70 template <class Real, class T>
  71 void do_test_expint_Ei(const T& data, const char* type_name, const char* test_name)
  72 {
  73 #if !(defined(ERROR_REPORTING_MODE) && !defined(EI_FUNCTION_TO_TEST))
  74    //
  75    // test Ei(T) against data:
  76    //
  77    using namespace std;
  78    typedef Real                   value_type;
  79
  80    std::cout << test_name << " with type " << type_name << std::endl;
  81
  82    typedef value_type (*pg)(value_type);
  83 #ifdef EI_FUNCTION_TO_TEST
  84    pg funcp = EI_FUNCTION_TO_TEST;
  85 #elif defined(BOOST_MATH_NO_DEDUCED_FUNCTION_POINTERS)
  86    pg funcp = boost::math::expint<value_type>;
  87 #else
  88    pg funcp = boost::math::expint;
  89 #endif
  90
  91    boost::math::tools::test_result<value_type> result;
  92    //
  93    // test expint against data:
  94    //
  95    result = boost::math::tools::test_hetero<Real>(
  96       data,
  97       bind_func<Real>(funcp, 0),
  98       extract_result<Real>(1));
  99    handle_test_result(result, data[result.worst()], result.worst(), type_name, "expint (Ei)", test_name);
 100 #endif
 101 }
 102
 103 template <class T>
 104 void test_expint(T, const char* name)
 105 {
 106    //
 107    // The actual test data is rather verbose, so it's in a separate file
 108    //
 109 #include "expint_data.ipp"
 110    do_test_expint<T>(expint_data, name, "Exponential Integral En");
 111 #include "expint_small_data.ipp"
 112    do_test_expint<T>(expint_small_data, name, "Exponential Integral En: small z values");
 113 #include "expint_1_data.ipp"
 114    do_test_expint<T>(expint_1_data, name, "Exponential Integral E1");
 115 #include "expinti_data.ipp"
 116    do_test_expint_Ei<T>(expinti_data, name, "Exponential Integral Ei");
 117
 118    if(boost::math::tools::log_max_value<T>() > 100)
 119    {
 120 #include "expinti_data_double.ipp"
 121       do_test_expint_Ei<T>(expinti_data_double, name, "Exponential Integral Ei: double exponent range");
 122    }
 123 #if (defined(LDBL_MAX_10_EXP) && (LDBL_MAX_10_EXP > 2000)) || defined(TEST_UDT)
 124    if(boost::math::tools::log_max_value<T>() > 1000)
 125    {
 126 #include "expinti_data_long.ipp"
 127       do_test_expint_Ei<T>(expinti_data_long, name, "Exponential Integral Ei: long exponent range");
 128    }
 129 #endif
 130 }
 131
 132 template <class T>
 133 void test_spots(T, const char* t)
 134 {
 135    std::cout << "Testing basic sanity checks for type " << t << std::endl;
 136    //
 137    // Basic sanity checks, tolerance is 100 epsilon
 138    // expressed as a percentage:
 139    //
 140    T tolerance = boost::math::tools::epsilon<T>() * 100 *
 141       (boost::is_floating_point<T>::value ? 500 : 500);
 142    //
 143    // En:
 144    //
 145    BOOST_CHECK_CLOSE(::boost::math::expint(0, static_cast<T>(1)/1024), static_cast<T>(1023.0004881223430781283448725609773366468629307172L), tolerance);
 146    BOOST_CHECK_CLOSE(::boost::math::expint(0, static_cast<T>(0.125F)), static_cast<T>(7.0599752206767632229191371458324058897760385999252L), tolerance);
 147    BOOST_CHECK_CLOSE(::boost::math::expint(0, static_cast<T>(0.5F)), static_cast<T>(1.2130613194252668472075990699823609068838362709744L), tolerance);
 148    BOOST_CHECK_CLOSE(::boost::math::expint(0, static_cast<T>(1.5F)), static_cast<T>(0.14875344009895321928885364717600834756144775290739L), tolerance);
 149    BOOST_CHECK_CLOSE(::boost::math::expint(0, static_cast<T>(4.5F)), static_cast<T>(0.0024686658973871792213651409526512283936753927790603L), tolerance);
 150    BOOST_CHECK_CLOSE(::boost::math::expint(0, static_cast<T>(50.0F)), static_cast<T>(3.8574996959278355660346856330540251495056653024605e-24L), tolerance);
 151
 152    BOOST_CHECK_CLOSE(::boost::math::expint(1, static_cast<T>(1)/1024), static_cast<T>(6.3552324648310718026144555193580322129376300855378L), tolerance);
 153    BOOST_CHECK_CLOSE(::boost::math::expint(1, static_cast<T>(0.125F)), static_cast<T>(1.6234256405841687914563069246244088736331060573721L), tolerance);
 154    BOOST_CHECK_CLOSE(::boost::math::expint(1, static_cast<T>(0.5F)), static_cast<T>(0.55977359477616081174679593931508523522684689031635L), tolerance);
 155    BOOST_CHECK_CLOSE(::boost::math::expint(1, static_cast<T>(1.5F)), static_cast<T>(0.10001958240663265190190933991166697826173000614035L), tolerance);
 156    BOOST_CHECK_CLOSE(::boost::math::expint(1, static_cast<T>(4.5F)), static_cast<T>(0.0020734007547146144328855938695797884889319725701443L), tolerance);
 157    BOOST_CHECK_CLOSE(::boost::math::expint(1, static_cast<T>(50.0F)), static_cast<T>(3.7832640295504590186989678540212857803028931862511e-24L), tolerance);
 158
 159    BOOST_CHECK_CLOSE(::boost::math::expint(2, static_cast<T>(1)/1024), static_cast<T>(0.99281763247803906867747111039220635198625517639812L), tolerance);
 160    BOOST_CHECK_CLOSE(::boost::math::expint(2, static_cast<T>(0.125F)), static_cast<T>(0.67956869751157430393285377765099962701786656781914L), tolerance);
 161    BOOST_CHECK_CLOSE(::boost::math::expint(2, static_cast<T>(0.5F)), static_cast<T>(0.32664386232455301773040156533363783582849469032901L), tolerance);
 162    BOOST_CHECK_CLOSE(::boost::math::expint(2, static_cast<T>(1.5F)), static_cast<T>(0.073100786538480851080416460896512053949576620150553L), tolerance);
 163    BOOST_CHECK_CLOSE(::boost::math::expint(2, static_cast<T>(4.5F)), static_cast<T>(0.0017786931420265415481579618738214795713453909401220L), tolerance);
 164    BOOST_CHECK_CLOSE(::boost::math::expint(2, static_cast<T>(50.0F)), static_cast<T>(3.7117833188688273667858889516369684601386058104706e-24L), tolerance);
 165
 166    BOOST_CHECK_CLOSE(::boost::math::expint(5, static_cast<T>(1)/1024), static_cast<T>(0.24967471743034509414923673526350536071348482068601L), tolerance);
 167    BOOST_CHECK_CLOSE(::boost::math::expint(5, static_cast<T>(0.125F)), static_cast<T>(0.21195078838966585733668853784460504343264488743527L), tolerance);
 168    BOOST_CHECK_CLOSE(::boost::math::expint(5, static_cast<T>(0.5F)), static_cast<T>(0.13097731169586484777931864012654136046214618229236L), tolerance);
 169    BOOST_CHECK_CLOSE(::boost::math::expint(5, static_cast<T>(1.5F)), static_cast<T>(0.038529924425495155395971538166055731456940831714065L), tolerance);
 170    BOOST_CHECK_CLOSE(::boost::math::expint(5, static_cast<T>(4.5F)), static_cast<T>(0.0012311157382296328534406162790653865883418172939975L), tolerance);
 171    BOOST_CHECK_CLOSE(::boost::math::expint(5, static_cast<T>(50.0F)), static_cast<T>(3.5124400631332394056901125740903320085753990490695e-24L), tolerance);
 172
 173    BOOST_CHECK_CLOSE(::boost::math::expint(22, static_cast<T>(1)/1024), static_cast<T>(0.047570244582119027573000641518739337055625638422014L), tolerance);
 174    BOOST_CHECK_CLOSE(::boost::math::expint(22, static_cast<T>(0.125F)), static_cast<T>(0.041762730174712898120606793100375713866392079558609L), tolerance);
 175    BOOST_CHECK_CLOSE(::boost::math::expint(22, static_cast<T>(0.5F)), static_cast<T>(0.028178840877963713109230354192609362941651630844684L), tolerance);
 176    BOOST_CHECK_CLOSE(::boost::math::expint(22, static_cast<T>(1.5F)), static_cast<T>(0.0098864453561701486668317763826728620676449196215016L), tolerance);
 177    BOOST_CHECK_CLOSE(::boost::math::expint(22, static_cast<T>(4.5F)), static_cast<T>(0.00043257793497205419001613830279995985617548506505159L), tolerance);
 178    BOOST_CHECK_CLOSE(::boost::math::expint(22, static_cast<T>(50.0F)), static_cast<T>(2.6900194251201629500599598206345018300567305625080e-24L), tolerance);
 179    //
 180    // Ei:
 181    //
 182    BOOST_CHECK_CLOSE(::boost::math::expint(static_cast<T>(1)/1024), static_cast<T>(-6.35327933972759151358547423727042905862963067106751711596065L), tolerance);
 183    BOOST_CHECK_CLOSE(::boost::math::expint(static_cast<T>(0.125)), static_cast<T>(-1.37320852494298333781545045921206470808223543321810480716122L), tolerance);
 184    BOOST_CHECK_CLOSE(::boost::math::expint(static_cast<T>(0.5)), static_cast<T>(0.454219904863173579920523812662802365281405554352642045162818L), tolerance);
 185    BOOST_CHECK_CLOSE(::boost::math::expint(static_cast<T>(1)), static_cast<T>(1.89511781635593675546652093433163426901706058173270759164623L), tolerance);
 186    BOOST_CHECK_CLOSE(::boost::math::expint(static_cast<T>(50.5)), static_cast<T>(1.72763195602911805201155668940185673806099654090456049881069e20L), tolerance);
 187
 188    BOOST_CHECK_CLOSE(::boost::math::expint(static_cast<T>(-1)/1024), static_cast<T>(-6.35523246483107180261445551935803221293763008553775821607264L), tolerance);
 189    BOOST_CHECK_CLOSE(::boost::math::expint(static_cast<T>(-0.125)), static_cast<T>(-1.62342564058416879145630692462440887363310605737209536579267L), tolerance);
 190    BOOST_CHECK_CLOSE(::boost::math::expint(static_cast<T>(-0.5)), static_cast<T>(-0.559773594776160811746795939315085235226846890316353515248293L), tolerance);
 191    BOOST_CHECK_CLOSE(::boost::math::expint(static_cast<T>(-1)), static_cast<T>(-0.219383934395520273677163775460121649031047293406908207577979L), tolerance);
 192    BOOST_CHECK_CLOSE(::boost::math::expint(static_cast<T>(-50.5)), static_cast<T>(-2.27237132932219350440719707268817831250090574830769670186618e-24L), tolerance);
 193 }
 194