home *** CD-ROM | disk | FTP | other *** search
/ C Programming Starter Kit 2.0 / SamsPublishing-CProgrammingStarterKit-v2.0-Win31.iso / bc45 / wild32.pak / MATHERRL.C < prev    next >
C/C++ Source or Header  |  1997-07-23  |  5KB  |  128 lines
  1. /*------------------------------------------------------------------------
  2.  * filename - matherrl.c
  3.  *
  4.  * function(s)
  5.  *        _matherrl - user-modifiable long double math error handler
  6.  *-----------------------------------------------------------------------*/
  7.  
  8. /*
  9.  *      C/C++ Run Time Library - Version 1.5
  10.  *
  11.  *      Copyright (c) 1987, 1994 by Borland International
  12.  *      All Rights Reserved.
  13.  *
  14.  */
  15.  
  16. #include <math.h>
  17.  
  18. #ifdef  UNIX__matherrl
  19. #include <stdio.h>
  20. #include <process.h>
  21. #include <_io.h>
  22. #include <_math.h>
  23.  
  24. /*------------------------------------------------------------------------*
  25.  
  26. Name            _matherrl - user-modifiable long double math error handler
  27.  
  28. Usage           #include <math.h>
  29.                 int _matherrl(struct _exceptionl *e);
  30.  
  31. Prototype in    math.h
  32.  
  33. Description     When  exceptions are  detected in  the long double math
  34.                 library then a call is made to __matherrl() with all of
  35.                 the available information.
  36.  
  37.                 That function does very little, except to map the exception
  38.                 "why"  into either  ERANGE or  EDOMAIN in  errno. Its  main
  39.                 purpose is  to act as  a focal point  for changes in  error
  40.                 handling.
  41.  
  42.                 For example,  if you were  writing a spreadsheet  you might
  43.                 replace  this function with one which pops up an error
  44.                 window explaining something like:
  45.  
  46.                         "logl (-2.0) caused domain error, in cell J7"
  47.  
  48.                 and then longjmp() to a  reset state in the spreadsheet and
  49.                 await the next command from the user.
  50.  
  51.                 The default version  of Turbo C's _matherrl routine masks
  52.                 underflow and precision errors; others errors are considered
  53.                 fatal.  It serves as a hook that you can replace when
  54.                 writing your own math error handling routine.
  55.  
  56.                 The rationale for masking underflow and precision errors
  57.                 is that these are not errors according to the ANSI C spec.
  58.                 Consequently, you will get
  59.                         expl(-1000) = 0
  60.                         sinl(1e100) = NAN
  61.                 without any error or warning, even though there is a total
  62.                 loss of precision in both cases.  You can trap these errors
  63.                 by modifying _matherrl.
  64.  
  65.                 The possible errors are
  66.                         DOMAIN, SING, OVERFLOW, UNDERFLOW, TLOSS, PLOSS
  67.                 and listed in <math.h>.  As explained above, UNDERFLOW and
  68.                 TLOSS are masked by the default _matherrl.  PLOSS is not
  69.                 supported by TC and is not generated by any library functions.
  70.                 The remaining errors, DOMAIN, SING, and OVERFLOW, are fatal
  71.                 with the default _matherrl.
  72.  
  73.                 You  can  modify  _matherrl  to  be  a  custom error handling
  74.                 routine (such as one that catches and resolves certain type
  75.                 of  errors); the  modified _matherrl  should return  0 if  it
  76.                 failed to resolve  the error, or non-zero if  the error was
  77.                 resolved. When _matherrl returns non-zero, no  error message
  78.                 is printed, and errno is not changed.
  79.  
  80.                 The  important thing  is  that  we  don't  know what error
  81.                 handling you want, but you are assured that all errors will
  82.                 arrive at  _matherrl() with all  the information you  need to
  83.                 design a custom format.
  84.  
  85. Return value    The default return  value for _matherrl is simply  0.
  86.                 _matherrl can also modify  e->retval, which propagates through
  87.                 __matherrl back to the original caller.
  88.  
  89.                 When _matherrl returns 0, (indicating that it was not able to
  90.                 resolve the error) __matherrl sets  errno and prints an error
  91.                 message.
  92.  
  93.                 When _matherrl returns non-zero, (indicating that it was able
  94.                 to resolve the error) errno is not set and no messages are
  95.                 printed.
  96.  
  97. *-------------------------------------------------------------------------*/
  98.  
  99. int _RTLENTRY _matherrl (struct _exceptionl *e)
  100. {
  101.     char errMsg[ 80 ];
  102.     sprintf (errMsg,
  103.         "%s (%8Lg,%8Lg): %s\n", e->name, e->arg1, e->arg2, whyS [e->type - 1]);
  104.     _ErrorExit(errMsg);
  105. }
  106.  
  107. #else   /* ! UNIX_matherr */
  108.  
  109. int _RTLENTRY _matherrl(struct _exceptionl *e)
  110. {
  111.         if (e->type == UNDERFLOW)
  112.         {
  113.                 /* flush underflow to 0 */
  114.                 e->retval = 0;
  115.                 return 1;
  116.         }
  117.         if (e->type == TLOSS)
  118.         {
  119.                 /* total loss of precision, but ignore the problem */
  120.                 return 1;
  121.         }
  122.         /* all other errors are fatal */
  123.         return 0;
  124. }
  125.  
  126.  
  127. #endif
  128.