mirror/Sprout
1
0
Fork 0
mirror of https://github.com/bolero-MURAKAMI/Sprout.git synced 2025-07-04 14:14:09 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

add index_tuple summary page

Browse source
This commit is contained in:
Bolero-MURAKAMI 2014-08-15 21:27:31 +09:00
parent 2d707944fb
commit e57368faee
473 changed files with 2597 additions and 1293 deletions
Download patch file Download diff file Expand all files Collapse all files

3
source/libs/string/basic_string/assign-iterator.rst
View file

@ -1,4 +1,5 @@
.. _sprout-string-basic_string-assign-iterator:
###############################################################################
assign
###############################################################################
@ -18,7 +19,7 @@ Requires
Effects
========================================
| Replaces the string controlled by *this with a string of length n whose elements are a copy of those pointed to by s.
| Replaces the string controlled by ``*this`` with a string of length n whose elements are a copy of those pointed to by s.
Returns
========================================

3
source/libs/string/basic_string/assign.rst
View file

@ -1,4 +1,5 @@
.. _sprout-string-basic_string-assign:
###############################################################################
assign
###############################################################################
@ -80,7 +81,7 @@ Requires
Effects
========================================
| Replaces the string controlled by *this with a string of length n whose elements are a copy of those pointed to by s.
| Replaces the string controlled by ``*this`` with a string of length n whose elements are a copy of those pointed to by s.
Returns
========================================

1
source/libs/string/basic_string/at.rst
View file

@ -1,4 +1,5 @@
.. _sprout-string-basic_string-at:
###############################################################################
at
###############################################################################

1
source/libs/string/basic_string/back.rst
View file

@ -1,4 +1,5 @@
.. _sprout-string-basic_string-back:
###############################################################################
back
###############################################################################

1
source/libs/string/basic_string/begin.rst
View file

@ -1,4 +1,5 @@
.. _sprout-string-basic_string-begin:
###############################################################################
begin
###############################################################################

1
source/libs/string/basic_string/c_array.rst
View file

@ -1,4 +1,5 @@
.. _sprout-string-basic_string-c_array:
###############################################################################
back
###############################################################################

1
source/libs/string/basic_string/cbegin.rst
View file

@ -1,4 +1,5 @@
.. _sprout-string-basic_string-cbegin:
###############################################################################
cbegin
###############################################################################

9
source/libs/string/basic_string/cend.rst
View file

@ -1,13 +1,14 @@
.. _sprout-string-basic_string-cbegin:
.. _sprout-string-basic_string-cend:
###############################################################################
cbegin
cend
###############################################################################
Interface
========================================
.. sourcecode:: c++
SPROUT_CONSTEXPR const_iterator cbegin() const SPROUT_NOEXCEPT;
SPROUT_CONSTEXPR const_iterator cend() const SPROUT_NOEXCEPT;
Returns
========================================
@ -22,7 +23,7 @@ Examples
using namespace sprout;
SPROUT_STATIC_CONSTEXPR auto input = string<8>("homuhomu");
static_assert(*(input.cbegin() - 1) == 'u', "input last element is u.");
static_assert(*(input.cend() - 1) == 'u', "input last element is u.");
Complexity
========================================

1
source/libs/string/basic_string/clear.rst
View file

@ -1,4 +1,5 @@
.. _sprout-string-basic_string-clear:
###############################################################################
clear
###############################################################################

1
source/libs/string/basic_string/compare-iterator.rst
View file

@ -1,4 +1,5 @@
.. _sprout-string-basic_string-compare-iterator:
###############################################################################
compare
###############################################################################

1
source/libs/string/basic_string/compare.rst
View file

@ -1,4 +1,5 @@
.. _sprout-string-basic_string-compare:
###############################################################################
compare
###############################################################################

1
source/libs/string/basic_string/constructor-.rst
View file

@ -1,4 +1,5 @@
.. _sprout-string-basic_string-constructor-:
###############################################################################
basic_string
###############################################################################

1
source/libs/string/basic_string/crbegin.rst
View file

@ -1,4 +1,5 @@
.. _sprout-string-basic_string-crbegin:
###############################################################################
crbegin
###############################################################################

1
source/libs/string/basic_string/crend.rst
View file

@ -1,4 +1,5 @@
.. _sprout-string-basic_string-crend:
###############################################################################
crend
###############################################################################

1
source/libs/string/basic_string/data.rst
View file

@ -1,4 +1,5 @@
.. _sprout-string-basic_string-data:
###############################################################################
back
###############################################################################

1
source/libs/string/basic_string/empty.rst
View file

