[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

20. Arithmetic Functions

This chapter contains information about functions for doing basic arithmetic operations, such as splitting a float into its integer and fractional parts or retrieving the imaginary part of a complex value. These functions are declared in the header files `math.h' and `complex.h'.

20.1 Integers  Basic integer types and concepts
20.2 Integer Division  Integer division with guaranteed rounding.
20.3 Floating Point Numbers  Basic concepts. IEEE 754.
20.4 Floating-Point Number Classification Functions  The five kinds of floating-point number.
20.5 Errors in Floating-Point Calculations  When something goes wrong in a calculation.
20.6 Rounding Modes  Controlling how results are rounded.
20.7 Floating-Point Control Functions  Saving and restoring the FPU's state.
20.8 Arithmetic Functions  Fundamental operations provided by the library.
20.9 Complex Numbers  The types. Writing complex constants.
20.10 Projections, Conjugates, and Decomposing of Complex Numbers  Projection, conjugation, decomposition.
20.11 Parsing of Numbers  Converting strings to numbers.
20.12 Old-fashioned System V number-to-string functions  An archaic way to convert numbers to strings.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

20.1 Integers

The C language defines several integer data types: integer, short integer, long integer, and character, all in both signed and unsigned varieties. The GNU C compiler extends the language to contain long long integers as well.

The C integer types were intended to allow code to be portable among machines with different inherent data sizes (word sizes), so each type may have different ranges on different machines. The problem with this is that a program often needs to be written for a particular range of integers, and sometimes must be written for a particular size of storage, regardless of what machine the program runs on.

To address this problem, the GNU C library contains C type definitions you can use to declare integers that meet your exact needs. Because the GNU C library header files are customized to a specific machine, your program source code doesn't have to be.

These typedefs are in `stdint.h'.

If you require that an integer be represented in exactly N bits, use one of the following types, with the obvious mapping to bit size and signedness:

If your C compiler and target machine do not allow integers of a certain size, the corresponding above type does not exist.

If you don't need a specific storage size, but want the smallest data structure with at least N bits, use one of these:

If you don't need a specific storage size, but want the data structure that allows the fastest access while having at least N bits (and among data structures with the same access speed, the smallest one), use one of these:

If you want an integer with the widest range possible on the platform on which it is being used, use one of the following. If you use these, you should write code that takes into account the variable size and range of the integer.

The GNU C library also provides macros that tell you the maximum and minimum possible values for each integer data type. The macro names follow these examples: INT32_MAX, UINT8_MAX, INT_FAST32_MIN, INT_LEAST64_MIN, UINTMAX_MAX, INTMAX_MAX, INTMAX_MIN. Note that there are no macros for unsigned integer minima. These are always zero.

There are similar macros for use with C's built in integer types which should come with your C compiler. These are described in A.5 Data Type Measurements.

Don't forget you can use the C sizeof function with any of these data types to get the number of bytes of storage each uses.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

20.2 Integer Division

This section describes functions for performing integer division. These functions are redundant when GNU CC is used, because in GNU C the `/' operator always rounds towards zero. But in other C implementations, `/' may round differently with negative arguments. div and ldiv are useful because they specify how to round the quotient: towards zero. The remainder has the same sign as the numerator.

These functions are specified to return a result r such that the value r.quot*denominator + r.rem equals numerator.

To use these facilities, you should include the header file `stdlib.h' in your program.

Data Type: div_t
This is a structure type used to hold the result returned by the div function. It has the following members:

int quot
The quotient from the division.

int rem
The remainder from the division.

Function: div_t div (int numerator, int denominator)
This function div computes the quotient and remainder from the division of numerator by denominator, returning the result in a structure of type div_t.

If the result cannot be represented (as in a division by zero), the behavior is undefined.

Here is an example, albeit not a very useful one.

 
div_t result;
result = div (20, -6);

Now result.quot is -3 and result.rem is 2.

Data Type: ldiv_t
This is a structure type used to hold the result returned by the ldiv function. It has the following members:

long int quot
The quotient from the division.

long int rem
The remainder from the division.

(This is identical to div_t except that the components are of type long int rather than int.)

Function: ldiv_t ldiv (long int numerator, long int denominator)
The ldiv function is similar to div, except that the arguments are of type long int and the result is returned as a structure of type ldiv_t.

Data Type: lldiv_t
This is a structure type used to hold the result returned by the lldiv function. It has the following members:

long long int quot
The quotient from the division.

long long int rem
The remainder from the division.

(This is identical to div_t except that the components are of type long long int rather than int.)

Function: lldiv_t lldiv (long long int numerator, long long int denominator)
The lldiv function is like the div function, but the arguments are of type long long int and the result is returned as a structure of type lldiv_t.

The lldiv function was added in ISO C99.

Data Type: imaxdiv_t
This is a structure type used to hold the result returned by the imaxdiv function. It has the following members:

intmax_t quot
The quotient from the division.

intmax_t rem
The remainder from the division.

(This is identical to div_t except that the components are of type intmax_t rather than int.)

See 20.1 Integers for a description of the intmax_t type.

Function: imaxdiv_t imaxdiv (intmax_t numerator, intmax_t denominator)
The imaxdiv function is like the div function, but the arguments are of type intmax_t and the result is returned as a structure of type imaxdiv_t.

See 20.1 Integers for a description of the intmax_t type.

The imaxdiv function was added in ISO C99.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

20.3 Floating Point Numbers

Most computer hardware has support for two different kinds of numbers: integers ( $<small>...</small>-3, -2, -1, 0, 1, 2, 3<small>...</small>$) and floating-point numbers. Floating-point numbers have three parts: the mantissa, the exponent, and the sign bit. The real number represented by a floating-point value is given by $(s ? -1 : 1) middot; M$ where $s$ is the sign bit, $e$ the exponent, and $M$ the mantissa. See section A.5.3.1 Floating Point Representation Concepts, for details. (It is possible to have a different base for the exponent, but all modern hardware uses $2$.)

Floating-point numbers can represent a finite subset of the real numbers. While this subset is large enough for most purposes, it is important to remember that the only reals that can be represented exactly are rational numbers that have a terminating binary expansion shorter than the width of the mantissa. Even simple fractions such as $1/5$ can only be approximated by floating point.

Mathematical operations and functions frequently need to produce values that are not representable. Often these values can be approximated closely enough for practical purposes, but sometimes they can't. Historically there was no way to tell when the results of a calculation were inaccurate. Modern computers implement the IEEE 754 standard for numerical computations, which defines a framework for indicating to the program when the results of calculation are not trustworthy. This framework consists of a set of exceptions that indicate why a result could not be represented, and the special values infinity and not a number (NaN).


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

20.4 Floating-Point Number Classification Functions

ISO C99 defines macros that let you determine what sort of floating-point number a variable holds.

Macro: int fpclassify (float-type x)
This is a generic macro which works on all floating-point types and which returns a value of type int. The possible values are:

FP_NAN
The floating-point number x is "Not a Number" (see section 20.5.2 Infinity and NaN)
FP_INFINITE
The value of x is either plus or minus infinity (see section 20.5.2 Infinity and NaN)
FP_ZERO
754}, where zero can be signed, this value is also returned if x is negative zero.
FP_SUBNORMAL
Numbers whose absolute value is too small to be represented in the normal format are represented in an alternate, denormalized format (see section A.5.3.1 Floating Point Representation Concepts). This format is less precise but can represent values closer to zero. fpclassify returns this value for values of x in this alternate format.
FP_NORMAL
This value is returned for all other values of x. It indicates that there is nothing special about the number.

fpclassify is most useful if more than one property of a number must be tested. There are more specific macros which only test one property at a time. Generally these macros execute faster than fpclassify, since there is special hardware support for them. You should therefore use the specific macros whenever possible.

Macro: int isfinite (float-type x)
This macro returns a nonzero value if x is finite: not plus or minus infinity, and not NaN. It is equivalent to

 
(fpclassify (x) != FP_NAN && fpclassify (x) != FP_INFINITE)

isfinite is implemented as a macro which accepts any floating-point type.

Macro: int isnormal (float-type x)
This macro returns a nonzero value if x is finite and normalized. It is equivalent to

 
(fpclassify (x) == FP_NORMAL)

Macro: int isnan (float-type x)
This macro returns a nonzero value if x is NaN. It is equivalent to

 
(fpclassify (x) == FP_NAN)

Another set of floating-point classification functions was provided by BSD. The GNU C library also supports these functions; however, we recommend that you use the ISO C99 macros in new code. Those are standard and will be available more widely. Also, since they are macros, you do not have to worry about the type of their argument.

Function: int isinf (double x)
Function: int isinff (float x)
Function: int isinfl (long double x)
This function returns -1 if x represents negative infinity, 1 if x represents positive infinity, and 0 otherwise.

Function: int isnan (double x)
Function: int isnanf (float x)
Function: int isnanl (long double x)
This function returns a nonzero value if x is a "not a number" value, and zero otherwise.

Note: The isnan macro defined by ISO C99 overrides the BSD function. This is normally not a problem, because the two routines behave identically. However, if you really need to get the BSD function for some reason, you can write

 
(isnan) (x)

Function: int finite (double x)
Function: int finitef (float x)
Function: int finitel (long double x)
This function returns a nonzero value if x is finite or a "not a number" value, and zero otherwise.

Function: double infnan (int error)
This function is provided for compatibility with BSD. Its argument is an error code, EDOM or ERANGE; infnan returns the value that a math function would return if it set errno to that value. See section 20.5.4 Error Reporting by Mathematical Functions. -ERANGE is also acceptable as an argument, and corresponds to -HUGE_VAL as a value.

In the BSD library, on certain machines, infnan raises a fatal signal in all cases. The GNU library does not do likewise, because that does not fit the ISO C specification.

Portability Note: The functions listed in this section are BSD extensions.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

20.5 Errors in Floating-Point Calculations

20.5.1 FP Exceptions  IEEE 754 math exceptions and how to detect them.
20.5.2 Infinity and NaN  Special values returned by calculations.
20.5.3 Examining the FPU status word  Checking for exceptions after the fact.
20.5.4 Error Reporting by Mathematical Functions  How the math functions report errors.


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

20.5.1 FP Exceptions

The IEEE 754 standard defines five exceptions that can occur during a calculation. Each corresponds to a particular sort of error, such as overflow.

When exceptions occur (when exceptions are raised, in the language of the standard), one of two things can happen. By default the exception is simply noted in the floating-point status word, and the program continues as if nothing had happened. The operation produces a default value, which depends on the exception (see the table below). Your program can check the status word to find out which exceptions happened.

Alternatively, you can enable traps for exceptions. In that case, when an exception is raised, your program will receive the SIGFPE signal. The default action for this signal is to terminate the program. See section 24. Signal Handling, for how you can change the effect of the signal.

In the System V math library, the user-defined function matherr is called when certain exceptions occur inside math library functions. However, the Unix98 standard deprecates this interface. We support it for historical compatibility, but recommend that you do not use it in new programs.

The exceptions defined in IEEE 754 are:

`Invalid Operation'
This exception is raised if the given operands are invalid for the operation to be performed. Examples are (see IEEE 754, section 7):
  1. Addition or subtraction: $infin;$. (But x} is false if the value of x is NaN. You can use this to test whether a value is NaN or not, but the recommended way to test for NaN is with the isnan function (see section 20.4 Floating-Point Number Classification Functions). In addition, <, >, <=, and >= will raise an exception when applied to NaNs.

    `math.h' defines macros that allow you to explicitly set a variable to infinity or NaN.

    Macro: float INFINITY
    An expression representing positive infinity. It is equal to the value produced by mathematical operations like 1.0 / 0.0. -INFINITY represents negative infinity.

    You can test whether a floating-point value is infinite by comparing it to this macro. However, this is not recommended; you should use the isfinite macro instead. See section 20.4 Floating-Point Number Classification Functions.

    This macro was introduced in the ISO C99 standard.

    Macro: float NAN
    An expression representing a value which is "not a number". This macro is a GNU extension, available only on machines that support the "not a number" value--that is to say, on all machines that support IEEE floating point.

    You can use `#ifdef NAN' to test whether the machine supports NaN. (Of course, you must arrange for GNU extensions to be visible, such as by defining _GNU_SOURCE, and then you must include `math.h'.)

    IEEE 754 also allows for another unusual value: negative zero. This value is produced when you divide a positive number by negative infinity, or when a negative result is smaller than the limits of representation. Negative zero behaves identically to zero in all calculations, unless you explicitly test the sign bit with signbit or copysign.


    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

    20.5.3 Examining the FPU status word

    ISO C99 defines functions to query and manipulate the floating-point status word. You can use these functions to check for untrapped exceptions when it's convenient, rather than worrying about them in the middle of a calculation.

    These constants represent the various IEEE 754 exceptions. Not all FPUs report all the different exceptions. Each constant is defined if and only if the FPU you are compiling for supports that exception, so you can test for FPU support with `#ifdef'. They are defined in `fenv.h'.

    FE_INEXACT
    The inexact exception.
    FE_DIVBYZERO
    The divide by zero exception.
    FE_UNDERFLOW
    The underflow exception.
    FE_OVERFLOW
    The overflow exception.
    FE_INVALID
    The invalid exception.

    The macro FE_ALL_EXCEPT is the bitwise OR of all exception macros which are supported by the FP implementation.

    These functions allow you to clear exception flags, test for exceptions, and save and restore the set of exceptions flagged.

    Function: int feclearexcept (int excepts)
    This function clears all of the supported exception flags indicated by excepts.

    The function returns zero in case the operation was successful, a non-zero value otherwise.

    Function: int feraiseexcept (int excepts)
    This function raises the supported exceptions indicated by excepts. If more than one exception bit in excepts is set the order in which the exceptions are raised is undefined except that overflow (FE_OVERFLOW) or underflow (FE_UNDERFLOW) are raised before inexact (FE_INEXACT). Whether for overflow or underflow the inexact exception is also raised is also implementation dependent.

    The function returns zero in case the operation was successful, a non-zero value otherwise.

    Function: int fetestexcept (int excepts)
    Test whether the exception flags indicated by the parameter except are currently set. If any of them are, a nonzero value is returned which specifies which exceptions are set. Otherwise the result is zero.

    To understand these functions, imagine that the status word is an integer variable named status. feclearexcept is then equivalent to `status &= ~excepts' and fetestexcept is equivalent to `(status & excepts)'. The actual implementation may be very different, of course.

    Exception flags are only cleared when the program explicitly requests it, by calling feclearexcept. If you want to check for exceptions from a set of calculations, you should clear all the flags first. Here is a simple example of the way to use fetestexcept:

     
    {
      double f;
      int raised;
      feclearexcept (FE_ALL_EXCEPT);
      f = compute ();
      raised = fetestexcept (FE_OVERFLOW | FE_INVALID);
      if (raised & FE_OVERFLOW) { /* ... */ }
      if (raised & FE_INVALID) { /* ... */ }
      /* ... */
    }
    

    You cannot explicitly set bits in the status word. You can, however, save the entire status word and restore it later. This is done with the following functions:

    Function: int fegetexceptflag (fexcept_t *flagp, int excepts)
    This function stores in the variable pointed to by flagp an implementation-defined value representing the current setting of the exception flags indicated by excepts.

    The function returns zero in case the operation was successful, a non-zero value otherwise.

    Function: int fesetexceptflag (const fexcept_t *flagp, int
    excepts) This function restores the flags for the exceptions indicated by excepts to the values stored in the variable pointed to by flagp.

    The function returns zero in case the operation was successful, a non-zero value otherwise.

    Note that the value stored in fexcept_t bears no resemblance to the bit mask returned by fetestexcept. The type may not even be an integer. Do not attempt to modify an fexcept_t variable.


    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

    20.5.4 Error Reporting by Mathematical Functions

    Many of the math functions are defined only over a subset of the real or complex numbers. Even if they are mathematically defined, their result may be larger or smaller than the range representable by their return type. These are known as domain errors, overflows, and underflows, respectively. Math functions do several things when one of these errors occurs. In this manual we will refer to the complete response as signalling a domain error, overflow, or underflow.

    When a math function suffers a domain error, it raises the invalid exception and returns NaN. It also sets errno to EDOM; 754} exception handling. Likewise, when overflow occurs, math (x*x + y*y)}}.

    Prototypes for abs, labs and llabs are in `stdlib.h'; imaxabs is declared in `inttypes.h'; fabs, fabsf and fabsl are declared in `math.h'. cabs, cabsf and cabsl are declared in `complex.h'.

    Function: int abs (int number)
    Function: long int labs (long int number)
    Function: long long int llabs (long long int number)
    Function: intmax_t imaxabs (intmax_t number)
    These functions return the absolute value of number.

    Most computers use a two's complement integer representation, in which the absolute value of INT_MIN (the smallest possible int) cannot be represented; thus, abs (INT_MIN) is not defined.

    llabs and imaxdiv are new to ISO C99.

    See 20.1 Integers for a description of the intmax_t type.

    Function: double fabs (double number)
    Function: float fabsf (float number)
    Function: long double fabsl (long double number)
    This function returns the absolute value of the floating-point number number.

    Function: double cabs (complex double z)
    Function: float cabsf (complex float z)
    Function: long double cabsl (complex long double z)
    These functions return the absolute value of the complex number z (see section 20.9 Complex Numbers). The absolute value of a complex number is:

     
    sqrt (creal (z) * creal (z) + cimag (z) * cimag (z))
    

    This function should always be used instead of the direct formula because it takes special care to avoid losing precision. It may also take advantage of hardware support for this operation. See hypot in 19.4 Exponentiation and Logarithms.


    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

    20.8.2 Normalization Functions

    The functions described in this section are primarily provided as a way to efficiently perform certain low-level manipulations on floating point numbers that are represented internally using a binary radix; see A.5.3.1 Floating Point Representation Concepts. These functions are required to have equivalent behavior even if the representation does not use a radix of 2, but of course they are unlikely to be particularly efficient in those cases.

    All these functions are declared in `math.h'.

    Function: double frexp (double value, int *exponent)
    Function: float frexpf (float value, int *exponent)
    Function: long double frexpl (long double value, int *exponent)
    These functions are used to split the number value into a normalized fraction and an exponent.

    If the argument value is not zero, the return value is value times a power of two, and is always in the range 1/2 (inclusive) to 1 (exclusive). The corresponding exponent is stored in *exponent; the return value multiplied by 2 raised to this exponent equals the original number value.

    For example, frexp (12.8, &exponent) returns 0.8 and stores 4 in exponent.

    If value is zero, then the return value is zero and zero is stored in *exponent.

    Function: double ldexp (double value, int exponent)
    Function: float ldexpf (float value, int exponent)
    Function: long double ldexpl (long double value, int exponent)
    These functions return the result of multiplying the floating-point number value by 2 raised to the power exponent. (It can be used to reassemble floating-point numbers that were taken apart by frexp.)

    For example, ldexp (0.8, 4) returns 12.8.

    The following functions, which come from BSD, provide facilities equivalent to those of ldexp and frexp.

    Function: double logb (double x)
    Function: float logbf (float x)
    Function: long double logbl (long double x)
    These functions return the integer part of the base-2 logarithm of x, an integer value represented in type double. This is the highest integer power of 2 contained in x. The sign of x is ignored. For example, logb (3.5) is 1.0 and logb (4.0) is 2.0.

    When 2 raised to this power is divided into x, it gives a quotient between 1 (inclusive) and 2 (exclusive).

    If x is zero, the return value is minus infinity if the machine supports infinities, and a very small number if it does not. If x is infinity, the return value is infinity.

    For finite x, the value returned by logb is one less than the value that frexp would store into *exponent.

    Function: double scalb (double value, int exponent)
    Function: float scalbf (float value, int exponent)
    Function: long double scalbl (long double value, int exponent)
    The scalb function is the BSD name for ldexp.

    Function: long long int scalbn (double x, int n)
    Function: long long int scalbnf (float x, int n)
    Function: long long int scalbnl (long double x, int n)
    scalbn is identical to scalb, except that the exponent n is an int instead of a floating-point number.

    Function: long long int scalbln (double x, long int n)
    Function: long long int scalblnf (float x, long int n)
    Function: long long int scalblnl (long double x, long int n)
    scalbln is identical to scalb, except that the exponent n is a long int instead of a floating-point number.

    Function: long long int significand (double x)
    Function: long long int significandf (float x)
    Function: long long int significandl (long double x)
    significand returns the mantissa of x scaled to the range $[1, 2)$. It is equivalent to scalb (x, (double) -ilogb (x)).

    This function exists mainly for use in certain standardized tests of IEEE 754 conformance.


    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

    20.8.3 Rounding Functions

    The functions listed here perform operations such as rounding and truncation of floating-point values. Some of these functions convert floating point numbers to integer values. They are all declared in `math.h'.

    You can also convert floating-point numbers to integers simply by casting them to int. This discards the fractional part, effectively rounding towards zero. However, this only works if the result can actually be represented as an int---for very large numbers, this is impossible. The functions listed here return the result as a double instead to get around this problem.

    Function: double ceil (double x)
    Function: float ceilf (float x)
    Function: long double ceill (long double x)
    These functions round x upwards to the nearest integer, returning that value as a double. Thus, ceil (1.5) is 2.0.

    Function: double floor (double x)
    Function: float floorf (float x)
    Function: long double floorl (long double x)
    These functions round x downwards to the nearest (1.5)} is 1.0 and floor (-1.5) is -2.0.

    Function: double trunc (double x)
    Function: float truncf (float x)
    Function: long double truncl (long double x)
    The trunc functions round x towards zero to the nearest integer (returned in floating-point format). Thus, trunc (1.5) is 1.0 and trunc (-1.5) is -1.0.

    Function: double rint (double x)
    Function: float rintf (float x)
    Function: long double rintl (long double x)
    These functions round x to an integer value according to the current rounding mode. See section A.5.3.2 Floating Point Parameters, for information about the various rounding modes. The default rounding mode is to round to the nearest integer; some machines support other modes, but round-to-nearest is always used unless you explicitly select another.

    If x was not initially an integer, these functions raise the inexact exception.

    Function: double nearbyint (double x)
    Function: float nearbyintf (float x)
    Function: long double nearbyintl (long double x)
    These functions return the same value as the rint functions, but do not raise the inexact exception if x is not an integer.

    Function: double round (double x)
    Function: float roundf (float x)
    Function: long double roundl (long double x)
    These functions are similar to rint, but they round halfway cases away from zero instead of to the nearest even integer.

    Function: long int lrint (double x)
    Function: long int lrintf (float x)
    Function: long int lrintl (long double x)
    These functions are just like rint, but they return a long int instead of a floating-point number.

    Function: long long int llrint (double x)
    Function: long long int llrintf (float x)
    Function: long long int llrintl (long double x)
    These functions are just like rint, but they return a long long int instead of a floating-point number.

    Function: long int lround (double x)
    Function: long int lroundf (float x)
    Function: long int lroundl (long double x)
    These functions are just like round, but they return a long int instead of a floating-point number.

    Function: long long int llround (double x)
    Function: long long int llroundf (float x)
    Function: long long int llroundl (long double x)
    These functions are just like round, but they return a long long int instead of a floating-point number.

    Function: double modf (double value, double *integer-part)
    Function: float modff (float value, float *integer-part)
    Function: long double modfl (long double value, long double *integer-part)
    These functions break the argument value into an integer part and a fractional part (between -1 and 1, exclusive). Their sum equals value. Each of the parts has the same sign as value, and the integer part is always rounded toward zero.

    modf stores the integer part in *integer-part, and returns the fractional part. For example, modf (2.5, &intpart) returns 0.5 and stores 2.0 into intpart.


    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

    20.8.4 Remainder Functions

    The functions in this section compute the remainder on division of two floating-point numbers. Each is a little different; pick the one that suits your problem.

    Function: double fmod (double numerator, double denominator)
    Function: float fmodf (float numerator, float denominator)
    Function: long double fmodl (long double numerator, long double denominator)
    These functions compute the remainder from the division of numerator by denominator. Specifically, the return value is numerator - n * denominator, where n is the quotient of numerator divided by denominator, rounded towards zero to an integer. Thus, fmod (6.5, 2.3) returns 1.9, which is 6.5 minus 4.6.

    The result has the same sign as the numerator and has magnitude less than the magnitude of the denominator.

    If denominator is zero, fmod signals a domain error.

    Function: double drem (double numerator, double denominator)
    Function: float dremf (float numerator, float denominator)
    Function: long double dreml (long double numerator, long double denominator)
    These functions are like fmod except that they rounds the internal quotient n to the nearest integer instead of towards zero to an integer. For example, drem (6.5, 2.3) returns -0.4, which is 6.5 minus 6.9.

    The absolute value of the result is less than or equal to half the absolute value of the denominator. The difference between (numerator, denominator)} is always either denominator, minus denominator, or zero.

    If denominator is zero, drem signals a domain error.

    Function: double remainder (double numerator, double denominator)
    Function: float remainderf (float numerator, float denominator)
    Function: long double remainderl (long double numerator, long double denominator)
    This function is another name for drem.


    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

    20.8.5 Setting and modifying single bits of FP values

    There are some operations that are too complicated or expensive to perform by hand on floating-point numbers. ISO C99 defines functions to do these operations, which mostly involve changing single bits.

    Function: double copysign (double x, double y)
    Function: float copysignf (float x, float y)
    Function: long double copysignl (long double x, long double y)
    These functions return x but with the sign of y. They work even if x or y are NaN or zero. Both of these can carry a sign (although not all implementations support it) and this is one of the few operations that can tell the difference.

    copysign never raises an exception.

    This function is defined in IEC 559 (and the appendix with recommended functions in IEEE 754/IEEE 854).

    Function: int signbit (float-type x)
    signbit is a generic macro which can work on all floating-point types. It returns a nonzero value if the value of x has its sign bit set.

    This is not the same as x < 0.0, because IEEE 754 floating point allows zero to be signed. The comparison -0.0 < 0.0 is false, but signbit (-0.0) will return a nonzero value.

    Function: double nextafter (double x, double y)
    Function: float nextafterf (float x, float y)
    Function: long double nextafterl (long double x, long double y)
    The nextafter function returns the next representable neighbor of x in the direction towards y. The size of the step between x and the result depends on the type of the result. If $<VAR>x</VAR> = <VAR>y</VAR>$ the function simply returns y. If either value is NaN, NaN is returned. Otherwise a value corresponding to the value of the least significant bit in the mantissa is added or subtracted, depending on the direction. nextafter will signal overflow or underflow if the result goes outside of the range of normalized numbers.

    This function is defined in IEC 559 (and the appendix with recommended functions in IEEE 754/IEEE 854).

    Function: double nexttoward (double x, long double y)
    Function: float nexttowardf (float x, long double y)
    Function: long double nexttowardl (long double x, long double y)
    These functions are identical to the corresponding versions of double}.

    Function: double nan (const char *tagp)
    Function: float nanf (const char *tagp)
    Function: long double nanl (const char *tagp)
    The nan function returns a representation of NaN, provided that NaN is supported by the target platform. nan ("n-char-sequence") is equivalent to strtod ("NAN(n-char-sequence)").

    754} systems, there are many representations of NaN, and tagp selects one. On other systems it may do nothing.


    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

    20.8.6 Floating-Point Comparison Functions

    The standard C comparison operators provoke exceptions when one or other of the operands is NaN. For example,

     
    int v = a < 1.0;
    

    will raise an exception if a is NaN. (This does not happen with == and !=; those merely return false and true, respectively, when NaN is examined.) Frequently this exception is undesirable. ISO C99 therefore defines comparison functions that do not raise exceptions when NaN is examined. All of the functions are implemented as macros which allow their arguments to be of any floating-point type. The macros are guaranteed to evaluate their arguments only once.

    Macro: int isgreater (real-floating x, real-floating y)
    This macro determines whether the argument x is greater than y. It is equivalent to (x) > (y), but no exception is raised if x or y are NaN.

    Macro: int isgreaterequal (real-floating x, real-floating y)
    This macro determines whether the argument x is greater than or equal to y. It is equivalent to (x) >= (y), but no exception is raised if x or y are NaN.

    Macro: int isless (real-floating x, real-floating y)
    This macro determines whether the argument x is less than y. It is equivalent to (x) < (y), but no exception is raised if x or y are NaN.

    Macro: int islessequal (real-floating x, real-floating y)
    This macro determines whether the argument x is less than or equal to y. It is equivalent to (x) <= (y), but no exception is raised if x or y are NaN.

    Macro: int islessgreater (real-floating x, real-floating y)
    This macro determines whether the argument x is less or greater (x) > (y)} (although it only evaluates x and y once), but no exception is raised if x or y are NaN.

    This macro is not equivalent to x != y, because that expression is true if x or y are NaN.

    Macro: int isunordered (real-floating x, real-floating y)
    This macro determines whether its arguments are unordered. In other words, it is true if x or y are NaN, and false otherwise.

    Not all machines provide hardware support for these operations. On machines that don't, the macros can be very slow. Therefore, you should not use these functions when NaN is not a concern.

    Note: There are no macros isequal or isunequal. They are unnecessary, because the == and != operators do not throw an exception if one or both of the operands are NaN.


    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

    20.8.7 Miscellaneous FP arithmetic functions

    The functions in this section perform miscellaneous but common operations that are awkward to express with C operators. On some processors these functions can use special machine instructions to perform these operations faster than the equivalent C code.

    Function: double fmin (double x, double y)
    Function: float fminf (float x, float y)
    Function: long double fminl (long double x, long double y)
    The fmin function returns the lesser of the two values x and y. It is similar to the expression
     
    ((x) < (y) ? (x) : (y))
    
    except that x and y are only evaluated once.

    If an argument is NaN, the other argument is returned. If both arguments are NaN, NaN is returned.

    Function: double fmax (double x, double y)
    Function: float fmaxf (float x, float y)
    Function: long double fmaxl (long double x, long double y)
    The fmax function returns the greater of the two values x and y.

    If an argument is NaN, the other argument is returned. If both arguments are NaN, NaN is returned.

    Function: double fdim (double x, double y)
    Function: float fdimf (float x, float y)
    Function: long double fdiml (long double x, long double y)
    The fdim function returns the positive difference between y} if x is greater than y, and $0$ otherwise.

    If x, y, or both are NaN, NaN is returned.

    Function: double fma (double x, double y, double z)
    Function: float fmaf (float x, float y, float z)
    Function: long double fmal (long double x, long double y, long double z)
    The fma function performs floating-point multiply-add. This is the operation $(<VAR>x</VAR> middot;) + <VAR>z</VAR>$, but the intermediate result is not rounded to the destination type. This can sometimes improve the precision of a calculation.

    This function was introduced because some processors have a special instruction to perform multiply-add. The C compiler cannot use it directly, because the expression `x*y + z' is defined to round the intermediate result. fma lets you choose when you want to round only once.

    On processors which do not implement multiply-add in hardware, fma can be very slow since it must avoid intermediate rounding. `math.h' defines the symbols FP_FAST_FMA, FP_FAST_FMAF, and FP_FAST_FMAL when the corresponding version of fma is no slower than the expression `x*y + z'. In the GNU C library, this always means the operation is implemented in hardware.


    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

    20.9 Complex Numbers

    ISO C99 introduces support for complex numbers in C. This is done with a new type qualifier, complex. It is a keyword if and only if `complex.h' has been included. There are three complex types, corresponding to the three real types: float complex, double complex, and long double complex.

    To construct complex numbers you need a way to indicate the imaginary part of a number. There is no standard notation for an imaginary floating point constant. Instead, `complex.h' defines two macros that can be used to create complex numbers.

    Macro: const float complex _Complex_I
    This macro is a representation of the complex number "$0+1i$". Multiplying a real floating-point value by _Complex_I gives a complex number whose value is purely imaginary. You can use this to construct complex constants:

     
    $3.0 + 4.0i$ = 3.0 + 4.0 * _Complex_I
    

    Note that _Complex_I * _Complex_I has the value -1, but the type of that value is complex.

    _Complex_I is a bit of a mouthful. `complex.h' also defines a shorter name for the same constant.

    Macro: const float complex I
    This macro has exactly the same value as _Complex_I. Most of the time it is preferable. However, it causes problems if you want to use the identifier I for something else. You can safely write

     
    #include <complex.h>
    #undef I
    

    if you need I for your own purposes. (In that case we recommend you also define some other short name for _Complex_I, such as J.)


    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

    20.10 Projections, Conjugates, and Decomposing of Complex Numbers

    ISO C99 also defines functions that perform basic operations on complex numbers, such as decomposition and conjugation. The prototypes for all these functions are in `complex.h'. All functions are available in three variants, one for each of the three complex types.

    Function: double creal (complex double z)
    Function: float crealf (complex float z)
    Function: long double creall (complex long double z)
    These functions return the real part of the complex number z.

    Function: double cimag (complex double z)
    Function: float cimagf (complex float z)
    Function: long double cimagl (complex long double z)
    These functions return the imaginary part of the complex number z.

    Function: complex double conj (complex double z)
    Function: complex float conjf (complex float z)
    Function: complex long double conjl (complex long double z)
    These functions return the conjugate value of the complex number z. The conjugate of a complex number has the same real part and a negated imaginary part. In other words, `conj(a + bi) = a + -bi'.

    Function: double carg (complex double z)
    Function: float cargf (complex float z)
    Function: long double cargl (complex long double z)
    These functions return the argument of the complex number z. The argument of a complex number is the angle in the complex plane between the positive real axis and a line passing through zero and the number. This angle is measured in the usual fashion and ranges from $0$ long int}.

    The atoll function was introduced in ISO C99. It too is obsolete (despite having just been added); use strtoll instead.

    Some locales specify a printed syntax for numbers other than the one that these functions understand. If you need to read numbers formatted in some other locale, you can use the strtoX_l functions. Each of the strtoX functions has a counterpart with `_l' added to its name. The `_l' counterparts take an additional argument: a pointer to an locale_t structure, which describes how the numbers to be read are formatted. See section 7. Locales and Internationalization.

    Portability Note: These functions are all GNU extensions. You can also use scanf or its relatives, which have the `'' flag for parsing numeric input according to the current locale (see section 12.12.4 Numeric Input Conversions). This feature is standard.

    Here is a function which parses a string as a sequence of integers and returns the sum of them:

     
    int
    sum_ints_from_string (char *string)
    {
      int sum = 0;
    
      while (1) {
        char *tail;
        int next;
    
        /* Skip whitespace by hand, to detect the end.  */
        while (isspace (*string)) string++;
        if (*string == 0)
          break;
    
        /* There is more nonwhitespace,  */
        /* so it ought to be another number.  */
        errno = 0;
        /* Parse it.  */
        next = strtol (string, &tail, 0);
        /* Add it in, if not overflow.  */
        if (errno)
          printf ("Overflow\n");
        else
          sum += next;
        /* Advance past it.  */
        string = tail;
      }
    
      return sum;
    }
    


    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

    20.11.2 Parsing of Floats

    These functions are declared in `stdlib.h'.

    Function: double strtod (const char *string, char **tailptr)
    The strtod ("string-to-double") function converts the initial part of string to a floating-point number, which is returned as a value of type double.

    This function attempts to decompose string as follows:

    • A (possibly empty) sequence of whitespace characters. Which characters are whitespace is determined by the isspace function (see section 4.1 Classification of Characters). These are discarded.

    • An optional plus or minus sign (`+' or `-').

    • A floating point number in decimal or hexadecimal format. The decimal format is:
      • A nonempty sequence of digits optionally containing a decimal-point character--normally `.', but it depends on the locale (see section 7.6.1.1 Generic Numeric Formatting Parameters).

      • An optional exponent part, consisting of a character `e' or `E', an optional sign, and a sequence of digits.

      The hexadecimal format is as follows:

      • A 0x or 0X followed by a nonempty sequence of hexadecimal digits optionally containing a decimal-point character--normally `.', but it depends on the locale (see section 7.6.1.1 Generic Numeric Formatting Parameters).

      • An optional binary-exponent part, consisting of a character `p' or `P', an optional sign, and a sequence of digits.

    • Any remaining characters in the string. If tailptr is not a null pointer, a pointer to this tail of the string is stored in *tailptr.

    If the string is empty, contains only whitespace, or does not contain an initial substring that has the expected syntax for a floating-point number, no conversion is performed. In this case, strtod returns a value of zero and the value returned in *tailptr is the value of string.

    In a locale other than the standard "C" or "POSIX" locales, this function may recognize additional locale-dependent syntax.

    If the string has valid syntax for a floating-point number but the value is outside the range of a double, strtod will signal overflow or underflow as described in 20.5.4 Error Reporting by Mathematical Functions.

    strtod recognizes four special input strings. The strings double} is a separate type).

    These functions have been GNU extensions and are new to ISO C99.

    Function: double atof (const char *string)
    This function is similar to the strtod function, except that it need not detect overflow and underflow errors. The atof function is provided mostly for compatibility with existing code; using strtod is more robust.

    The GNU C library also provides `_l' versions of these functions, which take an additional argument, the locale to use in conversion. See section 20.11.1 Parsing of Integers.


    [ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

    20.12 Old-fashioned System V number-to-string functions

    The old System V C library provided three functions to convert numbers to strings, with unusual and hard-to-use semantics. The GNU C library also provides these functions and some natural extensions.

    These functions are only available in glibc and on systems descended from AT&T Unix. Therefore, unless these functions do precisely what you need, it is better to use sprintf, which is standard.

    All these functions are defined in `stdlib.h'.

    Function: char * ecvt (double value, int ndigit, int *decpt, int *neg)
    The function ecvt converts the floating-point number value to a string with at most ndigit decimal digits. The returned string contains no decimal point or sign. The first digit of the string is non-zero (unless value is actually zero) and the last digit is rounded to nearest. *decpt is set to the index in the string of the first digit after the decimal point. *neg is set to a nonzero value if value is negative, zero otherwise.

    If ndigit decimal digits would exceed the precision of a double it is reduced to a system-specific value.

    The returned string is statically allocated and overwritten by each call to ecvt.

    If value is zero, it is implementation defined whether *decpt is 0 or 1.

    For example: ecvt (12.3, 5, &d, &n) returns "12300" and sets d to 2 and n to 0.

    Function: char * fcvt (double value, int ndigit, int *decpt, int *neg)
    The function fcvt is like ecvt, but ndigit specifies the number of digits after the decimal point. If ndigit is less than zero, value is rounded to the $<VAR>ndigit</VAR>+1$'th place to the left of the decimal point. For example, if ndigit is -1, value will be rounded to the nearest 10. If ndigit is negative and larger than the number of digits to the left of the decimal point in value, value will be rounded to one significant digit.

    If ndigit decimal digits would exceed the precision of a double it is reduced to a system-specific value.

    The returned string is statically allocated and overwritten by each call to fcvt.

    Function: char * gcvt (double value, int ndigit, char *buf)
    ndigit, value}. It is provided only for compatibility's sake. It returns buf.

    If ndigit decimal digits would exceed the precision of a double it is reduced to a system-specific value.

    As extensions, the GNU C library provides versions of these three functions that take long double arguments.

    Function: char * qecvt (long double value, int ndigit, int *decpt, int *neg)
    This function is equivalent to ecvt except that it takes a long double for the first parameter and that ndigit is restricted by the precision of a long double.

    Function: char * qfcvt (long double value, int ndigit, int *decpt, int *neg)
    This function is equivalent to fcvt except that it takes a long double for the first parameter and that ndigit is restricted by the precision of a long double.

    Function: char * qgcvt (long double value, int ndigit, char *buf)
    This function is equivalent to gcvt except that it takes a long double for the first parameter and that ndigit is restricted by the precision of a long double.

    The ecvt and fcvt functions, and their long double equivalents, all return a string located in a static buffer which is overwritten by the next call to the function. The GNU C library provides another set of extended functions which write the converted string into a user-supplied buffer. These have the conventional _r suffix.

    gcvt_r is not necessary, because gcvt already uses a user-supplied buffer.

    Function: char * ecvt_r (double value, int ndigit, int *decpt, int *neg, char *buf, size_t len)
    The ecvt_r function is the same as ecvt, except that it places its result into the user-specified buffer pointed to by buf, with length len.

    This function is a GNU extension.

    Function: char * fcvt_r (double value, int ndigit, int *decpt, int *neg, char *buf, size_t len)
    The fcvt_r function is the same as fcvt, except that it places its result into the user-specified buffer pointed to by buf, with length len.

    This function is a GNU extension.

    Function: char * qecvt_r (long double value, int ndigit, int *decpt, int *neg, char *buf, size_t len)
    The qecvt_r function is the same as qecvt, except that it places its result into the user-specified buffer pointed to by buf, with length len.

    This function is a GNU extension.

    Function: char * qfcvt_r (long double value, int ndigit, int *decpt, int *neg, char *buf, size_t len)
    The qfcvt_r function is the same as qfcvt, except that it places its result into the user-specified buffer pointed to by buf, with length len.

    This function is a GNU extension.


    [ << ] [ >> ]           [Top] [Contents] [Index] [ ? ]

    This document was generated by root on January, 13 2001 using texi2html