REMAINDER(3)               POSIX Programmer's Manual              REMAINDER(3)



PPRROOLLOOGG
       This manual page is part of the POSIX Programmer's Manual.  The OS
       implementation of this interface may differ (consult the corresponding
       OS manual page for details of OS behavior), or the interface may not be
       implemented on OS.

NNAAMMEE
       remainder, remainderf, remainderl -- remainder function

SSYYNNOOPPSSIISS
       #include <math.h>

       double remainder(double _x, double _y);
       float remainderf(float _x, float _y);
       long double remainderl(long double _x, long double _y);

DDEESSCCRRIIPPTTIIOONN
       The functionality described on this reference page is aligned with the
       ISO C standard. Any conflict between the requirements described here
       and the ISO C standard is unintentional. This volume of POSIX.1-2017
       defers to the ISO C standard.

       These functions shall return the floating-point remainder _r=_x-_n_y when _y
       is non-zero. The value _n is the integral value nearest the exact value
       _x/_y.  When |_n-_x/_y|=1/2, the value _n is chosen to be even.

       The behavior of _r_e_m_a_i_n_d_e_r() shall be independent of the rounding mode.

RREETTUURRNN VVAALLUUEE
       Upon successful completion, these functions shall return the floating-
       point remainder _r=_x-_n_y when _y is non-zero.

       On systems that do not support the IEC 60559 Floating-Point option, if
       _y is zero, it is implementation-defined whether a domain error occurs
       or zero is returned.

       If _x or _y is NaN, a NaN shall be returned.

       If _x is infinite or _y is 0 and the other is non-NaN, a domain error
       shall occur, and a NaN shall be returned.

EERRRROORRSS
       These functions shall fail if:

       Domain Error
                   The _x argument is +-Inf, or the _y argument is +-0 and the
                   other argument is non-NaN.

                   If the integer expression (_m_a_t_h___e_r_r_h_a_n_d_l_i_n_g & MATH_ERRNO)
                   is non-zero, then _e_r_r_n_o shall be set to [[EEDDOOMM]].  If the
                   integer expression (_m_a_t_h___e_r_r_h_a_n_d_l_i_n_g & MATH_ERREXCEPT) is
                   non-zero, then the invalid floating-point exception shall
                   be raised.

       These functions may fail if:

       Domain Error
                   The _y argument is zero.

                   If the integer expression (_m_a_t_h___e_r_r_h_a_n_d_l_i_n_g & MATH_ERRNO)
                   is non-zero, then _e_r_r_n_o shall be set to [[EEDDOOMM]].  If the
                   integer expression (_m_a_t_h___e_r_r_h_a_n_d_l_i_n_g & MATH_ERREXCEPT) is
                   non-zero, then the invalid floating-point exception shall
                   be raised.

       _T_h_e _f_o_l_l_o_w_i_n_g _s_e_c_t_i_o_n_s _a_r_e _i_n_f_o_r_m_a_t_i_v_e_.

EEXXAAMMPPLLEESS
       None.

AAPPPPLLIICCAATTIIOONN UUSSAAGGEE
       On error, the expressions (_m_a_t_h___e_r_r_h_a_n_d_l_i_n_g & MATH_ERRNO) and
       (_m_a_t_h___e_r_r_h_a_n_d_l_i_n_g & MATH_ERREXCEPT) are independent of each other, but
       at least one of them must be non-zero.

RRAATTIIOONNAALLEE
       None.

FFUUTTUURREE DDIIRREECCTTIIOONNSS
       None.

SSEEEE AALLSSOO
       _a_b_s(), _d_i_v(), _f_e_c_l_e_a_r_e_x_c_e_p_t(), _f_e_t_e_s_t_e_x_c_e_p_t(), _l_d_i_v()

       The Base Definitions volume of POSIX.1-2017, _S_e_c_t_i_o_n _4_._2_0, _T_r_e_a_t_m_e_n_t _o_f
       _E_r_r_o_r _C_o_n_d_i_t_i_o_n_s _f_o_r _M_a_t_h_e_m_a_t_i_c_a_l _F_u_n_c_t_i_o_n_s, <<mmaatthh..hh>>

CCOOPPYYRRIIGGHHTT
       Portions of this text are reprinted and reproduced in electronic form
       from IEEE Std 1003.1-2017, Standard for Information Technology --
       Portable Operating System Interface (POSIX), The Open Group Base
       Specifications Issue 7, 2018 Edition, Copyright (C) 2018 by the
       Institute of Electrical and Electronics Engineers, Inc and The Open
       Group.  In the event of any discrepancy between this version and the
       original IEEE and The Open Group Standard, the original IEEE and The
       Open Group Standard is the referee document. The original Standard can
       be obtained online at http://www.opengroup.org/unix/online.html .

       Any typographical or formatting errors that appear in this page are
       most likely to have been introduced during the conversion of the source
       files to man page format. To report such errors, see
       https://www.kernel.org/doc/man-pages/reporting_bugs.html .



IEEE/The Open Group                  2017                         REMAINDER(3)
