Spec-Zone.ru › C++

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

Определено в заголовочном файле <cmath>
Округление до типов с плавающей запятой
(1)
float       round ( float num );
double      round ( double num );
long double round ( long double num );
(с 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
(4)
long lround ( float num );
long lround ( double num );
long lround ( long double num );
(с 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)
long long
(7)
long long llround ( float num );
long long llround ( double num );
long long llround ( long double num );
(с 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, округляя значения пополам от нуля.

Возвращаемое значение
math-round away zero.svg
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 поднимается, и возвращается определенное реализацией значение.

Примечания

FE_INEXACT может быть (но не обязательно) поднят std::round при округлении конечного значения, не являющегося целым.

Наибольшие представимые значения с плавающей запятой — точные целые числа во всех стандартных форматах с плавающей запятой, поэтому 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)
{
    std::fenv_t save_env;
    std::feholdexcept(&save_env);
    double result = std::rint(x);
    if (std::fetestexcept(FE_INEXACT))
    {
        auto const save_round = std::fegetround();
        std::fesetround(FE_TOWARDZERO);
        result = std::rint(std::copysign(0.5 + std::fabs(x), x));
        std::fesetround(save_round);
    }
    std::feupdateenv(&save_env);
    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 <cfenv>
#include <climits>
#include <cmath>
#include <iostream>
 
// #pragma STDC FENV_ACCESS ON
 
int main()
{
    // 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/w/cpp/numeric/math/round

Spec-Zone.ru

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