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

来自cppreference.com
< cpp‎ | numeric‎ | math
 
C++
 
数值库
 
常用数学函数
函数
基本运算
(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)(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++11 起)
(C++23 前)
constexpr /* 浮点类型 */
            copysign ( /* 浮点类型 */ mag, /* 浮点类型 */ 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)
在标头 <cmath> 定义
template< class Arithmetic1, class Arithmetic2 >
/* 公共浮点类型 */ copysign( Arithmetic1 mag, Arithmetic2 sgn );
 (A) (C++11 起)
(C++23 起 constexpr)
1-3) 以 mag 的模和 sgn 的符号组成浮点值。标准库提供所有以无 cv 限定的浮点类型作为参数 mag 和 sgn 的类型的 std::copysign 重载。 (C++23 起)
A) 为算术类型的所有其他组合提供额外重载。

参数

mag, sgn - 浮点或整数值

返回值

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

如果 mag 是 NaN，那么返回带 sgn 符号的 NaN。

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

错误处理

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

如果实现支持 IEEE 浮点算术（IEC 60559），那么

注解

std::copysign 是操作 NaN 值符号的唯一可移植方式（使用 std::signbit 也可以检验 NaN 的符号）。

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

  • 如果 num1 或 num2 具有 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))     的效果相同。
  • 否则，如果 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</* 公共浮点类型 */>(num1),
              static_cast</* 公共浮点类型 */>(num2)) 的效果相同，其中 /* 公共浮点类型 */ 是 num1 和 num2 的类型中浮点转换等级和浮点转换子等级最高的浮点类型，整数类型的实参被视为具有与 double 相等的浮点转换等级。

如果不存在等级和子等级最高的浮点类型，那么在重载决议时不会从提供的重载中产生可用的候选。

(C++23 起)

示例

运行此代码
#include <cmath>
#include <iostream>
 
int main()
{
    std::cout << "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)
 检查给定数是否为负
(函数)
来自“https://zh.cppreference.com/mwiki/index.php?title=cpp/numeric/math/copysign&oldid=77162”