最終更新日時:
が更新

履歴 編集

function
<string>

std::stoul(C++11)

namespace std {
  unsigned long stoul(const string& str, size_t* idx = nullptr, unsigned long base = 10);
  unsigned long stoul(const wstring& str, size_t* idx = nullptr, unsigned long base = 10);
}

概要

文字列strを数値として読み取って、unsigned long型の値に変換する。

効果

パラメータstrstring型であればstd::strtoul(str.c_str(), &end, base)wstring型であればstd::wcstoul(str.c_str(), &end, base)を呼び出して、その戻り値を返す。

idxが非nullptrの場合、変換に使用されなかった要素のインデックス(end - str.c_str())が格納される。

パラメータbaseは、整数文字列strの基数を表す。デフォルトでは10進数として文字列を整数に変換する。基数は2から36(36含む)進数を指定できる。基数を0とした場合は、文字列のプレフィックスから基数が自動的に選択される。自動的な選択のルールは、以下のようになる:

  • 先頭が08進数
  • 先頭が0xもしくは0X16進数

戻り値

変換して得られた数値が返される。

例外

  • 数値への変換が行われなかった場合、std::invalid_argumentが送出される。
  • 以下の条件に合致した場合、std::out_of_rangeが送出される。
    • std::strtoul()関数がerrno変数にERANGEを設定した場合 (C++14)
    • 結果が範囲外の値になった場合

備考

errnoの扱い

  • Visual C++ 11やGCC (libstdc++) 4.8.2では、この関数を呼び出すとerrnoの値が変更される。
  • Clang (libc++) 3.3では、この関数の呼び出し前後でerrnoの値は変化しない。

グローバルロケールの影響

この関数は、setlocale()関数により挙動が変化する。

strtol()関数での文字列先頭の空白を読み飛ばす処理に、<cctype>isspace()関数が使用されるためである。

#include <iostream>
#include <string>

int main()
{
  // 10進法での変換
  std::cout << "---- base = 10" << std::endl;

  unsigned long a = std::stoul("10"); // std::stoul("10", nullptr, 10);
  std::cout << a << std::endl;

  unsigned long aw = std::stoul(L"11"); // std::stoul(L"11", nullptr, 10);
  std::cout << aw << std::endl;

  // 8進法での変換
  std::cout << "---- base = 8" << std::endl;

  unsigned long b = std::stoul("10", nullptr, 8);
  std::cout << b << std::endl;

  unsigned long bw = std::stoul(L"10", nullptr, 8);
  std::cout << bw << std::endl;

  // 16進法での変換
  std::cout << "---- base = 16" << std::endl;

  unsigned long c = std::stoul("10", nullptr, 16);
  std::cout << c << std::endl;

  unsigned long cw = std::stoul(L"11", nullptr, 16);
  std::cout << cw << std::endl;

  // 16進法での変換(プレフィックス付き)
  unsigned long d = std::stoul("0x20", nullptr, 16);
  std::cout << d << std::endl;

  unsigned long dw = std::stoul(L"0x21", nullptr, 16);
  std::cout << dw << std::endl;

  // base = 0による10進法・8進法・16進法の自動判別
  std::cout << "---- base = 0" << std::endl;

  std::cout << std::stoul("100", nullptr, 0) << std::endl;
  std::cout << std::stoul("0100", nullptr, 0) << std::endl;
  std::cout << std::stoul("0x100", nullptr, 0) << std::endl;

  std::cout << std::stoul(L"100", nullptr, 0) << std::endl;
  std::cout << std::stoul(L"0100", nullptr, 0) << std::endl;
  std::cout << std::stoul(L"0x100", nullptr, 0) << std::endl;

  // 2番目の仮引数の使用例
  std::cout << "---- use of idx parameter" << std::endl;

  std::string es = "30%";
  std::size_t ei;
  unsigned long e = std::stoul(es, &ei);
  std::cout << e << ' ' << es[ei] << std::endl;

  std::wstring ews = L"31%";
  std::size_t ewi;
  unsigned long ew = std::stoul(ews, &ewi);
  std::cout << ew << ' ' << ewi << std::endl;

  // 文字列先頭に空白がある場合
  std::cout << "---- space character before number" << std::endl;
  std::cout << std::stoul("    1") << std::endl;
  std::cout << std::stoul(L"    2") << std::endl;
}

出力

---- base = 10
10
11
---- base = 8
8
9
---- base = 16
16
17
---- base = 0
100
64
256
100
64
256
---- use of idx parameter
30 %
31 index: 2
---- space character before number
1
2

実装例

unsigned long stoul(const std::string& str, std::size_t* idx = nullptr, unsigned long base = 10) {
  const char* p = str.c_str();
  char* end;
  errno = 0;
  unsigned long x = std::strtoul(p, &end, base);
  if (p == end) {
    throw std::invalid_argument("stoul");
  }
  if (errno == ERANGE) {
    throw std::out_of_range("stoul");
  }
  if (idx != nullptr) {
    *idx = static_cast<std::size_t>(end - p);
  }
  return x;
}

unsigned long stoul(const std::wstring& str, std::size_t* idx = nullptr, unsigned long base = 10) {
  const wchar_t* p = str.c_str();
  wchar_t* end;
  unsigned long x = std::wcstoul(p, &end, base);
  if (p == end) {
    throw std::invalid_argument("stoul");
  }
  errno = 0;
  if (errno == ERANGE) {
    throw std::out_of_range("stoul");
  }
  if (idx != nullptr) {
    *idx = static_cast<std::size_t>(end - p);
  }
  return x;
}

バージョン

言語

  • C++11

処理系

参照

C標準ライブラリに由来する関数

  • atol: stoulatolstd::stringおよびstd::wstingに対応させ、戻り値の型をunsigned longに変更したものと見なせる。
  • strtoul, wcstoul: stoulwcstoullおよびwcstoulをそれぞれstd::stringstd::wstingに対応させたものと見なせる。

ファミリー

  • stoi: 戻り値の型がintとなったもの。
  • stol: 戻り値の型がlongとなったもの。
  • stoll: 戻り値の型がlong longとなったもの。
  • (stoul: この関数自身)
  • stoull: 戻り値の型がunsigned long longとなったもの。
  • stof: 戻り値の型がfloatとなったもの。
  • stod: 戻り値の型がdoubleとなったもの。
  • stold: 戻り値の型がlong doubleとなったもの。