share/man/man3m/sqrt.3m

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The Berkeley software License Agreement specifies the terms and conditions
  28 .\" for redistribution.
  29 .\"
  30 .\"
  31 .\" Copyright (c) 1985 Regents of the University of California.
  32 .\" All rights reserved.
  33 .\" Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
  34 .\" Copyright (c) 2001, The IEEE and The Open Group.  All Rights Reserved.
  35 .\" Portions Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
  36 .\"
  37 .TH SQRT 3M "Jul 12, 2006" "SunOS 5.11" "Mathematical Library Functions"
  38 .SH NAME
  39 sqrt, sqrtf, sqrtl \- square root function
  40 .SH SYNOPSIS
  41 .LP
  42 .nf
  43 c99 [ \fIflag\fR... ] \fIfile\fR... \fB-lm\fR [ \fIlibrary\fR... ]
  44 #include <math.h>
  45
  46 \fBdouble\fR \fBsqrt\fR(\fBdouble\fR \fIx\fR);
  47 .fi
  48
  49 .LP
  50 .nf
  51 \fBfloat\fR \fBsqrtf\fR(\fBfloat\fR \fIx\fR);
  52 .fi
  53
  54 .LP
  55 .nf
  56 \fBlong double\fR \fBsqrtl\fR(\fBlong double\fR \fIx\fR);
  57 .fi
  58
  59 .SH DESCRIPTION
  60 .sp
  61 .LP
  62 These functions compute the square root of their argument \fIx\fR.
  63 .SH RETURN VALUES
  64 .sp
  65 .LP
  66 Upon successful completion, these functions return the square root of \fIx\fR.
  67 .sp
  68 .LP
  69 For finite values of \fIx\fR < \(mi0, a domain error occurs and either a NaN
  70 (if supported) or an implementation-defined value is returned.
  71 .sp
  72 .LP
  73 If \fIx\fR is NaN, a NaN is returned.
  74 .sp
  75 .LP
  76 If \fIx\fR is \(+-0 or +Inf, \fIx\fR is returned.
  77 .sp
  78 .LP
  79 If \fIx\fR is \(miInf, a domain error occurs and a NaN is returned.
  80 .SH ERRORS
  81 .sp
  82 .LP
  83 These functions will fail if:
  84 .sp
  85 .ne 2
  86 .mk
  87 .na
  88 \fBDomain Error\fR
  89 .ad
  90 .RS 16n
  91 .rt
  92 The finite value of \fIx\fR is < \(mi0 or \fIx\fR is \(miInf.
  93 .sp
  94 If the integer expression (\fBmath_errhandling\fR & \fBMATH_ERREXCEPT\fR) is
  95 non-zero, the invalid floating-point exception is raised.
  96 .sp
  97 The \fBsqrt()\fR function sets \fBerrno\fR to \fBEDOM\fR if the value of
  98 \fIx\fR is negative.
  99 .RE
 100
 101 .SH USAGE
 102 .sp
 103 .LP
 104 An application wanting to check for exceptions should call
 105 \fBfeclearexcept\fR(\fBFE_ALL_EXCEPT\fR) before calling these functions. On
 106 return, if \fBfetestexcept\fR(\fBFE_INVALID\fR | \fBFE_DIVBYZERO\fR |
 107 \fBFE_OVERFLOW\fR | \fBFE_UNDERFLOW\fR) is non-zero, an exception has been
 108 raised. An application should either examine the return value or check the
 109 floating point exception flags to detect exceptions.
 110 .sp
 111 .LP
 112 An application can also set \fBerrno\fR to 0 before calling \fBsqrt()\fR. On
 113 return, if \fBerrno\fR is non-zero, an error has occurred. The \fBsqrtf()\fR
 114 and \fBsqrtl()\fR functions do not set \fBerrno\fR.
 115 .SH ATTRIBUTES
 116 .sp
 117 .LP
 118 See \fBattributes\fR(5) for descriptions of the following attributes:
 119 .sp
 120
 121 .sp
 122 .TS
 123 tab(    ) box;
 124 cw(2.75i) |cw(2.75i)
 125 lw(2.75i) |lw(2.75i)
 126 .
 127 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 128 _
 129 Interface Stability     Standard
 130 _
 131 MT-Level        MT-Safe
 132 .TE
 133
 134 .SH SEE ALSO
 135 .sp
 136 .LP
 137 \fBfeclearexcept\fR(3M), \fBfetestexcept\fR(3M), \fBisnan\fR(3M),
 138 \fBmath.h\fR(3HEAD), \fBattributes\fR(5), \fBstandards\fR(5)