lib/libm/common_source/hypot.3

   1 .\" Copyright (c) 1985, 1991, 1993
   2 .\"     The Regents of the University of California.  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 .\"     @(#)hypot.3     8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD: src/lib/libm/common_source/hypot.3,v 1.3.2.3 2001/08/17 15:43:05 ru Exp $
  34 .\" $DragonFly: src/lib/libm/common_source/Attic/hypot.3,v 1.2 2003/06/17 04:26:50 dillon Exp $
  35 .\"
  36 .Dd June 4, 1993
  37 .Dt HYPOT 3
  38 .Os
  39 .Sh NAME
  40 .Nm hypot ,
  41 .Nm cabs
  42 .Nd euclidean distance and complex absolute value functions
  43 .Sh LIBRARY
  44 .Lb libm
  45 .Sh SYNOPSIS
  46 .Fd #include <math.h>
  47 .Ft double
  48 .Fn hypot "double x" "double y"
  49 .Vt struct {double x, y;} z ;
  50 .Ft double
  51 .Fn cabs z
  52 .Sh DESCRIPTION
  53 The
  54 .Fn hypot
  55 and
  56 .Fn cabs
  57 functions
  58 computes the
  59 sqrt(x*x+y*y)
  60 in such a way that underflow will not happen, and overflow
  61 occurs only if the final result deserves it.
  62 .Pp
  63 .Fn hypot "\*(If" "v"
  64 =
  65 .Fn hypot "v" "\*(If"
  66 = +\*(If for all
  67 .Ar v ,
  68 including \*(Na.
  69 .Sh ERROR (due to Roundoff, etc.)
  70 Below 0.97
  71 .Em ulps .
  72 Consequently
  73 .Fn hypot "5.0" "12.0"
  74 = 13.0
  75 exactly;
  76 in general, hypot and cabs return an integer whenever an
  77 integer might be expected.
  78 .Pp
  79 The same cannot be said for the shorter and faster version of hypot
  80 and cabs that is provided in the comments in cabs.c; its error can
  81 exceed 1.2
  82 .Em ulps .
  83 .Sh NOTES
  84 As might be expected,
  85 .Fn hypot "v" "\*(Na"
  86 and
  87 .Fn hypot "\*(Na" "v"
  88 are \*(Na for all
  89 .Em finite
  90 .Ar v ;
  91 with "reserved operand" in place of "\*(Na", the
  92 same is true on a
  93 .Tn VAX .
  94 But programmers on machines other than a
  95 .Tn VAX
  96 (if has no \*(If)
  97 might be surprised at first to discover that
  98 .Fn hypot "\(+-\*(If" "\*(Na"
  99 = +\*(If.
 100 This is intentional; it happens because
 101 .Fn hypot "\*(If" "v"
 102 = +\*(If
 103 for
 104 .Em all
 105 .Ar v ,
 106 finite or infinite.
 107 Hence
 108 .Fn hypot "\*(If" "v"
 109 is independent of
 110 .Ar v .
 111 Unlike the reserved operand fault on a
 112 .Tn VAX ,
 113 the
 114 .Tn IEEE
 115 \*(Na is designed to
 116 disappear when it turns out to be irrelevant, as it does in
 117 .Fn hypot "\*(If" "\*(Na" .
 118 .Sh SEE ALSO
 119 .Xr math 3 ,
 120 .Xr sqrt 3
 121 .Sh HISTORY
 122 Both a
 123 .Fn hypot
 124 function and a
 125 .Fn cabs
 126 function
 127 appeared in
 128 .At v7 .