std::hypot, std::hypotf, std::hypotl

 

C++

編譯器支援

自由（freestanding）與宿主（hosted）

語言

標準庫

標準庫標頭檔案

具名要求

特性測試宏 (C++20)

語言支援庫

概念庫 (C++20)

診斷庫

記憶體管理庫

超程式設計庫 (C++11)

通用工具庫

容器庫

迭代器庫

範圍庫 (C++20)

演算法庫

字串庫

文字處理庫

數值庫

日期和時間庫

輸入/輸出庫

檔案系統庫 (C++17)

併發支援庫 (C++11)

執行控制庫 (C++26)

技術規範

符號索引

外部庫

 

數值庫

常用數學函式
數學特殊函式 (C++17)
數學常數 (C++20)
基本線性代數演算法 (C++26)
資料並行型別 (SIMD) (C++26)
浮點環境 (C++11)
複數
數值陣列 (valarray)
偽隨機數生成
位操作 (C++20)
因子運算
gcd (C++17)	lcm (C++17)
插值
midpoint (C++20)	lerp (C++20)
飽和算術
add_sat (C++26) sub_sat (C++26) saturate_cast (C++26)	mul_sat (C++26) div_sat (C++26)
通用數值運算
iota (C++11) ranges::iota (C++23) accumulate inner_product adjacent_difference    partial_sum	reduce (C++17) transform_reduce (C++17) inclusive_scan (C++17) exclusive_scan (C++17) transform_inclusive_scan (C++17) transform_exclusive_scan (C++17)

 

常用數學函式

函式
基本操作
abs(int)labsllabsimaxabs (C++11)   abs(float)fabs divldivlldivimaxdiv (C++11)	fmod remainder (C++11)   remquo (C++11) fma (C++11) fmax (C++11) fmin (C++11) fdim (C++11) nannanfnanl (C++11)(C++11)(C++11)
指數函式
exp exp2 (C++11) expm1 (C++11)	log log10 log1p (C++11) log2 (C++11)
冪函式
sqrt cbrt (C++11)	hypot (C++11) pow
三角和 雙曲函式
sin cos tan asin acos atan atan2	sinh cosh tanh asinh (C++11) acosh (C++11) atanh (C++11)
誤差函式和伽馬函式
erf (C++11) erfc (C++11)	lgamma (C++11) tgamma (C++11)

取整浮點運算
ceil floor roundlroundllround (C++11)(C++11)(C++11)	trunc (C++11) nearbyint (C++11) rintlrintllrint (C++11)(C++11)(C++11)
浮點操縱函式
ldexp scalbnscalbln (C++11)(C++11) ilogb (C++11) logb (C++11)	frexp modf nextafternexttoward (C++11)(C++11) copysign (C++11)
分類和比較
fpclassify (C++11) isfinite (C++11) isinf (C++11) isnan (C++11) isnormal (C++11) signbit (C++11)	isgreater (C++11) isgreaterequal (C++11) isless (C++11) islessequal (C++11) islessgreater (C++11) isunordered (C++11)
型別
div_t ldiv_t lldiv_t (C++11)	imaxdiv_t (C++11) float_t (C++11) double_t (C++11)
宏常量
HUGE_VALFHUGE_VALHUGE_VALL (C++11)(C++11) math_errhandlingMATH_ERRNOMATH_ERREXCEPT (C++11)   INFINITY (C++11) NAN (C++11)	分類 FP_NORMALFP_SUBNORMALFP_ZEROFP_INFINITEFP_NAN (C++11)(C++11)(C++11)(C++11)(C++11)

 

定義於標頭檔案 <cmath>
	(1)
float       hypot ( float x, float y ); double      hypot ( double x, double y ); long double hypot ( long double x, long double y );			(C++11 起) (直至 C++23)
/*floating-point-type*/             hypot ( /*floating-point-type*/ x,                     /*floating-point-type*/ y );			(C++23 起) (C++26 起為 constexpr)
float       hypotf( float x, float y );		(2)	(C++11 起) (C++26 起為 constexpr)
long double hypotl( long double x, long double y );		(3)	(C++11 起) (C++26 起為 constexpr)
		(4)
