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