xref: /freebsd/lib/msun/man/sqrt.3 (revision 2e3f49888ec8851bafb22011533217487764fdb0)
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.Dd February 15, 2020
29.Dt SQRT 3
30.Os
31.Sh NAME
32.Nm cbrt ,
33.Nm cbrtf ,
34.Nm cbrtl ,
35.Nm sqrt ,
36.Nm sqrtf ,
37.Nm sqrtl
38.Nd cube root and square root functions
39.Sh LIBRARY
40.Lb libm
41.Sh SYNOPSIS
42.In math.h
43.Ft double
44.Fn cbrt "double x"
45.Ft float
46.Fn cbrtf "float x"
47.Ft long double
48.Fn cbrtl "long double x"
49.Ft double
50.Fn sqrt "double x"
51.Ft float
52.Fn sqrtf "float x"
53.Ft long double
54.Fn sqrtl "long double x"
55.Sh DESCRIPTION
56The
57.Fn cbrt ,
58.Fn cbrtf ,
59and
60.Fn cbrtl
61functions compute
62the cube root of
63.Fa x .
64.Pp
65The
66.Fn sqrt ,
67.Fn sqrtf ,
68and
69.Fn sqrtl
70functions compute the
71non-negative square root of
72.Fa x .
73.Sh RETURN VALUES
74The
75.Fn cbrt ,
76.Fn cbrtf ,
77and
78.Fn cbrtl
79functions return the requested cube root.
80The
81.Fn sqrt ,
82.Fn sqrtf ,
83and
84.Fn sqrtl
85functions return the requested square root
86unless an error occurs.
87An attempt to take the
88.Fn sqrt
89of negative
90.Fa x
91raises an invalid exception and causes an \*(Na to be returned
92(except that the square root of -0 is valid and equal to -0.)
93.Sh SEE ALSO
94.Xr fenv 3 ,
95.Xr math 3
96.Sh STANDARDS
97The
98.Fn cbrt ,
99.Fn cbrtf ,
100.Fn cbrtl ,
101.Fn sqrt ,
102.Fn sqrtf ,
103and
104.Fn sqrtl
105functions conform to
106.St -isoC-99 .
107.Sh HISTORY
108The
109.Fn cbrt
110function appeared in
111.Bx 4.3 .
112The
113.Fn sqrt
114function appeared in
115.At v2 .
116.Fn sqrtl
117function appeared in
118.Fx 8.0 .
119The
120.Fn cbrtl
121function appeared in
122.Fx 9.0 .
123