namespace std {
unsigned long stoul(const std::string& str,
std::size_t* idx = nullptr,
unsigned long base = 10); // (1)
unsigned long stoul(const std::wstring& str,
std::size_t* idx = nullptr,
unsigned long base = 10); // (2)
}
概要
文字列str
を数値として読み取って、unsigned long
型の値に変換する。
効果
パラメータstr
がstring
型であれば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
とした場合は、文字列のプレフィックスから基数が自動的に選択される。自動的な選択のルールは、以下のようになる:
- 先頭が
0
:8
進数 - 先頭が
0x
もしくは0X
:16
進数
戻り値
変換して得られた数値が返される。
例外
- 数値への変換が行われなかった場合、
std::invalid_argument
が送出される。 - 以下の条件に合致した場合、
std::out_of_range
が送出される。
備考
errnoの扱い
- Visual C++ 11やGCC (libstdc++) 4.8.2では、この関数を呼び出すと
errno
の値が変更される。 - Clang (libc++) 3.3では、この関数の呼び出し前後で
errno
の値は変化しない。
グローバルロケールの影響
この関数は、setlocale()
関数により挙動が変化する。
strtoul()
関数での文字列先頭の空白を読み飛ばす処理に、<cctype>
のisspace()
関数が使用されるためである。
例
#include <iostream>
#include <string>
int main()
{
// 10進法での変換
{
std::cout << "---- base = 10" << std::endl;
unsigned long x = std::stoul("10"); // std::stoul("10", nullptr, 10);
std::cout << x << std::endl;
unsigned long xw = std::stoul(L"11"); // std::stoul(L"11", nullptr, 10);
std::cout << xw << std::endl;
}
// 2進法での変換
{
std::cout << "---- base = 2" << std::endl;
unsigned long x = std::stoul("1001", nullptr, 2);
std::cout << x << std::endl;
unsigned long xw = std::stoul(L"01001", nullptr, 2); // 先頭に0が付いていてもよい
std::cout << xw << std::endl;
}
// 8進法での変換
{
std::cout << "---- base = 8" << std::endl;
unsigned long x = std::stoul("10", nullptr, 8);
std::cout << x << std::endl;
unsigned long xw = std::stoul(L"10", nullptr, 8);
std::cout << xw << std::endl;
}
// 16進法での変換
{
std::cout << "---- base = 16" << std::endl;
unsigned long x = std::stoul("10", nullptr, 16);
std::cout << x << std::endl;
unsigned long xw = std::stoul(L"11", nullptr, 16);
std::cout << xw << std::endl;
}
// 16進法での変換(プレフィックス付き)
{
unsigned long x = std::stoul("0x20", nullptr, 16);
std::cout << x << std::endl;
unsigned long xw = std::stoul(L"0x21", nullptr, 16);
std::cout << xw << 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 s = "30%";
std::size_t i;
unsigned long x = std::stoul(s, &i);
std::cout << x << ' ' << s[i] << std::endl;
std::wstring ws = L"31%";
std::size_t wi;
unsigned long xw = std::stoul(ws, &wi);
std::cout << xw << ' ' << wi << 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 = 2
9
9
---- base = 8
8
8
---- base = 16
16
17
32
33
---- base = 0
100
64
256
100
64
256
---- use of idx parameter
30 %
31 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
処理系
- Clang: ?
- GCC: ?
- ICC: ?
- Visual C++: 2010 ✅, 2012 ✅, 2013 ✅
関連リンク
C標準ライブラリに由来する関数
atol
:stoul
はatol
をstd::string
およびstd::wstring
に対応させ、戻り値の型をunsigned long
に変更したものと見なせる。strtoul
,wcstoul
:stoul
はstrtoul
およびwcstoul
をそれぞれstd::string
とstd::wstring
に対応させたものと見なせる。
ファミリー
stoi
: 戻り値の型がint
となったもの。stol
: 戻り値の型がlong
となったもの。stoll
: 戻り値の型がlong long
となったもの。- (
stoul
: この関数自身) stoull
: 戻り値の型がunsigned long long
となったもの。stof
: 戻り値の型がfloat
となったもの。stod
: 戻り値の型がdouble
となったもの。stold
: 戻り値の型がlong double
となったもの。