lib/libm/common_source/acos.3

   1 .\" Copyright (c) 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 .\"     @(#)acos.3      8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD: src/lib/libm/common_source/acos.3,v 1.4.2.4 2001/07/22 12:07:16 dd Exp $
  34 .\"
  35 .Dd June 4, 1993
  36 .Dt ACOS 3
  37 .Os
  38 .Sh NAME
  39 .Nm acos
  40 .Nd arc cosine function
  41 .Sh LIBRARY
  42 .Lb libm
  43 .Sh SYNOPSIS
  44 .Fd #include <math.h>
  45 .Ft double
  46 .Fn acos "double x"
  47 .Sh DESCRIPTION
  48 The
  49 .Fn acos
  50 function computes the principal value of the arc cosine of
  51 .Fa x .
  52 A domain error occurs for arguments not in the range [-1, +1].
  53 For a discussion of error due to roundoff, see
  54 .Xr math 3 .
  55 .Sh RETURN VALUES
  56 The
  57 .Fn acos
  58 function returns the arc cosine in the range
  59 .Bq 0 , \*(Pi
  60 radians.
  61 On the
  62 .Tn VAX
  63 and
  64 .Tn Tahoe ,
  65 if:
  66 .Bd -unfilled -offset indent
  67 .Pf \&| Ns Ar x Ns \&| > 1 ,
  68 .Ed
  69 .Pp
  70 .Fn acos x
  71 sets the global variable
  72 .Va errno
  73 to
  74 .Er EDOM
  75 and a reserved operand fault is generated.
  76 .Sh SEE ALSO
  77 .Xr asin 3 ,
  78 .Xr atan 3 ,
  79 .Xr atan2 3 ,
  80 .Xr cos 3 ,
  81 .Xr cosh 3 ,
  82 .Xr math 3 ,
  83 .Xr sin 3 ,
  84 .Xr sinh 3 ,
  85 .Xr tan 3 ,
  86 .Xr tanh 3
  87 .Sh STANDARDS
  88 The
  89 .Fn acos
  90 function conforms to
  91 .St -isoC .