std::copysign, std::copysignf, std::copysignl
来自cppreference.com
在标头 <cmath> 定义 | ||
(1) | ||
float copysign (float mag, float sgn ); double copysign (double mag, double sgn ); | (C++23 前) | |
constexpr/* 浮点数类型 */ copysign (/* 浮点数类型 */ mag, | (C++23 起) | |
float copysignf(float mag, float sgn ); | (2) | (C++11 起) (C++23 起为 constexpr ) |
longdouble copysignl(longdouble mag, longdouble sgn ); | (3) | (C++11 起) (C++23 起为 constexpr ) |
SIMD 重载(C++26 起) | ||
在标头 <simd> 定义 | ||
template<class V0, class V1 > constexpr/*math-common-simd-t*/<V0, V1> | (S) | (C++26 起) |
额外重载(C++11 起) | ||
在标头 <cmath> 定义 | ||
template<class Integer > double copysign ( Integer mag, Integer sgn ); | (A) | (C++23 起为 constexpr ) |
1-3) 以 mag 的模和 sgn 的正负号组成浮点数。标准库提供所有以无 cv 限定的浮点数类型作为各形参的类型的
std::copysign
重载。(C++23 起)S) SIMD 重载对 v_mag和 v_sgn 实施逐元素 std::copysign 。
| (C++26 起) |
A) 为所有整数类型提供额外重载,将它们当做 double。 | (C++11 起) |
目录 |
[编辑]参数
mag, sgn | - | 浮点数或整数 |
[编辑]返回值
如果没有错误发生,那么返回以 mag 的模与 sgn 的正负号组成的浮点数。
如果 mag 是 NaN,那么返回带 sgn 正负号的 NaN。
如果 sgn 是 -0,那么只有在实现支持与算术运算一致的有符号零时结果才会为负。
[编辑]错误处理
此函数不受制于任何指定于 math_errhandling 的错误。
如果实现支持 IEEE 浮点数算术(IEC 60559),那么
- 返回值是准确的(决不引发 FE_INEXACT)且独立于当前舍入模式。
[编辑]注解
std::copysign
是操作 NaN 值正负号的唯一可移植方式(使用 std::signbit 也可以检验 NaN 的正负号)。
额外重载不需要以 (A) 的形式提供。它们只需要能够对它们的第一个实参 num1 和第二个实参 num2 满足以下要求:
| (C++23 前) |
如果 num1 和 num2 具有算术类型,那么 std::copysign(num1, num2) 和 std::copysign(static_cast</*公共浮点数类型*/>(num1), 如果不存在等级和子等级最高的浮点数类型,那么在重载决议时不会从提供的重载中产生可用的候选。 | (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
[编辑]参阅
(C++11)(C++11) | 浮点数的绝对值(|x|) (函数) |
(C++11) | 检查给定数是否为负 (函数) |
copysign 的 C 文档 |