lib/libm/common_source/sqrt.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 .\"     @(#)sqrt.3      8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD: src/lib/libm/common_source/sqrt.3,v 1.4.2.3 2001/03/06 16:46:22 ru Exp $
  34 .\" $DragonFly: src/lib/libm/common_source/Attic/sqrt.3,v 1.2 2003/06/17 04:26:50 dillon Exp $
  35 .\"
  36 .Dd June 4, 1993
  37 .Dt SQRT 3
  38 .Os
  39 .Sh NAME
  40 .Nm cbrt ,
  41 .Nm sqrt
  42 .Nd cube root and square root functions
  43 .Sh LIBRARY
  44 .Lb libm
  45 .Sh SYNOPSIS
  46 .Fd #include <math.h>
  47 .Ft double
  48 .Fn cbrt "double x"
  49 .Ft double
  50 .Fn sqrt "double x"
  51 .Sh DESCRIPTION
  52 The
  53 .Fn cbrt
  54 function computes
  55 the cube root of
  56 .Ar x .
  57 .Pp
  58 The
  59 .Fn sqrt
  60 computes the
  61 non-negative square root of x.
  62 .Sh RETURN VALUES
  63 The
  64 .Fn cbrt
  65 function returns the requested cube root.
  66 The
  67 .Fn sqrt
  68 function returns the requested square root
  69 unless an error occurs.
  70 On the
  71 .Tn VAX
  72 or
  73 .Tn Tahoe
  74 processor an attempt to take the
  75 .Fn sqrt
  76 of negative
  77 .Fa x
  78 causes an error; in this event,
  79 the global variable
  80 .Va errno
  81 is set to
  82 .Er EDOM
  83 and a reserved operand fault is generated.
  84 .Sh ERROR (due to Roundoff etc.)
  85 The
  86 .Fn cbrt
  87 function
  88 is accurate to within 0.7
  89 .Em ulps .
  90 .Pp
  91 The
  92 .Fn sqrt
  93 function on a
  94 .Tn VAX
  95 is accurate to within 0.501
  96 .Em ulps .
  97 Sqrt on a machine that conforms to
  98 .Tn IEEE
  99 754 is correctly rounded
 100 in accordance with the rounding mode in force; the error is less than
 101 half an
 102 .Em ulp
 103 in the default mode (round\-to\-nearest).
 104 An
 105 .Em ulp
 106 is one
 107 .Em U Ns nit
 108 in the
 109 .Em L Ns ast
 110 .Em P Ns lace
 111 carried.
 112 .Sh SEE ALSO
 113 .Xr infnan 3 ,
 114 .Xr math 3
 115 .Sh STANDARDS
 116 The
 117 .Fn sqrt
 118 function conforms to
 119 .St -isoC .
 120 .Sh HISTORY
 121 The
 122 .Fn cbrt
 123 function appeared in
 124 .Bx 4.3 .