Errno.i

   1 %module "Math::GSL::Errno"
   2 %{
   3     #include "gsl/gsl_errno.h"
   4     #include "gsl/gsl_types.h"
   5 %}
   6 %include "gsl/gsl_errno.h"
   7 %include "gsl/gsl_types.h"
   8
   9 %perlcode %{
  10 @EXPORT_OK = qw/
  11                 gsl_error gsl_stream_printf gsl_strerror gsl_set_error_handler
  12                 gsl_set_error_handler_off gsl_set_stream_handler gsl_set_stream
  13                 $GSL_SUCCESS $GSL_FAILURE $GSL_CONTINUE $GSL_EDOM
  14                 $GSL_ERANGE $GSL_EFAULT $GSL_EINVAL $GSL_EFAILED
  15                 $GSL_EFACTOR $GSL_ESANITY $GSL_ENOMEM $GSL_EBADFUNC
  16                 $GSL_ERUNAWAY $GSL_EMAXITER $GSL_EZERODIV $GSL_EBADTOL
  17                 $GSL_ETOL $GSL_EUNDRFLW $GSL_EOVRFLW $GSL_ELOSS
  18                 $GSL_EROUND $GSL_EBADLEN $GSL_ENOTSQR $GSL_ESING
  19                 $GSL_EDIVERGE $GSL_EUNSUP $GSL_EUNIMPL $GSL_ECACHE
  20                 $GSL_ETABLE $GSL_ENOPROG $GSL_ENOPROGJ $GSL_ETOLF
  21                 $GSL_ETOLX $GSL_ETOLG $GSL_EOF
  22             /;
  23 %EXPORT_TAGS = ( all => [ @EXPORT_OK ] );
  24
  25 =head1 NAME
  26
  27 Math::GSL::Errno - Error Handling
  28
  29 =cut
  30
  31 =head1 SYNOPSIS
  32
  33     use Math::GSL::Errno qw/:all/;
  34     gsl_set_error_handler_off();
  35
  36     print gsl_strerror($GSL_EDOM) . "\n";
  37
  38 =head1 STATUS CODES
  39
  40 =over 4
  41
  42 =item * $GSL_SUCCESS
  43
  44 =item * $GSL_FAILURE
  45
  46 =item * $GSL_CONTINUE
  47
  48 =item * $GSL_EDOM - Domain error; used by mathematical functions when an argument value does not fall into the domain over which the function is defined (like EDOM in the C library)
  49
  50 =item * $GSL_ERANGE - Range error; used by mathematical functions when the result value is not representable because of overflow or underflow (like ERANGE in the C library)
  51
  52 =item * $GSL_EFAULT
  53
  54 =item * $GSL_EINVAL - Invalid argument. This is used to indicate various kinds of problems with passing the wrong argument to a library function (like EINVAL in the C library).Invalid argument. This is used to indicate various kinds of problems with passing the wrong argument to a library function (like EINVAL in the C library).
  55
  56 =item * $GSL_EFAILED
  57
  58 =item * $GSL_EFACTOR
  59
  60 =item * $GSL_ESANITY
  61
  62 =item * $GSL_ENOMEM - No memory available. The system cannot allocate more virtual memory because its capacity is full (like ENOMEM in the C library). This error is reported when a GSL routine encounters problems when trying to allocate memory with malloc.
  63
  64 =item * $GSL_EBADFUNC
  65
  66 =item * $GSL_ERUNAWAY
  67
  68 =item * $GSL_EMAXITER
  69
  70 =item * $GSL_EZERODIV
  71
  72 =item * $GSL_EBADTOL
  73
  74 =item * $GSL_ETOL
  75
  76 =item * $GSL_EUNDRFLW
  77
  78 =item * $GSL_EOVRFLW
  79
  80 =item * $GSL_ELOSS
  81
  82 =item * $GSL_EROUND
  83
  84 =item * $GSL_EBADLEN
  85
  86 =item * $GSL_ENOTSQR
  87
  88 =item * $GSL_ESING
  89
  90 =item * $GSL_EDIVERGE
  91
  92 =item * $GSL_EUNSUP
  93
  94 =item * $GSL_EUNIMPL
  95
  96 =item * $GSL_ECACHE
  97
  98 =item * $GSL_ETABLE
  99
 100 =item * $GSL_ENOPROG
 101
 102 =item * $GSL_ENOPROGJ
 103
 104 =item * $GSL_ETOLF
 105
 106 =item * $GSL_ETOLX
 107
 108 =item * $GSL_ETOLG
 109
 110 =item * $GSL_EOF
 111
 112 =back
 113
 114 =head1 FUNCTIONS
 115
 116 =over
 117
 118 =item * gsl_error
 119
 120 =item * gsl_stream_printf
 121
 122 =item * gsl_strerror($gsl_errno) - This function returns a pointer to a string describing the error code gsl_errno. For example, print ("error: gsl_strerror ($status)\n"); would print an error message like error: output range error for a status value of GSL_ERANGE.
 123
 124 =item * gsl_set_error_handler
 125
 126 =item * gsl_set_error_handler_off() - This function turns off the error handler by defining an error handler which does nothing. This will cause the program to continue after any error, so the return values from any library routines must be checked. This is the recommended behavior for production programs. The previous handler is returned (so that you can restore it later).
 127
 128 =item * gsl_set_stream_handler
 129
 130 =item * gsl_set_stream
 131
 132 =back
 133
 134 =cut
 135
 136 %}