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

float       scalbn ( float num, int exp );
double      scalbn ( double num, int exp );
long double scalbn ( long double num, int exp );

constexpr /* floating-point-type */
            scalbn ( /* floating-point-type */ num, int exp );

float       scalbnf( float num, int exp );

long double scalbnl( long double num, int exp );

float       scalbln ( float num, long exp );
double      scalbln ( double num, long exp );
long double scalbln ( long double num, long exp );

constexpr /* floating-point-type */
            scalbln ( /* floating-point-type */ num, long exp );

float       scalblnf( float num, long exp );

long double scalblnl( long double num, long exp );

template< class Integer >
double scalbn( Integer num, int exp );

template< class Integer >
double scalbln( Integer num, long exp );

Параметры

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

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

Если возникает ошибка диапазона из-за переполнения, возвращается ±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-битного longdouble этот множитель равен 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

См. также