xref: /freebsd/lib/msun/man/sqrt.3 (revision 1e413cf93298b5b97441a21d9a50fdcd0ee9945e)
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.\" 4. 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.\" $FreeBSD$
30.\"
31.Dd December 14, 2007
32.Dt SQRT 3
33.Os
34.Sh NAME
35.Nm cbrt ,
36.Nm cbrtf ,
37.Nm sqrt ,
38.Nm sqrtf
39.Nd cube root and square root functions
40.Sh LIBRARY
41.Lb libm
42.Sh SYNOPSIS
43.In math.h
44.Ft double
45.Fn cbrt "double x"
46.Ft float
47.Fn cbrtf "float x"
48.Ft double
49.Fn sqrt "double x"
50.Ft float
51.Fn sqrtf "float x"
52.Sh DESCRIPTION
53The
54.Fn cbrt
55and the
56.Fn cbrtf
57functions compute
58the cube root of
59.Ar x .
60.Pp
61The
62.Fn sqrt
63and the
64.Fn sqrtf
65functions compute the
66non-negative square root of x.
67.Sh RETURN VALUES
68The
69.Fn cbrt
70and the
71.Fn cbrtf
72functions return the requested cube root.
73The
74.Fn sqrt
75and the
76.Fn sqrtf
77functions return the requested square root
78unless an error occurs.
79An attempt to take the
80.Fn sqrt
81of negative
82.Fa x
83raises an invalid exception and causes an \*(Na to be returned
84(except that the square root of -0 is valid and equal to -0.)
85.Sh SEE ALSO
86.Xr fenv 3 ,
87.Xr math 3
88.Sh STANDARDS
89The
90.Fn cbrt ,
91.Fn cbrtf ,
92.Fn sqrt ,
93and
94.Fn sqrtf
95functions conform to
96.St -isoC-99 .
97.Sh HISTORY
98The
99.Fn cbrt
100function appeared in
101.Bx 4.3 .
102