original/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  2010-09-20 ""  "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 .sp
  41 .BI "double sqrt(double " x );
  42 .br
  43 .BI "float sqrtf(float " x );
  44 .br
  45 .BI "long double sqrtl(long double " x );
  46 .fi
  47 .sp
  48 Link with \fI\-lm\fP.
  49 .sp
  50 .in -4n
  51 Feature Test Macro Requirements for glibc (see
  52 .BR feature_test_macros (7)):
  53 .in
  54 .sp
  55 .ad l
  56 .BR sqrtf (),
  57 .BR sqrtl ():
  58 .RS 4
  59 _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 600 || _ISOC99_SOURCE ||
  60 _POSIX_C_SOURCE\ >=\ 200112L;
  61 .br
  62 or
  63 .I cc\ -std=c99
  64 .RE
  65 .ad
  66 .SH DESCRIPTION
  67 The
  68 .BR sqrt ()
  69 function returns the nonnegative square root of
  70 .IR x .
  71 .SH RETURN VALUE
  72 On success, these functions return the square root of
  73 .IR x .
  74
  75 If
  76 .I x
  77 is a NaN, a NaN is returned.
  78
  79 If
  80 .I x
  81 is +0 (\-0), +0 (\-0) is returned.
  82
  83 If
  84 .I x
  85 is positive infinity, positive infinity is returned.
  86
  87 If
  88 .I x
  89 is less than \-0,
  90 a domain error occurs,
  91 and a NaN is returned.
  92 .SH ERRORS
  93 See
  94 .BR math_error (7)
  95 for information on how to determine whether an error has occurred
  96 when calling these functions.
  97 .PP
  98 The following errors can occur:
  99 .TP
 100 Domain error: \fIx\fP less than \-0
 101 .I errno
 102 is set to
 103 .BR EDOM .
 104 An invalid floating-point exception
 105 .RB ( FE_INVALID )
 106 is raised.
 107 .SH CONFORMING TO
 108 C99, POSIX.1-2001.
 109 The variant returning
 110 .I double
 111 also conforms to
 112 SVr4, 4.3BSD, C89.
 113 .SH SEE ALSO
 114 .BR cbrt (3),
 115 .BR csqrt (3),
 116 .BR hypot (3)
 117 .SH COLOPHON
 118 This page is part of release 3.68 of the Linux
 119 .I man-pages
 120 project.
 121 A description of the project,
 122 information about reporting bugs,
 123 and the latest version of this page,
 124 can be found at
 125 \%http://www.kernel.org/doc/man\-pages/.