std::remainder, std::remainderf, std::remainderl

float       remainder ( float x, float y );
double      remainder ( double x, double y );
long double remainder ( long double x, long double y );

constexpr /*floating-point-type*/
            remainder ( /*floating-point-type*/ x,
                        /*floating-point-type*/ y );

float       remainderf( float x, float y );

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

template< class V0, class V1 >
constexpr /*math-common-simd-t*/<V0, V1>
            remainder ( const V0& v_x, const V1& v_y );

template< class Integer >
double      remainder ( Integer x, Integer y );

Остаток по IEEE от операции деления с плавающей точкой x / y, вычисляемый этой функцией, в точности равен значению x - quo * y, где значение quo — это целое число, ближайшее к точному значению x / y. Если |quo - x / y| = ½, выбирается чётное значение quo.

В отличие от std::fmod, для возвращаемого значения не гарантируется знак, совпадающий со знаком x.

Если возвращаемое значение равно нулю, оно будет иметь тот же знак, что и x.

Параметры

Возвращаемое значение

В случае успеха возвращает остаток по IEEE от деления x / y, определённый выше.

При возникновении ошибки области определения возвращается значение, определяемое реализацией (NaN, если поддерживается).

Если возникает ошибка диапазона из-за потери значимости, возвращается правильный результат.

Если y равен нулю, но ошибка области определения не возникает, возвращается ноль.

Обработка ошибок

Об ошибках сообщается согласно math_errhandling.

Ошибка области определения может возникнуть, если y равен нулю.

Если реализация поддерживает арифметику с плавающей точкой IEEE (IEC 60559),

• Текущий режим округления не влияет на результат.
• FE_INEXACT никогда не возбуждается, результат всегда точен.
• Если x равен ±∞, а y не является NaN, возвращается NaN и возбуждается FE_INVALID.
• Если y равен ±0, а x не является NaN, возвращается NaN и возбуждается FE_INVALID.
• Если хотя бы один аргумент является NaN, возвращается NaN.

Примечания

POSIX требует, чтобы ошибка области определения возникала, если x бесконечен или y равен нулю.

std::fmod, но не std::remainder, полезен для незаметного преобразования типов с плавающей точкой в беззнаковые целочисленные типы: (0.0 <= (y = std::fmod(std::rint(x), 65536.0))) ? y : 65536.0 + y находится в диапазоне [-0.0, 65535.0], что соответствует unsignedshort, тогда как std::remainder(std::rint(x), 65536.0) находится в диапазоне [-32767.0, +32768.0], который выходит за пределы диапазона signedshort.

Не требуется, чтобы дополнительные перегрузки предоставлялись в точности в виде (A). Они должны лишь обеспечивать для первого аргумента num1 и второго аргумента num2 следующее:

Пример

#include <cfenv>
#include <cmath>
#include <iostream>
// #pragma STDC FENV_ACCESS ON

int main()
{
    std::cout << "remainder(+5.1, +3.0) = " << std::remainder(5.1, 3) << '\n'
              << "remainder(-5.1, +3.0) = " << std::remainder(-5.1, 3) << '\n'
              << "remainder(+5.1, -3.0) = " << std::remainder(5.1, -3) << '\n'
              << "remainder(-5.1, -3.0) = " << std::remainder(-5.1, -3) << '\n';
    
    // special values
    std::cout << "remainder(-0.0, 1.0) = " << std::remainder(-0.0, 1) << '\n'
              << "remainder(5.1, Inf) = " << std::remainder(5.1, INFINITY) << '\n';
    
    // error handling
    std::feclearexcept(FE_ALL_EXCEPT);
    std::cout << "remainder(+5.1, 0) = " << std::remainder(5.1, 0) << '\n';
    if (fetestexcept(FE_INVALID))
        std::cout << "    FE_INVALID raised\n";
}

remainder(+5.1, +3.0) = -0.9
remainder(-5.1, +3.0) = 0.9
remainder(+5.1, -3.0) = -0.9
remainder(-5.1, -3.0) = 0.9
remainder(-0.0, 1.0) = -0
remainder(5.1, Inf) = 5.1
remainder(+5.1, 0) = -nan
    FE_INVALID raised

См. также