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 Success
  45
  46 =item * $GSL_FAILURE
  47
  48 General Failure
  49
  50 =item * $GSL_CONTINUE
  51
  52 Iteration has not converged
  53
  54 =item * $GSL_EDOM
  55
  56 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)
  57
  58 =item * $GSL_ERANGE
  59
  60 Range error; used by mathematical functions when the result value is not representable because of overflow or underflow (like ERANGE in the C library)
  61
  62 =item * $GSL_EFAULT
  63
  64 Invalid Pointer
  65
  66 =item * $GSL_EINVAL
  67
  68 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).
  69
  70 =item * $GSL_EFAILED
  71
  72 Generic Failure
  73
  74 =item * $GSL_EFACTOR
  75
  76 Factorization Failed
  77
  78 =item * $GSL_ESANITY
  79
  80 Sanity Check Failed
  81
  82 =item * $GSL_ENOMEM
  83
  84 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.
  85
  86 =item * $GSL_EBADFUNC
  87
  88 Problem with user-supplied function
  89
  90 =item * $GSL_ERUNAWAY
  91
  92 Iterative process is our of control
  93
  94 =item * $GSL_EMAXITER
  95
  96 Exceeded max number of iterations
  97
  98 =item * $GSL_EZERODIV
  99
 100 Division by zero
 101
 102 =item * $GSL_EBADTOL
 103
 104 Invalid user-specified tolerance
 105
 106 =item * $GSL_ETOL
 107
 108 Failed to reach the specified tolerance
 109
 110 =item * $GSL_EUNDRFLW
 111
 112 Underflow
 113
 114 =item * $GSL_EOVRFLW
 115
 116 Overflow
 117
 118 =item * $GSL_ELOSS
 119
 120 Loss of accuracy
 121
 122 =item * $GSL_EROUND
 123
 124 Failed due to roundoff error
 125
 126 =item * $GSL_EBADLEN
 127
 128 Matrix/vector lengths not compatible
 129
 130 =item * $GSL_ENOTSQR
 131
 132 Not a square matrix
 133
 134 =item * $GSL_ESING
 135
 136 Singularity Detected
 137
 138 =item * $GSL_EDIVERGE
 139
 140 Integral/Series is divergent
 141
 142 =item * $GSL_EUNSUP
 143
 144 Not supported by hardware
 145
 146 =item * $GSL_EUNIMPL
 147
 148 Not implemented
 149
 150 =item * $GSL_ECACHE
 151
 152 Cache limit exceeded
 153
 154 =item * $GSL_ETABLE
 155
 156 Table limit exceeded
 157
 158 =item * $GSL_ENOPROG
 159
 160 Iteration not converging
 161
 162 =item * $GSL_ENOPROGJ
 163
 164 Jacobian not improving solution
 165
 166 =item * $GSL_ETOLF
 167
 168 Cannot reach tolerance in F
 169
 170 =item * $GSL_ETOLX
 171
 172 Cannot reach tolerance in X
 173
 174 =item * $GSL_ETOLG
 175
 176 Cannot reach tolerance in Gradient
 177
 178 =item * $GSL_EOF
 179
 180 End of file
 181
 182 =back
 183
 184 =head1 FUNCTIONS
 185
 186 =over
 187
 188 =item * gsl_error
 189
 190 =item * gsl_stream_printf
 191
 192 =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.
 193
 194 =item * gsl_set_error_handler
 195
 196 =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).
 197
 198 =item * gsl_set_stream_handler
 199
 200 =item * gsl_set_stream
 201
 202 =back
 203
 204 =cut
 205
 206 1;
 207
 208 %}