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
|
<html lang="en">
<head>
<title>Special Function Usage - GNU Scientific Library -- Reference Manual</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="GNU Scientific Library -- Reference Manual">
<meta name="generator" content="makeinfo 4.8">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="Special-Functions.html" title="Special Functions">
<link rel="next" href="The-gsl_005fsf_005fresult-struct.html" title="The gsl_sf_result struct">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007 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.2 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 freedom to copy and modify this
GNU Manual, like GNU software.''-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<div class="node">
<p>
<a name="Special-Function-Usage"></a>
Next: <a rel="next" accesskey="n" href="The-gsl_005fsf_005fresult-struct.html">The gsl_sf_result struct</a>,
Up: <a rel="up" accesskey="u" href="Special-Functions.html">Special Functions</a>
<hr>
</div>
<h3 class="section">7.1 Usage</h3>
<p>The special functions are available in two calling conventions, a
<dfn>natural form</dfn> which returns the numerical value of the function and
an <dfn>error-handling form</dfn> which returns an error code. The two types
of function provide alternative ways of accessing the same underlying
code.
<p>The <dfn>natural form</dfn> returns only the value of the function and can be
used directly in mathematical expressions. For example, the following
function call will compute the value of the Bessel function
J_0(x),
<pre class="example"> double y = gsl_sf_bessel_J0 (x);
</pre>
<p class="noindent">There is no way to access an error code or to estimate the error using
this method. To allow access to this information the alternative
error-handling form stores the value and error in a modifiable argument,
<pre class="example"> gsl_sf_result result;
int status = gsl_sf_bessel_J0_e (x, &result);
</pre>
<p class="noindent">The error-handling functions have the suffix <code>_e</code>. The returned
status value indicates error conditions such as overflow, underflow or
loss of precision. If there are no errors the error-handling functions
return <code>GSL_SUCCESS</code>.
<hr>The GNU Scientific Library - a free numerical library licensed under the GNU GPL<br>Back to the <a href="/software/gsl/">GNU Scientific Library Homepage</a></body></html>
|