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

来自cppreference.com
< cpp‎ | numeric‎ | math
 
 
 
常用数学函数
函数
基础运算
(C++11)  
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)(C++11)(C++11)
指数函数
(C++11)
(C++11)

(C++11)
(C++11)
幂函数
(C++11)
(C++11)
三角双曲函数
(C++11)
(C++11)
(C++11)

误差与伽马函数
(C++11)
(C++11)
(C++11)
(C++11)
最接近整数的浮点运算
(C++11)(C++11)(C++11)
(C++11)
(C++11)
(C++11)(C++11)(C++11)
浮点操作函数
(C++11)(C++11)
(C++11)
(C++11)
(C++11)(C++11)
copysign
(C++11)
分类与比较
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
类型
宏常量
分类
(C++11)(C++11)(C++11)(C++11)(C++11)


 
在标头 <cmath> 定义
(1)
float       copysign ( float mag, float sgn );

double      copysign ( double mag, double sgn );

long double copysign ( long double mag, long double sgn );
(C++23 前)
constexpr /* floating-point-type */

            copysign ( /* floating-point-type */ mag,

                       /* floating-point-type */ sgn );
(C++23 起)
float       copysignf( float mag, float sgn );
(2) (C++11 起)
(C++23 起 constexpr)
long double copysignl( long double mag, long double sgn );
(3) (C++11 起)
(C++23 起 constexpr)
额外重载 (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 起)
A) 为所有整数类型提供额外重载,将它们当做 double
(C++11 起)

参数

mag, sgn - 浮点或整数值

返回值

如果没有错误发生,那么返回以 mag 的模与 sgn 的正负号组成的浮点值。

如果 mag 是 NaN,那么返回带 sgn 正负号的 NaN。

如果 sgn 是 -0,那么只有在实现支持与算术运算一致的有符号零时结果才会为负。

错误处理

此函数不受制于任何指定于 math_errhandling 的错误。

如果实现支持 IEEE 浮点算术(IEC 60559),那么

注解

std::copysign 是操作 NaN 值正负号的唯一可移植方式(使用 std::signbit 也可以检验 NaN 的正负号)。

额外重载不需要以 (A) 的形式提供。它们只需要能够对它们的第一个实参 num1 和第二个实参 num2 满足以下要求:

  • 如果 num1num2 具有 long double 类型,那么 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))
    的效果相同。
  • 否则,如果 num1num2 具有 float 类型,那么 std::copysign(num1, num2)std::copysign(static_cast<float>(num1),
                  static_cast<float>(num2))
    的效果相同。
(C++23 前)

如果 num1num2 具有算术类型,那么 std::copysign(num1, num2)std::copysign(static_cast</* 公共浮点类型 */>(num1),
              static_cast</* 公共浮点类型 */>(num2))
的效果相同,其中 /* 公共浮点类型 */num1num2 的类型中浮点转换等级浮点转换子等级最高的浮点类型,整数类型的实参被视为具有与 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

参阅

浮点值的绝对值(|x|
(函数)
(C++11)
检查给定数是否为负
(函数)