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 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)strtod.3    8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD: src/lib/libc/stdlib/strtod.3,v 1.21 2007/01/09 00:28:10 imp Exp $
  34 .\" $DragonFly: src/lib/libc/stdlib/strtod.3,v 1.2 2003/06/17 04:26:46 dillon Exp $
  35 .\"
  36 .Dd March 2, 2003
  37 .Dt STRTOD 3
  38 .Os
  39 .Sh NAME
  40 .Nm strtod ,
  41 .Nm strtof ,
  42 .Nm strtold
  43 .Nd convert
  44 .Tn ASCII
  45 string to floating point
  46 .Sh LIBRARY
  47 .Lb libc
  48 .Sh SYNOPSIS
  49 .In stdlib.h
  50 .Ft double
  51 .Fn strtod "const char * restrict nptr" "char ** restrict endptr"
  52 .Ft float
  53 .Fn strtof "const char * restrict nptr" "char ** restrict endptr"
  54 .Ft "long double"
  55 .Fn strtold "const char * restrict nptr" "char ** restrict endptr"
  56 .Sh DESCRIPTION
  57 These conversion
  58 functions convert the initial portion of the string
  59 pointed to by
  60 .Fa nptr
  61 to
  62 .Vt double ,
  63 .Vt float ,
  64 and
  65 .Vt "long double"
  66 representation, respectively.
  67 .Pp
  68 The expected form of the string is an optional plus (``+'') or minus
  69 sign (``\-'') followed by either:
  70 .Bl -bullet
  71 .It
  72 a decimal significand consisting of a sequence of decimal digits
  73 optionally containing a decimal-point character, or
  74 .It
  75 a hexadecimal significand consisting of a ``0X'' or ``0x'' followed
  76 by a sequence of hexadecimal digits optionally containing a
  77 decimal-point character.
  78 .El
  79 .Pp
  80 In both cases, the significand may be optionally followed by an
  81 exponent.
  82 An exponent consists of an ``E'' or ``e'' (for decimal
  83 constants) or a ``P'' or ``p'' (for hexadecimal constants),
  84 followed by an optional plus or minus sign, followed by a
  85 sequence of decimal digits.
  86 For decimal constants, the exponent indicates the power of 10 by
  87 which the significand should be scaled.
  88 For hexadecimal constants, the scaling is instead done by powers
  89 of 2.
  90 .Pp
  91 Alternatively, if the portion of the string following the optional
  92 plus or minus sign begins with ``INFINITY'' or ``NAN'', ignoring
  93 case, it is interpreted as an infinity or a quiet NaN, respectively.
  94 .Pp
  95 In any of the above cases, leading white-space characters in the
  96 string (as defined by the
  97 .Xr isspace 3
  98 function) are skipped.
  99 The decimal point
 100 character is defined in the program's locale (category
 101 .Dv LC_NUMERIC ) .
 102 .Sh RETURN VALUES
 103 The
 104 .Fn strtod ,
 105 .Fn strtof ,
 106 and
 107 .Fn strtold
 108 functions return the converted value, if any.
 109 .Pp
 110 If
 111 .Fa endptr
 112 is not
 113 .Dv NULL ,
 114 a pointer to the character after the last character used
 115 in the conversion is stored in the location referenced by
 116 .Fa endptr .
 117 .Pp
 118 If no conversion is performed, zero is returned and the value of
 119 .Fa nptr
 120 is stored in the location referenced by
 121 .Fa endptr .
 122 .Pp
 123 If the correct value would cause overflow, plus or minus
 124 .Dv HUGE_VAL ,
 125 .Dv HUGE_VALF ,
 126 or
 127 .Dv HUGE_VALL
 128 is returned (according to the sign and type of the return value), and
 129 .Er ERANGE
 130 is stored in
 131 .Va errno .
 132 If the correct value would cause underflow, zero is
 133 returned and
 134 .Er ERANGE
 135 is stored in
 136 .Va errno .
 137 .Sh ERRORS
 138 .Bl -tag -width Er
 139 .It Bq Er ERANGE
 140 Overflow or underflow occurred.
 141 .El
 142 .Sh SEE ALSO
 143 .Xr atof 3 ,
 144 .Xr atoi 3 ,
 145 .Xr atol 3 ,
 146 .Xr strtol 3 ,
 147 .Xr strtoul 3 ,
 148 .Xr wcstod 3
 149 .Sh STANDARDS
 150 The
 151 .Fn strtod
 152 function
 153 conforms to
 154 .St -isoC-99 ,
 155 with the exception of the bug noted below.
 156 .Sh AUTHORS
 157 The author of this software is
 158 .An David M. Gay .
 159 .Bd -literal
 160 Copyright (c) 1998 by Lucent Technologies
 161 All Rights Reserved
 162
 163 Permission to use, copy, modify, and distribute this software and
 164 its documentation for any purpose and without fee is hereby
 165 granted, provided that the above copyright notice appear in all
 166 copies and that both that the copyright notice and this
 167 permission notice and warranty disclaimer appear in supporting
 168 documentation, and that the name of Lucent or any of its entities
 169 not be used in advertising or publicity pertaining to
 170 distribution of the software without specific, written prior
 171 permission.
 172
 173 LUCENT DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 174 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS.
 175 IN NO EVENT SHALL LUCENT OR ANY OF ITS ENTITIES BE LIABLE FOR ANY
 176 SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 177 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
 178 IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
 179 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
 180 THIS SOFTWARE.
 181 .Ed
 182 .Sh BUGS
 183 These routines do not recognize the C99 ``NaN(...)'' syntax.