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