float       hypot ( float x, float y, float z ); double      hypot ( double x, double y, double z ); long double hypot ( long double x, long double y, long double z );				(C++17 起) (直至 C++23)
/*floating-point-type*/             hypot ( /*floating-point-type*/ x,                     /*floating-point-type*/ y,                     /*floating-point-type*/ z );				(C++23 起) (C++26 起為 constexpr)
附加過載
定義於標頭檔案 <cmath>
template< class Arithmetic1, Arithmetic2 > /*common-floating-point-type*/             hypot ( Arithmetic1 x, Arithmetic2 y );			(A)	(C++11 起) (C++26 起為 constexpr)
template< class Arithmetic1, Arithmetic2, Arithmetic3 > /*common-floating-point-type*/             hypot ( Arithmetic1 x, Arithmetic2 y, Arithmetic3 z );			(B)	(C++17 起)

1-3) 計算 x 和 y 平方和的平方根，在計算的中間階段沒有不適當的溢位或下溢。庫為所有 cv 非限定浮點型別作為引數 x 和 y 的型別提供了 std::hypot 的過載。(C++23 起)

4) 計算 x、y 和 z 平方和的平方根，在計算的中間階段沒有不適當的溢位或下溢。庫為所有 cv 非限定浮點型別作為引數 x、y 和 z 的型別提供了 std::hypot 的過載。(C++23 起)

A,B) 為所有其他算術型別組合提供了額外的過載。

此函式的兩個引數版本計算的值是直角三角形斜邊的長度，其兩邊長度分別為 x 和 y，或是點 (x,y) 到原點 (0,0) 的距離，或是複數 x+iy 的模。

此函式的三引數版本計算的值是點 (x,y,z) 到原點 (0,0,0) 的距離。

引數

x, y, z

-

浮點數或整數值

返回值

1-3,A) 如果沒有發生錯誤，則返回直角三角形的斜邊，\(\scriptsize{\sqrt{x^2+y^2} }\)√x2
+y2
。

4,B) 如果沒有發生錯誤，則返回 3D 空間中到原點的距離，\(\scriptsize{\sqrt{x^2+y^2+z^2} }\)√x2
+y2
+z2
。

如果發生因溢位導致的範圍錯誤，返回 +HUGE_VAL、+HUGE_VALF 或 +HUGE_VALL。

如果發生因下溢導致的範圍錯誤，返回正確的結果（舍入後）。

錯誤處理

錯誤按 math_errhandling 指定的方式報告。

如果實現支援 IEEE 浮點運算 (IEC 60559)，

• std::hypot(x, y)、std::hypot(y, x) 和 std::hypot(x, -y) 是等價的。
• 如果其中一個引數是 ±0，則 std::hypot(x, y) 等價於呼叫帶非零引數的 std::fabs。
• 如果其中一個引數是 ±∞，即使另一個引數是 NaN，std::hypot(x, y) 也返回 +∞。
• 否則，如果任何引數是 NaN，則返回 NaN。

注意

實現通常保證精度小於 1 ulp（最後一位單位——最小精度單位）：GNU、BSD。

std::hypot(x, y) 等價於 std::abs(std::complex<double>(x, y))。

POSIX 指定，只有當兩個引數都是非正規數且正確結果也是非正規數時，才會發生下溢（這禁止了簡單的實現）。

三維空間中兩點 (x1, y1, z1) 和 (x2, y2, z2) 之間的距離可以使用 std::hypot 的三引數過載計算為 std::hypot(x2 - x1, y2 - y1, z2 - z1)。

(C++17 起)

不需要完全按照 (A,B) 提供額外的過載。它們只需要足以確保其第一個引數 num1、第二個引數 num2 和可選的第三個引數 num3 的型別得到處理。

