diff options
Diffstat (limited to 'devdocs/c/numeric%2Fmath%2Ffdim.html')
| -rw-r--r-- | devdocs/c/numeric%2Fmath%2Ffdim.html | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/devdocs/c/numeric%2Fmath%2Ffdim.html b/devdocs/c/numeric%2Fmath%2Ffdim.html new file mode 100644 index 00000000..4d64f3ac --- /dev/null +++ b/devdocs/c/numeric%2Fmath%2Ffdim.html @@ -0,0 +1,63 @@ + <h1 id="firstHeading" class="firstHeading">fdim, fdimf, fdiml</h1> <table class="t-dcl-begin"> <tr class="t-dsc-header"> <th> Defined in header <code><math.h></code> </th> <th> </th> <th> </th> </tr> <tr class="t-dcl t-since-c99"> <td> <pre data-language="c">float fdimf( float x, float y );</pre> +</td> <td> (1) </td> <td> <span class="t-mark-rev t-since-c99">(since C99)</span> </td> </tr> <tr class="t-dcl t-since-c99"> <td> <pre data-language="c">double fdim( double x, double y );</pre> +</td> <td> (2) </td> <td> <span class="t-mark-rev t-since-c99">(since C99)</span> </td> </tr> <tr class="t-dcl t-since-c99"> <td> <pre data-language="c">long double fdiml( long double x, long double y );</pre> +</td> <td> (3) </td> <td> <span class="t-mark-rev t-since-c99">(since C99)</span> </td> </tr> <tr class="t-dsc-header"> <th> Defined in header <code><tgmath.h></code> </th> <th> </th> <th> </th> </tr> <tr class="t-dcl t-since-c99"> <td> <pre data-language="c">#define fdim( x, y )</pre> +</td> <td> (4) </td> <td> <span class="t-mark-rev t-since-c99">(since C99)</span> </td> </tr> </table> <div class="t-li1"> +<span class="t-li">1-3)</span> Returns the positive difference between <code>x</code> and <code>y</code>, that is, if <code>x>y</code>, returns <code>x-y</code>, otherwise (if <code>x≤y</code>), returns +0.</div> <div class="t-li1"> +<span class="t-li">4)</span> Type-generic macro: If any argument has type <code>long double</code>, <code>fdiml</code> is called. Otherwise, if any argument has integer type or has type <code>double</code>, <code>fdim</code> is called. Otherwise, <code>fdimf</code> is called.</div> <h3 id="Parameters"> Parameters</h3> <table class="t-par-begin"> <tr class="t-par"> <td> x, y </td> <td> - </td> <td> floating point value </td> +</tr> +</table> <h3 id="Return_value"> Return value</h3> <p>If successful, returns the positive difference between x and y.</p> +<p>If a range error due to overflow occurs, <code><a href="huge_val" title="c/numeric/math/HUGE VAL">+HUGE_VAL</a></code>, <code>+HUGE_VALF</code>, or <code>+HUGE_VALL</code> is returned.</p> +<p>If a range error due to underflow occurs, the correct value (after rounding) is returned.</p> +<h3 id="Error_handling"> Error handling</h3> <p>Errors are reported as specified in <code>math_errhandling</code>.</p> +<p>If the implementation supports IEEE floating-point arithmetic (IEC 60559),</p> +<ul><li> If either argument is NaN, NaN is returned </li></ul> <h3 id="Notes"> Notes</h3> <p>Equivalent to <code><a href="http://en.cppreference.com/w/c/numeric/math/fmax"><span class="kw651">fmax</span></a><span class="br0">(</span>x<span class="sy2">-</span>y, <span class="nu0">0</span><span class="br0">)</span></code> except for the NaN handling requirements.</p> +<h3 id="Example"> Example</h3> <div class="t-example"> <div class="c source-c"><pre data-language="c">#include <stdio.h> +#include <math.h> +#include <errno.h> +#include <fenv.h> +// #pragma STDC FENV_ACCESS ON +int main(void) +{ + printf("fdim(4, 1) = %f, fdim(1, 4)=%f\n", fdim(4,1), fdim(1,4)); + printf("fdim(4,-1) = %f, fdim(1,-4)=%f\n", fdim(4,-1), fdim(1,-4)); + //error handling + errno = 0; feclearexcept(FE_ALL_EXCEPT); + printf("fdim(1e308, -1e308) = %f\n", fdim(1e308, -1e308)); + if(errno == ERANGE) perror(" errno == ERANGE"); + if(fetestexcept(FE_OVERFLOW)) puts(" FE_OVERFLOW raised"); +}</pre></div> <p>Possible output:</p> +<div class="text source-text"><pre data-language="c">fdim(4, 1) = 3.000000, fdim(1, 4)=0.000000 +fdim(4,-1) = 5.000000, fdim(1,-4)=5.000000 +fdim(1e308, -1e308) = inf + errno == ERANGE: Numerical result out of range + FE_OVERFLOW raised</pre></div> </div> <h3 id="References"> References</h3> <ul> +<li> C17 standard (ISO/IEC 9899:2018): </li> +<ul> +<li> 7.12.12.1 The fdim functions (p: 187-188) </li> +<li> 7.25 Type-generic math <tgmath.h> (p: 272-273) </li> +<li> F.10.9.1 The fdim functions (p: 386) </li> +</ul> +<li> C11 standard (ISO/IEC 9899:2011): </li> +<ul> +<li> 7.12.12.1 The fdim functions (p: 257) </li> +<li> 7.25 Type-generic math <tgmath.h> (p: 373-375) </li> +<li> F.10.9.1 The fdim functions (p: 530) </li> +</ul> +<li> C99 standard (ISO/IEC 9899:1999): </li> +<ul> +<li> 7.12.12.1 The fdim functions (p: 238) </li> +<li> 7.22 Type-generic math <tgmath.h> (p: 335-337) </li> +<li> F.9.9.1 The fdim functions (p: 466) </li> +</ul> +</ul> <h3 id="See_also"> See also</h3> <table class="t-dsc-begin"> <tr class="t-dsc"> <td> <div><a href="abs" title="c/numeric/math/abs"> <span class="t-lines"><span>abs</span><span>labs</span><span>llabs</span></span></a></div> +<div><span class="t-lines"><span><span class="t-mark-rev t-since-c99">(C99)</span></span></span></div> </td> <td> computes absolute value of an integral value (\(\small{|x|}\)|x|) <br> <span class="t-mark">(function)</span> </td> +</tr> <tr class="t-dsc"> <td> <div><a href="fmax" title="c/numeric/math/fmax"> <span class="t-lines"><span>fmax</span><span>fmaxf</span><span>fmaxl</span></span></a></div> +<div><span class="t-lines"><span><span class="t-mark-rev t-since-c99">(C99)</span></span><span><span class="t-mark-rev t-since-c99">(C99)</span></span><span><span class="t-mark-rev t-since-c99">(C99)</span></span></span></div> </td> <td> determines larger of two floating-point values <br> <span class="t-mark">(function)</span> </td> +</tr> <tr class="t-dsc"> <td colspan="2"> <span><a href="https://en.cppreference.com/w/cpp/numeric/math/fdim" title="cpp/numeric/math/fdim">C++ documentation</a></span> for <code>fdim</code> </td> +</tr> </table> <div class="_attribution"> + <p class="_attribution-p"> + © cppreference.com<br>Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.<br> + <a href="https://en.cppreference.com/w/c/numeric/math/fdim" class="_attribution-link">https://en.cppreference.com/w/c/numeric/math/fdim</a> + </p> +</div> |