File: Error-Codes.html

package info (click to toggle)
gsl-ref-html 2.3-1
  • links: PTS
  • area: non-free
  • in suites: bullseye, buster, sid
  • size: 6,876 kB
  • ctags: 4,574
  • sloc: makefile: 35
file content (135 lines) | stat: -rw-r--r-- 6,245 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016 The GSL Team.

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with the
Invariant Sections being "GNU General Public License" and "Free Software
Needs Free Documentation", the Front-Cover text being "A GNU Manual",
and with the Back-Cover Text being (a) (see below). A copy of the
license is included in the section entitled "GNU Free Documentation
License".

(a) The Back-Cover Text is: "You have the freedom to copy and modify this
GNU Manual." -->
<!-- Created by GNU Texinfo 5.1, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GNU Scientific Library &ndash; Reference Manual: Error Codes</title>

<meta name="description" content="GNU Scientific Library &ndash; Reference Manual: Error Codes">
<meta name="keywords" content="GNU Scientific Library &ndash; Reference Manual: Error Codes">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Function-Index.html#Function-Index" rel="index" title="Function Index">
<link href="Error-Handling.html#Error-Handling" rel="up" title="Error Handling">
<link href="Error-Handlers.html#Error-Handlers" rel="next" title="Error Handlers">
<link href="Error-Reporting.html#Error-Reporting" rel="previous" title="Error Reporting">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
div.smalllisp {margin-left: 3.2em}
kbd {font-style:oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="Error-Codes"></a>
<div class="header">
<p>
Next: <a href="Error-Handlers.html#Error-Handlers" accesskey="n" rel="next">Error Handlers</a>, Previous: <a href="Error-Reporting.html#Error-Reporting" accesskey="p" rel="previous">Error Reporting</a>, Up: <a href="Error-Handling.html#Error-Handling" accesskey="u" rel="up">Error Handling</a> &nbsp; [<a href="Function-Index.html#Function-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Error-Codes-1"></a>
<h3 class="section">3.2 Error Codes</h3>
<a name="index-error-codes_002c-reserved"></a>
<p>The error code numbers returned by library functions are defined in
the file <samp>gsl_errno.h</samp>.  They all have the prefix <code>GSL_</code> and
expand to non-zero constant integer values. Error codes above 1024 are
reserved for applications, and are not used by the library.  Many of
the error codes use the same base name as the corresponding error code
in the C library.  Here are some of the most common error codes,
</p>
<a name="index-error-codes"></a>
<dl>
<dt><a name="index-GSL_005fEDOM"></a>Macro: <em>int</em> <strong>GSL_EDOM</strong></dt>
<dd><p>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)
</p></dd></dl>

<dl>
<dt><a name="index-GSL_005fERANGE"></a>Macro: <em>int</em> <strong>GSL_ERANGE</strong></dt>
<dd><p>Range error; used by mathematical functions when the result value is not
representable because of overflow or underflow (like ERANGE in the C
library)
</p></dd></dl>

<dl>
<dt><a name="index-GSL_005fENOMEM"></a>Macro: <em>int</em> <strong>GSL_ENOMEM</strong></dt>
<dd><p>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 <code>malloc</code>.
</p></dd></dl>

<dl>
<dt><a name="index-GSL_005fEINVAL"></a>Macro: <em>int</em> <strong>GSL_EINVAL</strong></dt>
<dd><p>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). 
</p></dd></dl>

<p>The error codes can be converted into an error message using the
function <code>gsl_strerror</code>.
</p>
<dl>
<dt><a name="index-gsl_005fstrerror"></a>Function: <em>const char *</em> <strong>gsl_strerror</strong> <em>(const int <var>gsl_errno</var>)</em></dt>
<dd><p>This function returns a pointer to a string describing the error code
<var>gsl_errno</var>. For example,
</p>
<div class="example">
<pre class="example">printf (&quot;error: %s\n&quot;, gsl_strerror (status));
</pre></div>

<p>would print an error message like <code>error: output range error</code> for a
status value of <code>GSL_ERANGE</code>.
</p></dd></dl>

<hr>
<div class="header">
<p>
Next: <a href="Error-Handlers.html#Error-Handlers" accesskey="n" rel="next">Error Handlers</a>, Previous: <a href="Error-Reporting.html#Error-Reporting" accesskey="p" rel="previous">Error Reporting</a>, Up: <a href="Error-Handling.html#Error-Handling" accesskey="u" rel="up">Error Handling</a> &nbsp; [<a href="Function-Index.html#Function-Index" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>