.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Math::GSL::Errno 3pm"
.TH Math::GSL::Errno 3pm 2024-03-07 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Math::GSL::Errno \- Error Handling
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&    use Math::GSL::Errno qw/:all/;
\&    gsl_set_error_handler_off();
\&
\&    print gsl_strerror($GSL_EDOM) . "\en";
.Ve
.SH "STATUS CODES"
.IX Header "STATUS CODES"
.IP \(bu 4
\&\f(CW$GSL_SUCCESS\fR
.Sp
Success
.IP \(bu 4
\&\f(CW$GSL_FAILURE\fR
.Sp
General Failure
.IP \(bu 4
\&\f(CW$GSL_CONTINUE\fR
.Sp
Iteration has not converged
.IP \(bu 4
\&\f(CW$GSL_EDOM\fR
.Sp
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)
.IP \(bu 4
\&\f(CW$GSL_ERANGE\fR
.Sp
Range error; used by mathematical functions when the result value is not representable because of overflow or underflow (like ERANGE in the C library)
.IP \(bu 4
\&\f(CW$GSL_EFAULT\fR
.Sp
Invalid Pointer
.IP \(bu 4
\&\f(CW$GSL_EINVAL\fR
.Sp
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).
.IP \(bu 4
\&\f(CW$GSL_EFAILED\fR
.Sp
Generic Failure
.IP \(bu 4
\&\f(CW$GSL_EFACTOR\fR
.Sp
Factorization Failed
.IP \(bu 4
\&\f(CW$GSL_ESANITY\fR
.Sp
Sanity Check Failed
.IP \(bu 4
\&\f(CW$GSL_ENOMEM\fR
.Sp
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.
.IP \(bu 4
\&\f(CW$GSL_EBADFUNC\fR
.Sp
Problem with user-supplied function
.IP \(bu 4
\&\f(CW$GSL_ERUNAWAY\fR
.Sp
Iterative process is our of control
.IP \(bu 4
\&\f(CW$GSL_EMAXITER\fR
.Sp
Exceeded max number of iterations
.IP \(bu 4
\&\f(CW$GSL_EZERODIV\fR
.Sp
Division by zero
.IP \(bu 4
\&\f(CW$GSL_EBADTOL\fR
.Sp
Invalid user-specified tolerance
.IP \(bu 4
\&\f(CW$GSL_ETOL\fR
.Sp
Failed to reach the specified tolerance
.IP \(bu 4
\&\f(CW$GSL_EUNDRFLW\fR
.Sp
Underflow
.IP \(bu 4
\&\f(CW$GSL_EOVRFLW\fR
.Sp
Overflow
.IP \(bu 4
\&\f(CW$GSL_ELOSS\fR
.Sp
Loss of accuracy
.IP \(bu 4
\&\f(CW$GSL_EROUND\fR
.Sp
Failed due to roundoff error
.IP \(bu 4
\&\f(CW$GSL_EBADLEN\fR
.Sp
Matrix/vector lengths not compatible
.IP \(bu 4
\&\f(CW$GSL_ENOTSQR\fR
.Sp
Not a square matrix
.IP \(bu 4
\&\f(CW$GSL_ESING\fR
.Sp
Singularity Detected
.IP \(bu 4
\&\f(CW$GSL_EDIVERGE\fR
.Sp
Integral/Series is divergent
.IP \(bu 4
\&\f(CW$GSL_EUNSUP\fR
.Sp
Not supported by hardware
.IP \(bu 4
\&\f(CW$GSL_EUNIMPL\fR
.Sp
Not implemented
.IP \(bu 4
\&\f(CW$GSL_ECACHE\fR
.Sp
Cache limit exceeded
.IP \(bu 4
\&\f(CW$GSL_ETABLE\fR
.Sp
Table limit exceeded
.IP \(bu 4
\&\f(CW$GSL_ENOPROG\fR
.Sp
Iteration not converging
.IP \(bu 4
\&\f(CW$GSL_ENOPROGJ\fR
.Sp
Jacobian not improving solution
.IP \(bu 4
\&\f(CW$GSL_ETOLF\fR
.Sp
Cannot reach tolerance in F
.IP \(bu 4
\&\f(CW$GSL_ETOLX\fR
.Sp
Cannot reach tolerance in X
.IP \(bu 4
\&\f(CW$GSL_ETOLG\fR
.Sp
Cannot reach tolerance in Gradient
.IP \(bu 4
\&\f(CW$GSL_EOF\fR
.Sp
End of file
.SH FUNCTIONS
.IX Header "FUNCTIONS"
.IP \(bu 4
gsl_error
.IP \(bu 4
gsl_stream_printf
.IP \(bu 4
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)\en"); would print an error message like error: output range error for a status value of GSL_ERANGE.
.IP \(bu 4
gsl_set_error_handler
.IP \(bu 4
\&\fBgsl_set_error_handler_off()\fR \- 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).
.IP \(bu 4
gsl_set_stream_handler
.IP \(bu 4
gsl_set_stream