如果 num1、num2 或 num3 的型別是 long double，則 std::hypot(num1, num2) 的效果與 std::hypot(static_cast<long double>(num1),            static_cast<long double>(num2)) 相同，並且 std::hypot(num1, num2, num3) 的效果與 std::hypot(static_cast<long double>(num1),            static_cast<long double>(num2),            static_cast<long double>(num3)) 相同。 否則，如果 num1、num2 和/或 num3 的型別是 double 或整數型別，則 std::hypot(num1, num2) 的效果與 std::hypot(static_cast<double>(num1),            static_cast<double>(num2)) 相同，並且 std::hypot(num1, num2, num3) 的效果與 std::hypot(static_cast<double>(num1),            static_cast<double>(num2),            static_cast<double>(num3)) 相同。 否則，如果 num1、num2 或 num3 的型別是 float，則 std::hypot(num1, num2) 的效果與 std::hypot(static_cast<float>(num1),            static_cast<float>(num2)) 相同，並且 std::hypot(num1, num2, num3) 的效果與 std::hypot(static_cast<float>(num1),            static_cast<float>(num2),            static_cast<float>(num3)) 相同。

(直至 C++23)

如果 num1、num2 和 num3 具有算術型別，則 std::hypot(num1, num2) 的效果與 std::hypot(static_cast</*common-floating-point-type*/>(num1),            static_cast</*common-floating-point-type*/>(num2)) 相同，並且 std::hypot(num1, num2, num3) 的效果與 std::hypot(static_cast</*common-floating-point-type*/>(num1),            static_cast</*common-floating-point-type*/>(num2),            static_cast</*common-floating-point-type*/>(num3)) 相同， 其中 /*common-floating-point-type*/ 是在 num1、num2 和 num3 的型別中，具有最高浮點轉換等級和最高浮點轉換次等級的浮點型別，整數型別的引數被認為與 double 具有相同的浮點轉換等級。 如果不存在具有最高等級和次等級的浮點型別，則過載決議不會從提供的過載中產生可用的候選函式。

(C++23 起)

特性測試宏	值	標準	特性
__cpp_lib_hypot	201603L	(C++17)	std::hypot 的三引數過載 (4,B)

示例

執行此程式碼

#include <cerrno>
#include <cfenv>
#include <cfloat>
#include <cmath>
#include <cstring>
#include <iostream>
 
// #pragma STDC FENV_ACCESS ON
 
struct Point3D { float x, y, z; };
 
int main()
{
    // typical usage
    std::cout << "(1,1) cartesian is (" << std::hypot(1, 1)
              << ',' << std::atan2(1,1) << ") polar\n";
 
    Point3D a{3.14, 2.71, 9.87}, b{1.14, 5.71, 3.87};
    // C++17 has 3-argument hypot overload:
    std::cout << "distance(a,b) = "
              << std::hypot(a.x - b.x, a.y - b.y, a.z - b.z) << '\n';
 
    // special values
    std::cout << "hypot(NAN,INFINITY) = " << std::hypot(NAN, INFINITY) << '\n';
 
    // error handling
    errno = 0;
    std::feclearexcept(FE_ALL_EXCEPT);
    std::cout << "hypot(DBL_MAX,DBL_MAX) = " << std::hypot(DBL_MAX, DBL_MAX) << '\n';
 
    if (errno == ERANGE)
        std::cout << "    errno = ERANGE " << std::strerror(errno) << '\n';
    if (std::fetestexcept(FE_OVERFLOW))
        std::cout << "    FE_OVERFLOW raised\n";
}

輸出

(1,1) cartesian is (1.41421,0.785398) polar
distance(a,b) = 7
hypot(NAN,INFINITY) = inf
hypot(DBL_MAX,DBL_MAX) = inf
    errno = ERANGE Numerical result out of range
    FE_OVERFLOW raised

參閱

powpowfpowl (C++11)(C++11)	將數字提升到給定冪（\(\small{x^y}\)xy） (函式)
sqrtsqrtfsqrtl (C++11)(C++11)	計算平方根（\(\small{\sqrt{x}}\)√x） (函式)
cbrtcbrtfcbrtl (C++11)(C++11)(C++11)	計算立方根（\(\small{\sqrt[3]{x}}\)3√x） (函式)
abs(std::complex)	返回複數的模 (函式模板)
C 文件 用於 hypot