Spec-Zone.ru › C++

std::round, std::roundf, std::roundl, std::lround, std::lroundf, std::lroundl, std::llround, std::llroundf

Определено в заголовочном файле <cmath>
Округление до типов с плавающей точкой
float       round ( float num );
double      round ( double num );
long double round ( long double num );
(1) (начиная с C++11)
(до C++23)
constexpr /* floating-point-type */
            round ( /* floating-point-type */ num );
(начиная с C++23)
float       roundf( float num );
(2) (начиная с C++11)
(constexpr начиная с C++23)
long double roundl( long double num );
(3) (начиная с C++11)
(constexpr начиная с C++23)
Округление до long
long lround ( float num );
long lround ( double num );
long lround ( long double num );
(4) (начиная с C++11)
(до C++23)
constexpr long lround( /* floating-point-type */ num );
(начиная с C++23)
long lroundf( float num );
(5) (начиная с C++11)
(constexpr начиная с C++23)
long lroundl( long double num );
(6) (начиная с C++11)
(constexpr начиная с C++23)
Округление до longlong
long long llround ( float num );
long long llround ( double num );
long long llround ( long double num );
(7) (начиная с C++11)
(до C++23)
constexpr long long llround( /* floating-point-type */ num );
(начиная с C++23)
long long llroundf( float num );
(8) (начиная с C++11)
(constexpr начиная с C++23)
long long llroundl( long double num );
(9) (начиная с C++11)
(constexpr начиная с C++23)
Дополнительные перегрузки
Определено в заголовочном файле <cmath>
template< class Integer >
double round( Integer num );
(A) (начиная с C++11)
(constexpr начиная с C++23)
template< class Integer >
long lround( Integer num );
(B) (начиная с C++11)
(constexpr начиная с C++23)
template< class Integer >
long long llround( Integer num );
(C) (начиная с C++11)
(constexpr начиная с C++23)
1-3) Вычисляет ближайшее целое значение num (в формате с плавающей точкой), округляя значения, находящиеся посередине, от нуля независимо от текущего режима округления. Библиотека предоставляет перегрузки std::round для всех типов с плавающей точкой без cv-квалификаторов в качестве типа параметра num.(начиная с C++23)
4-9) Вычисляет ближайшее целое значение num (в целочисленном формате), округляя значения, находящиеся посередине, от нуля независимо от текущего режима округления. Библиотека предоставляет перегрузки std::lround и std::llround для всех типов с плавающей точкой без cv-квалификаторов в качестве типа параметра num.(начиная с C++23)
A-C) Предоставляются дополнительные перегрузки для всех целочисленных типов, которые обрабатываются как double.

Параметры

num - значение с плавающей точкой или целочисленное значение

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

Если ошибок не возникает, возвращается ближайшее целое значение num, округлённое от нуля в случаях, когда значение находится посередине.

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

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

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

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

Если результат std::lround или std::llround выходит за пределы диапазона, представимого возвращаемым типом, может возникнуть ошибка области определения или ошибка диапазона.

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

Для функции std::round:
  • Текущий режим округления не влияет на результат.
  • Если num равно ±∞, оно возвращается без изменений.
  • Если num равно ±0, оно возвращается без изменений.
  • Если num является NaN, возвращается NaN.
Для функций std::lround и std::llround:
  • FE_INEXACT никогда не возникает.
  • Текущий режим округления не влияет на результат.
  • Если num равно ±∞, возникает FE_INVALID и возвращается значение, определяемое реализацией.
  • Если результат округления выходит за пределы диапазона возвращаемого типа, возникает FE_INVALID и возвращается значение, определяемое реализацией.
  • Если num является NaN, возникает FE_INVALID и возвращается значение, определяемое реализацией.

Примечания

При округлении конечного нецелого значения функция std::round может (но не обязана) вызывать FE_INEXACT.

Наибольшие представимые значения с плавающей точкой являются точными целыми числами во всех стандартных форматах с плавающей точкой, поэтому std::round само по себе никогда не вызывает переполнения; однако при сохранении результата в целочисленной переменной может произойти переполнение любого целочисленного типа (включая std::intmax_t).

POSIX указывает, что все случаи, когда std::lround или std::llround вызывают FE_INEXACT, являются ошибками области определения.

Версия std::round для double ведёт себя так, как если бы она была реализована следующим образом:

