summaryrefslogtreecommitdiffstats
path: root/upstream/archlinux/man3p/modf.3p
diff options
context:
space:
mode:
Diffstat (limited to 'upstream/archlinux/man3p/modf.3p')
-rw-r--r--upstream/archlinux/man3p/modf.3p109
1 files changed, 109 insertions, 0 deletions
diff --git a/upstream/archlinux/man3p/modf.3p b/upstream/archlinux/man3p/modf.3p
new file mode 100644
index 00000000..d1c332c8
--- /dev/null
+++ b/upstream/archlinux/man3p/modf.3p
@@ -0,0 +1,109 @@
+'\" et
+.TH MODF "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
+.\"
+.SH PROLOG
+This manual page is part of the POSIX Programmer's Manual.
+The Linux implementation of this interface may differ (consult
+the corresponding Linux manual page for details of Linux behavior),
+or the interface may not be implemented on Linux.
+.\"
+.SH NAME
+modf,
+modff,
+modfl
+\(em decompose a floating-point number
+.SH SYNOPSIS
+.LP
+.nf
+#include <math.h>
+.P
+double modf(double \fIx\fP, double *\fIiptr\fP);
+float modff(float \fIvalue\fP, float *\fIiptr\fP);
+long double modfl(long double \fIvalue\fP, long double *\fIiptr\fP);
+.fi
+.SH DESCRIPTION
+The functionality described on this reference page is aligned with the
+ISO\ C standard. Any conflict between the requirements described here and the
+ISO\ C standard is unintentional. This volume of POSIX.1\(hy2017 defers to the ISO\ C standard.
+.P
+These functions shall break the argument
+.IR x
+into integral and fractional parts, each of which has the same sign as
+the argument. It stores the integral part as a
+.BR double
+(for the
+\fImodf\fR()
+function), a
+.BR float
+(for the
+\fImodff\fR()
+function), or a
+.BR "long double"
+(for the
+\fImodfl\fR()
+function), in the object pointed to by
+.IR iptr .
+.SH "RETURN VALUE"
+Upon successful completion, these functions shall return the signed
+fractional part of
+.IR x .
+.P
+If
+.IR x
+is NaN, a NaN shall be returned, and *\fIiptr\fP shall be set to a
+NaN.
+.P
+If
+.IR x
+is \(+-Inf, \(+-0 shall be returned, and *\fIiptr\fP shall be set to
+\(+-Inf.
+.SH ERRORS
+No errors are defined.
+.LP
+.IR "The following sections are informative."
+.SH EXAMPLES
+None.
+.SH "APPLICATION USAGE"
+The
+\fImodf\fR()
+function computes the function result and *\fIiptr\fP such that:
+.sp
+.RS 4
+.nf
+
+a = modf(x, iptr) ;
+x == a+*iptr ;
+.fi
+.P
+.RE
+.P
+allowing for the usual floating-point inaccuracies.
+.SH RATIONALE
+None.
+.SH "FUTURE DIRECTIONS"
+None.
+.SH "SEE ALSO"
+.IR "\fIfrexp\fR\^(\|)",
+.IR "\fIisnan\fR\^(\|)",
+.IR "\fIldexp\fR\^(\|)"
+.P
+The Base Definitions volume of POSIX.1\(hy2017,
+.IR "\fB<math.h>\fP"
+.\"
+.SH COPYRIGHT
+Portions of this text are reprinted and reproduced in electronic form
+from IEEE Std 1003.1-2017, Standard for Information Technology
+-- Portable Operating System Interface (POSIX), The Open Group Base
+Specifications Issue 7, 2018 Edition,
+Copyright (C) 2018 by the Institute of
+Electrical and Electronics Engineers, Inc and The Open Group.
+In the event of any discrepancy between this version and the original IEEE and
+The Open Group Standard, the original IEEE and The Open Group Standard
+is the referee document. The original Standard can be obtained online at
+http://www.opengroup.org/unix/online.html .
+.PP
+Any typographical or formatting errors that appear
+in this page are most likely
+to have been introduced during the conversion of the source files to
+man page format. To report such errors, see
+https://www.kernel.org/doc/man-pages/reporting_bugs.html .