original/man3/floor.3

   1 .\" Copyright 2001 Andries Brouwer <aeb@cwi.nl>.
   2 .\" and Copyright 2008, Linux Foundation, written by Michael Kerrisk
   3 .\"     <mtk.manpages@gmail.com>
   4 .\"
   5 .\" Permission is granted to make and distribute verbatim copies of this
   6 .\" manual provided the copyright notice and this permission notice are
   7 .\" preserved on all copies.
   8 .\"
   9 .\" Permission is granted to copy and distribute modified versions of this
  10 .\" manual under the conditions for verbatim copying, provided that the
  11 .\" entire resulting derived work is distributed under the terms of a
  12 .\" permission notice identical to this one.
  13 .\"
  14 .\" Since the Linux kernel and libraries are constantly changing, this
  15 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  16 .\" responsibility for errors or omissions, or for damages resulting from
  17 .\" the use of the information contained herein.  The author(s) may not
  18 .\" have taken the same level of care in the production of this manual,
  19 .\" which is licensed free of charge, as they might when working
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\"
  25 .TH FLOOR 3  2010-09-20 "" "Linux Programmer's Manual"
  26 .SH NAME
  27 floor, floorf, floorl \- largest integral value not greater than argument
  28 .SH SYNOPSIS
  29 .nf
  30 .B #include <math.h>
  31 .sp
  32 .BI "double floor(double " x );
  33 .br
  34 .BI "float floorf(float " x );
  35 .br
  36 .BI "long double floorl(long double " x );
  37 .fi
  38 .sp
  39 Link with \fI\-lm\fP.
  40 .sp
  41 .in -4n
  42 Feature Test Macro Requirements for glibc (see
  43 .BR feature_test_macros (7)):
  44 .in
  45 .sp
  46 .ad l
  47 .BR floorf (),
  48 .BR floorl ():
  49 .RS 4
  50 _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 600 || _ISOC99_SOURCE ||
  51 _POSIX_C_SOURCE\ >=\ 200112L;
  52 .br
  53 or
  54 .I cc\ -std=c99
  55 .RE
  56 .ad
  57 .SH DESCRIPTION
  58 These functions return the largest integral value that is not greater than
  59 .IR x .
  60
  61 For example,
  62 .IR floor(0.5)
  63 is 0.0, and
  64 .IR floor(\-0.5)
  65 is \-1.0.
  66 .SH "RETURN VALUE"
  67 These functions return the floor of
  68 .IR x .
  69
  70 If \fIx\fP is integral, +0, \-0, NaN, or an infinity,
  71 \fIx\fP itself is returned.
  72 .SH ERRORS
  73 No errors occur.
  74 POSIX.1-2001 documents a range error for overflows, but see NOTES.
  75 .SH "CONFORMING TO"
  76 C99, POSIX.1-2001.
  77 The variant returning
  78 .I double
  79 also conforms to
  80 SVr4, 4.3BSD, C89.
  81 .SH NOTES
  82 SUSv2 and POSIX.1-2001 contain text about overflow (which might set
  83 .I errno
  84 to
  85 .BR ERANGE ,
  86 or raise an
  87 .B FE_OVERFLOW
  88 exception).
  89 In practice, the result cannot overflow on any current machine,
  90 so this error-handling stuff is just nonsense.
  91 .\" The POSIX.1-2001 APPLICATION USAGE SECTION discusses this point.
  92 (More precisely, overflow can happen only when the maximum value
  93 of the exponent is smaller than the number of mantissa bits.
  94 For the IEEE-754 standard 32-bit and 64-bit floating-point numbers
  95 the maximum value of the exponent is 128 (respectively, 1024),
  96 and the number of mantissa bits is 24 (respectively, 53).)
  97 .SH "SEE ALSO"
  98 .BR ceil (3),
  99 .BR lrint (3),
 100 .BR nearbyint (3),
 101 .BR rint (3),
 102 .BR round (3),
 103 .BR trunc (3)