std::copysign, std::copysignf, std::copysignl

Определено в заголовочном файле `<cmath>`
float copysign ( float mag, float sgn ); double copysign ( double mag, double sgn ); long double copysign ( long double mag, long double sgn );	(1)	(до C++23)
constexpr /floating-point-type/ copysign ( /floating-point-type/ mag, /floating-point-type/ sgn );	(1)		(начиная с C++23)
float copysignf( float mag, float sgn );	(2)	(начиная с C++11) (constexpr начиная с C++23)
long double copysignl( long double mag, long double sgn );	(3)	(начиная с C++11) (constexpr начиная с C++23)
Перегрузка SIMD (начиная с C++26)
Определено в заголовочном файле `<simd>`
template< class V0, class V1 > constexpr /math-common-simd-t/<V0, V1> copysign ( const V0& v_mag, const V1& v_sgn );	(S)	(начиная с C++26)
Дополнительные перегрузки (начиная с C++11)
Определено в заголовочном файле `<cmath>`
template< class Integer > double copysign ( Integer mag, Integer sgn );	(A)	(constexpr начиная с C++23)

1-3) Формирует значение с плавающей точкой с модулем mag и знаком sgn. Библиотека предоставляет перегрузки std::copysign для всех не cv-квалифицированных типов с плавающей точкой в качестве типов параметров.(начиная с C++23)

S) Перегрузка SIMD выполняет поэлементную операцию std::copysign над v_magи v_sgn. (Определение приведено в math-common-simd-t.) (начиная с C++26)

A) Для всех целочисленных типов предоставляются дополнительные перегрузки, которые рассматриваются как double.

(начиная с C++11)

Параметры

mag, sgn

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

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

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

Если mag является NaN, возвращается NaN со знаком sgn.

Если sgn равно -0, результат будет отрицательным только в том случае, если реализация поддерживает знаковый ноль согласованно в арифметических операциях.

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

Эта функция не подвержена ошибкам, указанным в math_errhandling.

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

Возвращаемое значение является точным (исключение FE_INEXACT никогда не возникает) и не зависит от текущего режима округления.

Примечания

std::copysign — единственный переносимый способ изменить знак значения NaN (для проверки знака NaN также можно использовать std::signbit).

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

Если num1 или num2 имеет тип longdouble, то std::copysign(num1, num2) действует так же, как std::copysign(static_cast<long double>(num1),static_cast<long double>(num2)).
В противном случае, если num1 и/или num2 имеет тип double или целочисленный тип, то std::copysign(num1, num2) действует так же, как std::copysign(static_cast<double>(num1),static_cast<double>(num2)).
В противном случае, если num1 или num2 имеет тип float, то std::copysign(num1, num2) действует так же, как std::copysign(static_cast<float>(num1),static_cast<float>(num2)).

(до C++23)

Если num1 и num2 имеют арифметические типы, то std::copysign(num1, num2) действует так же, как std::copysign(static_cast</*common-floating-point-type*/>(num1),static_cast</*common-floating-point-type*/>(num2)), где /*common-floating-point-type*/ — тип с плавающей точкой с наибольшим рангом преобразования с плавающей точкой и наибольшим подрангом преобразования с плавающей точкой среди типов num1 и num2; считается, что аргументы целочисленного типа имеют тот же ранг преобразования с плавающей точкой, что и double.

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

(начиная с C++23)

Пример

#include <cmath>
#include <iostream>

int main()
{
    std::cout << std::showpos
              << "copysign(1.0,+2.0) = " << std::copysign(1.0, +2.0) << '\n'
              << "copysign(1.0,-2.0) = " << std::copysign(1.0, -2.0) << '\n'
              << "copysign(inf,-2.0) = " << std::copysign(INFINITY, -2.0) << '\n'
              << "copysign(NaN,-2.0) = " << std::copysign(NAN, -2.0) << '\n';
}

Вывод:

copysign(1.0,+2.0) = +1
copysign(1.0,-2.0) = -1
copysign(inf,-2.0) = -inf
copysign(NaN,-2.0) = -nan

См. также

abs(float)fabsfabsffabsl (C++11)(C++11)	абсолютное значение числа с плавающей точкой (\(\small{\|x\|}\)\|x\|) (функция)
signbit (C++11)	проверяет, является ли заданное число отрицательным (функция)
Документация C для `copysign`

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