lib/msun/man/hypot.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. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     from: @(#)hypot.3       6.7 (Berkeley) 5/6/91
  33 .\" $FreeBSD: src/lib/msun/man/hypot.3,v 1.5.2.4 2002/12/29 16:35:36 schweikh Exp $
  34 .\" $DragonFly: src/lib/msun/man/Attic/hypot.3,v 1.2 2003/06/17 04:26:52 dillon Exp $
  35 .\"
  36 .Dd May 6, 1991
  37 .Dt HYPOT 3
  38 .Os
  39 .Sh NAME
  40 .Nm hypot ,
  41 .Nm hypotf ,
  42 .Nm cabs ,
  43 .Nm cabsf
  44 .Nd Euclidean distance and complex absolute value functions
  45 .Sh LIBRARY
  46 .Lb libm
  47 .Sh SYNOPSIS
  48 .In math.h
  49 .Ft double
  50 .Fn hypot "double x" "double y"
  51 .Ft float
  52 .Fn hypotf "float x" "float y"
  53 .Vt struct {double x, y;} z ;
  54 .Ft double
  55 .Fn cabs z
  56 .Vt struct {float x, y;} z ;
  57 .Ft float
  58 .Fn cabsf z
  59 .Sh DESCRIPTION
  60 The
  61 .Fn hypot ,
  62 .Fn hypotf ,
  63 .Fn cabs
  64 and
  65 .Fn cabsf
  66 functions
  67 compute the
  68 sqrt(x*x+y*y)
  69 in such a way that underflow will not happen, and overflow
  70 occurs only if the final result deserves it.
  71 .Pp
  72 .Fn hypot "\*(If" "v"
  73 =
  74 .Fn hypot "v" "\*(If"
  75 = +\*(If for all
  76 .Ar v ,
  77 including \*(Na.
  78 .Sh ERROR (due to Roundoff, etc.)
  79 Below 0.97
  80 .Em ulps .
  81 Consequently
  82 .Fn hypot "5.0" "12.0"
  83 = 13.0
  84 exactly;
  85 in general, hypot and cabs return an integer whenever an
  86 integer might be expected.
  87 .Pp
  88 The same cannot be said for the shorter and faster version of hypot
  89 and cabs that is provided in the comments in cabs.c; its error can
  90 exceed 1.2
  91 .Em ulps .
  92 .Sh NOTES
  93 As might be expected,
  94 .Fn hypot "v" "\*(Na"
  95 and
  96 .Fn hypot "\*(Na" "v"
  97 are \*(Na for all
  98 .Em finite
  99 .Ar v ;
 100 with "reserved operand" in place of "\*(Na", the
 101 same is true on a
 102 .Tn VAX .
 103 But programmers on machines other than a
 104 .Tn VAX
 105 (if has no \*(If)
 106 might be surprised at first to discover that
 107 .Fn hypot "\(+-\*(If" "\*(Na"
 108 = +\*(If.
 109 This is intentional; it happens because
 110 .Fn hypot "\*(If" "v"
 111 = +\*(If
 112 for
 113 .Em all
 114 .Ar v ,
 115 finite or infinite.
 116 Hence
 117 .Fn hypot "\*(If" "v"
 118 is independent of
 119 .Ar v .
 120 Unlike the reserved operand fault on a
 121 .Tn VAX ,
 122 the
 123 .Tn IEEE
 124 \*(Na is designed to
 125 disappear when it turns out to be irrelevant, as it does in
 126 .Fn hypot "\*(If" "\*(Na" .
 127 .Sh SEE ALSO
 128 .Xr math 3 ,
 129 .Xr sqrt 3
 130 .Sh HISTORY
 131 Both a
 132 .Fn hypot
 133 function and a
 134 .Fn cabs
 135 function
 136 appeared in
 137 .At v7 .