@ -1,4 +1,5 @@
.. _sprout-string-basic_string-empty:
###############################################################################
empty
###############################################################################

1
source/libs/string/basic_string/end.rst
View file

@ -1,4 +1,5 @@
.. _sprout-string-basic_string-end:
###############################################################################
end
###############################################################################

1
source/libs/string/basic_string/find.rst
View file

@ -1,4 +1,5 @@
.. _sprout-string-basic_string-find:
###############################################################################
find
###############################################################################

1
source/libs/string/basic_string/front.rst
View file

@ -1,4 +1,5 @@
.. _sprout-string-basic_string-front:
###############################################################################
front
###############################################################################

1
source/libs/string/basic_string/hash_value.rst
View file

@ -1,4 +1,5 @@
.. _sprout-string-basic_string-hash_value:
###############################################################################
hash_value
###############################################################################

205
source/libs/string/basic_string/index.rst
View file

@ -1,4 +1,5 @@
.. _sprout-string-basic_string:
###############################################################################
basic_string
###############################################################################
@ -63,25 +64,25 @@ Description
Member types
----------------------------------------
======================================== =============================================================================== =======================================
type definition note
======================================== =============================================================================== =======================================
traits_type Traits
value_type Traits::char_type
size_type std::size_t
difference_type std::ptrdiff_t
reference value_type&
const_reference value_type const&
pointer value_type*
const_pointer value_type const*
iterator **ConstexprRandomAccessIterator** convertible to const_iterator,
convertible to pointer
const_iterator **ConstexprRandomAccessIterator** convertible to const_pointer
reverse_iterator sprout::reverse_iterator<iterator>,
**ConstexprRandomAccessIterator**
const_reverse_iterator sprout::reverse_iterator<const_iterator>,
**ConstexprRandomAccessIterator**
======================================== =============================================================================== =======================================
.. csv-table::
:header: type, definition, note
:widths: 4, 4, 4
traits_type, Traits, ""
value_type, Traits::char_type, ""
size_type, std::size_t, ""
difference_type, std::ptrdiff_t, ""
reference, value_type&, ""
const_reference, value_type const&, ""
pointer, value_type*, ""
const_pointer, value_type const*, ""
iterator, **ConstexprRandomAccessIterator**, "| convertible to const_iterator
convertible to pointer"
const_iterator, **ConstexprRandomAccessIterator**, convertible to const_pointer
reverse_iterator, "| sprout::reverse_iterator<iterator>
**ConstexprRandomAccessIterator**", ""
const_reverse_iterator, "| sprout::reverse_iterator<const_iterator>
**ConstexprRandomAccessIterator**", ""
Member functions
----------------------------------------
@ -89,124 +90,124 @@ Member functions
construct/copy/destroy
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
======================================== ===============================================================================
function
======================================== ===============================================================================
:doc:`(constructor) <./constructor->`
:doc:`operator= <./operator-assign>`
======================================== ===============================================================================
.. csv-table::
:header: function
:widths: 4, 8
:doc:`(constructor) <./constructor->`, ""
:doc:`operator= <./operator-assign>`, ""
iterators
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
======================================== ===============================================================================
function
======================================== ===============================================================================
:doc:`begin <./begin>`
:doc:`end <./end>`
:doc:`rbegin <./rbegin>`
:doc:`rend <./rend>`
:doc:`cbegin <./cbegin>`
:doc:`cend <./cend>`
:doc:`crbegin <./crbegin>`
:doc:`crend <./crend>`
======================================== ===============================================================================
.. csv-table::
:header: function
:widths: 4, 8
:doc:`begin <./begin>`, ""
:doc:`end <./end>`, ""
:doc:`rbegin <./rbegin>`, ""
:doc:`rend <./rend>`, ""
:doc:`cbegin <./cbegin>`, ""
:doc:`cend <./cend>`, ""
:doc:`crbegin <./crbegin>`, ""
:doc:`crend <./crend>`, ""
capacity
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
======================================== ===============================================================================
function
======================================== ===============================================================================
:doc:`size <./size>`
:doc:`length <./length>`
:doc:`max_size <./max_size>`
:doc:`resize <./resize>`
:doc:`clear <./clear>`
:doc:`empty <./empty>`
======================================== ===============================================================================
.. csv-table::
:header: function
:widths: 4, 8
:doc:`size <./size>`, ""
:doc:`length <./length>`, ""
:doc:`max_size <./max_size>`, ""
:doc:`resize <./resize>`, ""
:doc:`clear <./clear>`, ""
:doc:`empty <./empty>`, ""
element access
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
======================================== ===============================================================================
function
======================================== ===============================================================================
:doc:`operator[] <./operator-subscript>`
:doc:`at <./at>`
:doc:`front <./front>`
:doc:`back <./back>`
======================================== ===============================================================================
.. csv-table::
:header: function
:widths: 4, 8
:doc:`operator[] <./operator-subscript>`, ""
:doc:`at <./at>`, ""
:doc:`front <./front>`, ""
:doc:`back <./back>`, ""
modifiers
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
======================================== ===============================================================================
function
======================================== ===============================================================================
:doc:`assign <./assign>`
:doc:`swap <./swap>`
======================================== ===============================================================================
.. csv-table::
:header: function
:widths: 4, 8
:doc:`assign <./assign>`, ""
:doc:`swap <./swap>`, ""
string operations
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
============================================================ ===============================================================================
function
============================================================ ===============================================================================
:doc:`data <./data>`
:doc:`c_array <./c_array>`
:doc:`find <./find>`
:doc:`rfind <./rfind>`
:doc:`find_first_of <./find_first_of>`
:doc:`find_last_of <./find_last_of>`
:doc:`find_first_not_of <./find_first_not_of>`
:doc:`find_last_not_of <./find_last_not_of>`
:doc:`substr <./substr>`
:doc:`compare <./compare>`
============================================================ ===============================================================================
.. csv-table::
:header: function
:widths: 4, 8
:doc:`data <./data>`, ""
:doc:`c_array <./c_array>`, ""
:doc:`find <./find>`, ""
:doc:`rfind <./rfind>`, ""
:doc:`find_first_of <./find_first_of>`, ""
:doc:`find_last_of <./find_last_of>`, ""
:doc:`find_first_not_of <./find_first_not_of>`, ""
:doc:`find_last_not_of <./find_last_not_of>`, ""
:doc:`substr <./substr>`, ""
:doc:`compare <./compare>`, ""
conversions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
================================================================================ ===============================================================================
function
================================================================================ ===============================================================================
:doc:`operator std::basic_string <./operator-std-basic_string>`
================================================================================ ===============================================================================
.. csv-table::
:header: function
:widths: 4, 8
:doc:`operator std::basic_string <./operator-std-basic_string>`, ""
construct/copy/destroy (for string iterator)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
============================================================ ===============================================================================
function
============================================================ ===============================================================================
:doc:`operator= <./operator-assign-iterator>`
============================================================ ===============================================================================
.. csv-table::
:header: function
:widths: 4, 8
:doc:`operator= <./operator-assign-iterator>`, ""
modifiers (for string iterator)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
======================================== ===============================================================================
function
======================================== ===============================================================================
:doc:`assign <./assign-iterator>`
======================================== ===============================================================================
.. csv-table::
:header: function
:widths: 4, 8
:doc:`assign <./assign-iterator>`, ""
string operations (for string iterator)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
============================================================ ===============================================================================
function
============================================================ ===============================================================================
:doc:`find <./find-iterator>`
:doc:`rfind <./rfind-iterator>`
:doc:`find_first_of <./find_first_of-iterator>`
:doc:`find_last_of <./find_last_of-iterator>`
:doc:`find_first_not_of <./find_first_not_of-iterator>`
:doc:`find_last_not_of <./find_last_not_of-iterator>`
:doc:`compare <./compare-iterator>`
============================================================ ===============================================================================
.. csv-table::
:header: function
:widths: 4, 8
:doc:`find <./find-iterator>`, ""
:doc:`rfind <./rfind-iterator>`, ""
:doc:`find_first_of <./find_first_of-iterator>`, ""
:doc:`find_last_of <./find_last_of-iterator>`, ""
:doc:`find_first_not_of <./find_first_not_of-iterator>`, ""
:doc:`find_last_not_of <./find_last_not_of-iterator>`, ""
:doc:`compare <./compare-iterator>`, ""
Header
========================================

