summaryrefslogtreecommitdiffstats
path: root/upstream/archlinux/man3p/atof.3p
diff options
context:
space:
mode:
Diffstat (limited to 'upstream/archlinux/man3p/atof.3p')
-rw-r--r--upstream/archlinux/man3p/atof.3p87
1 files changed, 87 insertions, 0 deletions
diff --git a/upstream/archlinux/man3p/atof.3p b/upstream/archlinux/man3p/atof.3p
new file mode 100644
index 00000000..30a045f1
--- /dev/null
+++ b/upstream/archlinux/man3p/atof.3p
@@ -0,0 +1,87 @@
+'\" et
+.TH ATOF "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
+atof
+\(em convert a string to a double-precision number
+.SH SYNOPSIS
+.LP
+.nf
+#include <stdlib.h>
+.P
+double atof(const char *\fIstr\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
+The call
+.IR atof ( str )
+shall be equivalent to:
+.sp
+.RS 4
+.nf
+
+strtod(\fIstr\fP,(char **)NULL),
+.fi
+.P
+.RE
+.P
+except that the handling of errors may differ. If the value cannot be
+represented, the behavior is undefined.
+.SH "RETURN VALUE"
+The
+\fIatof\fR()
+function shall return the converted value if the value can be
+represented.
+.SH ERRORS
+No errors are defined.
+.LP
+.IR "The following sections are informative."
+.SH EXAMPLES
+None.
+.SH "APPLICATION USAGE"
+The
+\fIatof\fR()
+function is subsumed by
+\fIstrtod\fR()
+but is retained because it is used extensively in existing code. If the
+number is not known to be in range,
+\fIstrtod\fR()
+should be used because
+\fIatof\fR()
+is not required to perform any error checking.
+.SH RATIONALE
+None.
+.SH "FUTURE DIRECTIONS"
+None.
+.SH "SEE ALSO"
+.IR "\fIstrtod\fR\^(\|)"
+.P
+The Base Definitions volume of POSIX.1\(hy2017,
+.IR "\fB<stdlib.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 .