original/man3/cbrt.3

   1 .\" Copyright 1995 Jim Van Zandt <jrv@vanzandt.mv.com>
   2 .\"
   3 .\" Permission is granted to make and distribute verbatim copies of this
   4 .\" manual provided the copyright notice and this permission notice are
   5 .\" preserved on all copies.
   6 .\"
   7 .\" Permission is granted to copy and distribute modified versions of this
   8 .\" manual under the conditions for verbatim copying, provided that the
   9 .\" entire resulting derived work is distributed under the terms of a
  10 .\" permission notice identical to this one.
  11 .\"
  12 .\" Since the Linux kernel and libraries are constantly changing, this
  13 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  14 .\" responsibility for errors or omissions, or for damages resulting from
  15 .\" the use of the information contained herein.  The author(s) may not
  16 .\" have taken the same level of care in the production of this manual,
  17 .\" which is licensed free of charge, as they might when working
  18 .\" professionally.
  19 .\"
  20 .\" Formatted or processed versions of this manual, if unaccompanied by
  21 .\" the source, must acknowledge the copyright and authors of this work.
  22 .\"
  23 .\" changed `square root' into `cube root' - aeb, 950919
  24 .\"
  25 .\" Modified 2002-07-27 Walter Harms
  26 .\" (walter.harms@informatik.uni-oldenburg.de)
  27 .\"
  28 .TH CBRT 3  2010-09-20 "GNU"  "Linux Programmer's Manual"
  29 .SH NAME
  30 cbrt, cbrtf, cbrtl \- cube root function
  31 .SH SYNOPSIS
  32 .nf
  33 .B #include <math.h>
  34 .sp
  35 .BI "double cbrt(double " x );
  36 .br
  37 .BI "float cbrtf(float " x );
  38 .br
  39 .BI "long double cbrtl(long double " x );
  40 .fi
  41 .sp
  42 Link with \fI\-lm\fP.
  43 .sp
  44 .in -4n
  45 Feature Test Macro Requirements for glibc (see
  46 .BR feature_test_macros (7)):
  47 .in
  48 .sp
  49 .ad l
  50 .BR cbrt ():
  51 .br
  52 .RS 4
  53 _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 500 ||
  54 _XOPEN_SOURCE\ &&\ _XOPEN_SOURCE_EXTENDED || _ISOC99_SOURCE ||
  55 _POSIX_C_SOURCE\ >=\ 200112L;
  56 .br
  57 or
  58 .I cc\ -std=c99
  59 .RE
  60 .BR cbrtf (),
  61 .BR cbrtl ():
  62 .RS 4
  63 _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 600 || _ISOC99_SOURCE ||
  64 _POSIX_C_SOUCE\ >=\ 200112L;
  65 .br
  66 or
  67 .I cc\ -std=c99
  68 .RS
  69 .ad b
  70 .SH DESCRIPTION
  71 The
  72 .BR cbrt ()
  73 function returns the (real) cube root of \fIx\fP.
  74 This function cannot fail; every representable real value has a
  75 representable real cube root.
  76 .SH RETURN VALUE
  77 These functions return the cube root of
  78 .IR x .
  79
  80 If
  81 .I x
  82 is +0, \-0, positive infinity, negative infinity, or NaN,
  83 .I x
  84 is returned.
  85 .SH ERRORS
  86 No errors occur.
  87 .SH "CONFORMING TO"
  88 C99, POSIX.1-2001.
  89 .\" .BR cbrt ()
  90 .\" was a GNU extension. It is now a C99 requirement.
  91 .SH "SEE ALSO"
  92 .BR pow (3),
  93 .BR sqrt (3)