Libm
Libm
libm 2.5.0
December 2016
Steve Chamberlain
Roland Pesch
Red Hat Support
Jeff Johnston
Red Hat Support
sac@cygnus.com
pesch@cygnus.com
jjohnstn@redhat.com
Description
acos computes the inverse cosine (arc cosine) of the input value. Arguments to acos must
be in the range −1 to 1.
acosf is identical to acos, except that it performs its calculations on floats.
Returns
acos and acosf return values in radians, in the range of 0 to π.
If x is not between −1 and 1, the returned value is NaN (not a number), and the global
variable errno is set to EDOM.
4 The Red Hat newlib C Math Library
Description
acosh calculates the inverse hyperbolic cosine of x. acosh is defined as
√
ln x + x2 − 1
Returns
acosh and acoshf return the calculated value. If x less than 1, the return value is NaN
and errno is set to EDOM.
Portability
Neither acosh nor acoshf are ANSI C. They are not recommended for portable programs.
Chapter 1: Mathematical Functions (math.h) 5
Description
asin computes the inverse sine (arc sine) of the argument x. Arguments to asin must be
in the range −1 to 1.
asinf is identical to asin, other than taking and returning floats.
Returns
asin returns values in radians, in the range of −π/2 to π/2.
If x is not in the range −1 to 1, asin and asinf return NaN (not a number), and the global
variable errno is set to EDOM.
6 The Red Hat newlib C Math Library
Description
asinh calculates the inverse hyperbolic sine of x. asinh is defined as
√
sign(x) × ln |x| + 1 + x2
Returns
asinh and asinhf return the calculated value.
Portability
Neither asinh nor asinhf are ANSI C.
Chapter 1: Mathematical Functions (math.h) 7
Description
atan computes the inverse tangent (arc tangent) of the input value.
atanf is identical to atan, save that it operates on floats.
Returns
atan returns a value in radians, in the range of −π/2 to π/2.
Portability
atan is ANSI C. atanf is an extension.
8 The Red Hat newlib C Math Library
Description
atan2 computes the inverse tangent (arc tangent) of y/x. atan2 produces the correct result
even for angles near π/2 or −π/2 (that is, when x is near 0).
atan2f is identical to atan2, save that it takes and returns float.
Returns
atan2 and atan2f return a value in radians, in the range of −π to π.
Portability
atan2 is ANSI C. atan2f is an extension.
Chapter 1: Mathematical Functions (math.h) 9
Description
atanh calculates the inverse hyperbolic tangent of x.
atanhf is identical, other than taking and returning float values.
Returns
atanh and atanhf return the calculated value.
If |x| is greater than 1, the global errno is set to EDOM and the result is a NaN. A DOMAIN
error is reported.
If |x| is 1, the global errno is set to EDOM; and the result is infinity with the same sign as
x. A SING error is reported.
Portability
Neither atanh nor atanhf are ANSI C.
10 The Red Hat newlib C Math Library
Description
The Bessel functions are a family of functions that solve the differential equation
d2 y dy
x2 2
+x + (x2 − p2 )y = 0
dx dx
These functions have many applications in engineering and physics.
jn calculates the Bessel function of the first kind of order n. j0 and j1 are special cases for
order 0 and order 1 respectively.
Similarly, yn calculates the Bessel function of the second kind of order n, and y0 and y1 are
special cases for order 0 and 1.
jnf, j0f, j1f, ynf, y0f, and y1f perform the same calculations, but on float rather than
double values.
Returns
The value of each Bessel function at x is returned.
Portability
None of the Bessel functions are in ANSI C.
Chapter 1: Mathematical Functions (math.h) 11
Description
cbrt computes the cube root of the argument.
Returns
The cube root is returned.
Portability
cbrt is in System V release 4. cbrtf is an extension.
12 The Red Hat newlib C Math Library
Description
copysign constructs a number with the magnitude (absolute value) of its first argument,
x, and the sign of its second argument, y.
copysignf does the same thing; the two functions differ only in the type of their arguments
and result.
Returns
copysign returns a double with the magnitude of x and the sign of y. copysignf returns
a float with the magnitude of x and the sign of y.
Portability
copysign is not required by either ANSI C or the System V Interface Definition (Issue 2).
Chapter 1: Mathematical Functions (math.h) 13
Description
(ex + e−x )
2
Angles are specified in radians. coshf is identical, save that it takes and returns float.
Returns
The computed value is returned. When the correct value would create an overflow, cosh
returns the value HUGE_VAL with the appropriate sign, and the global value errno is set to
ERANGE.
Portability
cosh is ANSI. coshf is an extension.
14 The Red Hat newlib C Math Library
Description
erf calculates an approximation to the “error function”, which estimates the probability
that an observation will fall within x standard deviations of the mean (assuming a normal
distribution). The error function is defined as
x
2
Z
2
√ × e−t dt
π 0
erfc calculates the complementary probability; that is, erfc(x) is 1 - erf(x). erfc is
computed directly, so that you can use it to avoid the loss of precision that would result
from subtracting large probabilities (on large x) from 1.
erff and erfcf differ from erf and erfc only in the argument and result types.
Returns
For positive arguments, erf and all its variants return a probability—a number between 0
and 1.
Portability
None of the variants of erf are ANSI C.
Chapter 1: Mathematical Functions (math.h) 15
Description
exp and expf calculate the exponential of x, that is, ex (where e is the base of the natural
system of logarithms, approximately 2.71828).
Returns
On success, exp and expf return the calculated value. If the result underflows, the returned
value is 0. If the result overflows, the returned value is HUGE_VAL. In either case, errno is
set to ERANGE.
Portability
exp is ANSI C. expf is an extension.
16 The Red Hat newlib C Math Library
Description
exp10 and exp10f calculate 10 ^ x, that is, 10x
Returns
On success, exp10 and exp10f return the calculated value. If the result underflows, the
returned value is 0. If the result overflows, the returned value is HUGE_VAL. In either case,
errno is set to ERANGE.
Portability
exp10 and exp10f are GNU extensions.
Chapter 1: Mathematical Functions (math.h) 17
Description
exp2 and exp2f calculate 2 ^ x, that is, 2x
Returns
On success, exp2 and exp2f return the calculated value. If the result underflows, the
returned value is 0. If the result overflows, the returned value is HUGE_VAL. In either case,
errno is set to ERANGE.
Portability
ANSI C, POSIX.
18 The Red Hat newlib C Math Library
Description
expm1 and expm1f calculate the exponential of x and subtract 1, that is, ex − 1 (where e is
the base of the natural system of logarithms, approximately 2.71828). The result is accurate
even for small values of x, where using exp(x)-1 would lose many significant digits.
Returns
e raised to the power x, minus 1.
Portability
Neither expm1 nor expm1f is required by ANSI C or by the System V Interface Definition
(Issue 2).
Chapter 1: Mathematical Functions (math.h) 19
Description
fabs and fabsf calculate |x|, the absolute value (magnitude) of the argument x, by direct
manipulation of the bit representation of x.
Returns
The calculated value is returned. No errors are detected.
Portability
fabs is ANSI. fabsf is an extension.
20 The Red Hat newlib C Math Library
Description
The fdim functions determine the positive difference between their arguments, returning:
x - y if x > y, or
+0 if x ≤ y, or
NAN if either argument is NAN.
A range error may occur.
Returns
The fdim functions return the positive difference value.
Portability
ANSI C, POSIX.
Chapter 1: Mathematical Functions (math.h) 21
Description
floor and floorf find bxc, the nearest integer less than or equal to x. ceil and ceilf
find dxe, the nearest integer greater than or equal to x.
Returns
floor and ceil return the integer result as a double. floorf and ceilf return the integer
result as a float.
Portability
floor and ceil are ANSI. floorf and ceilf are extensions.
22 The Red Hat newlib C Math Library
Description
The fma functions compute (x * y) + z, rounded as one ternary operation: they compute
the value (as if) to infinite precision and round once to the result format, according to the
rounding mode characterized by the value of FLT ROUNDS. That is, they are supposed to
do this: see below.
Returns
The fma functions return (x * y) + z, rounded as one ternary operation.
Bugs
This implementation does not provide the function that it should, purely returning "(x *
y) + z;" with no attempt at all to provide the simulated infinite precision intermediates
which are required. DO NOT USE THEM.
If double has enough more precision than float, then fmaf should provide the expected
numeric results, as it does use double for the calculation. But since this is not the case for
all platforms, this manual cannot determine if it is so for your case.
Portability
ANSI C, POSIX.
Chapter 1: Mathematical Functions (math.h) 23
Description
The fmax functions determine the maximum numeric value of their arguments. NaN argu-
ments are treated as missing data: if one argument is a NaN and the other numeric, then
the fmax functions choose the numeric value.
Returns
The fmax functions return the maximum numeric value of their arguments.
Portability
ANSI C, POSIX.
24 The Red Hat newlib C Math Library
Description
The fmin functions determine the minimum numeric value of their arguments. NaN argu-
ments are treated as missing data: if one argument is a NaN and the other numeric, then
the fmin functions choose the numeric value.
Returns
The fmin functions return the minimum numeric value of their arguments.
Portability
ANSI C, POSIX.
Chapter 1: Mathematical Functions (math.h) 25
Description
The fmod and fmodf functions compute the floating-point remainder of x/y (x modulo y).
Returns
The fmod function returns the value x − i × y, for the largest integer i such that, if y is
nonzero, the result has the same sign as x and magnitude less than the magnitude of y.
fmod(x,0) returns NaN, and sets errno to EDOM.
Portability
fmod is ANSI C. fmodf is an extension.
26 The Red Hat newlib C Math Library
Description
All nonzero, normal numbers can be described as m * 2**p. frexp represents the double
val as a mantissa m and a power of two p. The resulting mantissa will always be greater
than or equal to 0.5, and less than 1.0 (as long as val is nonzero). The power of two will
be stored in *exp.
m and p are calculated so that val = m × 2p .
frexpf is identical, other than taking and returning floats rather than doubles.
Returns
frexp returns the mantissa m. If val is 0, infinity, or Nan, frexp will set *exp to 0 and
return val.
Portability
frexp is ANSI. frexpf is an extension.
Chapter 1: Mathematical Functions (math.h) 27
Description
gamma calculates ln(Γ (x)), the natural logarithm of the gamma function of x. The gamma
function (exp(gamma(x))) is a generalization of factorial, and retains the property that
Γ (N ) ≡ N × Γ (N − ). Accordingly, the results of the gamma function itself grow very
quickly. gamma is defined as ln(Γ (x)) rather than simply Γ (x) to extend the useful range
of results representable.
The sign of the result is returned in the global variable signgam, which is declared in math.h.
gammaf performs the same calculation as gamma, but uses and returns float values.
lgamma and lgammaf are alternate names for gamma and gammaf. The use of lgamma instead
of gamma is a reminder that these functions compute the log of the gamma function, rather
than the gamma function itself.
The functions gamma_r, gammaf_r, lgamma_r, and lgammaf_r are just like gamma, gammaf,
lgamma, and lgammaf, respectively, but take an additional argument. This additional ar-
gument is a pointer to an integer. This additional argument is used to return the sign of
the result, and the global variable signgam is not used. These functions may be used for
reentrant calls (but they will still set the global variable errno if an error occurs).
tgamma and tgammaf are the "true gamma" functions, returning Γ (x), the gamma function
of x–without a logarithm. (They are apparently so named because of the prior existence of
the old, poorly-named gamma functions which returned the log of gamma up through BSD
4.2.)
Returns
Normally, the computed result is returned.
When x is a nonpositive integer, gamma returns HUGE_VAL and errno is set to EDOM. If the
result overflows, gamma returns HUGE_VAL and errno is set to ERANGE.
Portability
Neither gamma nor gammaf is ANSI C. It is better not to use either of these; use lgamma or
tgamma instead.
28 The Red Hat newlib C Math Library
lgamma, lgammaf, tgamma, and tgammaf are nominally C standard in terms of the base
return values, although the signgam global for lgamma is not standard.
Chapter 1: Mathematical Functions (math.h) 29
Description √
hypot calculates the Euclidean distance x2 + y 2 between the origin (0,0) and a point
represented by the Cartesian coordinates (x,y). hypotf differs only in the type of its
arguments and result.
Returns
Normally, the distance value is returned. On overflow, hypot returns HUGE_VAL and sets
errno to ERANGE.
Portability
hypot and hypotf are not ANSI C.
30 The Red Hat newlib C Math Library
Description
All nonzero, normal numbers can be described as m * 2**p. ilogb and ilogbf examine
the argument val, and return p. The functions frexp and frexpf are similar to ilogb and
ilogbf, but also return m.
Returns
ilogb and ilogbf return the power of two used to form the floating-point argument. If
val is 0, they return FP_ILOGB0. If val is infinite, they return INT_MAX. If val is NaN,
they return FP_ILOGBNAN. (FP_ILOGB0 and FP_ILOGBNAN are defined in math.h, but in turn
are defined as INT MIN or INT MAX from limits.h. The value of FP ILOGB0 may be
either INT MIN or -INT MAX. The value of FP ILOGBNAN may be either INT MAX or
INT MIN.)
Portability
C99, POSIX
Chapter 1: Mathematical Functions (math.h) 31
Description
infinity and infinityf return the special number IEEE infinity in double- and single-
precision arithmetic respectively.
Portability
infinity and infinityf are neither standard C nor POSIX. C and POSIX require macros
HUGE VAL and HUGE VALF to be defined in math.h, which Newlib defines to be in-
finities corresponding to these archaic infinity() and infinityf() functions in floating-point
implementations which do have infinities.
32 The Red Hat newlib C Math Library
Description
isgreater, isgreaterequal, isless, islessequal, islessgreater, and isunordered
are macros defined for use in comparing floating-point numbers without raising any floating-
point exceptions.
The relational operators (i.e. <, >, <=, and >=) support the usual mathematical relation-
ships between numeric values. For any ordered pair of numeric values exactly one of the
relationships–less, greater, and equal–is true. Relational operators may raise the "invalid"
floating-point exception when argument values are NaNs. For a NaN and a numeric value,
or for two NaNs, just the unordered relationship is true (i.e., if one or both of the argu-
ments a NaN, the relationship is called unordered). The specified macros are quiet (non
floating-point exception raising) versions of the relational operators, and other comparison
macros that facilitate writing efficient code that accounts for NaNs without suffering the
"invalid" floating-point exception. In the synopses shown, "real-floating" indicates that the
argument is an expression of real floating type.
Please note that saying that the macros do not raise floating-point exceptions, it is referring
to the function that they are performing. It is certainly possible to give them an expression
which causes an exception. For example:
Returns
No floating-point exceptions are raised for any of the macros.
The isgreater macro returns the value of (x) > (y).
The isgreaterequal macro returns the value of (x) >= (y).
The isless macro returns the value of (x) < (y).
The islessequal macro returns the value of (x) <= (y).
The islessgreater macro returns the value of (x) < (y) || (x) > (y).
The isunordered macro returns 1 if either of its arguments is NaN and 0 otherwise.
Chapter 1: Mathematical Functions (math.h) 33
Portability
C99, POSIX.
34 The Red Hat newlib C Math Library
Description
fpclassify, isfinite, isinf, isnan, and isnormal are macros defined for use in clas-
sifying floating-point numbers. This is a help because of special "values" like NaN and
infinities. In the synopses shown, "real-floating" indicates that the argument is an expres-
sion of real floating type. These function-like macros are C99 and POSIX-compliant, and
should be used instead of the now-archaic SUSv2 functions.
The fpclassify macro classifies its argument value as NaN, infinite, normal, subnormal,
zero, or into another implementation-defined category. First, an argument represented in a
format wider than its semantic type is converted to its semantic type. Then classification is
based on the type of the argument. The fpclassify macro returns the value of the number
classification macro appropriate to the value of its argument:
FP_INFINITE
x is either plus or minus infinity;
FP_NAN x is "Not A Number" (plus or minus);
FP_NORMAL
x is a "normal" number (i.e. is none of the other special forms);
FP_SUBNORMAL
x is too small be stored as a regular normalized number (i.e. loss of precision
is likely); or
FP_ZERO x is 0 (either plus or minus).
The "is" set of macros provide a useful set of shorthand ways for classifying floating-point
numbers, providing the following equivalent relations:
Chapter 1: Mathematical Functions (math.h) 35
isfinite(x)
returns non-zero if x is finite. (It is equivalent to (fpclassify(x) !=
FP INFINITE && fpclassify(x) != FP NAN).)
isinf(x) returns non-zero if x is infinite. (It is equivalent to (fpclassify(x) ==
FP INFINITE).)
isnan(x) returns non-zero if x is NaN. (It is equivalent to (fpclassify(x) ==
FP NAN).)
isnormal(x)
returns non-zero if x is normal. (It is equivalent to (fpclassify(x) ==
FP NORMAL).)
The archaic SUSv2 functions provide information on the floating-point argument supplied.
There are five major number formats ("exponent" referring to the biased exponent in the
binary-encoded number):
zero A number which contains all zero bits, excluding the sign bit.
subnormal
A number with a zero exponent but a nonzero fraction.
normal A number with an exponent and a fraction.
infinity A number with an all 1’s exponent and a zero fraction.
NAN A number with an all 1’s exponent and a nonzero fraction.
isnan returns 1 if the argument is a nan. isinf returns 1 if the argument is infinity. finite
returns 1 if the argument is zero, subnormal or normal. The isnanf, isinff and finitef
functions perform the same operations as their isnan, isinf and finite counterparts, but
on single-precision floating-point numbers.
It should be noted that the C99 standard dictates that isnan and isinf are macros that
operate on multiple types of floating-point. The SUSv2 standard declares isnan as a func-
tion taking double. Newlib has decided to declare them both as functions and as macros in
math.h to maintain backward compatibility.
Returns
The fpclassify macro returns the value corresponding to the appropriate FP macro.
The isfinite macro returns nonzero if x is finite, else 0.
The isinf macro returns nonzero if x is infinite, else 0.
The isnan macro returns nonzero if x is an NaN, else 0.
The isnormal macro returns nonzero if x has a normal value, else 0.
Portability
math.h macros are C99, POSIX.1-2001.
The functions originate from BSD; isnan was listed in the X/Open Portability Guide and
Single Unix Specification, but was dropped when the macro was standardized in POSIX.1-
2001.
36 The Red Hat newlib C Math Library
Description
ldexp calculates the value val × 2exp . ldexpf is identical, save that it takes and returns
float rather than double values.
Returns
ldexp returns the calculated value.
Underflow and overflow both set errno to ERANGE. On underflow, ldexp and ldexpf return
0.0. On overflow, ldexp returns plus or minus HUGE_VAL.
Portability
ldexp is ANSI. ldexpf is an extension.
Chapter 1: Mathematical Functions (math.h) 37
Description
Return the natural logarithm of x, that is, its logarithm base e (where e is the base of the
natural system of logarithms, 2.71828. . . ). log and logf are identical save for the return
and argument types.
Returns
Normally, returns the calculated value. When x is zero, the returned value is -HUGE_VAL
and errno is set to ERANGE. When x is negative, the returned value is NaN (not a number)
and errno is set to EDOM.
Portability
log is ANSI. logf is an extension.
38 The Red Hat newlib C Math Library
Description
log10 returns the base 10 logarithm of x. It is implemented as log(x) / log(10).
log10f is identical, save that it takes and returns float values.
Returns
log10 and log10f return the calculated value.
See the description of log for information on errors.
Portability
log10 is ANSI C. log10f is an extension.
Chapter 1: Mathematical Functions (math.h) 39
Description
log1p calculates ln(1 + x), the natural logarithm of 1+x. You can use log1p rather than
‘log(1+x)’ for greater precision when x is very small.
log1pf calculates the same thing, but accepts and returns float values rather than double.
Returns
log1p returns a double, the natural log of 1+x. log1pf returns a float, the natural log of
1+x.
Portability
Neither log1p nor log1pf is required by ANSI C or by the System V Interface Definition
(Issue 2).
40 The Red Hat newlib C Math Library
Description
The log2 functions compute the base-2 logarithm of x. A domain error occurs if the
argument is less than zero. A range error occurs if the argument is zero.
The Newlib implementations are not full, intrinisic calculations, but rather are derivatives
based on log. (Accuracy might be slightly off from a direct calculation.) In addition to
functions, they are also implemented as macros defined in math.h:
#define log2(x) (log (x) / _M_LN2)
#define log2f(x) (logf (x) / (float) _M_LN2)
To use the functions instead, just undefine the macros first.
Returns
The log2 functions return log2 (x) on success. When x is zero, the returned value is -HUGE_
VAL and errno is set to ERANGE. When x is negative, the returned value is NaN (not a
number) and errno is set to EDOM.
Portability
C99, POSIX, System V Interface Definition (Issue 6).
Chapter 1: Mathematical Functions (math.h) 41
Description
The logb functions extract the exponent of x, as a signed integer value in floating-point
format. If x is subnormal it is treated as though it were normalized; thus, for positive
finite x, 1 ≤ (x · F LT RADIX −logb(x) ) < F LT RADIX. A domain error may occur if
the argument is zero. In this floating-point implementation, FLT RADIX is 2. Which also
means that for finite x, logb(x) = floor(log2(fabs(x))).
All nonzero, normal numbers can be described as m · 2p , where 1.0 ≤ m < 2.0. The logb
functions examine the argument x, and return p. The frexp functions are similar to the
logb functions, but returning m adjusted to the interval [.5, 1) or 0, and p+1.
Returns
When x is:
+inf or -inf, +inf is returned;
NaN, NaN is returned;
0, -inf is returned, and the divide-by-zero exception is raised;
otherwise, the logb functions return the signed exponent of x.
Portability
ANSI C, POSIX
See Also
frexp, ilogb
42 The Red Hat newlib C Math Library
Description
The lrint and llrint functions round their argument to the nearest integer value, using
the current rounding direction. If the rounded value is outside the range of the return type,
the numeric result is unspecified. A range error may occur if the magnitude of x is too
large. The "inexact" floating-point exception is raised in implementations that support it
when the result differs in value from the argument (i.e., when a fraction actually has been
truncated).
Returns
x rounded to an integral value, using the current rounding direction.
See Also
lround
Portability
ANSI C, POSIX
Chapter 1: Mathematical Functions (math.h) 43
Description
The lround and llround functions round their argument to the nearest integer value,
rounding halfway cases away from zero, regardless of the current rounding direction. If
the rounded value is outside the range of the return type, the numeric result is unspecified
(depending upon the floating-point implementation, not the library). A range error may
occur if the magnitude of x is too large.
Returns
x rounded to an integral value as an integer.
See Also
See the round functions for the return being the same floating-point type as the argument.
lrint, llrint.
Portability
ANSI C, POSIX
44 The Red Hat newlib C Math Library
Description
modf splits the double val apart into an integer part and a fractional part, returning the
fractional part and storing the integer part in *ipart. No rounding whatsoever is done;
the sum of the integer and fractional parts is guaranteed to be exactly equal to val. That
is, if realpart = modf(val, &intpart); then ‘realpart+intpart’ is the same as val. modff
is identical, save that it takes and returns float rather than double values.
Returns
The fractional part is returned. Each result has the same sign as the supplied argument
val.
Portability
modf is ANSI C. modff is an extension.
Chapter 1: Mathematical Functions (math.h) 45
Description
nan and nanf return an IEEE NaN (Not a Number) in double- and single-precision arith-
metic respectively. The argument is currently disregarded.
46 The Red Hat newlib C Math Library
Description
The nearbyint functions round their argument to an integer value in floating-point for-
mat, using the current rounding direction and (supposedly) without raising the "inexact"
floating-point exception. See the rint functions for the same function with the "inexact"
floating-point exception being raised when appropriate.
Bugs
Newlib does not support the floating-point exception model, so that the floating-point ex-
ception control is not present and thereby what may be seen will be compiler and hardware
dependent in this regard. The Newlib nearbyint functions are identical to the rint func-
tions with respect to the floating-point exception behavior, and will cause the "inexact"
exception to be raised for most targets.
Returns
x rounded to an integral value, using the current rounding direction.
Portability
ANSI C, POSIX
See Also
rint, round
Chapter 1: Mathematical Functions (math.h) 47
Description
nextafter returns the double-precision floating-point number closest to val in the direction
toward dir. nextafterf performs the same operation in single precision. For example,
nextafter(0.0,1.0) returns the smallest positive number which is representable in double
precision.
Returns
Returns the next closest number to val in the direction toward dir.
Portability
Neither nextafter nor nextafterf is required by ANSI C or by the System V Interface
Definition (Issue 2).
48 The Red Hat newlib C Math Library
Description
pow and powf calculate x raised to the exponent y. (That is, xy .)
Returns
On success, pow and powf return the value calculated.
When the argument values would produce overflow, pow returns HUGE_VAL and set errno
to ERANGE. If the argument x passed to pow or powf is a negative noninteger, and y is also
not an integer, then errno is set to EDOM. If x and y are both 0, then pow and powf return
1.
Portability
pow is ANSI C. powf is an extension.
Chapter 1: Mathematical Functions (math.h) 49
Description
pow10 and pow10f calculate 10 ^ x, that is, 10x
Returns
On success, pow10 and pow10f return the calculated value. If the result underflows, the
returned value is 0. If the result overflows, the returned value is HUGE_VAL. In either case,
errno is set to ERANGE.
Portability
pow10 and pow10f are GNU extensions.
50 The Red Hat newlib C Math Library
Description
remainder and remainderf find the remainder of x/y; this value is in the range -y/2 ..
+y/2.
Returns
remainder returns the integer result as a double.
Portability
remainder is a System V release 4. remainderf is an extension.
Chapter 1: Mathematical Functions (math.h) 51
Description
The remquo functions compute the same remainder as the remainder functions; this value
is in the range -y/2 ... +y/2. In the object pointed to by quo they store a value whose sign
is the sign of x/y and whose magnitude is congruent modulo 2**n to the magnitude of the
integral quotient of x/y. (That is, quo is given the n lsbs of the quotient, not counting the
sign.) This implementation uses n=31 if int is 32 bits or more, otherwise, n is 1 less than
the width of int.
For example:
remquo(-29.0, 3.0, &quo)
returns -1.0 and sets quo=10, and
remquo(-98307.0, 3.0, &quo)
returns -0.0 and sets quo=-32769, although for 16-bit int, quo=-1. In the latter case, the
actual quotient of -(32769=0x8001) is reduced to -1 because of the 15-bit limitation for the
quotient.
Returns
When either argument is NaN, NaN is returned. If y is 0 or x is infinite (and neither is
NaN), a domain error occurs (i.e. the "invalid" floating point exception is raised or errno
is set to EDOM), and NaN is returned. Otherwise, the remquo functions return x REM y.
Bugs
IEEE754-2008 calls for remquo(subnormal, inf) to cause the "underflow" floating-point
exception. This implementation does not.
Portability
C99, POSIX.
52 The Red Hat newlib C Math Library
Description
The rint functions round their argument to an integer value in floating-point format, using
the current rounding direction. They raise the "inexact" floating-point exception if the
result differs in value from the argument. See the nearbyint functions for the same function
with the "inexact" floating-point exception never being raised. Newlib does not directly
support floating-point exceptions. The rint functions are written so that the "inexact"
exception is raised in hardware implementations that support it, even though Newlib does
not provide access.
Returns
x rounded to an integral value, using the current rounding direction.
Portability
ANSI C, POSIX
See Also
nearbyint, round
Chapter 1: Mathematical Functions (math.h) 53
Description
The round functions round their argument to the nearest integer value in floating-point
format, rounding halfway cases away from zero, regardless of the current rounding direction.
(While the "inexact" floating-point exception behavior is unspecified by the C standard,
the round functions are written so that "inexact" is not raised if the result does not equal
the argument, which behavior is as recommended by IEEE 754 for its related functions.)
Returns
x rounded to an integral value.
Portability
ANSI C, POSIX
See Also
nearbyint, rint
54 The Red Hat newlib C Math Library
Description
The scalbn and scalbln functions compute x · F LT RADIX n . efficiently. The result
is computed by manipulating the exponent, rather than by actually performing an expo-
nentiation or multiplication. In this floating-point implementation FLT RADIX=2, which
makes the scalbn functions equivalent to the ldexp functions.
Returns
x times 2 to the power n. A range error may occur.
Portability
ANSI C, POSIX
See Also
ldexp
Chapter 1: Mathematical Functions (math.h) 55
Description
The signbit macro determines whether the sign of its argument value is negative. The
macro reports the sign of all values, including infinities, zeros, and NaNs. If zero is unsigned,
it is treated as positive. As shown in the synopsis, the argument is "real-floating," meaning
that any of the real floating-point types (float, double, etc.) may be given to it.
Note that because of the possibilities of signed 0 and NaNs, the expression "x < 0.0" does
not give the same result as signbit in all cases.
Returns
The signbit macro returns a nonzero value if and only if the sign of its argument value is
negative.
Portability
C99, POSIX.
56 The Red Hat newlib C Math Library
Description
sin and cos compute (respectively) the sine and cosine of the argument x. Angles are
specified in radians.
sinf and cosf are identical, save that they take and return float values.
Returns
The sine or cosine of x is returned.
Portability
sin and cos are ANSI C. sinf and cosf are extensions.
Chapter 1: Mathematical Functions (math.h) 57
Description
sinh computes the hyperbolic sine of the argument x. Angles are specified in radians.
sinh(x) is defined as
ex − e−x
2
sinhf is identical, save that it takes and returns float values.
Returns
The hyperbolic sine of x is returned.
When the correct result is too large to be representable (an overflow), sinh returns HUGE_
VAL with the appropriate sign, and sets the global value errno to ERANGE.
Portability
sinh is ANSI C. sinhf is an extension.
58 The Red Hat newlib C Math Library
Description
sqrt computes the positive square root of the argument.
Returns
On success, the square root is returned. If x is real and positive, then the result is positive.
If x is real and negative, the global value errno is set to EDOM (domain error).
Portability
sqrt is ANSI C. sqrtf is an extension.
Chapter 1: Mathematical Functions (math.h) 59
Description
tan computes the tangent of the argument x. Angles are specified in radians.
tanf is identical, save that it takes and returns float values.
Returns
The tangent of x is returned.
Portability
tan is ANSI. tanf is an extension.
60 The Red Hat newlib C Math Library
Description
tanh computes the hyperbolic tangent of the argument x. Angles are specified in radians.
tanh(x) is defined as
sinh(x)/cosh(x)
tanhf is identical, save that it takes and returns float values.
Returns
The hyperbolic tangent of x is returned.
Portability
tanh is ANSI C. tanhf is an extension.
Chapter 1: Mathematical Functions (math.h) 61
Description
The trunc functions round their argument to the integer value, in floating format, nearest to
but no larger in magnitude than the argument, regardless of the current rounding direction.
(While the "inexact" floating-point exception behavior is unspecified by the C standard,
the trunc functions are written so that "inexact" is not raised if the result does not equal
the argument, which behavior is as recommended by IEEE 754 for its related functions.)
Returns
x truncated to an integral value.
Portability
ANSI C, POSIX
Chapter 2: Mathematical Complex Functions (complex.h) 63
Description
These functions compute compute the complex absolute value (also called norm, modulus,
or magnitude) of z.
cabsf is identical to cabs, except that it performs its calculations on float complex.
cabsl is identical to cabs, except that it performs its calculations on long double complex.
Returns
The cabs* functions return the complex absolute value.
Portability
cabs, cabsf and cabsl are ISO C99
Chapter 2: Mathematical Complex Functions (complex.h) 65
Description
These functions compute the complex arc cosine of z, with branch cuts outside the interval
[-1, +1] along the real axis.
cacosf is identical to cacos, except that it performs its calculations on floats complex.
Returns
These functions return the complex arc cosine value, in the range of a strip mathematically
unbounded along the imaginary axis and in the interval [0, π] along the real axis.
Portability
cacos and cacosf are ISO C99
66 The Red Hat newlib C Math Library
Description
These functions compute the complex arc hyperbolic cosine of z, with a branch cut at values
less than 1 along the real axis.
cacoshf is identical to cacosh, except that it performs its calculations on floats complex.
Returns
These functions return the complex arc hyperbolic cosine value, in the range of a half-strip
of non-negative values along the real axis and in the interval [−iπ, +iπ] along the imaginary
axis.
Portability
cacosh and cacoshf are ISO C99
Chapter 2: Mathematical Complex Functions (complex.h) 67
Description
These functions compute the argument (also called phase angle) of z, with a branch cut
along the negative real axis.
cargf is identical to carg, except that it performs its calculations on floats complex.
Returns
The carg functions return the value of the argument in the interval [−π, +π]
Portability
carg and cargf are ISO C99
68 The Red Hat newlib C Math Library
Description
These functions compute the complex arc sine of z, with branch cuts outside the interval
[-1, +1] along the real axis.
casinf is identical to casin, except that it performs its calculations on floats complex.
Returns
These functions return the complex arc sine value, in the range of a strip mathematically
unbounded along the imaginary axis and in the interval [−π/2, +π/2] along the real axis.
Portability
casin and casinf are ISO C99
Chapter 2: Mathematical Complex Functions (complex.h) 69
Description
These functions compute the complex arc hyperbolic sine of z, with branch cuts outside the
interval [−i, +i] along the imaginary axis.
casinhf is identical to casinh, except that it performs its calculations on floats complex.
Returns
These functions return the complex arc hyperbolic sine value, in the range of a strip math-
ematically unbounded along the real axis and in the interval [−iπ/2, +iπ/2] along the
imaginary axis.
Portability
casinh and casinhf are ISO C99
70 The Red Hat newlib C Math Library
Description
These functions compute the complex arc tangent of z, with branch cuts outside the interval
[−i, +i] along the imaginary axis.
catanf is identical to catan, except that it performs its calculations on floats complex.
Returns
These functions return the complex arc tangent, in the range of a strip mathematically
unbounded along the imaginary axis and in the interval [−π/2, +π/2] along the real axis.
Portability
catan and catanf are ISO C99
Chapter 2: Mathematical Complex Functions (complex.h) 71
Description
These functions compute the complex arc hyperbolic tan of z, with branch cuts outside the
interval [-1, +1] along the real axis.
catanhf is identical to catanh, except that it performs its calculations on floats complex.
Returns
These functions return the complex arc hyperbolic tangent value, in the range of a strip
mathematically unbounded along the real axis and in the interval [−iπ/2, +iπ/2] along the
imaginary axis.
Portability
catanh and catanhf are ISO C99
72 The Red Hat newlib C Math Library
Description
These functions compute the complex cosine of z.
ccosf is identical to ccos, except that it performs its calculations on floats complex.
Returns
These functions return the complex cosine value.
Portability
ccos and ccosf are ISO C99
Chapter 2: Mathematical Complex Functions (complex.h) 73
Description
These functions compute the complex hyperbolic cosine of z.
ccoshf is identical to ccosh, except that it performs its calculations on floats complex.
Returns
These functions return the complex hyperbolic cosine value.
Portability
ccosh and ccoshf are ISO C99
74 The Red Hat newlib C Math Library
Description
These functions compute the complex base-e exponential of z.
cexpf is identical to cexp, except that it performs its calculations on floats complex.
Returns
The cexp functions return the complex base-e exponential value.
Portability
cexp and cexpf are ISO C99
Chapter 2: Mathematical Complex Functions (complex.h) 75
Description
These functions compute the imaginary part of z.
cimagf is identical to cimag, except that it performs its calculations on float complex.
cimagl is identical to cimag, except that it performs its calculations on long double
complex.
Returns
The cimag* functions return the imaginary part value (as a real).
Portability
cimag, cimagf and cimagl are ISO C99
76 The Red Hat newlib C Math Library
Description
These functions compute the complex natural (base-e) logarithm of z, with a branch cut
along the negative real axis.
clogf is identical to clog, except that it performs its calculations on floats complex.
Returns
The clog functions return the complex natural logarithm value, in the range of a strip
mathematically unbounded along the real axis and in the interval [−iπ, +iπ] along the
imaginary axis.
Portability
clog and clogf are ISO C99
Chapter 2: Mathematical Complex Functions (complex.h) 77
Description
These functions compute the complex base-10 logarithm of z. clog10 is equivalent to
clog(z)/log(10).
clog10f is identical to clog10, except that it performs its calculations on floats complex.
Returns
The clog10 functions return the complex base-10 logarithm value.
Portability
clog10 and clog10f are GNU extensions.
78 The Red Hat newlib C Math Library
Description
These functions compute the complex conjugate of z, by reversing the sign of its imaginary
part.
conjf is identical to conj, except that it performs its calculations on floats complex.
Returns
The conj functions return the complex conjugate value.
Portability
conj and conjf are ISO C99
Chapter 2: Mathematical Complex Functions (complex.h) 79
Description
The cpow functions compute the complex power function xy power, with a branch cut for
the first parameter along the negative real axis.
cpowf is identical to cpow, except that it performs its calculations on floats complex.
Returns
The cpow functions return the complex power function value.
Portability
cpow and cpowf are ISO C99
80 The Red Hat newlib C Math Library
Description
These functions compute a projection of z onto the Riemann sphere: z projects to z except
that all complex infinities (even those with one infinite part and one NaN part) project to
positive infinity on the real axis. If z has an infinite part, then cproj(z) is equivalent to
INFINITY + I * copysign(0.0, cimag(z))
cprojf is identical to cproj, except that it performs its calculations on floats complex.
Returns
The cproj functions return the value of the projection onto the Riemann sphere.
Portability
cproj and cprojf are ISO C99
Chapter 2: Mathematical Complex Functions (complex.h) 81
Description
These functions compute the real part of z.
crealf is identical to creal, except that it performs its calculations on float complex.
creall is identical to creal, except that it performs its calculations on long double
complex.
Returns
The creal* functions return the real part value.
Portability
creal, crealf and creall are ISO C99
82 The Red Hat newlib C Math Library
Description
These functions compute the complex sine of z.
csinf is identical to csin, except that it performs its calculations on floats complex.
Returns
These functions return the complex sine value.
Portability
csin and csinf are ISO C99
Chapter 2: Mathematical Complex Functions (complex.h) 83
Description
These functions compute the complex hyperbolic sine of z.
ccoshf is identical to ccosh, except that it performs its calculations on floats complex.
Returns
These functions return the complex hyperbolic sine value.
Portability
csinh and csinhf are ISO C99
84 The Red Hat newlib C Math Library
Description
These functions compute the complex square root of z, with a branch cut along the negative
real axis.
csqrtf is identical to csqrt, except that it performs its calculations on floats complex.
Returns
The csqrt functions return the complex square root value, in the range of the right halfplane
(including the imaginary axis).
Portability
csqrt and csqrtf are ISO C99
Chapter 2: Mathematical Complex Functions (complex.h) 85
Description
These functions compute the complex tangent of z.
ctanf is identical to ctan, except that it performs its calculations on floats complex.
Returns
These functions return the complex tangent value.
Portability
ctan and ctanf are ISO C99
86 The Red Hat newlib C Math Library
Description
These functions compute the complex hyperbolic tangent of z.
ctanhf is identical to ctanh, except that it performs its calculations on floats complex.
Returns
These functions return the complex hyperbolic tangent value.
Portability
ctanh and ctanhf are ISO C99
Chapter 3: Floating-Point Environment (fenv.h) 87
Description
This method attempts to clear the floating-point exceptions specified in except.
Returns
If the except argument is zero or all requested exceptions were successfully cleared, this
method returns zero. Otherwise, a non-zero value is returned.
Portability
ANSI C requires feclearexcept.
Not all Newlib targets have a working implementation. Refer to the file sys/fenv.h to see
the status for your target.
Chapter 3: Floating-Point Environment (fenv.h) 89
Description
This method attempts to return the floating-point environment in the area specified by
envp.
Returns
If floating-point environment was successfully returned, then this method returns zero.
Otherwise, a non-zero value is returned.
Portability
ANSI C requires fegetenv.
Not all Newlib targets have a working implementation. Refer to the file sys/fenv.h to see
the status for your target.
90 The Red Hat newlib C Math Library
Description
This method attempts to store an implementation-defined representation of the states of
the floating-point status flags specified by excepts in the memory pointed to by flagp.
Returns
If the information was successfully returned, this method returns zero. Otherwise, a non-
zero value is returned.
Portability
ANSI C requires fegetexceptflag.
Not all Newlib targets have a working implementation. Refer to the file sys/fenv.h to see
the status for your target.
Chapter 3: Floating-Point Environment (fenv.h) 91
Description
This method returns the current rounding direction.
Returns
This method returns the rounding direction, corresponding to the value of the respective
rouding macro. If the current rounding direction cannot be determined, then a negative
value is returned.
Portability
ANSI C requires fegetround.
Not all Newlib targets have a working implementation. Refer to the file sys/fenv.h to see
the status for your target.
92 The Red Hat newlib C Math Library
Description
This method attempts to save the current floating-point environment in the fenv t instance
pointed to by envp, clear the floating point status flags, and then, if supported by the target
architecture, install a "non-stop" (e.g. continue on floating point exceptions) mode for all
floating-point exceptions.
Returns
This method will return zero if the non-stop floating-point exception handler was installed.
Otherwise, a non-zero value is returned.
Portability
ANSI C requires feholdexcept.
Not all Newlib targets have a working implementation. Refer to the file sys/fenv.h to see
the status for your target.
Chapter 3: Floating-Point Environment (fenv.h) 93
Description
This method attempts to raise the floating-point exceptions specified in excepts.
Returns
If the excepts argument is zero or all requested exceptions were successfully raised, this
method returns zero. Otherwise, a non-zero value is returned.
Portability
ANSI C requires feraiseexcept.
Not all Newlib targets have a working implementation. Refer to the file sys/fenv.h to see
the status for your target.
94 The Red Hat newlib C Math Library
Description
This method attempts to establish the floating-point environment pointed to by envp.
The argument envp must point to a floating-point environment obtained via fegetenv
or feholdexcept or a floating-point environment macro such as FE_DFL_ENV.
It only sets the states of the flags as recorded in its argument, and does not actually raise
the associated floating-point exceptions.
Returns
If floating-point environment was successfully established, then this method returns zero.
Otherwise, a non-zero value is returned.
Portability
ANSI C requires fesetenv.
Not all Newlib targets have a working implementation. Refer to the file sys/fenv.h to see
the status for your target.
Chapter 3: Floating-Point Environment (fenv.h) 95
Description
This method attempts to set the floating-point status flags specified by excepts to the
states indicated by flagp. The argument flagp must point to an fexcept t instance obtained
via calling fegetexceptflag with at least the floating-point exceptions specified by the
argument excepts.
This method does not raise any floating-point exceptions. It only sets the state of the flags.
Returns
If the information was successfully returned, this method returns zero. Otherwise, a non-
zero value is returned.
Portability
ANSI C requires fesetexceptflag.
Not all Newlib targets have a working implementation. Refer to the file sys/fenv.h to see
the status for your target.
96 The Red Hat newlib C Math Library
Description
This method attempts to set the current rounding direction represented by round. round
must be the value of one of the rounding-direction macros.
Returns
If the rounding mode was successfully established, this method returns zero. Otherwise, a
non-zero value is returned.
Portability
ANSI C requires fesetround.
Not all Newlib targets have a working implementation. Refer to the file sys/fenv.h to see
the status for your target.
Chapter 3: Floating-Point Environment (fenv.h) 97
Description
This method test the current floating-point exceptions to determine which of those specified
in except are currently set.
Returns
This method returns the bitwise-inclusive OR of the floating point exception macros which
correspond to the currently set floating point exceptions.
Portability
ANSI C requires fetestexcept.
Not all Newlib targets have a working implementation. Refer to the file sys/fenv.h to see
the status for your target.
98 The Red Hat newlib C Math Library
Description
This method attempts to save the currently raised floating point exceptions in its automatic
storage, install the floating point environment specified by envp, and raise the saved floating
point exceptions.
The argument envp must point to a floating-point environment obtained via fegetenv or
feholdexcept.
Returns
If all actions are completed successfully, then this method returns zero. Otherwise, a non-
zero value is returned.
Portability
ANSI C requires feupdateenv.
Not all Newlib targets have a working implementation. Refer to the file sys/fenv.h to see
the status for your target.
Chapter 4: Reentrancy Properties of libm 99
Document Index
M R
matherr and reentrancy . . . . . . . . . . . . . . . . . . . . . . . 99
reentrancy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
104 The Red Hat newlib C Math Library
Table of Contents