close_range.2: Glibc 2.34 has added a close_range() wrapper
[man-pages.git] / man3 / cbrt.3
blob78f818d9fc2ddb9649cd6db70302b7254415d276
1 .\" Copyright 1995 Jim Van Zandt <jrv@vanzandt.mv.com>
2 .\"
3 .\" %%%LICENSE_START(VERBATIM)
4 .\" Permission is granted to make and distribute verbatim copies of this
5 .\" manual provided the copyright notice and this permission notice are
6 .\" preserved on all copies.
7 .\"
8 .\" Permission is granted to copy and distribute modified versions of this
9 .\" manual under the conditions for verbatim copying, provided that the
10 .\" entire resulting derived work is distributed under the terms of a
11 .\" permission notice identical to this one.
12 .\"
13 .\" Since the Linux kernel and libraries are constantly changing, this
14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
15 .\" responsibility for errors or omissions, or for damages resulting from
16 .\" the use of the information contained herein.  The author(s) may not
17 .\" have taken the same level of care in the production of this manual,
18 .\" which is licensed free of charge, as they might when working
19 .\" professionally.
20 .\"
21 .\" Formatted or processed versions of this manual, if unaccompanied by
22 .\" the source, must acknowledge the copyright and authors of this work.
23 .\" %%%LICENSE_END
24 .\"
25 .\" changed `square root' into `cube root' - aeb, 950919
26 .\"
27 .\" Modified 2002-07-27 Walter Harms
28 .\" (walter.harms@informatik.uni-oldenburg.de)
29 .\"
30 .TH CBRT 3  2021-03-22 "GNU"  "Linux Programmer's Manual"
31 .SH NAME
32 cbrt, cbrtf, cbrtl \- cube root function
33 .SH SYNOPSIS
34 .nf
35 .B #include <math.h>
36 .PP
37 .BI "double cbrt(double " x );
38 .BI "float cbrtf(float " x );
39 .BI "long double cbrtl(long double " x );
40 .fi
41 .PP
42 Link with \fI\-lm\fP.
43 .PP
44 .RS -4
45 Feature Test Macro Requirements for glibc (see
46 .BR feature_test_macros (7)):
47 .RE
48 .PP
49 .BR cbrt ():
50 .nf
51     _ISOC99_SOURCE || _POSIX_C_SOURCE >= 200112L
52         || _XOPEN_SOURCE >= 500
53 .\"    || _XOPEN_SOURCE && _XOPEN_SOURCE_EXTENDED
54         || /* Since glibc 2.19: */ _DEFAULT_SOURCE
55         || /* Glibc <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE
56 .fi
57 .PP
58 .BR cbrtf (),
59 .BR cbrtl ():
60 .nf
61     _ISOC99_SOURCE || _POSIX_C_SOURCE >= 200112L
62         || /* Since glibc 2.19: */ _DEFAULT_SOURCE
63         || /* Glibc <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE
64 .fi
65 .SH DESCRIPTION
66 These functions return the (real) cube root of
67 .IR x .
68 This function cannot fail; every representable real value has a
69 representable real cube root.
70 .SH RETURN VALUE
71 These functions return the cube root of
72 .IR x .
73 .PP
75 .I x
76 is +0, \-0, positive infinity, negative infinity, or NaN,
77 .I x
78 is returned.
79 .SH ERRORS
80 No errors occur.
81 .SH ATTRIBUTES
82 For an explanation of the terms used in this section, see
83 .BR attributes (7).
84 .ad l
85 .nh
86 .TS
87 allbox;
88 lbx lb lb
89 l l l.
90 Interface       Attribute       Value
92 .BR cbrt (),
93 .BR cbrtf (),
94 .BR cbrtl ()
95 T}      Thread safety   MT-Safe
96 .TE
97 .hy
98 .ad
99 .sp 1
100 .SH CONFORMING TO
101 C99, POSIX.1-2001, POSIX.1-2008.
102 .\" .BR cbrt ()
103 .\" was a GNU extension. It is now a C99 requirement.
104 .SH SEE ALSO
105 .BR pow (3),
106 .BR sqrt (3)