lib/libm/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. 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: @(#)sqrt.3        6.4 (Berkeley) 5/6/91
  29 .\"     $NetBSD: sqrt.3,v 1.14 2013/11/19 19:24:33 joerg Exp $
  30 .\"
  31 .Dd November 19, 2013
  32 .Dt SQRT 3
  33 .Os
  34 .Sh NAME
  35 .Nm cbrt ,
  36 .Nm cbrtf ,
  37 .Nm cbrtl ,
  38 .Nm sqrt ,
  39 .Nm sqrtf ,
  40 .Nm sqrtl
  41 .Nd cube root and square root functions
  42 .Sh LIBRARY
  43 .Lb libm
  44 .Sh SYNOPSIS
  45 .In math.h
  46 .Ft double
  47 .Fn cbrt "double x"
  48 .Ft float
  49 .Fn cbrtf "float x"
  50 .Ft long double
  51 .Fn cbrtl "long double x"
  52 .Ft double
  53 .Fn sqrt "double x"
  54 .Ft float
  55 .Fn sqrtf "float x"
  56 .Ft long double
  57 .Fn sqrtl "long double x"
  58 .Sh DESCRIPTION
  59 The
  60 .Fn cbrt ,
  61 .Fn cbrtf
  62 and
  63 .Fn cbrtl
  64 functions compute
  65 the cube root of
  66 .Ar x .
  67 .Pp
  68 The
  69 .Fn sqrt ,
  70 .Fn sqrtf
  71 and
  72 .Fn sqrtl
  73 functions compute
  74 the non-negative square root of x.
  75 .Sh RETURN VALUES
  76 If x is negative,
  77 .Fn sqrt "x" ,
  78 .Fn sqrtf "x"
  79 and
  80 .Fn sqrtl "x"
  81 .\" POSIX_MODE
  82 set the global variable
  83 .Va errno
  84 to EDOM.
  85 .\" SYSV_MODE
  86 .\" call
  87 .\" .Xr matherr 3 .
  88 .Sh SEE ALSO
  89 .Xr math 3
  90 .\" .Xr matherr 3
  91 .Sh STANDARDS
  92 The
  93 .Fn sqrt
  94 function conforms to
  95 .St -ansiC .
  96 .Sh HISTORY
  97 The
  98 .Fn cbrt
  99 function appeared in
 100 .Bx 4.3 .