std::basic_string

 

C++

言語

標準ライブラリヘッダ

フリースタンディング処理系とホスト処理系

名前付き要件

言語サポートライブラリ

コンセプトライブラリ(C++20)

診断ライブラリ

ユーティリティライブラリ

文字列ライブラリ

コンテナライブラリ

イテレータライブラリ

範囲ライブラリ(C++20)

アルゴリズムライブラリ

数値演算ライブラリ

入出力ライブラリ

ローカライゼーションライブラリ

正規表現ライブラリ(C++11)

アトミック操作ライブラリ(C++11)

スレッドサポートライブラリ(C++11)

ファイルシステムライブラリ(C++17)

技術仕様書

 

文字列ライブラリ

ヌル終端文字列

バイト文字列

マルチバイト文字列

ワイド文字列

クラス

basic_string

basic_string_view (C++17)

char_traits

 

std::basic_string

メンバ関数 basic_string::basic_string basic_string::operator= basic_string::assign basic_string::get_allocator 要素アクセス basic_string::at basic_string::operator[] basic_string::front (C++11) basic_string::back (C++11) basic_string::data basic_string::c_str basic_string::operator basic_string_view (C++17) イテレータ basic_string::beginbasic_string::cbegin (C++11) basic_string::endbasic_string::cend (C++11) basic_string::rbeginbasic_string::crbegin (C++11) basic_string::rendbasic_string::crend (C++11) 容量 basic_string::empty basic_string::sizebasic_string::length basic_string::max_size basic_string::reserve basic_string::capacity basic_string::shrink_to_fit (C++11)

操作 basic_string::clear basic_string::insert basic_string::erase basic_string::push_back basic_string::pop_back (C++11) basic_string::append basic_string::operator+= basic_string::compare basic_string::starts_with (C++20) basic_string::ends_with (C++20) basic_string::replace basic_string::substr basic_string::copy basic_string::resize basic_string::swap 検索 basic_string::find basic_string::rfind basic_string::find_first_of basic_string::find_first_not_of basic_string::find_last_of basic_string::find_last_not_of 定数 basic_string::npos

非メンバ関数 operator+ swap(std::basic_string) operator""s (C++14) erase(std::basic_string)erase_if(std::basic_string) (C++20)(C++20) 入出力 operator<<operator>> getline 比較 operator==operator!=operator<operator>operator<=operator>= 数値変換 (C++11) stoistolstoll stoulstoull stofstodstold to_string to_wstring ヘルパークラス hash<std::string>hash<std::wstring>hash<std::u32string>hash<std::u16string>hash<std::u8string> (C++11)(C++11)(C++11)(C++11)(C++20) hash<std::pmr::string>hash<std::pmr::wstring>hash<std::pmr::u32string>hash<std::pmr::u16string>hash<std::pmr::u8string> (C++20)(C++20)(C++20)(C++20)(C++20) 推定ガイド(C++17)

 

ヘッダ <string> で定義
template<     class CharT,     class Traits =std::char_traits<CharT>,     class Allocator =std::allocator<CharT> >class basic_string;	(1)
namespace pmr {     template<class CharT, class Traits =std::char_traits<CharT>>     using basic_string = std::basic_string< CharT, Traits,                                             std::polymorphic_allocator<CharT>> }	(2)	(C++17以上)

クラステンプレート basic_string は char ライクなオブジェクト (トリビアルな標準レイアウト型の非配列オブジェクト) の並びを格納したり操作したりします。 このクラスは文字の型やその型の操作の性質には依存しません。 操作は Traits テンプレート引数で与えられる std::char_traits の特殊化またはそれと互換の特性クラスによって定義されます。 Traits::char_type と CharT は同じ型でなければならず、そうでなければプログラムは ill-formed です。

basic_string の要素は隣接して格納されます。 つまり、 basic_string s に対して、 [0, s.size()) の任意の n について &*(s.begin()+ n)==&*s.begin()+ n です。 別の言い方をすると、 CharT[] 配列の最初の要素へのポインタを期待する関数に s[0] へのポインタを渡すことができます。

(C++11以上)

std::basic_string は AllocatorAwareContainer, SequenceContainerおよび ContiguousContainer(C++17以上) の要件を満たします。

一般的な文字型に対していくつかの typedef が提供されます。

ヘッダ <string> で定義
型	定義
std::string	std::basic_string<char>
std::wstring	std::basic_string<wchar_t>
std::u8string(C++20)	std::basic_string<char8_t>
std::u16string(C++11)	std::basic_string<char16_t>
std::u32string(C++11)	std::basic_string<char32_t>
std::pmr::string(C++17)	std::pmr::basic_string<char>
std::pmr::wstring(C++17)	std::pmr::basic_string<wchar_t>
std::pmr::u8string(C++20)	std::pmr::basic_string<char8_t>
std::pmr::u16string(C++17)	std::pmr::basic_string<char16_t>
std::pmr::u32string(C++17)	std::pmr::basic_string<char32_t>

テンプレート引数

CharT	-	文字型
Traits	-	文字型の操作を指定する型特性クラス
Allocator	-	内部の記憶域を確保するために使用されるアロケータ型

メンバ型

メンバ型	定義
traits_type	Traits
value_type	CharT
allocator_type	Allocator
size_type	Allocator::size_type (C++11未満) std::allocator_traits<Allocator>::size_type (C++11以上)
difference_type	Allocator::difference_type (C++11未満) std::allocator_traits<Allocator>::difference_type (C++11以上)
reference	Allocator::reference (C++11未満) value_type& (C++11以上)
const_reference	Allocator::const_reference (C++11未満) const value_type& (C++11以上)
pointer	Allocator::pointer (C++11未満) std::allocator_traits<Allocator>::pointer (C++11以上)
const_pointer	Allocator::const_pointer (C++11未満) std::allocator_traits<Allocator>::const_pointer (C++11以上)
iterator	LegacyRandomAccessIterator
const_iterator	const LegacyRandomAccessIterator
reverse_iterator	std::reverse_iterator<iterator>
const_reverse_iterator	std::reverse_iterator<const_iterator>

