• Class / Function / Type

      std::
    • Header file

      <>
    • Other / All

    最終更新日時(UTC):
    が更新

    履歴 編集

    function template
    <numeric>

    std::gcd

    namespace std {
      template <class M, class N>
      constexpr common_type_t<M, N> gcd(M m, N n);
    }
    

    概要

    最大公約数 (greatest common divisor, gcd) を求める。

    適格要件

    • M および Nbool 以外の整数型であること

    事前条件

    • |m| および |n|common_type_t<M, N> の値として表現できること
      • この条件により、gcd(m, m) == |m|が型Mの表現可能な値であることが保証される

    戻り値

    • mn が共に 0 の場合 0 を返す
    • それ以外の場合、引数 |m||n| の最大公約数を返す

    例外

    投げない。

    基本的な使い方

    #include <cassert>
    #include <numeric>
    
    int main() {
      assert(std::gcd(12, 42) == 6);
      assert(std::gcd(42, 12) == 6);
    
      // コンパイル時に最大公約数を求めることもできる
      static_assert(std::gcd(0, 0) == 0);
      static_assert(std::gcd(3u, -7l) == 1);
    }
    

    出力

    負の最大公約数が生成される状況の例

    #include <iostream>
    #include <numeric>
    #include <cstdint>
    #include <limits>
    
    int main() {
      // 符号付き整数の場合、戻り値が負になることがある。
      // mとnの絶対値をとって符号なし整数として最大公約数を求めるが、
      // 戻り値型は符号付き整数型であるため、変換時に符号付き整数の正の値として
      // 表現できないと負の値になる
      using T = std::int32_t;
      constexpr auto m = std::numeric_limits<T>::min();
      const auto gs = std::gcd<T, T>(m, m);  // |m| が int32_t で表せないと m < 0 になる
      std::cout << "gcd<int32_t, int32_t>(" << m << ", " << m << ")   " << gs << std::endl;
    
      // 符号なし整数にすれば戻り値は常に正になる
      using U = std::uint32_t;
      const auto gu = std::gcd<U, U>(m, m);
      std::cout << "gcd<uint32_t, uint32_t>(" << m << ", " << m << ") " << gu << std::endl;
    }
    

    出力例

    gcd<int32_t, int32_t>(-2147483648, -2147483648)   -2147483648
    gcd<uint32_t, uint32_t>(-2147483648, -2147483648) 2147483648
    

    3つ以上の値に対する最大公約数を求める

    #include <cassert>
    #include <numeric>
    #include <vector>
    
    // 可変引数で最大公約数を求める関数
    template <class T>
    T vgcd(T m, T n) {
      return std::gcd(m, n);
    }
    
    template <class T, class... Args>
    T vgcd(T a, Args... args) {
      return vgcd(a, vgcd(args...));
    }
    
    int main() {
      // 2つずつ最大公約数を求める
      assert(std::gcd(std::gcd(12, 42), 72) == 6);
    
      // リスト全体の最大公約数を求める
      std::vector<int> v = {12, 42, 72};
      int r = std::accumulate(v.begin(), v.end(), 0, [](int m, int n) {
        return std::gcd(m, n);
      });
      assert(r == 6);
    
      // 可変引数で最大公約数を求める
      assert(vgcd(12, 42, 72) == 6);
    }
    

    出力

    バージョン

    言語

    • C++17

    処理系

    備考

    Clang (libc++)

    • 事前条件を満たすかどうかチェックしないが、戻り値を constexpr 指定するとオーバーフロー時にコンパイルエラーとなることがある。
    • 事前条件を満たさない場合、オーバーフローにより戻り値が負になることがある。

    GCC (libstdc++)

    • 事前条件を満たすかどうかチェックしないが、戻り値を constexpr 指定するとオーバーフロー時にコンパイルエラーとなることがある。
    • 事前条件を満たさない場合、オーバーフローにより戻り値が負になることがある。

    参照

    関連項目

    実装例

    gcd(m,n)={|m|if n=0gcd(n,mmodn)otherwise