xref: /freebsd/lib/msun/man/sqrt.3 (revision 6e5dcc6113da649a79e5bc2c3ea9329bcd1d85d5)
1.\" Copyright (c) 1985, 1991 Regents of the University of California.
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\"     from: @(#)sqrt.3	6.4 (Berkeley) 5/6/91
29.\"
30.Dd February 15, 2020
31.Dt SQRT 3
32.Os
33.Sh NAME
34.Nm cbrt ,
35.Nm cbrtf ,
36.Nm cbrtl ,
37.Nm sqrt ,
38.Nm sqrtf ,
39.Nm sqrtl
40.Nd cube root and square root functions
41.Sh LIBRARY
42.Lb libm
43.Sh SYNOPSIS
44.In math.h
45.Ft double
46.Fn cbrt "double x"
47.Ft float
48.Fn cbrtf "float x"
49.Ft long double
50.Fn cbrtl "long double x"
51.Ft double
52.Fn sqrt "double x"
53.Ft float
54.Fn sqrtf "float x"
55.Ft long double
56.Fn sqrtl "long double x"
57.Sh DESCRIPTION
58The
59.Fn cbrt ,
60.Fn cbrtf ,
61and
62.Fn cbrtl
63functions compute
64the cube root of
65.Fa x .
66.Pp
67The
68.Fn sqrt ,
69.Fn sqrtf ,
70and
71.Fn sqrtl
72functions compute the
73non-negative square root of
74.Fa x .
75.Sh RETURN VALUES
76The
77.Fn cbrt ,
78.Fn cbrtf ,
79and
80.Fn cbrtl
81functions return the requested cube root.
82The
83.Fn sqrt ,
84.Fn sqrtf ,
85and
86.Fn sqrtl
87functions return the requested square root
88unless an error occurs.
89An attempt to take the
90.Fn sqrt
91of negative
92.Fa x
93raises an invalid exception and causes an \*(Na to be returned
94(except that the square root of -0 is valid and equal to -0.)
95.Sh SEE ALSO
96.Xr fenv 3 ,
97.Xr math 3
98.Sh STANDARDS
99The
100.Fn cbrt ,
101.Fn cbrtf ,
102.Fn cbrtl ,
103.Fn sqrt ,
104.Fn sqrtf ,
105and
106.Fn sqrtl
107functions conform to
108.St -isoC-99 .
109.Sh HISTORY
110The
111.Fn cbrt
112function appeared in
113.Bx 4.3 .
114The
115.Fn sqrt
116function appeared in
117.At v2 .
118.Fn sqrtl
119function appeared in
120.Fx 8.0 .
121The
122.Fn cbrtl
123function appeared in
124.Fx 9.0 .
125