xref: /illumos-gate/usr/src/man/man3c/ecvt.3c (revision bbf21555)

Sun Microsystems, Inc. gratefully acknowledges The Open Group for
permission to reproduce portions of its copyrighted documentation.
Original documentation from The Open Group can be obtained online at
http://www.opengroup.org/bookstore/.

The Institute of Electrical and Electronics Engineers and The Open
Group, have given us permission to reprint portions of their
documentation.

In the following statement, the phrase ``this text'' refers to portions
of the system documentation.

Portions of this text are reprinted and reproduced in electronic form
in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
Standard for Information Technology -- Portable Operating System
Interface (POSIX), The Open Group Base Specifications Issue 6,
Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
Engineers, Inc and The Open Group. In the event of any discrepancy
between these versions 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.

This notice shall appear on any product containing this material.

The contents of this file are subject to the terms of the
Common Development and Distribution License (the "License").
You may not use this file except in compliance with the License.

You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
or http://www.opensolaris.org/os/licensing.
See the License for the specific language governing permissions
and limitations under the License.

When distributing Covered Code, include this CDDL HEADER in each
file and include the License file at usr/src/OPENSOLARIS.LICENSE.
If applicable, add the following below this CDDL HEADER, with the
fields enclosed by brackets "[]" replaced with your own identifying
information: Portions Copyright [yyyy] [name of copyright owner]


Copyright 1989 AT&T
Portions Copyright (c) 1992, X/Open Company Limited, All Rights Reserved.
Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.

ECVT 3C "May 18, 2004"
NAME
ecvt, fcvt, gcvt - convert floating-point number to string
SYNOPSIS

#include <stdlib.h>

char *ecvt(double value, int ndigit, int *restrict decpt, int *restrict sign);

char *fcvt(double value, int ndigit, int *restrict decpt, int *restrict sign);

char *gcvt(double value, int ndigit, char *buf);
DESCRIPTION

The ecvt(), fcvt() and gcvt() functions convert floating-point numbers to null-terminated strings.

"ecvt()"

The ecvt() function converts value to a null-terminated string of ndigit digits (where ndigit is reduced to an unspecified limit determined by the precision of a double) and returns a pointer to the string. The high-order digit is non-zero, unless the value is 0. The low-order digit is rounded. The position of the radix character relative to the beginning of the string is stored in the integer pointed to by decpt (negative means to the left of the returned digits). The radix character is not included in the returned string. If the sign of the result is negative, the integer pointed to by sign is non-zero, otherwise it is 0.

If the converted value is out of range or is not representable, the contents of the returned string are unspecified.

"fcvt()"

The fcvt() function is identical to ecvt() except that ndigit specifies the number of digits desired after the radix point. The total number of digits in the result string is restricted to an unspecified limit as determined by the precision of a double.

"gcvt()"

The gcvt() function converts value to a null-terminated string (similar to that of the %g format of printf(3C)) in the array pointed to by buf and returns buf. It produces ndigit significant digits (limited to an unspecified value determined by the precision of a double) in %f if possible, or %e (scientific notation) otherwise. A minus sign is included in the returned string if value is less than 0. A radix character is included in the returned string if value is not a whole number. Trailing zeros are suppressed where value is not a whole number. The radix character is determined by the current locale. If setlocale(3C) has not been called successfully, the default locale, POSIX, is used. The default locale specifies a period (.) as the radix character. The LC_NUMERIC category determines the value of the radix character within the current locale.

RETURN VALUES

The ecvt() and fcvt() functions return a pointer to a null-terminated string of digits.

The gcvt() function returns buf.

ERRORS

No errors are defined.

USAGE

The return values from ecvt() and fcvt() might point to thread-specific data that can be overwritten by subsequent calls to these functions by the same thread.

For portability to implementations conforming to earlier versions of Solaris, sprintf(3C) is preferred over this function.

ATTRIBUTES

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Standard
MT-Level Safe
SEE ALSO

printf (3C), setlocale (3C), sprintf (3C), attributes (7), standards (7)