名稱空間
變體
操作

std::fmod, std::fmodf, std::fmodl

來自 cppreference.com
< cpp‎ | numeric‎ | math
 
C++
 
數值庫
 
常用數學函式
函式
基本操作
fmod
(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)
(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)


 
定義於標頭檔案 <cmath>
(1)
float       fmod ( float x, float y );

double      fmod ( double x, double y );

long double fmod ( long double x, long double y );
 (直至 C++23)
constexpr /*浮點型別*/

            fmod ( /*floating-point-type*/ x,

                   /*floating-point-type*/ y );
 (C++23 起)
float       fmodf( float x, float y );
 (2) (C++11 起)
(C++23 起為 constexpr)
long double fmodl( long double x, long double y );
 (3) (C++11 起)
(C++23 起為 constexpr)
SIMD 過載 (C++26 起)
定義於標頭檔案 <simd>
template< class V0, class V1 >

constexpr /*math-common-simd-t*/<V0, V1>

            fmod ( const V0& v_x, const V1& v_y );
 (S) (C++26 起)
額外過載 (自 C++11 起)
定義於標頭檔案 <cmath>
template< class Integer >
double      fmod ( Integer x, Integer y );
 (A) (C++23 起為 constexpr)
1-3) 計算除法操作 x / y 的浮點餘數。 庫為所有 cv-unqualified 浮點型別提供了 std::fmod 的過載作為引數的型別。(C++23 起)
S) SIMD 過載在 v_x 和 v_y 上執行逐元素的 std::fmod。
(參閱 math-common-simd-t 的定義。)
(C++26 起)
A) 為所有整數型別提供了額外的過載，它們被視為 double。
 (C++11 起)

此函式計算的除法操作 x / y 的浮點餘數精確地是值 x - iquot * y，其中 iquot 是 x / y 截斷小數部分後的值。

返回值的符號與 x 相同，且幅度小於 y。

目錄

[編輯] 引數

x, y - 浮點數或整數值

[編輯] 返回值

成功時，返回如上定義的除法 x / y 的浮點餘數。

如果發生域錯誤，則返回實現定義的值 (支援 NaN 時返回 NaN)。

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

[編輯] 錯誤處理

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

如果 y 為零，則可能發生域錯誤。

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

  • 如果 x 為 ±0 且 y 不為零，返回 ±0。
  • 如果 x 為 ±∞ 且 y 不為 NaN，返回 NaN 並引發 FE_INVALID。
  • 如果 y 為 ±0 且 x 不為 NaN，返回 NaN 並引發 FE_INVALID。
  • 如果 y 為 ±∞ 且 x 有限，返回 x。
  • 如果任一引數為 NaN，則返回 NaN。

[編輯] 注意

POSIX 要求如果 x 是無窮大或 y 是零，則發生域錯誤。

std::fmod，而不是 std::remainder，對於浮點型別到無符號整數型別的靜默包裝很有用：(0.0 <= (y = std::fmod(std::rint(x), 65536.0)) ? y : 65536.0 + y) 在範圍 [-0.0, 65535.0] 內，這對應於 unsigned short，但 std::remainder(std::rint(x), 65536.0 在範圍 [-32767.0, +32768.0] 內，這超出了 signed short 的範圍。

std::fmod 的 double 版本表現得彷彿按以下方式實現：

double fmod(double x, double y)
{
#pragma STDC FENV_ACCESS ON
    double result = std::remainder(std::fabs(x), y = std::fabs(y));
    if (std::signbit(result))
        result += y;
    return std::copysign(result, x);
}

表示式 x - std::trunc(x / y) * y 可能不等於 std::fmod(x, y)，當 x / y 的舍入為了初始化 std::trunc 的引數而損失太多精度時（例如：x = 30.508474576271183309，y = 6.1016949152542370172）。

附加的過載不要求完全以 (A) 的形式提供。它們只需要足以確保對於它們的第一個引數 num1 和第二個引數 num2

  • 如果 num1 或 num2 的型別為 long double，則 std::fmod(num1, num2) 的效果與 std::fmod(static_cast<long double>(num1),
              static_cast<long double>(num2))     相同。
  • 否則，如果 num1 和/或 num2 的型別為 double 或整數型別，則 std::fmod(num1, num2) 的效果與 std::fmod(static_cast<double>(num1),
              static_cast<double>(num2))     相同。
  • 否則，如果 num1 或 num2 的型別為 float，則 std::fmod(num1, num2) 的效果與 std::fmod(static_cast<float>(num1),
              static_cast<float>(num2))     相同。
 (直至 C++23)

如果 num1 和 num2 具有算術型別，則 std::fmod(num1, num2) 的效果與 std::fmod(static_cast</*common-floating-point-type*/>(num1),
          static_cast</*common-floating-point-type*/>(num2)) 相同，其中 /*common-floating-point-type*/ 是浮點型別，在 num1 和 num2 的型別之間具有最大的 浮點轉換等級 和最大的 浮點轉換次等級，整數型別引數被視為具有與 double 相同的浮點轉換等級。

如果不存在具有最高等級和次等級的浮點型別，則過載決議不會從提供的過載中產生可用的候選函式。

 (C++23 起)

[編輯] 示例

執行此程式碼
#include <cfenv>
#include <cmath>
#include <iostream>
// #pragma STDC FENV_ACCESS ON
 
int main()
{
    std::cout << "fmod(+5.1, +3.0) = " << std::fmod(5.1, 3) << '\n'
              << "fmod(-5.1, +3.0) = " << std::fmod(-5.1, 3) << '\n'
              << "fmod(+5.1, -3.0) = " << std::fmod(5.1, -3) << '\n'
              << "fmod(-5.1, -3.0) = " << std::fmod(-5.1, -3) << '\n';
 
    // special values
    std::cout << "fmod(+0.0, 1.0) = " << std::fmod(0, 1) << '\n'
              << "fmod(-0.0, 1.0) = " << std::fmod(-0.0, 1) << '\n'
              << "fmod(5.1, Inf) = " << std::fmod(5.1, INFINITY) << '\n';
 
    // error handling
    std::feclearexcept(FE_ALL_EXCEPT);
    std::cout << "fmod(+5.1, 0) = " << std::fmod(5.1, 0) << '\n';
    if (std::fetestexcept(FE_INVALID))
        std::cout << "    FE_INVALID raised\n";
}

可能的輸出

fmod(+5.1, +3.0) = 2.1
fmod(-5.1, +3.0) = -2.1
fmod(+5.1, -3.0) = 2.1
fmod(-5.1, -3.0) = -2.1
fmod(+0.0, 1.0) = 0
fmod(-0.0, 1.0) = -0
fmod(5.1, Inf) = 5.1
fmod(+5.1, 0) = -nan
    FE_INVALID raised

[編輯] 參閱

(C++11)
 計算整數除法的商和餘數
(函式) [編輯]
(C++11)(C++11)(C++11)
 除法運算的帶符號餘數
(函式) [編輯]
(C++11)(C++11)(C++11)
 帶符號餘數以及除法運算的最後三位
(函式) [編輯]
C 文件 關於 fmod
取自“https://cppreference.tw/mwiki/index.php?title=cpp/numeric/math/fmod&oldid=175785”