Spec-Zone.ru › C++

std::scalbn, std::scalbnf, std::scalbnl, std::scalbln, std::scalblnf, std::scalblnl

Определено в заголовке <cmath>
int
(1)
float       scalbn ( float num, int exp );
double      scalbn ( double num, int exp );
long double scalbn ( long double num, int exp );
(с C++11)
(до C++23)
constexpr /* floating-point-type */
            scalbn ( /* floating-point-type */ num, int exp );
(с C++23)
float       scalbnf( float num, int exp );
(2) (с C++11)
(constexpr с C++23)
long double scalbnl( long double num, int exp );
(3) (с C++11)
(constexpr с C++23)
long
(4)
float       scalbln ( float num, long exp );
double      scalbln ( double num, long exp );
long double scalbln ( long double num, long exp );
(с C++11)
(до C++23)
constexpr /* floating-point-type */
            scalbln ( /* floating-point-type */ num, long exp );
(с C++23)
float       scalblnf( float num, long exp );
(5) (с C++11)
(constexpr с C++23)
long double scalblnl( long double num, long exp );
(6) (с C++11)
(constexpr с C++23)
Дополнительные перегрузки
Определено в заголовке <cmath>
template< class Integer >
double scalbn( Integer num, int exp );
(A) (с C++11)
(constexpr с C++23)
template< class Integer >
double scalbln( Integer num, long exp );
(B) (с C++11)
(constexpr с C++23)
1-6) Умножает значение с плавающей точкой num на FLT_RADIX в степени exp. Библиотека предоставляет перегрузки std::scalbn и std::scalbln для всех типов с плавающей точкой без квалификаторов cv, как тип параметра num.(с C++23)
A,B) Дополнительные перегрузки предоставляются для всех целочисленных типов, которые рассматриваются как double.

Параметры

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

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

Если ошибок не произошло, возвращается num умноженное на FLT_RADIX в степени exp (num×FLT_RADIXexp).

Если произошла ошибка диапазона из-за переполнения, возвращается ±HUGE_VAL, ±HUGE_VALF, или ±HUGE_VALL.

Если произошла ошибка диапазона из-за недополнения, возвращается корректное значение (после округления).

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

Ошибки сообщаются, как указано в math_errhandling.

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

  • Если не происходит ошибка диапазона, FE_INEXACT никогда не генерируется (результат точный).
  • Если не происходит ошибка диапазона, текущий режим округления игнорируется.
  • Если num равно ±0, возвращается без изменений.
  • Если num равно ±∞, возвращается без изменений.
  • Если exp равно 0, то num возвращается без изменений.
  • Если num равно NaN, возвращается NaN.

Примечания

На двоичных системах (где FLT_RADIX равно 2), std::scalbn эквивалентно std::ldexp.

Хотя std::scalbn и std::scalbln предназначены для эффективной работы, на многих реализациях они менее эффективны, чем умножение или деление на степень двойки с помощью операторов.

Имя функции означает "новая scalb", где scalb была более старой нестандартной функцией, второй аргумент которой имел тип с плавающей точкой.

Функция std::scalbln предоставляется, потому что множитель, необходимый для масштабирования от наименьшего положительного значения с плавающей точкой до самого большого конечного значения, может быть больше 32767, стандартно гарантированного INT_MAX. В частности, для 80-битного long double этот множитель равен 32828.

Реализация GNU не устанавливает errno независимо от math_errhandling.

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

  • std::scalbn(num, exp) имеет тот же эффект, что и std::scalbn(static_cast<double>(num), exp).
  • std::scalbln(num, exp) имеет тот же эффект, что и std::scalbln(static_cast<double>(num), exp).

Пример

#include <cerrno>
#include <cfenv>
#include <cmath>
#include <cstring>
#include <iostream>
// #pragma STDC FENV_ACCESS ON
 
int main()
{
    std::cout << "scalbn(7, -4) = " << std::scalbn(7, -4) << '\n'
              << "scalbn(1, -1074) = " << std::scalbn(1, -1074)
              << " (minimum positive subnormal double)\n"
              << "scalbn(nextafter(1,0), 1024) = "
              << std::scalbn(std::nextafter(1,0), 1024)
              << " (largest finite double)\n";
 
    // special values
    std::cout << "scalbn(-0, 10) = " << std::scalbn(-0.0, 10) << '\n'
              << "scalbn(-Inf, -1) = " << std::scalbn(-INFINITY, -1) << '\n';
 
    // error handling
    errno = 0;
    std::feclearexcept(FE_ALL_EXCEPT);
 
    std::cout << "scalbn(1, 1024) = " << std::scalbn(1, 1024) << '\n';
 
    if (errno == ERANGE)
        std::cout << "    errno == ERANGE: " << std::strerror(errno) << '\n';
    if (std::fetestexcept(FE_OVERFLOW))
        std::cout << "    FE_OVERFLOW raised\n";
}

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

scalbn(7, -4) = 0.4375
scalbn(1, -1074) = 4.94066e-324 (minimum positive subnormal double)
scalbn(nextafter(1,0), 1024) = 1.79769e+308 (largest finite double)
scalbn(-0, 10) = -0
scalbn(-Inf, -1) = -inf
scalbn(1, 1024) = inf
    errno == ERANGE: Numerical result out of range
    FE_OVERFLOW raised

См. также

frexpfrexpffrexpl
(C++11)(C++11)
разлагает число на мантиссу и степень 2
(функция)
ldexpldexpfldexpl
(C++11)(C++11)
умножает число на 2 в степени
(функция)
C документация для scalbn

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

Spec-Zone.ru

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