add doc: string index

source/libs/algorithm/mismatch.rst

@@ -32,9 +32,11 @@ Returns
 ========================================
 
 | A pair of iterators i and j such that ``j == first2 + (i - first1)`` and i is the first iterator in the range [first1,last1) for which the following corresponding  conditions hold:
+
 * j is in the range [first2,last2).
 * ``!(*i == *(first2 + (i - first1)))``
 * ``!pred(*i, *(first2 + (i - first1)))``
+
 | Returns the pair ``first1 + min(last1 - first1, last2 - first2)`` and ``first2 + min(last1 - first1, last2 - first2)`` if such an iterator i is not found.
 
 Examples

source/libs/index.rst

@@ -8,6 +8,7 @@ Libraries
 
     array/index
     algorithm/index
+    string/index
 
 .. _sprout-listed_by_alphabetically:
 *******************************************************************************
@@ -16,6 +17,7 @@ Libraries Listed Alphabetically
 
 * :doc:`algorithm <./algorithm/index>` - Standard library like generic algorithms.
 * :doc:`array <./array/index>` - Standard library compliant class template for storing fixed-size sequences of objects.
+* :doc:`string <./string/index>` - Compile-time string of fixed-length buffer.
 
 .. _sprout-listed_by_category:
 *******************************************************************************

source/libs/string/index.rst

@@ -0,0 +1,169 @@
+.. _sprout-string:
+###############################################################################
+Sprout.String
+###############################################################################
+
+.. toctree::
+    :hidden:
+
+Description
+========================================
+
+Character traits
+****************************************
+
+Classes
+----------------------------------------
+
+======================================== ===============================================================================
+class
+======================================== ===============================================================================
+:doc:`char_traits <./char_traits/index>`
+======================================== ===============================================================================
+
+String classes
+****************************************
+
+Classes
+----------------------------------------
+
+============================================================ ===============================================================================
+class
+============================================================ ===============================================================================
+:doc:`basic_string <./basic_string/index>`
+:doc:`string <./string>`
+:doc:`wstring <./wstring>`
+:doc:`u16string <./u16string>`
+:doc:`u32string <./u32string>`
+============================================================ ===============================================================================
+
+Non-member functions
+----------------------------------------
+
+specialized algorithms
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+============================================================ ===============================================================================
+function
+============================================================ ===============================================================================
+:doc:`swap <./basic_string/swap-global>`
+============================================================ ===============================================================================
+
+concatenations
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+============================================================ ===============================================================================
+function
+============================================================ ===============================================================================
+:doc:`operator+ <./basic_string/operator-plus>`
+============================================================ ===============================================================================
+
+comparisons
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+============================================================ ===============================================================================
+function
+============================================================ ===============================================================================
+:doc:`operator== <./basic_string/operator-equal_to>`
+:doc:`operator!= <./basic_string/operator-not_equal_to>`
+:doc:`operator\< <./basic_string/operator-less>`
+:doc:`operator\> <./basic_string/operator-greater>`
+:doc:`operator\<= <./basic_string/operator-less_equal>`
+:doc:`operator\>= <./basic_string/operator-greater_equal>`
+============================================================ ===============================================================================
+
+inserters and extractors
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+============================================================ ===============================================================================
+function
+============================================================ ===============================================================================
+:doc:`operator\<\< <./basic_string/operator-left_shift>`
+:doc:`operator\>\> <./basic_string/operator-right_shift>`
+============================================================ ===============================================================================
+
+numeric conversions
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+================================================================================ ===============================================================================
+function
+================================================================================ ===============================================================================
+:doc:`string_to_int <./string_to_int>`
+:doc:`stoi <./stoi>`
+:doc:`stol <./stol>`
+:doc:`stoul <./stoul>`
+:doc:`stoll <./stoll>`
+:doc:`stoull <./stoull>`
+:doc:`stoull <./stoull>`
+:doc:`stoimax <./stoimax>`
+:doc:`stoumax <./stoumax>`
+:doc:`from_string \<IntType\> <./from_string-inttype>`
+:doc:`string_to_float <./string_to_float>`
+:doc:`stof <./stof>`
+:doc:`stod <./stod>`
+:doc:`stold <./stold>`
+:doc:`from_string \<FloatType\> <./from_string-floattype>`
+:doc:`int_to_string <./int_to_string>`
+:doc:`to_string_of \<IntType\> <./to_string_of-inttype>`
+:doc:`to_string \<IntType\> <./to_string-inttype>`
+:doc:`to_wstring \<IntType\> <./to_wstring-inttype>`
+:doc:`to_u16string \<IntType\> <./to_u16string-inttype>`
+:doc:`to_u32string \<IntType\> <./to_u32string-inttype>`
+:doc:`float_to_string <./float_to_string>`
+:doc:`float_to_string_exp <./float_to_string_exp>`
+:doc:`to_string_of \<FloatType\> <./to_string_of-floattype>`
+:doc:`to_string \<FloatType\> <./to_string-floattype>`
+:doc:`to_wstring \<FloatType\> <./to_wstring-floattype>`
+:doc:`to_u16string \<FloatType\> <./to_u16string-floattype>`
+:doc:`to_u32string \<FloatType\> <./to_u32string-floattype>`
+================================================================================ ===============================================================================
+
+string generators
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+============================================================ ===============================================================================
+function
+============================================================ ===============================================================================
+:doc:`to_string <./to_string>`
+:doc:`string_from_c_str <./string_from_c_str>`
+:doc:`make_string <./make_string>`
+:doc:`shrink <./shrink>`
+:doc:`stretch <./stretch>`
+============================================================ ===============================================================================
+
+Tuple interface
+----------------------------------------
+
+============================================================ ===============================================================================
+matafunction
+============================================================ ===============================================================================
+:doc:`std::tuple_size <./basic_string/std-tuple_size>`
+:doc:`std::tuple_element <./basic_string/std-tuple_element>`
+============================================================ ===============================================================================
+
+============================================================ ===============================================================================
+function
+============================================================ ===============================================================================
+:doc:`tuple_get <./basic_string/tuple_get>`
+============================================================ ===============================================================================
+
+Hash support
+----------------------------------------
+
+============================================================ ===============================================================================
+class
+============================================================ ===============================================================================
+:doc:`std::hash <./basic_string/std-hash>`
+============================================================ ===============================================================================
+
+============================================================ ===============================================================================
+function
+============================================================ ===============================================================================
+:doc:`hash_value <./basic_string/hash_value>`
+============================================================ ===============================================================================
+
+Header
+========================================
+
+``sprout/string.hpp``
+