[共通] String::choice() #1253

Siv3D/include/Siv3D/String.hpp

@@ -595,6 +595,32 @@ namespace s3d
 		[[nodiscard]]
 		String capitalized()&&;
 
+		/// @brief 文字列の要素を 1 つランダムに返します。
+		/// @return 文字列からランダムに選ばれた要素への参照
+		[[nodiscard]]
+		value_type& choice();
+
+		/// @brief 文字列の要素を 1 つランダムに返します。
+		/// @return 文字列からランダムに選ばれた要素への参照
+		[[nodiscard]]
+		const value_type& choice() const;
+
+		/// @brief 指定した乱数エンジンを用いて、文字列の要素を 1 つランダムに返します。
+		/// @tparam URBG 使用する乱数エンジンの型
+		/// @param rbg 使用する乱数エンジン
+		/// @return 文字列からランダムに選ばれた要素への参照
+		SIV3D_CONCEPT_URBG
+		[[nodiscard]]
+		value_type& choice(URBG&& rbg);
+
+		/// @brief 指定した乱数エンジンを用いて、文字列の要素を 1 つランダムに返します。
+		/// @tparam URBG 使用する乱数エンジンの型
+		/// @param rbg 使用する乱数エンジン
+		/// @return 文字列からランダムに選ばれた要素への参照
+		SIV3D_CONCEPT_URBG
+		[[nodiscard]]
+		const value_type& choice(URBG&& rbg) const;
+
 		/// @brief 指定した値と等しい要素の個数を返します。
 		/// @param ch 検索する値
 		/// @return 指定した値と等しい要素の個数	

Siv3D/include/Siv3D/detail/String.ipp

@@ -642,6 +642,32 @@ namespace s3d
 		return std::any_of(m_string.begin(), m_string.end(), f);
 	}
 
+	SIV3D_CONCEPT_URBG_
+	inline String::value_type& String::choice(URBG&& rbg)
+	{
+		const size_t size = m_string.size();
+
+		if (size == 0)
+		{
+			throw std::out_of_range{ "String::choice(): String is empty" };
+		}
+
+		return m_string[RandomClosedOpen<size_t>(0, size, std::forward<URBG>(rbg))];
+	}
+
+	SIV3D_CONCEPT_URBG_
+	inline const String::value_type& String::choice(URBG&& rbg) const
+	{
+		const size_t size = m_string.size();
+
+		if (size == 0)
+		{
+			throw std::out_of_range{ "String::choice(): String is empty" };
+		}
+
+		return m_string[RandomClosedOpen<size_t>(0, size, std::forward<URBG>(rbg))];
+	}
+
 	template <class Fty, std::enable_if_t<std::is_invocable_r_v<bool, Fty, char32>>*>
 	inline size_t String::count_if(Fty f) const
 	{

Siv3D/src/Siv3D/String/SivString.cpp

@@ -254,6 +254,16 @@ namespace s3d
 		return std::move(*this);
 	}
 
+	String::value_type& String::choice()
+	{
+		return choice(GetDefaultRNG());
+	}
+
+	const String::value_type& String::choice() const
+	{
+		return choice(GetDefaultRNG());
+	}
+
 	size_t String::count(const value_type ch) const noexcept
 	{
 		return std::count(m_string.begin(), m_string.end(), ch);