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  2021-03-22 "" "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 .PP
  42 .BI "double acos(double " x );
  43 .BI "float acosf(float " x );
  44 .BI "long double acosl(long double " x );
  45 .fi
  46 .PP
  47 Link with \fI\-lm\fP.
  48 .PP
  49 .RS -4
  50 Feature Test Macro Requirements for glibc (see
  51 .BR feature_test_macros (7)):
  52 .RE
  53 .PP
  54 .BR acosf (),
  55 .BR acosl ():
  56 .nf
  57     _ISOC99_SOURCE || _POSIX_C_SOURCE >= 200112L
  58         || /* Since glibc 2.19: */ _DEFAULT_SOURCE
  59         || /* Glibc <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE
  60 .fi
  61 .SH DESCRIPTION
  62 These functions calculate the arc cosine of
  63 .IR x ;
  64 that is
  65 the value whose cosine is
  66 .IR x .
  67 .SH RETURN VALUE
  68 On success, these functions return the arc cosine of
  69 .IR x
  70 in radians; the return value is in the range [0,\ pi].
  71 .PP
  72 If
  73 .I x
  74 is a NaN, a NaN is returned.
  75 .PP
  76 If
  77 .I x
  78 is +1,
  79 +0 is returned.
  80 .PP
  81 If
  82 .I x
  83 is positive infinity or negative infinity,
  84 a domain error occurs,
  85 and a NaN is returned.
  86 .PP
  87 If
  88 .I x
  89 is outside the range [\-1,\ 1],
  90 a domain error occurs,
  91 and a NaN is returned.
  92 .SH ERRORS
  93 See
  94 .BR math_error (7)
  95 for information on how to determine whether an error has occurred
  96 when calling these functions.
  97 .PP
  98 The following errors can occur:
  99 .TP
 100 Domain error: \fIx\fP is outside the range [\-1,\ 1]
 101 .I errno
 102 is set to
 103 .BR EDOM .
 104 An invalid floating-point exception
 105 .RB ( FE_INVALID )
 106 is raised.
 107 .SH ATTRIBUTES
 108 For an explanation of the terms used in this section, see
 109 .BR attributes (7).
 110 .ad l
 111 .nh
 112 .TS
 113 allbox;
 114 lbx lb lb
 115 l l l.
 116 Interface       Attribute       Value
 117 T{
 118 .BR acos (),
 119 .BR acosf (),
 120 .BR acosl ()
 121 T}      Thread safety   MT-Safe
 122 .TE
 123 .hy
 124 .ad
 125 .sp 1
 126 .SH CONFORMING TO
 127 C99, POSIX.1-2001, POSIX.1-2008.
 128 .PP
 129 The variant returning
 130 .I double
 131 also conforms to
 132 SVr4, 4.3BSD, C89.
 133 .SH SEE ALSO
 134 .BR asin (3),
 135 .BR atan (3),
 136 .BR atan2 (3),
 137 .BR cacos (3),
 138 .BR cos (3),
 139 .BR sin (3),
 140 .BR tan (3)