メンバ関数

コンストラクタ	basic_string を構築します (パブリックメンバ関数)
デストラクタ	内部の記憶域を解放し、文字列を破棄します (パブリックメンバ関数)
operator=	文字列に値を代入します (パブリックメンバ関数)
assign	文字列に文字を代入します (パブリックメンバ関数)
get_allocator	関連付けられているアロケータを返します (パブリックメンバ関数)
要素アクセス
at	境界チェック付きで指定された文字にアクセスします (パブリックメンバ関数)
operator[]	指定された文字にアクセスします (パブリックメンバ関数)
front (C++11)	最初の文字にアクセスします (パブリックメンバ関数)
back (C++11)	最後の文字にアクセスします (パブリックメンバ関数)
data	文字列の最初の文字を指すポインタを返します (パブリックメンバ関数)
c_str	文字列の変更不可能な標準 C の文字配列バージョンを返します (パブリックメンバ関数)
operator basic_string_view (C++17)	文字列全体に対する変更不可能な string_view を返します (パブリックメンバ関数)
イテレータ
begincbegin (C++11)	先頭を指すイテレータを返します (パブリックメンバ関数)
end cend (C++11)	終端を指すイテレータを返します (パブリックメンバ関数)
rbegin crbegin (C++11)	先頭を指す逆イテレータを返します (パブリックメンバ関数)
rend crend (C++11)	終端を指す逆イテレータを返します (パブリックメンバ関数)
容量
empty	文字列が空かどうか調べます (パブリックメンバ関数)
sizelength	文字数を返します (パブリックメンバ関数)
max_size	最大文字数を返します (パブリックメンバ関数)
reserve	記憶域を予約します (パブリックメンバ関数)
capacity	現在確保されている記憶域に保持することができる文字数を返します (パブリックメンバ関数)
shrink_to_fit (C++11)	未使用のメモリを解放してメモリ使用量を減らします (パブリックメンバ関数)
操作
clear	内容をクリアします (パブリックメンバ関数)
insert	文字を挿入します (パブリックメンバ関数)
erase	文字を削除します (パブリックメンバ関数)
push_back	文字を末尾に追加します (パブリックメンバ関数)
pop_back (C++11)	最後の文字を削除します (パブリックメンバ関数)
append	文字を末尾に追加します (パブリックメンバ関数)
operator+=	文字を末尾に追加します (パブリックメンバ関数)
compare	2つの文字列を比較します (パブリックメンバ関数)
starts_with (C++20)	文字列が指定された接頭辞で始まるか調べます (パブリックメンバ関数)
ends_with (C++20)	文字列が指定された接尾辞で終わるか調べます (パブリックメンバ関数)
replace	文字列の指定された部分を置換します (パブリックメンバ関数)
substr	部分文字列を返します (パブリックメンバ関数)
copy	文字をコピーします (パブリックメンバ関数)
resize	格納されている文字の数を変更します (パブリックメンバ関数)
swap	内容を入れ替えます (パブリックメンバ関数)
検索
find	文字列内の文字を探します (パブリックメンバ関数)
rfind	部分文字列が現れる最後の位置を探します (パブリックメンバ関数)
find_first_of	文字が現れる最初の位置を探します (パブリックメンバ関数)
find_first_not_of	文字が現れない最初の位置を探します (パブリックメンバ関数)
find_last_of	文字が現れる最後の位置を探します (パブリックメンバ関数)
find_last_not_of	文字が現れない最後の位置を探します (パブリックメンバ関数)
定数
npos [静的]	特殊な値です。正確な意味は文脈に依存します (パブリック静的メンバ定数)

非メンバ関数

operator+	2つの文字列または文字列と文字を連結します (関数テンプレート)
operator==operator!=operator<operator>operator<=operator>=	2つの文字列を辞書的に比較します (関数テンプレート)
std::swap(std::basic_string)	std::swap アルゴリズムの特殊化 (関数テンプレート)
erase(std::basic_string)erase_if(std::basic_string) (C++20)	特定の基準を満たすすべての要素を削除します (関数テンプレート)
入出力
operator<<operator>>	文字列のストリーム入出力を行います (関数テンプレート)
getline	入出力ストリームから文字列にデータを読み込みます (関数)
数値変換
stoistolstoll (C++11)(C++11)(C++11)	文字列を符号付き整数に変換します (関数)
stoulstoull (C++11)(C++11)	文字列を符号なし整数に変換します (関数)
stofstodstold (C++11)(C++11)(C++11)	文字列を浮動小数点値に変換します (関数)
to_string (C++11)	整数または浮動小数点値を string に変換します (関数)
to_wstring (C++11)	整数または浮動小数点値を wstring に変換します (関数)

リテラル

名前空間 std::literals::string_literals で定義
operator""s (C++14)	文字配列リテラルを basic_string に変換します (関数)

ヘルパークラス

std::hash<std::string>std::hash<std::u8string>std::hash<std::u16string>std::hash<std::u32string>std::hash<std::wstring>std::hash<std::pmr::string>std::hash<std::pmr::u8string>std::hash<std::pmr::u16string>std::hash<std::pmr::u32string>std::hash<std::pmr::wstring> (C++11)(C++20)(C++11)(C++11)(C++11)(C++20)(C++20)(C++20)(C++20)(C++20)

文字列に対するハッシュサポート (クラステンプレートの特殊化)