original/man3/cos.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-27 by Walter Harms
  33 .\"     (walter.harms@informatik.uni-oldenburg.de)
  34 .TH COS 3 2013-10-14 ""   "Linux Programmer's Manual"
  35 .SH NAME
  36 cos, cosf, cosl \- cosine function
  37 .SH SYNOPSIS
  38 .nf
  39 .B #include <math.h>
  40 .sp
  41 .BI "double cos(double " x );
  42 .br
  43 .BI "float cosf(float " x );
  44 .br
  45 .BI "long double cosl(long double " x );
  46 .fi
  47 .sp
  48 Link with \fI\-lm\fP.
  49 .sp
  50 .in -4n
  51 Feature Test Macro Requirements for glibc (see
  52 .BR feature_test_macros (7)):
  53 .in
  54 .sp
  55 .ad l
  56 .BR cosf (),
  57 .BR cosl ():
  58 .RS 4
  59 _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 600 || _ISOC99_SOURCE ||
  60 _POSIX_C_SOURCE\ >=\ 200112L;
  61 .br
  62 or
  63 .I cc\ -std=c99
  64 .RE
  65 .ad
  66 .SH DESCRIPTION
  67 The
  68 .BR cos ()
  69 function returns the cosine of
  70 .IR x ,
  71 where
  72 .I x
  73 is
  74 given in radians.
  75 .SH RETURN VALUE
  76 On success, these functions return the cosine of
  77 .IR x .
  78
  79 If
  80 .I x
  81 is a NaN, a NaN is returned.
  82
  83 If
  84 .I x
  85 is positive infinity or negative infinity,
  86 a domain error occurs,
  87 and a NaN is returned.
  88 .SH ERRORS
  89 See
  90 .BR math_error (7)
  91 for information on how to determine whether an error has occurred
  92 when calling these functions.
  93 .PP
  94 The following errors can occur:
  95 .TP
  96 Domain error: \fIx\fP is an infinity
  97 .I errno
  98 is set to
  99 .BR EDOM
 100 (but see BUGS).
 101 An invalid floating-point exception
 102 .RB ( FE_INVALID )
 103 is raised.
 104 .SH ATTRIBUTES
 105 .SS Multithreading (see pthreads(7))
 106 The
 107 .BR cos (),
 108 .BR cosf (),
 109 and
 110 .BR cosl ()
 111 functions are thread-safe.
 112 .SH CONFORMING TO
 113 C99, POSIX.1-2001.
 114 The variant returning
 115 .I double
 116 also conforms to
 117 SVr4, 4.3BSD.
 118 .SH BUGS
 119 Before version 2.10, the glibc implementation did not set
 120 .\" http://sources.redhat.com/bugzilla/show_bug.cgi?id=6780
 121 .I errno
 122 to
 123 .B EDOM
 124 when a domain error occurred.
 125 .SH SEE ALSO
 126 .BR acos (3),
 127 .BR asin (3),
 128 .BR atan (3),
 129 .BR atan2 (3),
 130 .BR ccos (3),
 131 .BR sin (3),
 132 .BR sincos (3),
 133 .BR tan (3)
 134 .SH COLOPHON
 135 This page is part of release 3.64 of the Linux
 136 .I man-pages
 137 project.
 138 A description of the project,
 139 and information about reporting bugs,
 140 can be found at
 141 \%http://www.kernel.org/doc/man\-pages/.