share/man/man3m/erf.3m

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The Berkeley software License Agreement specifies the terms and conditions
  28 .\" for redistribution.
  29 .\"
  30 .\"
  31 .\" Copyright (c) 1983 Regents of the University of California.
  32 .\" All rights reserved.
  33 .\" Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
  34 .\" Copyright (c) 2001, The IEEE and The Open Group.  All Rights Reserved.
  35 .\" Portions Copyright (c) 2006, Sun Microsystems, Inc.  All Rights Reserved.
  36 .\"
  37 .TH ERF 3M "Jul 12, 2006" "SunOS 5.11" "Mathematical Library Functions"
  38 .SH NAME
  39 erf, erff, erfl \- error function
  40 .SH SYNOPSIS
  41 .LP
  42 .nf
  43 c99 [ \fIflag\fR... ] \fIfile\fR... \fB-lm\fR [ \fIlibrary\fR... ]
  44 #include <math.h>
  45
  46 \fBdouble\fR \fBerf\fR(\fBdouble\fR \fIx\fR);
  47 .fi
  48
  49 .LP
  50 .nf
  51 \fBfloat\fR \fBerff\fR(\fBfloat\fR \fIx\fR);
  52 .fi
  53
  54 .LP
  55 .nf
  56 \fBlong double\fR \fBerfl\fR(\fBlong double\fR \fIx\fR);
  57 .fi
  58
  59 .SH DESCRIPTION
  60 .sp
  61 .LP
  62 These functions compute the error function of their argument \fIx\fR, defined
  63 as:
  64 .sp
  65 2/sqrt(pi)*intregral from 0 to x of exp(-t*t) dt
  66 .SH RETURN VALUES
  67 .sp
  68 .LP
  69 Upon successful completion, these functions return the value of the error
  70 function.
  71 .sp
  72 .LP
  73 If \fIx\fR is NaN, a NaN is returned.
  74 .sp
  75 .LP
  76 If \fIx\fR is \(+-0, \(+-0 is returned.
  77 .sp
  78 .LP
  79 If \fIx\fR is \(+-Inf, \(+-1 is returned.
  80 .sp
  81 .LP
  82 If \fIx\fR is subnormal, 2/sqrt(\c
  83 .if n pi\c
  84 .if t \(*p
  85 \c
  86 ) * 2 is returned.
  87 .SH ATTRIBUTES
  88 .sp
  89 .LP
  90 See \fBattributes\fR(5) for descriptions of the following attributes:
  91 .sp
  92
  93 .sp
  94 .TS
  95 tab(    ) box;
  96 cw(2.75i) |cw(2.75i)
  97 lw(2.75i) |lw(2.75i)
  98 .
  99 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 100 _
 101 Interface Stability     Standard
 102 _
 103 MT-Level        MT-Safe
 104 .TE
 105
 106 .SH SEE ALSO
 107 .sp
 108 .LP
 109 \fBerfc\fR(3M), \fBfeclearexcept\fR(3M), \fBfetestexcept\fR(3M),
 110 \fBisnan\fR(3M), \fBmath.h\fR(3HEAD), \fBattributes\fR(5), \fBstandards\fR(5)