File: The-gsl_005fsf_005fresult-struct.html

package info (click to toggle)
gsl-ref-html 1.16-1
  • links: PTS
  • area: non-free
  • in suites: jessie, jessie-kfreebsd, stretch
  • size: 5,816 kB
  • ctags: 4,130
  • sloc: makefile: 35
file content (110 lines) | stat: -rw-r--r-- 4,817 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
<!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 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 no
Invariant Sections and no cover texts.  A copy of the license is
included in the section entitled "GNU Free Documentation License". -->
<!-- Created by GNU Texinfo 5.1, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GNU Scientific Library &ndash; Reference Manual: The gsl_sf_result struct</title>

<meta name="description" content="GNU Scientific Library &ndash; Reference Manual: The gsl_sf_result struct">
<meta name="keywords" content="GNU Scientific Library &ndash; Reference Manual: The gsl_sf_result struct">
<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="Special-Functions.html#Special-Functions" rel="up" title="Special Functions">
<link href="Special-Function-Modes.html#Special-Function-Modes" rel="next" title="Special Function Modes">
<link href="Special-Function-Usage.html#Special-Function-Usage" rel="previous" title="Special Function Usage">
<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="The-gsl_005fsf_005fresult-struct"></a>
<div class="header">
<p>
Next: <a href="Special-Function-Modes.html#Special-Function-Modes" accesskey="n" rel="next">Special Function Modes</a>, Previous: <a href="Special-Function-Usage.html#Special-Function-Usage" accesskey="p" rel="previous">Special Function Usage</a>, Up: <a href="Special-Functions.html#Special-Functions" accesskey="u" rel="up">Special Functions</a> &nbsp; [<a href="Function-Index.html#Function-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="The-gsl_005fsf_005fresult-struct-1"></a>
<h3 class="section">7.2 The gsl_sf_result struct</h3>
<a name="index-gsl_005fsf_005fresult"></a>
<a name="index-gsl_005fsf_005fresult_005fe10"></a>
<a name="index-gsl_005fsf_005fresult-1"></a>
<a name="index-gsl_005fsf_005fresult_005fe10-1"></a>

<p>The error handling form of the special functions always calculate an
error estimate along with the value of the result.  Therefore,
structures are provided for amalgamating a value and error estimate.
These structures are declared in the header file <samp>gsl_sf_result.h</samp>.
</p>
<p>The <code>gsl_sf_result</code> struct contains value and error fields.
</p>
<div class="example">
<pre class="example">typedef struct
{
  double val;
  double err;
} gsl_sf_result;
</pre></div>

<p>The field <var>val</var> contains the value and the field <var>err</var> contains
an estimate of the absolute error in the value.
</p>
<p>In some cases, an overflow or underflow can be detected and handled by a
function.  In this case, it may be possible to return a scaling exponent
as well as an error/value pair in order to save the result from
exceeding the dynamic range of the built-in types.  The
<code>gsl_sf_result_e10</code> struct contains value and error fields as well
as an exponent field such that the actual result is obtained as
<code>result * 10^(e10)</code>.
</p>
<div class="example">
<pre class="example">typedef struct
{
  double val;
  double err;
  int    e10;
} gsl_sf_result_e10;
</pre></div>




</body>
</html>