share/man/man3m/hypot.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 contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
  44 .\" Copyright (c) 2001, The IEEE and The Open Group.  All Rights Reserved.
  45 .\" Portions Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
  46 .\"
  47 .TH HYPOT 3M "Sep 1, 2002" "SunOS 5.11" "Mathematical Library Functions"
  48 .SH NAME
  49 hypot, hypotf, hypotl \- Euclidean distance function
  50 .SH SYNOPSIS
  51 .LP
  52 .nf
  53 c99 [ \fIflag\fR... ] \fIfile\fR... \fB-lm\fR [ \fIlibrary\fR... ]
  54 #include <math.h>
  55
  56 \fBdouble\fR \fBhypot\fR(\fBdouble\fR \fIx\fR, \fBdouble\fR \fIy\fR);
  57 .fi
  58
  59 .LP
  60 .nf
  61 \fBfloat\fR \fBhypotf\fR(\fBfloat\fR \fIx\fR, \fBfloat\fR \fIy\fR);
  62 .fi
  63
  64 .LP
  65 .nf
  66 \fBlong double\fR \fBhypotl\fR(\fBlong double\fR \fIx\fR, \fBlong double\fR \fIy\fR);
  67 .fi
  68
  69 .SH DESCRIPTION
  70 .sp
  71 .LP
  72 These functions compute the length of the square root of \fIx\fR^2 + \fIy\fR^2
  73 without undue overflow or underflow.
  74 .SH RETURN VALUES
  75 .sp
  76 .LP
  77 Upon successful completion, these functions return the length of the hypotenuse
  78 of a right angled triangle with sides of length \fIx\fR^2 and \fIy\fR^2.
  79 .sp
  80 .LP
  81 If the correct value would cause overflow, a range error occurs and
  82 \fBhypot()\fR, \fBhypotf()\fR, and \fBhypotl()\fR return the value of the macro
  83 \fBHUGE_VAL\fR, \fBHUGE_VALF\fR, and \fBHUGE_VALL\fR, respectively.
  84 .sp
  85 .LP
  86 If \fIx\fR or \fIy\fR is \(+-Inf, +Inf is returned even if one of \fIx\fR or
  87 \fIy\fR is NaN.
  88 .sp
  89 .LP
  90 If \fIx\fR or \fIy\fR is NaN and the other is not \(+-Inf, a NaN is returned.
  91 .SH ERRORS
  92 .sp
  93 .LP
  94 These functions will fail if:
  95 .sp
  96 .ne 2
  97 .mk
  98 .na
  99 \fBRange Error\fR
 100 .ad
 101 .RS 15n
 102 .rt
 103 The result overflows.
 104 .sp
 105 If the integer expression (\fBmath_errhandling\fR & \fBMATH_ERREXCEPT\fR) is
 106 non-zero, the overflow floating-point exception is raised.
 107 .RE
 108
 109 .SH USAGE
 110 .sp
 111 .LP
 112 \fBhypot\fR(\fIx\fR,\fIy\fR), \fBhypot\fR(\fIy\fR,\fIx\fR), and
 113 \fBhypot\fR(\fIx\fR, \(mi\fIy\fR) are equivalent.
 114 .sp
 115 .LP
 116 \fBhypot\fR(\fIx\fR, \(+-0) is equivalent to \fBfabs\fR(\fIx\fR).
 117 .sp
 118 .LP
 119 These functions takes precautions against underflow and overflow during
 120 intermediate steps of the computation.
 121 .sp
 122 .LP
 123 An application wanting to check for exceptions should call
 124 \fBfeclearexcept\fR(\fBFE_ALL_EXCEPT\fR) before calling these functions. On
 125 return, if \fBfetestexcept\fR(\fBFE_INVALID\fR | \fBFE_DIVBYZERO\fR |
 126 \fBFE_OVERFLOW\fR | \fBFE_UNDERFLOW\fR) is non-zero, an exception has been
 127 raised. An application should either examine the return value or check the
 128 floating point exception flags to detect exceptions.
 129 .SH ATTRIBUTES
 130 .sp
 131 .LP
 132 See \fBattributes\fR(5) for descriptions of the following attributes:
 133 .sp
 134
 135 .sp
 136 .TS
 137 tab(    ) box;
 138 cw(2.75i) |cw(2.75i)
 139 lw(2.75i) |lw(2.75i)
 140 .
 141 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 142 _
 143 Interface Stability     Standard
 144 _
 145 MT-Level        MT-Safe
 146 .TE
 147
 148 .SH SEE ALSO
 149 .sp
 150 .LP
 151 \fBfabs\fR(3M), \fBfeclearexcept\fR(3M), \fBfetestexcept\fR(3M),
 152 \fBisnan\fR(3M), \fBmath.h\fR(3HEAD), \fBsqrt\fR(3M), \fBattributes\fR(5),
 153 \fBstandards\fR(5)