pod/Errno.pod

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