1
source/libs/string/basic_string/length.rst
View file

@ -1,4 +1,5 @@
.. _sprout-string-basic_string-length:
###############################################################################
length
###############################################################################

1
source/libs/string/basic_string/max_size.rst
View file

@ -1,4 +1,5 @@
.. _sprout-string-basic_string-max_size:
###############################################################################
max_size
###############################################################################

1
source/libs/string/basic_string/operator-assign-iterator.rst
View file

@ -1,4 +1,5 @@
.. _sprout-string-basic_string-operator-assign-iterator:
###############################################################################
operator=
###############################################################################

1
source/libs/string/basic_string/operator-assign.rst
View file

@ -1,4 +1,5 @@
.. _sprout-string-basic_string-operator-assign:
###############################################################################
operator=
###############################################################################

1
source/libs/string/basic_string/operator-equal_to.rst
View file

@ -1,4 +1,5 @@
.. _sprout-string-basic_string-operator-equal_to:
###############################################################################
operator==
###############################################################################

1
source/libs/string/basic_string/operator-greater.rst
View file

@ -1,4 +1,5 @@
.. _sprout-string-basic_string-operator-greater:
###############################################################################
operator>
###############################################################################

1
source/libs/string/basic_string/operator-greater_equal.rst
View file

@ -1,4 +1,5 @@
.. _sprout-string-basic_string-operator-greater_equal:
###############################################################################
operator>=
###############################################################################

