]> git.ipfire.org Git - thirdparty/man-pages.git/blame - man3/sqrt.3
proc.5: Note kernel version for /proc/PID/smaps VmFlags "dd" flag
[thirdparty/man-pages.git] / man3 / sqrt.3
CommitLineData
fea681da 1.\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
631c6898
MK
2.\" and Copyright 2008, Linux Foundation, written by Michael Kerrisk
3.\" <mtk.manpages@gmail.com>
fea681da 4.\"
93015253 5.\" %%%LICENSE_START(VERBATIM)
fea681da
MK
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.
c13182ef 14.\"
fea681da
MK
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.
c13182ef 22.\"
fea681da
MK
23.\" Formatted or processed versions of this manual, if unaccompanied by
24.\" the source, must acknowledge the copyright and authors of this work.
4b72fb64 25.\" %%%LICENSE_END
fea681da
MK
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)
4b8c67d9 34.TH SQRT 3 2017-09-15 "" "Linux Programmer's Manual"
fea681da
MK
35.SH NAME
36sqrt, sqrtf, sqrtl \- square root function
37.SH SYNOPSIS
38.nf
39.B #include <math.h>
68e4db0a 40.PP
fea681da 41.BI "double sqrt(double " x );
fea681da 42.BI "float sqrtf(float " x );
fea681da
MK
43.BI "long double sqrtl(long double " x );
44.fi
68e4db0a 45.PP
20c58d70 46Link with \fI\-lm\fP.
68e4db0a 47.PP
631c6898
MK
48.in -4n
49Feature Test Macro Requirements for glibc (see
50.BR feature_test_macros (7)):
51.in
68e4db0a 52.PP
631c6898
MK
53.ad l
54.BR sqrtf (),
55.BR sqrtl ():
b90c43a8 56.RS 4
e9d91bcf
MK
57_ISOC99_SOURCE || _POSIX_C_SOURCE\ >=\ 200112L
58 || /* Since glibc 2.19: */ _DEFAULT_SOURCE
59 || /* Glibc versions <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE
b90c43a8
MK
60.RE
61.ad
fea681da 62.SH DESCRIPTION
5600f73a 63These functions return the nonnegative square root of
022671eb 64.IR x .
47297adb 65.SH RETURN VALUE
631c6898
MK
66On success, these functions return the square root of
67.IR x .
847e0d88 68.PP
631c6898
MK
69If
70.I x
71is a NaN, a NaN is returned.
847e0d88 72.PP
631c6898
MK
73If
74.I x
75is +0 (\-0), +0 (\-0) is returned.
847e0d88 76.PP
631c6898
MK
77If
78.I x
79is positive infinity, positive infinity is returned.
847e0d88 80.PP
631c6898
MK
81If
82.I x
83is less than \-0,
efe294cb 84a domain error occurs,
631c6898 85and a NaN is returned.
fea681da 86.SH ERRORS
631c6898
MK
87See
88.BR math_error (7)
89for information on how to determine whether an error has occurred
90when calling these functions.
91.PP
92The following errors can occur:
fea681da 93.TP
631c6898
MK
94Domain error: \fIx\fP less than \-0
95.I errno
96is set to
97.BR EDOM .
98An invalid floating-point exception
99.RB ( FE_INVALID )
100is raised.
606e09e6
MS
101.SH ATTRIBUTES
102For an explanation of the terms used in this section, see
103.BR attributes (7).
104.TS
105allbox;
106lbw24 lb lb
107l l l.
108Interface Attribute Value
109T{
110.BR sqrt (),
111.BR sqrtf (),
112.BR sqrtl ()
113T} Thread safety MT-Safe
114.TE
47297adb 115.SH CONFORMING TO
9a74e018 116C99, POSIX.1-2001, POSIX.1-2008.
847e0d88 117.PP
631c6898
MK
118The variant returning
119.I double
120also conforms to
68e1685c 121SVr4, 4.3BSD, C89.
47297adb 122.SH SEE ALSO
36268806
MK
123.BR cbrt (3),
124.BR csqrt (3),
fea681da 125.BR hypot (3)