man3/erf.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\" and Copyright 2008, Linux Foundation, written by Michael Kerrisk
   3 .\"     <mtk.manpages@gmail.com>
   4 .\"
   5 .\" %%%LICENSE_START(VERBATIM)
   6 .\" Permission is granted to make and distribute verbatim copies of this
   7 .\" manual provided the copyright notice and this permission notice are
   8 .\" preserved on all copies.
   9 .\"
  10 .\" Permission is granted to copy and distribute modified versions of this
  11 .\" manual under the conditions for verbatim copying, provided that the
  12 .\" entire resulting derived work is distributed under the terms of a
  13 .\" permission notice identical to this one.
  14 .\"
  15 .\" Since the Linux kernel and libraries are constantly changing, this
  16 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  17 .\" responsibility for errors or omissions, or for damages resulting from
  18 .\" the use of the information contained herein.  The author(s) may not
  19 .\" have taken the same level of care in the production of this manual,
  20 .\" which is licensed free of charge, as they might when working
  21 .\" professionally.
  22 .\"
  23 .\" Formatted or processed versions of this manual, if unaccompanied by
  24 .\" the source, must acknowledge the copyright and authors of this work.
  25 .\" %%%LICENSE_END
  26 .\"
  27 .\" References consulted:
  28 .\"     Linux libc source code
  29 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  30 .\"     386BSD man pages
  31 .\" Modified 1993-07-24 by Rik Faith (faith@cs.unc.edu)
  32 .\" Modified 2002-07-27 by Walter Harms
  33 .\"     (walter.harms@informatik.uni-oldenburg.de)
  34 .\"
  35 .TH ERF 3  2021-03-22 "GNU" "Linux Programmer's Manual"
  36 .SH NAME
  37 erf, erff, erfl \- error function
  38 .SH SYNOPSIS
  39 .nf
  40 .B #include <math.h>
  41 .PP
  42 .BI "double erf(double " x );
  43 .BI "float erff(float " x );
  44 .BI "long double erfl(long double " x );
  45 .PP
  46 .fi
  47 Link with \fI\-lm\fP.
  48 .PP
  49 .RS -4
  50 Feature Test Macro Requirements for glibc (see
  51 .BR feature_test_macros (7)):
  52 .RE
  53 .PP
  54 .BR erf ():
  55 .nf
  56     _ISOC99_SOURCE || _POSIX_C_SOURCE >= 200112L || _XOPEN_SOURCE
  57         || /* Since glibc 2.19: */ _DEFAULT_SOURCE
  58         || /* Glibc <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE
  59 .fi
  60 .PP
  61 .BR erff (),
  62 .BR erfl ():
  63 .nf
  64     _ISOC99_SOURCE || _POSIX_C_SOURCE >= 200112L
  65         || /* Since glibc 2.19: */ _DEFAULT_SOURCE
  66         || /* Glibc <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE
  67 .fi
  68 .SH DESCRIPTION
  69 These functions return the error function of
  70 .IR x ,
  71 defined as
  72 .TP
  73     erf(x) = 2/sqrt(pi) * integral from 0 to x of exp(\-t*t) dt
  74 .SH RETURN VALUE
  75 On success, these functions return the value of the error function of
  76 .IR x ,
  77 a value in the range [\-1,\ 1].
  78 .PP
  79 If
  80 .I x
  81 is a NaN, a NaN is returned.
  82 .PP
  83 If
  84 .I x
  85 is +0 (\-0), +0 (\-0) is returned.
  86 .PP
  87 If
  88 .I x
  89 is positive infinity (negative infinity),
  90 +1 (\-1) is returned.
  91 .PP
  92 If
  93 .I x
  94 is subnormal,
  95 a range error occurs,
  96 and the return value is 2*x/sqrt(pi).
  97 .SH ERRORS
  98 See
  99 .BR math_error (7)
 100 for information on how to determine whether an error has occurred
 101 when calling these functions.
 102 .PP
 103 The following errors can occur:
 104 .TP
 105 Range error: result underflow (\fIx\fP is subnormal)
 106 .\" .I errno
 107 .\" is set to
 108 .\" .BR ERANGE .
 109 An underflow floating-point exception
 110 .RB ( FE_UNDERFLOW )
 111 is raised.
 112 .PP
 113 These functions do not set
 114 .IR errno .
 115 .\" It is intentional that these functions do not set errno for this case
 116 .\" see http://sources.redhat.com/bugzilla/show_bug.cgi?id=6785
 117 .SH ATTRIBUTES
 118 For an explanation of the terms used in this section, see
 119 .BR attributes (7).
 120 .ad l
 121 .nh
 122 .TS
 123 allbox;
 124 lbx lb lb
 125 l l l.
 126 Interface       Attribute       Value
 127 T{
 128 .BR erf (),
 129 .BR erff (),
 130 .BR erfl ()
 131 T}      Thread safety   MT-Safe
 132 .TE
 133 .hy
 134 .ad
 135 .sp 1
 136 .SH CONFORMING TO
 137 C99, POSIX.1-2001, POSIX.1-2008.
 138 .PP
 139 The variant returning
 140 .I double
 141 also conforms to
 142 SVr4, 4.3BSD.
 143 .SH SEE ALSO
 144 .BR cerf (3),
 145 .BR erfc (3),
 146 .BR exp (3)