176 lines
6.6 KiB
HTML
176 lines
6.6 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
<meta name="generator" content="HTML Tidy, see www.w3.org">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
|
<link type="text/css" rel="stylesheet" href="style.css"><!-- Generated by The Open Group's rhtm tool v1.2.1 -->
|
|
<!-- Copyright (c) 2001 The Open Group, All Rights Reserved -->
|
|
<title>erfc</title>
|
|
</head>
|
|
<body bgcolor="white">
|
|
<script type="text/javascript" language="JavaScript" src="../jscript/codes.js">
|
|
</script>
|
|
|
|
<basefont size="3"> <a name="erfc"></a> <a name="tag_03_127"></a><!-- erfc -->
|
|
<!--header start-->
|
|
<center><font size="2">The Open Group Base Specifications Issue 6<br>
|
|
IEEE Std 1003.1-2001<br>
|
|
Copyright © 2001 The IEEE and The Open Group, All Rights reserved.</font></center>
|
|
|
|
<!--header end-->
|
|
<hr size="2" noshade>
|
|
<h4><a name="tag_03_127_01"></a>NAME</h4>
|
|
|
|
<blockquote>erfc, erfcf, erfcl - complementary error functions</blockquote>
|
|
|
|
<h4><a name="tag_03_127_02"></a>SYNOPSIS</h4>
|
|
|
|
<blockquote class="synopsis">
|
|
<p><code><tt>#include <<a href="../basedefs/math.h.html">math.h</a>><br>
|
|
<br>
|
|
double erfc(double</tt> <i>x</i><tt>);<br>
|
|
float erfcf(float</tt> <i>x</i><tt>);<br>
|
|
long double erfcl(long double</tt> <i>x</i><tt>);<br>
|
|
</tt></code></p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_127_03"></a>DESCRIPTION</h4>
|
|
|
|
<blockquote>
|
|
<div class="box"><sup>[<a href="javascript:open_code('CX')">CX</a>]</sup> <img src="../images/opt-start.gif" alt="[Option Start]"
|
|
border="0"> The functionality described on this reference page is aligned with the ISO C standard. Any conflict between the
|
|
requirements described here and the ISO C standard is unintentional. This volume of IEEE Std 1003.1-2001 defers to
|
|
the ISO C standard. <img src="../images/opt-end.gif" alt="[Option End]" border="0"></div>
|
|
|
|
<p>These functions shall compute the complementary error function 1.0 - <i>erf</i>(<i>x</i>).</p>
|
|
|
|
<p>An application wishing to check for error situations should set <i>errno</i> to zero and call
|
|
<i>feclearexcept</i>(FE_ALL_EXCEPT) before calling these functions. On return, if <i>errno</i> is non-zero or
|
|
<i>fetestexcept</i>(FE_INVALID | FE_DIVBYZERO | FE_OVERFLOW | FE_UNDERFLOW) is non-zero, an error has occurred.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_127_04"></a>RETURN VALUE</h4>
|
|
|
|
<blockquote>
|
|
<p>Upon successful completion, these functions shall return the value of the complementary error function.</p>
|
|
|
|
<p>If the correct value would cause underflow and is not representable, a range error may occur and <sup>[<a href=
|
|
"javascript:open_code('MX')">MX</a>]</sup> <img src="../images/opt-start.gif" alt="[Option Start]" border="0"> either 0.0 (if
|
|
representable), or <img src="../images/opt-end.gif" alt="[Option End]" border="0"> an implementation-defined value shall be
|
|
returned.</p>
|
|
|
|
<p><sup>[<a href="javascript:open_code('MX')">MX</a>]</sup> <img src="../images/opt-start.gif" alt="[Option Start]" border="0"> If
|
|
<i>x</i> is NaN, a NaN shall be returned.</p>
|
|
|
|
<p>If <i>x</i> is ±0, +1 shall be returned.</p>
|
|
|
|
<p>If <i>x</i> is -Inf, +2 shall be returned.</p>
|
|
|
|
<p>If <i>x</i> is +Inf, +0 shall be returned.</p>
|
|
|
|
<p>If the correct value would cause underflow and is representable, a range error may occur and the correct value shall be
|
|
returned. <img src="../images/opt-end.gif" alt="[Option End]" border="0"></p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_127_05"></a>ERRORS</h4>
|
|
|
|
<blockquote>
|
|
<p>These functions may fail if:</p>
|
|
|
|
<dl compact>
|
|
<dt>Range Error</dt>
|
|
|
|
<dd>The result underflows.
|
|
|
|
<p>If the integer expression (math_errhandling & MATH_ERRNO) is non-zero, then <i>errno</i> shall be set to [ERANGE]. If the
|
|
integer expression (math_errhandling & MATH_ERREXCEPT) is non-zero, then the underflow floating-point exception shall be
|
|
raised.</p>
|
|
</dd>
|
|
</dl>
|
|
</blockquote>
|
|
|
|
<hr>
|
|
<div class="box"><em>The following sections are informative.</em></div>
|
|
|
|
<h4><a name="tag_03_127_06"></a>EXAMPLES</h4>
|
|
|
|
<blockquote>
|
|
<p>None.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_127_07"></a>APPLICATION USAGE</h4>
|
|
|
|
<blockquote>
|
|
<p>The <i>erfc</i>() function is provided because of the extreme loss of relative accuracy if <i>erf</i>(<i>x</i>) is called for
|
|
large <i>x</i> and the result subtracted from 1.0.</p>
|
|
|
|
<p>Note for IEEE Std 754-1985 <b>double</b>, 26.55 < <i>x</i> implies <i>erfc</i>( <i>x</i>) has underflowed.</p>
|
|
|
|
<p>On error, the expressions (math_errhandling & MATH_ERRNO) and (math_errhandling & MATH_ERREXCEPT) are independent of
|
|
each other, but at least one of them must be non-zero.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_127_08"></a>RATIONALE</h4>
|
|
|
|
<blockquote>
|
|
<p>None.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_127_09"></a>FUTURE DIRECTIONS</h4>
|
|
|
|
<blockquote>
|
|
<p>None.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_127_10"></a>SEE ALSO</h4>
|
|
|
|
<blockquote>
|
|
<p><a href="erf.html"><i>erf</i>()</a> , <a href="feclearexcept.html"><i>feclearexcept</i>()</a> , <a href=
|
|
"fetestexcept.html"><i>fetestexcept</i>()</a> , <a href="isnan.html"><i>isnan</i>()</a> , the Base Definitions volume of
|
|
IEEE Std 1003.1-2001, <a href="../basedefs/xbd_chap04.html#tag_04_18">Section 4.18, Treatment of Error Conditions for
|
|
Mathematical Functions</a>, <a href="../basedefs/math.h.html"><i><math.h></i></a></p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_127_11"></a>CHANGE HISTORY</h4>
|
|
|
|
<blockquote>
|
|
<p>First released in Issue 1. Derived from Issue 1 of the SVID.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_127_12"></a>Issue 5</h4>
|
|
|
|
<blockquote>
|
|
<p>The DESCRIPTION is updated to indicate how an application should check for an error. This text was previously published in the
|
|
APPLICATION USAGE section.</p>
|
|
</blockquote>
|
|
|
|
<h4><a name="tag_03_127_13"></a>Issue 6</h4>
|
|
|
|
<blockquote>
|
|
<p>The <i>erfc</i>() function is no longer marked as an extension.</p>
|
|
|
|
<p>These functions are split out from the <a href="../functions/erf.html"><i>erf</i>()</a> reference page.</p>
|
|
|
|
<p>The DESCRIPTION, RETURN VALUE, ERRORS, and APPLICATION USAGE sections are revised to align with the ISO/IEC 9899:1999
|
|
standard.</p>
|
|
|
|
<p>IEC 60559:1989 standard floating-point extensions over the ISO/IEC 9899:1999 standard are marked.</p>
|
|
</blockquote>
|
|
|
|
<div class="box"><em>End of informative text.</em></div>
|
|
|
|
<hr>
|
|
<hr size="2" noshade>
|
|
<center><font size="2"><!--footer start-->
|
|
UNIX ® is a registered Trademark of The Open Group.<br>
|
|
POSIX ® is a registered Trademark of The IEEE.<br>
|
|
[ <a href="../mindex.html">Main Index</a> | <a href="../basedefs/contents.html">XBD</a> | <a href=
|
|
"../utilities/contents.html">XCU</a> | <a href="../functions/contents.html">XSH</a> | <a href="../xrat/contents.html">XRAT</a>
|
|
]</font></center>
|
|
|
|
<!--footer end-->
|
|
<hr size="2" noshade>
|
|
</body>
|
|
</html>
|
|
|