lib/msun/man/erf.3

   1 .\" Copyright (c) 1985, 1991 Regents of the University of California.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     from: @(#)erf.3 6.4 (Berkeley) 4/20/91
  33 .\" $FreeBSD: src/lib/msun/man/erf.3,v 1.5.2.4 2001/12/17 10:08:36 ru Exp $
  34 .\" $DragonFly: src/lib/msun/man/Attic/erf.3,v 1.2 2003/06/17 04:26:52 dillon Exp $
  35 .\"
  36 .Dd April 20, 1991
  37 .Dt ERF 3
  38 .Os
  39 .Sh NAME
  40 .Nm erf ,
  41 .Nm erff ,
  42 .Nm erfc ,
  43 .Nm erfcf
  44 .Nd error function operators
  45 .Sh LIBRARY
  46 .Lb libm
  47 .Sh SYNOPSIS
  48 .In math.h
  49 .Ft double
  50 .Fn erf "double x"
  51 .Ft float
  52 .Fn erff "float x"
  53 .Ft double
  54 .Fn erfc "double x"
  55 .Ft float
  56 .Fn erfcf "float x"
  57 .Sh DESCRIPTION
  58 These functions calculate the error function of
  59 .Fa x .
  60 .Pp
  61 The
  62 .Fn erf
  63 and the
  64 .Fn erff
  65 functions calculate the error function of x; where
  66 .Bd -ragged -offset indent
  67 .if n \{\
  68 erf(x) = 2/sqrt(pi)\(**\|integral from 0 to x of exp(\-t\(**t) dt. \}
  69 .if t \{\
  70 erf\|(x) :=
  71 (2/\(sr\(*p)\|\(is\d\s8\z0\s10\u\u\s8x\s10\d\|exp(\-t\u\s82\s10\d)\|dt. \}
  72 .Ed
  73 .Pp
  74 The
  75 .Fn erfc
  76 and the
  77 .Fn erfcf
  78 functions calculate the complementary error function of
  79 .Fa x ;
  80 that is
  81 .Fn erfc
  82 subtracts the result of the error function
  83 .Fn erf x
  84 from 1.0.
  85 This is useful, since for large
  86 .Fa x
  87 places disappear.
  88 .Sh SEE ALSO
  89 .Xr math 3
  90 .Sh HISTORY
  91 The
  92 .Fn erf
  93 and
  94 .Fn erfc
  95 functions appeared in
  96 .Bx 4.3 .