#include <cfenv>
#include <cmath>

#pragma STDC FENV_ACCESS ON

double round(double x)
{
    const int save_round = std::fegetround();
    std::fesetround(FE_TOWARDZERO);
    const double result = std::rint(std::copysign(0.5 + std::fabs(x), x));
    std::fesetround(save_round);
    return result;
}

Дополнительные перегрузки не обязательно должны быть предоставлены в точности в виде (A-C). Достаточно, чтобы они обеспечивали для своего аргумента num целочисленного типа следующее:

  • std::round(num) имеет тот же эффект, что и std::round(static_cast<double>(num)).
  • std::lround(num) имеет тот же эффект, что и std::lround(static_cast<double>(num)).
  • std::llround(num) имеет тот же эффект, что и std::llround(static_cast<double>(num)).

Пример

#include <cassert>
#include <cfenv>
#include <cfloat>
#include <climits>
#include <cmath>
#include <iostream>

// #pragma STDC FENV_ACCESS ON

double custom_round(double x)
{
    const int save_round = std::fegetround();
    std::fesetround(FE_TOWARDZERO);
    const double result = std::rint(std::copysign(0.5 + std::fabs(x), x));
    std::fesetround(save_round);
    return result;
}

void test_custom_round()
{
    for (const double x :
        {
            0.0, 0.3,
            0.5 - DBL_EPSILON / 2,
            0.5,
            0.5 + DBL_EPSILON / 2,
            0.7, 1.0, 2.3, 2.5, 2.7, 3.0,
            static_cast<double>(INFINITY)
        })
        assert(round(+x) == custom_round(+x) && round(-x) == custom_round(-x));
}

int main()
{
    test_custom_round();

    std::cout << std::showpos;

    // round
    std::cout << "round(+2.3) = " << std::round(2.3)
              << "  round(+2.5) = " << std::round(2.5)
              << "  round(+2.7) = " << std::round(2.7) << '\n'
              << "round(-2.3) = " << std::round(-2.3)
              << "  round(-2.5) = " << std::round(-2.5)
              << "  round(-2.7) = " << std::round(-2.7) << '\n';
    
    std::cout << "round(-0.0) = " << std::round(-0.0)  << '\n'
              << "round(-Inf) = " << std::round(-INFINITY) << '\n';
    
    // lround
    std::cout << "lround(+2.3) = " << std::lround(2.3)
              << "  lround(+2.5) = " << std::lround(2.5)
              << "  lround(+2.7) = " << std::lround(2.7) << '\n'
              << "lround(-2.3) = " << std::lround(-2.3)
              << "  lround(-2.5) = " << std::lround(-2.5)
              << "  lround(-2.7) = " << std::lround(-2.7) << '\n';
    
    std::cout << "lround(-0.0) = " << std::lround(-0.0)  << '\n'
              << "lround(-Inf) = " << std::lround(-INFINITY) << '\n';
    
    // error handling
    std::feclearexcept(FE_ALL_EXCEPT);
    
    std::cout << "std::lround(LONG_MAX+1.5) = "
              << std::lround(LONG_MAX + 1.5) << '\n';
    if (std::fetestexcept(FE_INVALID))
        std::cout << "    FE_INVALID was raised\n";
}

Возможный вывод:

round(+2.3) = +2  round(+2.5) = +3  round(+2.7) = +3
round(-2.3) = -2  round(-2.5) = -3  round(-2.7) = -3
round(-0.0) = -0
round(-Inf) = -inf
lround(+2.3) = +2  lround(+2.5) = +3  lround(+2.7) = +3
lround(-2.3) = -2  lround(-2.5) = -3  lround(-2.7) = -3
lround(-0.0) = +0
lround(-Inf) = -9223372036854775808
std::lround(LONG_MAX+1.5) = -9223372036854775808
    FE_INVALID was raised

См. также

floorfloorffloorl
(C++11)(C++11)
ближайшее целое число, не превосходящее заданное значение
(функция)
ceilceilfceill
(C++11)(C++11)
ближайшее целое число, не меньшее заданного значения
(функция)
trunctruncftruncl
(C++11)(C++11)(C++11)
ближайшее целое число, не превосходящее заданное значение по модулю
(функция)
Документация по C для round

© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/cpp/numeric/math/round

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API