lib/msun/man/sqrt.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: @(#)sqrt.3        6.4 (Berkeley) 5/6/91
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd May 6, 1991
  36 .Dt SQRT 3
  37 .Os
  38 .Sh NAME
  39 .Nm cbrt ,
  40 .Nm cbrtf ,
  41 .Nm sqrt ,
  42 .Nm sqrtf
  43 .Nd cube root and square root functions
  44 .Sh LIBRARY
  45 .Lb libm
  46 .Sh SYNOPSIS
  47 .In math.h
  48 .Ft double
  49 .Fn cbrt "double x"
  50 .Ft float
  51 .Fn cbrtf "float x"
  52 .Ft double
  53 .Fn sqrt "double x"
  54 .Ft float
  55 .Fn sqrtf "float x"
  56 .Sh DESCRIPTION
  57 The
  58 .Fn cbrt
  59 and the
  60 .Fn cbrtf
  61 functions compute
  62 the cube root of
  63 .Ar x .
  64 .Pp
  65 The
  66 .Fn sqrt
  67 and the
  68 .Fn sqrtf
  69 functions compute the
  70 non-negative square root of x.
  71 .Sh RETURN VALUES
  72 The
  73 .Fn cbrt
  74 and the
  75 .Fn cbrtf
  76 functions return the requested cube root.
  77 The
  78 .Fn sqrt
  79 and the
  80 .Fn sqrtf
  81 functions return the requested square root
  82 unless an error occurs.
  83 An attempt to take the
  84 .Fn sqrt
  85 of negative
  86 .Fa x
  87 raises an invalid exception and causes an \*(Na to be returned.
  88 .Sh SEE ALSO
  89 .Xr fenv 3 ,
  90 .Xr math 3
  91 .Sh STANDARDS
  92 The
  93 .Fn sqrt
  94 function conforms to
  95 .St -isoC .
  96 .Sh HISTORY
  97 The
  98 .Fn cbrt
  99 function appeared in
 100 .Bx 4.3 .