man3/sqrt.3

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