b7375c9021d34d7fe45731775ea547b820f854bb
[dragonfly.git] / lib / libc / stdlib / strtod.3
1 .\" Copyright (c) 1990, 1991, 1993
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" This code is derived from software contributed to Berkeley by
5 .\" the American National Standards Committee X3, on Information
6 .\" Processing Systems.
7 .\"
8 .\" Redistribution and use in source and binary forms, with or without
9 .\" modification, are permitted provided that the following conditions
10 .\" are met:
11 .\" 1. Redistributions of source code must retain the above copyright
12 .\"    notice, this list of conditions and the following disclaimer.
13 .\" 2. Redistributions in binary form must reproduce the above copyright
14 .\"    notice, this list of conditions and the following disclaimer in the
15 .\"    documentation and/or other materials provided with the distribution.
16 .\" 3. All advertising materials mentioning features or use of this software
17 .\"    must display the following acknowledgement:
18 .\"     This product includes software developed by the University of
19 .\"     California, Berkeley and its contributors.
20 .\" 4. Neither the name of the University nor the names of its contributors
21 .\"    may be used to endorse or promote products derived from this software
22 .\"    without specific prior written permission.
23 .\"
24 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 .\" SUCH DAMAGE.
35 .\"
36 .\"     @(#)strtod.3    8.1 (Berkeley) 6/4/93
37 .\" $FreeBSD: src/lib/libc/stdlib/strtod.3,v 1.4.2.7 2001/12/14 18:33:58 ru Exp $
38 .\" $DragonFly: src/lib/libc/stdlib/strtod.3,v 1.2 2003/06/17 04:26:46 dillon Exp $
39 .\"
40 .Dd June 4, 1993
41 .Dt STRTOD 3
42 .Os
43 .Sh NAME
44 .Nm strtod
45 .Nd convert
46 .Tn ASCII
47 string to double
48 .Sh LIBRARY
49 .Lb libc
50 .Sh SYNOPSIS
51 .In stdlib.h
52 .Ft double
53 .Fn strtod "const char *nptr" "char **endptr"
54 .Sh DESCRIPTION
55 The
56 .Fn strtod
57 function converts the initial portion of the string
58 pointed to by
59 .Fa nptr
60 to
61 .Em double
62 representation.
63 .Pp
64 The expected form of the string is an optional plus (``+'') or minus
65 sign (``\-'') followed by a sequence of digits optionally containing
66 a decimal-point character, optionally followed by an exponent.
67 An exponent consists of an ``E'' or ``e'', followed by an optional plus
68 or minus sign, followed by a sequence of digits.
69 .Pp
70 Leading white-space characters in the string (as defined by the
71 .Xr isspace 3
72 function) are skipped.
73 .Sh RETURN VALUES
74 The
75 .Fn strtod
76 function returns the converted value, if any.
77 .Pp
78 If
79 .Fa endptr
80 is not
81 .Dv NULL ,
82 a pointer to the character after the last character used
83 in the conversion is stored in the location referenced by
84 .Fa endptr .
85 .Pp
86 If no conversion is performed, zero is returned and the value of
87 .Fa nptr
88 is stored in the location referenced by
89 .Fa endptr .
90 .Pp
91 If the correct value would cause overflow, plus or minus
92 .Dv HUGE_VAL
93 is returned (according to the sign of the value), and
94 .Er ERANGE
95 is stored in
96 .Va errno .
97 If the correct value would cause underflow, zero is
98 returned and
99 .Er ERANGE
100 is stored in
101 .Va errno .
102 .Sh ERRORS
103 .Bl -tag -width Er
104 .It Bq Er ERANGE
105 Overflow or underflow occurred.
106 .El
107 .Sh SEE ALSO
108 .Xr atof 3 ,
109 .Xr atoi 3 ,
110 .Xr atol 3 ,
111 .Xr strtol 3 ,
112 .Xr strtoul 3
113 .Sh STANDARDS
114 The
115 .Fn strtod
116 function
117 conforms to
118 .St -isoC .
119 .Sh AUTHORS
120 The author of this software is
121 .An David M. Gay .
122 .Pp
123 Copyright (c) 1991 by AT&T.
124 .Pp
125 Permission to use, copy, modify, and distribute this software for any
126 purpose without fee is hereby granted, provided that this entire notice
127 is included in all copies of any software which is or includes a copy
128 or modification of this software and in all copies of the supporting
129 documentation for such software.
130 .Pp
131 THIS SOFTWARE IS BEING PROVIDED "AS IS", WITHOUT ANY EXPRESS OR IMPLIED
132 WARRANTY.  IN PARTICULAR, NEITHER THE AUTHOR NOR AT&T MAKES ANY
133 REPRESENTATION OR WARRANTY OF ANY KIND CONCERNING THE MERCHANTABILITY
134 OF THIS SOFTWARE OR ITS FITNESS FOR ANY PARTICULAR PURPOSE.
135 .Pp
136 Contact your vendor for a free copy of the source code to
137 .Fn strtod
138 and accompanying functions.