|
Packit |
7cfc04 |
'\" et
|
|
Packit |
7cfc04 |
.TH FLOOR "3P" 2013 "IEEE/The Open Group" "POSIX Programmer's Manual"
|
|
Packit |
7cfc04 |
.SH PROLOG
|
|
Packit |
7cfc04 |
This manual page is part of the POSIX Programmer's Manual.
|
|
Packit |
7cfc04 |
The Linux implementation of this interface may differ (consult
|
|
Packit |
7cfc04 |
the corresponding Linux manual page for details of Linux behavior),
|
|
Packit |
7cfc04 |
or the interface may not be implemented on Linux.
|
|
Packit |
7cfc04 |
|
|
Packit |
7cfc04 |
.SH NAME
|
|
Packit |
7cfc04 |
floor,
|
|
Packit |
7cfc04 |
floorf,
|
|
Packit |
7cfc04 |
floorl
|
|
Packit |
7cfc04 |
\(em floor function
|
|
Packit |
7cfc04 |
.SH SYNOPSIS
|
|
Packit |
7cfc04 |
.LP
|
|
Packit |
7cfc04 |
.nf
|
|
Packit |
7cfc04 |
#include <math.h>
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
double floor(double \fIx\fP);
|
|
Packit |
7cfc04 |
float floorf(float \fIx\fP);
|
|
Packit |
7cfc04 |
long double floorl(long double \fIx\fP);
|
|
Packit |
7cfc04 |
.fi
|
|
Packit |
7cfc04 |
.SH DESCRIPTION
|
|
Packit |
7cfc04 |
The functionality described on this reference page is aligned with the
|
|
Packit |
7cfc04 |
ISO\ C standard. Any conflict between the requirements described here and the
|
|
Packit |
7cfc04 |
ISO\ C standard is unintentional. This volume of POSIX.1\(hy2008 defers to the ISO\ C standard.
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
These functions shall compute the largest integral value not greater
|
|
Packit |
7cfc04 |
than
|
|
Packit |
7cfc04 |
.IR x .
|
|
Packit |
7cfc04 |
.SH "RETURN VALUE"
|
|
Packit |
7cfc04 |
The result shall have the same sign as
|
|
Packit |
7cfc04 |
.IR x .
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
Upon successful completion, these functions shall return the largest
|
|
Packit |
7cfc04 |
integral value not greater than
|
|
Packit |
7cfc04 |
.IR x ,
|
|
Packit |
7cfc04 |
expressed as a
|
|
Packit |
7cfc04 |
.BR double ,
|
|
Packit |
7cfc04 |
.BR float ,
|
|
Packit |
7cfc04 |
or
|
|
Packit |
7cfc04 |
.BR "long double" ,
|
|
Packit |
7cfc04 |
as appropriate for the return type of the function.
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
If
|
|
Packit |
7cfc04 |
.IR x
|
|
Packit |
7cfc04 |
is NaN, a NaN shall be returned.
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
If
|
|
Packit |
7cfc04 |
.IR x
|
|
Packit |
7cfc04 |
is \(+-0 or \(+-Inf,
|
|
Packit |
7cfc04 |
.IR x
|
|
Packit |
7cfc04 |
shall be returned.
|
|
Packit |
7cfc04 |
.SH ERRORS
|
|
Packit |
7cfc04 |
No errors are defined.
|
|
Packit |
7cfc04 |
.LP
|
|
Packit |
7cfc04 |
.IR "The following sections are informative."
|
|
Packit |
7cfc04 |
.SH EXAMPLES
|
|
Packit |
7cfc04 |
None.
|
|
Packit |
7cfc04 |
.SH "APPLICATION USAGE"
|
|
Packit |
7cfc04 |
The integral value returned by these functions might not be expressible
|
|
Packit |
7cfc04 |
as an
|
|
Packit |
7cfc04 |
.BR intmax_t .
|
|
Packit |
7cfc04 |
The return value should be tested before assigning it to an integer
|
|
Packit |
7cfc04 |
type to avoid the undefined results of an integer overflow.
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
These functions may raise the inexact floating-point exception if the
|
|
Packit |
7cfc04 |
result differs in value from the argument.
|
|
Packit |
7cfc04 |
.SH RATIONALE
|
|
Packit |
7cfc04 |
None.
|
|
Packit |
7cfc04 |
.SH "FUTURE DIRECTIONS"
|
|
Packit |
7cfc04 |
None.
|
|
Packit |
7cfc04 |
.SH "SEE ALSO"
|
|
Packit |
7cfc04 |
.IR "\fIceil\fR\^(\|)",
|
|
Packit |
7cfc04 |
.IR "\fIfeclearexcept\fR\^(\|)",
|
|
Packit |
7cfc04 |
.IR "\fIfetestexcept\fR\^(\|)",
|
|
Packit |
7cfc04 |
.IR "\fIisnan\fR\^(\|)"
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
.IR "Section 4.19" ", " "Treatment of Error Conditions for Mathematical Functions",
|
|
Packit |
7cfc04 |
.IR "\fB<math.h>\fP"
|
|
Packit |
7cfc04 |
.SH COPYRIGHT
|
|
Packit |
7cfc04 |
Portions of this text are reprinted and reproduced in electronic form
|
|
Packit |
7cfc04 |
from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology
|
|
Packit |
7cfc04 |
-- Portable Operating System Interface (POSIX), The Open Group Base
|
|
Packit |
7cfc04 |
Specifications Issue 7, Copyright (C) 2013 by the Institute of
|
|
Packit |
7cfc04 |
Electrical and Electronics Engineers, Inc and The Open Group.
|
|
Packit |
7cfc04 |
(This is POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the
|
|
Packit |
7cfc04 |
event of any discrepancy between this version and the original IEEE and
|
|
Packit |
7cfc04 |
The Open Group Standard, the original IEEE and The Open Group Standard
|
|
Packit |
7cfc04 |
is the referee document. The original Standard can be obtained online at
|
|
Packit |
7cfc04 |
http://www.unix.org/online.html .
|
|
Packit |
7cfc04 |
|
|
Packit |
7cfc04 |
Any typographical or formatting errors that appear
|
|
Packit |
7cfc04 |
in this page are most likely
|
|
Packit |
7cfc04 |
to have been introduced during the conversion of the source files to
|
|
Packit |
7cfc04 |
man page format. To report such errors, see
|
|
Packit |
7cfc04 |
https://www.kernel.org/doc/man-pages/reporting_bugs.html .
|