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