/usr/share/gtk-doc/html/libgwyddion/libgwyddion-Math-Fallback.html is in libgwyddion20-doc 2.26-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Math Fallback</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Gwyddion Library Reference Manual">
<link rel="up" href="index.html" title="Gwyddion Library Reference Manual">
<link rel="prev" href="libgwyddion-Math.html" title="Math">
<link rel="next" href="libgwyddion-GwyNLFitter.html" title="GwyNLFitter">
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libgwyddion-Math.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td> </td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Gwyddion Library Reference Manual</th>
<td><a accesskey="n" href="libgwyddion-GwyNLFitter.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libgwyddion-Math-Fallback.synopsis" class="shortcut">Top</a>
|
<a href="#libgwyddion-Math-Fallback.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libgwyddion-Math-Fallback"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgwyddion-Math-Fallback.top_of_page"></a>Math Fallback</span></h2>
<p>Math Fallback — Fallback implementations of standard mathematical
functions</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libgwyddion-Math-Fallback.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libgwyddion/gwymathfallback.h>
#define <a class="link" href="libgwyddion-Math-Fallback.html#acosh" title="acosh">acosh</a>
#define <a class="link" href="libgwyddion-Math-Fallback.html#asinh" title="asinh">asinh</a>
#define <a class="link" href="libgwyddion-Math-Fallback.html#atanh" title="atanh">atanh</a>
#define <a class="link" href="libgwyddion-Math-Fallback.html#cbrt" title="cbrt">cbrt</a>
#define <a class="link" href="libgwyddion-Math-Fallback.html#gwy-isinf" title="gwy_isinf">gwy_isinf</a>
#define <a class="link" href="libgwyddion-Math-Fallback.html#gwy-isnan" title="gwy_isnan">gwy_isnan</a>
<span class="returnvalue">double</span> <a class="link" href="libgwyddion-Math-Fallback.html#gwy-math-fallback-acosh" title="gwy_math_fallback_acosh ()">gwy_math_fallback_acosh</a> (<em class="parameter"><code><span class="type">double</span> x</code></em>);
<span class="returnvalue">double</span> <a class="link" href="libgwyddion-Math-Fallback.html#gwy-math-fallback-asinh" title="gwy_math_fallback_asinh ()">gwy_math_fallback_asinh</a> (<em class="parameter"><code><span class="type">double</span> x</code></em>);
<span class="returnvalue">double</span> <a class="link" href="libgwyddion-Math-Fallback.html#gwy-math-fallback-atanh" title="gwy_math_fallback_atanh ()">gwy_math_fallback_atanh</a> (<em class="parameter"><code><span class="type">double</span> x</code></em>);
<span class="returnvalue">double</span> <a class="link" href="libgwyddion-Math-Fallback.html#gwy-math-fallback-cbrt" title="gwy_math_fallback_cbrt ()">gwy_math_fallback_cbrt</a> (<em class="parameter"><code><span class="type">double</span> x</code></em>);
<span class="returnvalue">double</span> <a class="link" href="libgwyddion-Math-Fallback.html#gwy-math-fallback-hypot" title="gwy_math_fallback_hypot ()">gwy_math_fallback_hypot</a> (<em class="parameter"><code><span class="type">double</span> x</code></em>,
<em class="parameter"><code><span class="type">double</span> y</code></em>);
<span class="returnvalue">double</span> <a class="link" href="libgwyddion-Math-Fallback.html#gwy-math-fallback-isinf" title="gwy_math_fallback_isinf ()">gwy_math_fallback_isinf</a> (<em class="parameter"><code><span class="type">double</span> x</code></em>);
<span class="returnvalue">double</span> <a class="link" href="libgwyddion-Math-Fallback.html#gwy-math-fallback-isnan" title="gwy_math_fallback_isnan ()">gwy_math_fallback_isnan</a> (<em class="parameter"><code><span class="type">double</span> x</code></em>);
<span class="returnvalue">double</span> <a class="link" href="libgwyddion-Math-Fallback.html#gwy-math-fallback-pow10" title="gwy_math_fallback_pow10 ()">gwy_math_fallback_pow10</a> (<em class="parameter"><code><span class="type">double</span> x</code></em>);
#define <a class="link" href="libgwyddion-Math-Fallback.html#hypot" title="hypot">hypot</a>
#define <a class="link" href="libgwyddion-Math-Fallback.html#pow10" title="pow10">pow10</a>
</pre>
</div>
<div class="refsect1">
<a name="libgwyddion-Math-Fallback.description"></a><h2>Description</h2>
<p>
Fallback functions
<code class="function">gwy_math_fallback_<em class="replaceable"><code>foo</code></em></code> are
defined for mathematical functions
<code class="function"><em class="replaceable"><code>foo</code></em></code> that might not be
implemented on all platforms and are commonly used in Gwyddion. These
functions are always defined (as <code class="literal">static inline</code>), however,
you should not use them as they can be less efficient or precise than the
standard functions.
</p>
<p>
For each unavailable function (and only for those), this header file defines
a replacement macro expanding to the name of the fallback function.
Therefore after including it, you can use for instance
<code class="function">cbrt</code> regardless if the platform provides it or not.
Note this header has to be included explicitly to avoid possible inadvertent
clashes with other definitions of <code class="function">cbrt</code>.
</p>
<p>
Since all replacement macros expand to names of functions, it is possible
to take the address of any of them.
</p>
</div>
<div class="refsect1">
<a name="libgwyddion-Math-Fallback.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="acosh"></a><h3>acosh</h3>
<pre class="programlisting">#define acosh gwy_math_fallback_acosh
</pre>
<p>
Macro defined to <a class="link" href="libgwyddion-Math-Fallback.html#gwy-math-fallback-acosh" title="gwy_math_fallback_acosh ()"><code class="function">gwy_math_fallback_acosh()</code></a> if the platform does not provide
<code class="function">acosh</code>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="asinh"></a><h3>asinh</h3>
<pre class="programlisting">#define asinh gwy_math_fallback_asinh
</pre>
<p>
Macro defined to <a class="link" href="libgwyddion-Math-Fallback.html#gwy-math-fallback-asinh" title="gwy_math_fallback_asinh ()"><code class="function">gwy_math_fallback_asinh()</code></a> if the platform does not provide
<code class="function">asinh</code>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="atanh"></a><h3>atanh</h3>
<pre class="programlisting">#define atanh gwy_math_fallback_atanh
</pre>
<p>
Macro defined to <a class="link" href="libgwyddion-Math-Fallback.html#gwy-math-fallback-atanh" title="gwy_math_fallback_atanh ()"><code class="function">gwy_math_fallback_atanh()</code></a> if the platform does not provide
<code class="function">atanh</code>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="cbrt"></a><h3>cbrt</h3>
<pre class="programlisting">#define cbrt gwy_math_fallback_cbrt
</pre>
<p>
Macro defined to <a class="link" href="libgwyddion-Math-Fallback.html#gwy-math-fallback-cbrt" title="gwy_math_fallback_cbrt ()"><code class="function">gwy_math_fallback_cbrt()</code></a> if the platform does not provide
<code class="function">cbrt</code>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-isinf"></a><h3>gwy_isinf</h3>
<pre class="programlisting">#define gwy_isinf isinf
</pre>
<p>
Macro defined to working <code class="function">isinf()</code> implementation, either a system one or
<code class="function">gwy_math_callback_isinf()</code>.
</p>
<p class="since">Since 2.22</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-isnan"></a><h3>gwy_isnan</h3>
<pre class="programlisting">#define gwy_isnan isnan
</pre>
<p>
Macro defined to working <code class="function">isnan()</code> implementation, either a system one or
<code class="function">gwy_math_callback_isnan()</code>.
</p>
<p class="since">Since 2.22</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-math-fallback-acosh"></a><h3>gwy_math_fallback_acosh ()</h3>
<pre class="programlisting"><span class="returnvalue">double</span> gwy_math_fallback_acosh (<em class="parameter"><code><span class="type">double</span> x</code></em>);</pre>
<p>
Fallback for the standard mathematical function
<code class="function">acosh</code>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
<td>Floating point number greater or equal to 1.0.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Inverse hyperbolic cosine of <em class="parameter"><code>x</code></em>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.9</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-math-fallback-asinh"></a><h3>gwy_math_fallback_asinh ()</h3>
<pre class="programlisting"><span class="returnvalue">double</span> gwy_math_fallback_asinh (<em class="parameter"><code><span class="type">double</span> x</code></em>);</pre>
<p>
Fallback for the standard mathematical function
<code class="function">asinh</code>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
<td>Floating point number.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Inverse hyperbolic sine of <em class="parameter"><code>x</code></em>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.9</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-math-fallback-atanh"></a><h3>gwy_math_fallback_atanh ()</h3>
<pre class="programlisting"><span class="returnvalue">double</span> gwy_math_fallback_atanh (<em class="parameter"><code><span class="type">double</span> x</code></em>);</pre>
<p>
Fallback for the standard mathematical function
<code class="function">atanh</code>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
<td>Floating point number in the range [-1, 1].</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Inverse hyperbolic tangent of <em class="parameter"><code>x</code></em>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.9</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-math-fallback-cbrt"></a><h3>gwy_math_fallback_cbrt ()</h3>
<pre class="programlisting"><span class="returnvalue">double</span> gwy_math_fallback_cbrt (<em class="parameter"><code><span class="type">double</span> x</code></em>);</pre>
<p>
Fallback for the standard mathematical function
<code class="function">cbrt</code>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
<td>Floating point number.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Cubic root of <em class="parameter"><code>x</code></em>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.9</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-math-fallback-hypot"></a><h3>gwy_math_fallback_hypot ()</h3>
<pre class="programlisting"><span class="returnvalue">double</span> gwy_math_fallback_hypot (<em class="parameter"><code><span class="type">double</span> x</code></em>,
<em class="parameter"><code><span class="type">double</span> y</code></em>);</pre>
<p>
Fallback for the standard mathematical function
<code class="function">hypot</code>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
<td>Floating point number.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
<td>Floating point number.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Length of hypotenuse of a right-angle triangle with sides of
lengths <em class="parameter"><code>x</code></em> and <em class="parameter"><code>y</code></em>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.9</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-math-fallback-isinf"></a><h3>gwy_math_fallback_isinf ()</h3>
<pre class="programlisting"><span class="returnvalue">double</span> gwy_math_fallback_isinf (<em class="parameter"><code><span class="type">double</span> x</code></em>);</pre>
<p>
Fallback for the standard mathematical function
<code class="function">isinf</code>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
<td>Floating point number.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>x</code></em> is infinity, <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.22</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-math-fallback-isnan"></a><h3>gwy_math_fallback_isnan ()</h3>
<pre class="programlisting"><span class="returnvalue">double</span> gwy_math_fallback_isnan (<em class="parameter"><code><span class="type">double</span> x</code></em>);</pre>
<p>
Fallback for the standard mathematical function
<code class="function">isnan</code>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
<td>Floating point number.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>x</code></em> is infinity, <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.22</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-math-fallback-pow10"></a><h3>gwy_math_fallback_pow10 ()</h3>
<pre class="programlisting"><span class="returnvalue">double</span> gwy_math_fallback_pow10 (<em class="parameter"><code><span class="type">double</span> x</code></em>);</pre>
<p>
Fallback for the standard mathematical function
<code class="function">pow10</code>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
<td>Floating point number.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>10 raised to <em class="parameter"><code>x</code></em>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.9</p>
</div>
<hr>
<div class="refsect2">
<a name="hypot"></a><h3>hypot</h3>
<pre class="programlisting">#define hypot gwy_math_fallback_hypot
</pre>
<p>
Macro defined to <a class="link" href="libgwyddion-Math-Fallback.html#gwy-math-fallback-hypot" title="gwy_math_fallback_hypot ()"><code class="function">gwy_math_fallback_hypot()</code></a> if the platform does not provide
<code class="function">hypot</code>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="pow10"></a><h3>pow10</h3>
<pre class="programlisting">#define pow10 gwy_math_fallback_pow10
</pre>
<p>
Macro defined to <a class="link" href="libgwyddion-Math-Fallback.html#gwy-math-fallback-pow10" title="gwy_math_fallback_pow10 ()"><code class="function">gwy_math_fallback_pow10()</code></a> if the platform does not provide
<code class="function">pow10</code>.
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.8</div>
</body>
</html>
|