swig/Errno.i

   1 %module "Math::GSL::Errno"
   2 %include "typemaps.i"
   3 %include "gsl_typemaps.i"
   4 %{
   5     #include "gsl/gsl_errno.h"
   6     #include "gsl/gsl_types.h"
   7 %}
   8 %include "gsl/gsl_errno.h"
   9 %include "gsl/gsl_types.h"
  10
  11 %perlcode %{
  12 @EXPORT_OK = qw/
  13                 gsl_error gsl_stream_printf gsl_strerror gsl_set_error_handler
  14                 gsl_set_error_handler_off gsl_set_stream_handler gsl_set_stream
  15                 $GSL_SUCCESS $GSL_FAILURE $GSL_CONTINUE $GSL_EDOM
  16                 $GSL_ERANGE $GSL_EFAULT $GSL_EINVAL $GSL_EFAILED
  17                 $GSL_EFACTOR $GSL_ESANITY $GSL_ENOMEM $GSL_EBADFUNC
  18                 $GSL_ERUNAWAY $GSL_EMAXITER $GSL_EZERODIV $GSL_EBADTOL
  19                 $GSL_ETOL $GSL_EUNDRFLW $GSL_EOVRFLW $GSL_ELOSS
  20                 $GSL_EROUND $GSL_EBADLEN $GSL_ENOTSQR $GSL_ESING
  21                 $GSL_EDIVERGE $GSL_EUNSUP $GSL_EUNIMPL $GSL_ECACHE
  22                 $GSL_ETABLE $GSL_ENOPROG $GSL_ENOPROGJ $GSL_ETOLF
  23                 $GSL_ETOLX $GSL_ETOLG $GSL_EOF
  24             /;
  25 %EXPORT_TAGS = ( all => [ @EXPORT_OK ] );
  26
  27 =head1 NAME
  28
  29 Math::GSL::Errno - Error Handling
  30
  31 =cut
  32
  33 =head1 SYNOPSIS
  34
  35     use Math::GSL::Errno qw/:all/;
  36     gsl_set_error_handler_off();
  37
  38     print gsl_strerror($GSL_EDOM) . "\n";
  39
  40 =head1 STATUS CODES
  41
  42 =over 4
  43
  44 =item * $GSL_SUCCESS
  45
  46 Success
  47
  48 =item * $GSL_FAILURE
  49
  50 General Failure
  51
  52 =item * $GSL_CONTINUE
  53
  54 Iteration has not converged
  55
  56 =item * $GSL_EDOM
  57
  58 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)
  59
  60 =item * $GSL_ERANGE
  61
  62 Range error; used by mathematical functions when the result value is not representable because of overflow or underflow (like ERANGE in the C library)
  63
  64 =item * $GSL_EFAULT
  65
  66 Invalid Pointer
  67
  68 =item * $GSL_EINVAL
  69
  70 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).
  71
  72 =item * $GSL_EFAILED
  73
  74 Generic Failure
  75
  76 =item * $GSL_EFACTOR
  77
  78 Factorization Failed
  79
  80 =item * $GSL_ESANITY
  81
  82 Sanity Check Failed
  83
  84 =item * $GSL_ENOMEM
  85
  86 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.
  87
  88 =item * $GSL_EBADFUNC
  89
  90 Problem with user-supplied function
  91
  92 =item * $GSL_ERUNAWAY
  93
  94 Iterative process is our of control
  95
  96 =item * $GSL_EMAXITER
  97
  98 Exceeded max number of iterations
  99
 100 =item * $GSL_EZERODIV
 101
 102 Division by zero
 103
 104 =item * $GSL_EBADTOL
 105
 106 Invalid user-specified tolerance
 107
 108 =item * $GSL_ETOL
 109
 110 Failed to reach the specified tolerance
 111
 112 =item * $GSL_EUNDRFLW
 113
 114 Underflow
 115
 116 =item * $GSL_EOVRFLW
 117
 118 Overflow
 119
 120 =item * $GSL_ELOSS
 121
 122 Loss of accuracy
 123
 124 =item * $GSL_EROUND
 125
 126 Failed due to roundoff error
 127
 128 =item * $GSL_EBADLEN
 129
 130 Matrix/vector lengths not compatible
 131
 132 =item * $GSL_ENOTSQR
 133
 134 Not a square matrix
 135
 136 =item * $GSL_ESING
 137
 138 Singularity Detected
 139
 140 =item * $GSL_EDIVERGE
 141
 142 Integral/Series is divergent
 143
 144 =item * $GSL_EUNSUP
 145
 146 Not supported by hardware
 147
 148 =item * $GSL_EUNIMPL
 149
 150 Not implemented
 151
 152 =item * $GSL_ECACHE
 153
 154 Cache limit exceeded
 155
 156 =item * $GSL_ETABLE
 157
 158 Table limit exceeded
 159
 160 =item * $GSL_ENOPROG
 161
 162 Iteration not converging
 163
 164 =item * $GSL_ENOPROGJ
 165
 166 Jacobian not improving solution
 167
 168 =item * $GSL_ETOLF
 169
 170 Cannot reach tolerance in F
 171
 172 =item * $GSL_ETOLX
 173
 174 Cannot reach tolerance in X
 175
 176 =item * $GSL_ETOLG
 177
 178 Cannot reach tolerance in Gradient
 179
 180 =item * $GSL_EOF
 181
 182 End of file
 183
 184 =back
 185
 186 =head1 FUNCTIONS
 187
 188 =over
 189
 190 =item * gsl_error
 191
 192 =item * gsl_stream_printf
 193
 194 =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.
 195
 196 =item * gsl_set_error_handler
 197
 198 =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).
 199
 200 =item * gsl_set_stream_handler
 201
 202 =item * gsl_set_stream
 203
 204 =back
 205
 206 =cut
 207
 208 1;
 209
 210 %}