original/man3/acos.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-25 by Walter Harms
  33 .\"     (walter.harms@informatik.uni-oldenburg.de)
  34 .\"
  35 .TH ACOS 3  2010-09-20 "" "Linux Programmer's Manual"
  36 .SH NAME
  37 acos, acosf, acosl \- arc cosine function
  38 .SH SYNOPSIS
  39 .nf
  40 .B #include <math.h>
  41 .sp
  42 .BI "double acos(double " x );
  43 .BI "float acosf(float " x );
  44 .BI "long double acosl(long double " x );
  45 .fi
  46 .sp
  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 acosf (),
  56 .BR acosl ():
  57 .RS 4
  58 _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 600 || _ISOC99_SOURCE ||
  59 _POSIX_C_SOURCE\ >=\ 200112L;
  60 .br
  61 or
  62 .I cc\ -std=c99
  63 .RE
  64 .ad b
  65 .SH DESCRIPTION
  66 The
  67 .BR acos ()
  68 function calculates the arc cosine of \fIx\fP; that is
  69 the value whose cosine is \fIx\fP.
  70 .SH RETURN VALUE
  71 On success, these functions return the arc cosine of
  72 .IR x
  73 in radians; the return value is in the range [0,\ pi].
  74
  75 If
  76 .I x
  77 is a NaN, a NaN is returned.
  78
  79 If
  80 .I x
  81 is +1,
  82 +0 is returned.
  83
  84 If
  85 .I x
  86 is positive infinity or negative infinity,
  87 a domain error occurs,
  88 and a NaN is returned.
  89
  90 If
  91 .I x
  92 is outside the range [\-1,\ 1],
  93 a domain error occurs,
  94 and a NaN is returned.
  95 .SH ERRORS
  96 See
  97 .BR math_error (7)
  98 for information on how to determine whether an error has occurred
  99 when calling these functions.
 100 .PP
 101 The following errors can occur:
 102 .TP
 103 Domain error: \fIx\fP is outside the range [\-1,\ 1]
 104 .I errno
 105 is set to
 106 .BR EDOM .
 107 An invalid floating-point exception
 108 .RB ( FE_INVALID )
 109 is raised.
 110 .SH CONFORMING TO
 111 C99, POSIX.1-2001.
 112 The variant returning
 113 .I double
 114 also conforms to
 115 SVr4, 4.3BSD, C89.
 116 .SH SEE ALSO
 117 .BR asin (3),
 118 .BR atan (3),
 119 .BR atan2 (3),
 120 .BR cacos (3),
 121 .BR cos (3),
 122 .BR sin (3),
 123 .BR tan (3)