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