original/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  2013-10-29 "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
  42 .BI "double erf(double " x );
  43 .BI "float erff(float " x );
  44 .BI "long double erfl(long double " x );
  45
  46 .fi
  47 Link with \fI\-lm\fP.
  48 .sp
  49 .in -4n
  50 Feature Test Macro Requirements for glibc (see
  51 .BR feature_test_macros (7)):
  52 .in
  53 .sp
  54 .ad l
  55 .BR erf ():
  56 .RS 4
  57 _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE || _ISOC99_SOURCE ||
  58 _POSIX_C_SOURCE\ >=\ 200112L;
  59 .br
  60 or
  61 .I cc\ -std=c99
  62 .RE
  63 .br
  64 .BR erff (),
  65 .BR erfl ():
  66 .RS 4
  67 _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 600 || _ISOC99_SOURCE ||
  68 _POSIX_C_SOURCE\ >=\ 200112L;
  69 .br
  70 or
  71 .I cc\ -std=c99
  72 .RE
  73 .ad b
  74 .SH DESCRIPTION
  75 The
  76 .BR erf ()
  77 function returns the error function of
  78 .IR x ,
  79 defined
  80 as
  81 .TP
  82     erf(x) = 2/sqrt(pi)* integral from 0 to x of exp(\-t*t) dt
  83 .SH RETURN VALUE
  84 On success, these functions return the error function of
  85 .IR x ,
  86 a value in the range [\-1,\ 1].
  87
  88 If
  89 .I x
  90 is a NaN, a NaN is returned.
  91
  92 If
  93 .I x
  94 is +0 (\-0), +0 (\-0) is returned.
  95
  96 If
  97 .I x
  98 is positive infinity (negative infinity),
  99 +1 (\-1) is returned.
 100
 101 If
 102 .I x
 103 is subnormal,
 104 a range error occurs,
 105 and the return value is 2*x/sqrt(pi).
 106 .SH ERRORS
 107 See
 108 .BR math_error (7)
 109 for information on how to determine whether an error has occurred
 110 when calling these functions.
 111 .PP
 112 The following errors can occur:
 113 .TP
 114 Range error: result underflow (\fIx\fP is subnormal)
 115 .\" .I errno
 116 .\" is set to
 117 .\" .BR ERANGE .
 118 An underflow floating-point exception
 119 .RB ( FE_UNDERFLOW )
 120 is raised.
 121 .PP
 122 These functions do not set
 123 .IR errno .
 124 .\" FIXME . Is it intentional that these functions do not set errno?
 125 .\" Bug raised: http://sources.redhat.com/bugzilla/show_bug.cgi?id=6785
 126 .SH ATTRIBUTES
 127 .SS Multithreading (see pthreads(7))
 128 The
 129 .BR erf (),
 130 .BR erff (),
 131 and
 132 .BR erfl ()
 133 functions are thread-safe.
 134 .SH CONFORMING TO
 135 C99, POSIX.1-2001.
 136 The variant returning
 137 .I double
 138 also conforms to
 139 SVr4, 4.3BSD.
 140 .SH SEE ALSO
 141 .BR cerf (3),
 142 .BR erfc (3),
 143 .BR exp (3)
 144 .SH COLOPHON
 145 This page is part of release 3.68 of the Linux
 146 .I man-pages
 147 project.
 148 A description of the project,
 149 information about reporting bugs,
 150 and the latest version of this page,
 151 can be found at
 152 \%http://www.kernel.org/doc/man\-pages/.