lib/libm/common_source/erf.3

   1 .\" Copyright (c) 1985, 1991, 1993
   2 .\"     The Regents of the University of California.  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 .\"     @(#)erf.3       8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD: src/lib/libm/common_source/erf.3,v 1.3.2.4 2001/08/17 15:43:05 ru Exp $
  34 .\" $DragonFly: src/lib/libm/common_source/Attic/erf.3,v 1.2 2003/06/17 04:26:50 dillon Exp $
  35 .\"
  36 .Dd June 4, 1993
  37 .Dt ERF 3
  38 .Os
  39 .Sh NAME
  40 .Nm erf ,
  41 .Nm erfc
  42 .Nd error function operators
  43 .Sh LIBRARY
  44 .Lb libm
  45 .Sh SYNOPSIS
  46 .Fd #include <math.h>
  47 .Ft double
  48 .Fn erf "double x"
  49 .Ft double
  50 .Fn erfc "double x"
  51 .Sh DESCRIPTION
  52 These functions calculate the error function of
  53 .Fa x .
  54 .Pp
  55 The
  56 .Fn erf
  57 calculates the error function of x; where
  58 .Bd -ragged -offset indent
  59 .if n \{\
  60 erf(x) = 2/sqrt(pi)\(**\|integral from 0 to x of exp(\-t\(**t) dt. \}
  61 .if t \{\
  62 erf\|(x) :=
  63 (2/\(sr\(*p)\|\(is\d\s8\z0\s10\u\u\s8x\s10\d\|exp(\-t\u\s82\s10\d)\|dt. \}
  64 .Ed
  65 .Pp
  66 The
  67 .Fn erfc
  68 function calculates the complementary error function of
  69 .Fa x ;
  70 that is
  71 .Fn erfc
  72 subtracts the result of the error function
  73 .Fn erf x
  74 from 1.0.
  75 This is useful, since for large
  76 .Fa x
  77 places disappear.
  78 .Sh SEE ALSO
  79 .Xr math 3
  80 .Sh HISTORY
  81 The
  82 .Fn erf
  83 and
  84 .Fn erfc
  85 functions appeared in
  86 .Bx 4.3 .