1
source/libs/string/basic_string/operator-less.rst
View file

@ -1,4 +1,5 @@
.. _sprout-string-basic_string-operator-less:
###############################################################################
operator<
###############################################################################

1
source/libs/string/basic_string/operator-less_equal.rst
View file

@ -1,4 +1,5 @@
.. _sprout-string-basic_string-operator-less_equal:
###############################################################################
operator<=
###############################################################################

1
source/libs/string/basic_string/operator-not_equal_to.rst
View file

@ -1,4 +1,5 @@
.. _sprout-string-basic_string-operator-not_equal_to:
###############################################################################
operator!=
###############################################################################

1
source/libs/string/basic_string/operator-plus.rst
View file

@ -1,4 +1,5 @@
.. _sprout-string-basic_string-operator-plus:
###############################################################################
operator+
###############################################################################

1
source/libs/string/basic_string/operator-std-basic_string.rst
View file

@ -1,4 +1,5 @@
.. _sprout-string-basic_string-operator-std-basic_string:
###############################################################################
operator std::basic_string
###############################################################################

1
source/libs/string/basic_string/operator-subscript.rst
View file

@ -1,4 +1,5 @@
.. _sprout-string-basic_string-operator-subscript:
###############################################################################
operator[]
###############################################################################

1
source/libs/string/basic_string/rbegin.rst
View file

@ -1,4 +1,5 @@
.. _sprout-string-basic_string-rbegin:
###############################################################################
rbegin
###############################################################################

1
source/libs/string/basic_string/rend.rst
View file

@ -1,4 +1,5 @@
.. _sprout-string-basic_string-rend:
###############################################################################
rend
###############################################################################

3
source/libs/string/basic_string/resize.rst
View file

@ -1,4 +1,5 @@
.. _sprout-string-basic_string-resize:
###############################################################################
resize
###############################################################################
@ -19,7 +20,7 @@ Requires
Effects
========================================
| Alters the length of the string designated by *this as follows:
| Alters the length of the string designated by ``*this`` as follows:
* If ``n <= size()``, the function replaces the string designated by ``*this`` with a string of length n whose elements are a copy of the initial elements of the original string designated by ``*this``.
* If ``n > size()``, the function replaces the string designated by ``*this`` with a string of length n whose first size() elements are a copy of the original string designated by ``*this``, and whose remaining elements are all initialized to c.

1
source/libs/string/basic_string/size.rst
View file

@ -1,4 +1,5 @@
.. _sprout-string-basic_string-size:
###############################################################################
size
###############################################################################

1
source/libs/string/basic_string/std-hash.rst
View file

@ -1,4 +1,5 @@
.. _sprout-string-basic_string-std-hash:
###############################################################################
std::hash
###############################################################################

1
source/libs/string/basic_string/std-tuple_element.rst
View file

@ -1,4 +1,5 @@
.. _sprout-string-basic_string-std-tuple_element:
###############################################################################
std::tuple_element
###############################################################################

1
source/libs/string/basic_string/std-tuple_size.rst
View file

@ -1,4 +1,5 @@
.. _sprout-string-basic_string-std-tuple_size:
###############################################################################
std::tuple_size
###############################################################################

1
source/libs/string/basic_string/substr.rst
View file

@ -1,4 +1,5 @@
.. _sprout-string-basic_string-substr:
###############################################################################
substr
###############################################################################

1
source/libs/string/basic_string/swap-global.rst
View file

@ -1,4 +1,5 @@
.. _sprout-string-basic_string-swap-global:
###############################################################################
swap
###############################################################################

1
source/libs/string/basic_string/swap.rst
View file

@ -1,4 +1,5 @@
.. _sprout-string-basic_string-swap:
###############################################################################
swap
###############################################################################

1
source/libs/string/basic_string/tuple_get.rst
View file

@ -1,4 +1,5 @@
.. _sprout-string-basic_string-tuple_get:
###############################################################################
tuple_get
###############################################################################