remainder(), remainderf(), remainderl()

QNX SDP8.0C Library ReferenceAPIDeveloper

Compute the floating point remainder

Synopsis:

#include <math.h>

double remainder( double x, 
                  double y );

float remainderf( float x, 
                  float y );

long double remainderl( long double x, 
                        long double y );

Arguments:

x
The numerator of the division.
y
The denominator.

Library:

libm
The general-purpose math library.
libm-sve
A library that optimizes the code for ARMv8.2 chips that have Scalable Vector Extension hardware.

Your system requirements will determine how you should work with these libraries:

  • If you want only selected processes to run with the SVE version, you can include both libraries in your OS image and use the -l m or -l m-sve option to qcc to link explicitly against the appropriate one.
  • If you want all processes to use the SVE version, include libm-sve.so in your OS image and set up a symbolic link from libm.so to libm-sve.so. Use the -l m option to qcc to link against the library.
Note:
Compile your program with the -fno-builtin option to prevent the compiler from using a built-in version of the function.

Description:

These functions return the floating point remainder r = x - ny, where y is nonzero. The value n is the integral value nearest the exact value x/y. When |n - x/y| = ½, the value n is chosen to be even.

The behavior of remainder() is independent of the rounding mode.

To check for error situations, use feclearexcept() and fetestexcept(). For example:

  • Call feclearexcept(FE_ALL_EXCEPT) before calling remainder(), remainderf(), or remainderl().
  • On return, if fetestexcept(FE_ALL_EXCEPT) is nonzero, then an error has occurred.

Returns:

The floating point remainder r = x - ny, where y is nonzero.

If: These functions return: Errors:
x is ±Inf NaN FE_INVALID
x or y is NaN NaN
x isn't NaN, and y is zero NaN FE_INVALID

These functions raise FE_INEXACT if the FPU reports that the result can't be exactly represented as a floating-point number.

Classification:

C11, POSIX 1003.1

Safety:
Cancellation pointNo
Signal handlerYes
ThreadYes
Page updated: