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

12
docs/_sources/index.txt
View file

@ -1,4 +1,5 @@
.. _sprout: .. _sprout:
############################################################################### ###############################################################################
Sprout C++ Libraries Sprout C++ Libraries
############################################################################### ###############################################################################
@ -11,6 +12,7 @@ Contents:
libs/index libs/index
.. _sprout-welcome: .. _sprout-welcome:
******************************************************************************* *******************************************************************************
Welcome to the Sprout C++ Libraries Welcome to the Sprout C++ Libraries
******************************************************************************* *******************************************************************************
@ -18,6 +20,7 @@ Welcome to the Sprout C++ Libraries
| C++11 constexpr based Containers, Algorithms, Random numbers, Parsing, Ray tracing, Synthesizer, and others. | C++11 constexpr based Containers, Algorithms, Random numbers, Parsing, Ray tracing, Synthesizer, and others.
.. _sprout-documentation: .. _sprout-documentation:
******************************************************************************* *******************************************************************************
Library Documentation Library Documentation
******************************************************************************* *******************************************************************************
@ -25,6 +28,7 @@ Library Documentation
| The starting point for the documentation of individual libraries is the :doc:`Libraries page <./libs/index>`, which gives a brief description of each library and links to its documentation. | The starting point for the documentation of individual libraries is the :doc:`Libraries page <./libs/index>`, which gives a brief description of each library and links to its documentation.
.. _sprout-project: .. _sprout-project:
******************************************************************************* *******************************************************************************
Project page Project page
******************************************************************************* *******************************************************************************
@ -34,6 +38,7 @@ Project page
* `Wiki (japanese) <http://www.boleros.x0.com/doc/sproutwiki/>`_ * `Wiki (japanese) <http://www.boleros.x0.com/doc/sproutwiki/>`_
.. _sprout-install: .. _sprout-install:
******************************************************************************* *******************************************************************************
Install Install
******************************************************************************* *******************************************************************************
@ -42,16 +47,18 @@ Install
| This library can be used in the header only. | This library can be used in the header only.
.. _sprout-compilers: .. _sprout-compilers:
******************************************************************************* *******************************************************************************
Supported Compilers Supported Compilers
******************************************************************************* *******************************************************************************
Linux: Linux:
* GCC, C++11/14 mode: 4.7.0, 4.7.1, 4.7.2, 4.7.3, 4.8.0, 4.8.1, 4.8.2, 4.9.0 * GCC, C++11/14 mode: 4.7.0, 4.7.1, 4.7.2, 4.7.3, 4.7.4, 4.8.0, 4.8.1, 4.8.2, 4.8.3, 4.9.0
* Clang, C++11/14 mode: 3.2, 3.3, 3.4 * Clang, C++11/14 mode: 3.2, 3.3, 3.4, 3.4.1, 3.4.2
.. _sprout-author: .. _sprout-author:
******************************************************************************* *******************************************************************************
Author Author
******************************************************************************* *******************************************************************************
@ -60,6 +67,7 @@ Author
| `Website <http://bolero-murakami.github.io/>`_ | `Twitter <https://twitter.com/bolero_murakami>`_ | `Facebook <http://www.facebook.com/genya.murakami>`_ | `Blog <http://boleros.hateblo.jp/>`_ | `Github <https://github.com/bolero-MURAKAMI>`_ | `SlideShare <http://www.slideshare.net/GenyaMurakami>`_ | `Website <http://bolero-murakami.github.io/>`_ | `Twitter <https://twitter.com/bolero_murakami>`_ | `Facebook <http://www.facebook.com/genya.murakami>`_ | `Blog <http://boleros.hateblo.jp/>`_ | `Github <https://github.com/bolero-MURAKAMI>`_ | `SlideShare <http://www.slideshare.net/GenyaMurakami>`_
.. _sprout-copyrights: .. _sprout-copyrights:
******************************************************************************* *******************************************************************************
Copyrights Copyrights
******************************************************************************* *******************************************************************************

1
docs/_sources/libs/algorithm/adjacent_find.txt
View file

@ -1,4 +1,5 @@
.. _sprout-algorithm-adjacent_find: .. _sprout-algorithm-adjacent_find:
############################################################################### ###############################################################################
adjacent_find adjacent_find
############################################################################### ###############################################################################

1
docs/_sources/libs/algorithm/all_of.txt
View file

@ -1,4 +1,5 @@
.. _sprout-algorithm-all_of: .. _sprout-algorithm-all_of:
############################################################################### ###############################################################################
all_of all_of
############################################################################### ###############################################################################

1
docs/_sources/libs/algorithm/all_of_equal.txt
View file

@ -1,4 +1,5 @@
.. _sprout-algorithm-all_of_equal: .. _sprout-algorithm-all_of_equal:
############################################################################### ###############################################################################
all_of_equal all_of_equal
############################################################################### ###############################################################################

1
docs/_sources/libs/algorithm/any_of.txt
View file

@ -1,4 +1,5 @@
.. _sprout-algorithm-any_of: .. _sprout-algorithm-any_of:
############################################################################### ###############################################################################
any_of any_of
############################################################################### ###############################################################################

1
docs/_sources/libs/algorithm/any_of_equal.txt
View file

@ -1,4 +1,5 @@
.. _sprout-algorithm-any_of_equal: .. _sprout-algorithm-any_of_equal:
############################################################################### ###############################################################################
any_of_equal any_of_equal
############################################################################### ###############################################################################

1
docs/_sources/libs/algorithm/binary_search.txt
View file

@ -1,4 +1,5 @@
.. _sprout-algorithm-binary_search: .. _sprout-algorithm-binary_search:
############################################################################### ###############################################################################
binary_search binary_search
############################################################################### ###############################################################################

1
docs/_sources/libs/algorithm/clamp.txt
View file

@ -1,4 +1,5 @@
.. _sprout-algorithm-clamp: .. _sprout-algorithm-clamp:
############################################################################### ###############################################################################
clamp clamp
############################################################################### ###############################################################################

1
docs/_sources/libs/algorithm/count.txt
View file

@ -1,4 +1,5 @@
.. _sprout-algorithm-count: .. _sprout-algorithm-count:
############################################################################### ###############################################################################
count count
############################################################################### ###############################################################################

1
docs/_sources/libs/algorithm/count_if.txt
View file

@ -1,4 +1,5 @@
.. _sprout-algorithm-count_if: .. _sprout-algorithm-count_if:
############################################################################### ###############################################################################
count_if count_if
############################################################################### ###############################################################################

1
docs/_sources/libs/algorithm/equal.txt
View file

@ -1,4 +1,5 @@
.. _sprout-algorithm-equal: .. _sprout-algorithm-equal:
############################################################################### ###############################################################################
equal equal
############################################################################### ###############################################################################

1
docs/_sources/libs/algorithm/equal_range.txt
View file

@ -1,4 +1,5 @@
.. _sprout-algorithm-equal_range: .. _sprout-algorithm-equal_range:
############################################################################### ###############################################################################
equal_range equal_range
############################################################################### ###############################################################################

1
docs/_sources/libs/algorithm/find.txt
View file

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

3
docs/_sources/libs/algorithm/find_end.txt
View file

@ -1,4 +1,5 @@
.. _sprout-algorithm-find: .. _sprout-algorithm-find_end:
############################################################################### ###############################################################################
find_end find_end
############################################################################### ###############################################################################

3
docs/_sources/libs/algorithm/find_first_of.txt
View file

@ -1,4 +1,5 @@
.. _sprout-algorithm-find: .. _sprout-algorithm-find_first_of:
############################################################################### ###############################################################################
find_first_of find_first_of
############################################################################### ###############################################################################

1
docs/_sources/libs/algorithm/find_if.txt
View file

@ -1,4 +1,5 @@
.. _sprout-algorithm-find_if: .. _sprout-algorithm-find_if:
############################################################################### ###############################################################################
find_if find_if
############################################################################### ###############################################################################

1
docs/_sources/libs/algorithm/find_if_not.txt
View file

@ -1,4 +1,5 @@
.. _sprout-algorithm-find_if_not: .. _sprout-algorithm-find_if_not:
############################################################################### ###############################################################################
find_if_not find_if_not
############################################################################### ###############################################################################

148
docs/_sources/libs/algorithm/index.txt
View file

@ -1,4 +1,5 @@
.. _sprout-algorithm: .. _sprout-algorithm:
############################################################################### ###############################################################################
Sprout.Algorithm Sprout.Algorithm
############################################################################### ###############################################################################
@ -50,110 +51,117 @@ Sprout.Algorithm
clamp clamp
.. _sprout-algorithm-non_modifying: .. _sprout-algorithm-non_modifying:
******************************************************************************* *******************************************************************************
Non-modifying sequence operations Non-modifying sequence operations
******************************************************************************* *******************************************************************************
======================================== =============================================================================== .. csv-table::
function :header: function
======================================== =============================================================================== :widths: 4, 8
:doc:`all_of <./all_of>`
:doc:`all_of_equal <./all_of_equal>` :doc:`all_of <./all_of>`, ""
:doc:`any_of <./any_of>` :doc:`all_of_equal <./all_of_equal>`, ""
:doc:`any_of_equal <./any_of_equal>` :doc:`any_of <./any_of>`, ""
:doc:`none_of <./none_of>` :doc:`any_of_equal <./any_of_equal>`, ""
:doc:`none_of_equal <./none_of_equal>` :doc:`none_of <./none_of>`, ""
:doc:`one_of <./one_of>` :doc:`none_of_equal <./none_of_equal>`, ""
:doc:`one_of_equal <./one_of_equal>` :doc:`one_of <./one_of>`, ""
:doc:`find <./find>` :doc:`one_of_equal <./one_of_equal>`, ""
:doc:`find_if <./find_if>` :doc:`find <./find>`, ""
:doc:`find_if_not <./find_if_not>` :doc:`find_if <./find_if>`, ""
:doc:`find_end <./find_end>` :doc:`find_if_not <./find_if_not>`, ""
:doc:`find_first_of <./find_first_of>` :doc:`find_end <./find_end>`, ""
:doc:`adjacent_find <./adjacent_find>` :doc:`find_first_of <./find_first_of>`, ""
:doc:`count <./count>` :doc:`adjacent_find <./adjacent_find>`, ""
:doc:`count_if <./count_if>` :doc:`count <./count>`, ""
:doc:`mismatch <./mismatch>` :doc:`count_if <./count_if>`, ""
:doc:`equal <./equal>` :doc:`mismatch <./mismatch>`, ""
:doc:`is_permutation <./is_permutation>` :doc:`equal <./equal>`, ""
:doc:`search <./search>` :doc:`is_permutation <./is_permutation>`, ""
:doc:`search_n <./search_n>` :doc:`search <./search>`, ""
======================================== =============================================================================== :doc:`search_n <./search_n>`, ""
.. _sprout-algorithm-non_modifying-sorting: .. _sprout-algorithm-non_modifying-sorting:
Sorting Sorting
======================================== ========================================
================================================================================ =============================================================================== .. csv-table::
function :header: function
================================================================================ =============================================================================== :widths: 4, 8
:doc:`is_sorted <./is_sorted>`
:doc:`is_sorted_until <./is_sorted_until>` :doc:`is_sorted <./is_sorted>`, ""
:doc:`is_increasing <./is_increasing>` :doc:`is_sorted_until <./is_sorted_until>`, ""
:doc:`is_decreasing <./is_decreasing>` :doc:`is_increasing <./is_increasing>`, ""
:doc:`is_strictly_increasing <./is_strictly_increasing>` :doc:`is_decreasing <./is_decreasing>`, ""
:doc:`is_strictly_decreasing <./is_strictly_decreasing>` :doc:`is_strictly_increasing <./is_strictly_increasing>`, ""
================================================================================ =============================================================================== :doc:`is_strictly_decreasing <./is_strictly_decreasing>`, ""
.. _sprout-algorithm-non_modifying-binary: .. _sprout-algorithm-non_modifying-binary:
Binary search Binary search
======================================== ========================================
======================================== =============================================================================== .. csv-table::
function :header: function
======================================== =============================================================================== :widths: 4, 8
:doc:`lower_bound <./lower_bound>`
:doc:`upper_bound <./upper_bound>` :doc:`lower_bound <./lower_bound>`, ""
:doc:`equal_range <./equal_range>` :doc:`upper_bound <./upper_bound>`, ""
:doc:`binary_search <./binary_search>` :doc:`equal_range <./equal_range>`, ""
======================================== =============================================================================== :doc:`binary_search <./binary_search>`, ""
.. _sprout-algorithm-non_modifying-heap: .. _sprout-algorithm-non_modifying-heap:
Heap operations Heap operations
======================================== ========================================
======================================== =============================================================================== .. csv-table::
function :header: function
======================================== =============================================================================== :widths: 4, 8
:doc:`is_heap <./is_heap>`
:doc:`is_heap_until <./is_heap_until>` :doc:`is_heap <./is_heap>`, ""
======================================== =============================================================================== :doc:`is_heap_until <./is_heap_until>`, ""
.. _sprout-algorithm-non_modifying-minmax: .. _sprout-algorithm-non_modifying-minmax:
Minimum and maximum Minimum and maximum
======================================== ========================================
======================================== =============================================================================== .. csv-table::
function :header: function
======================================== =============================================================================== :widths: 4, 8
:doc:`min <./min>`
:doc:`max <./max>` :doc:`min <./min>`, ""
:doc:`minmax <./minmax>` :doc:`max <./max>`, ""
:doc:`min_element <./min_element>` :doc:`minmax <./minmax>`, ""
:doc:`max_element <./max_element>` :doc:`min_element <./min_element>`, ""
:doc:`minmax_element <./minmax_element>` :doc:`max_element <./max_element>`, ""
======================================== =============================================================================== :doc:`minmax_element <./minmax_element>`, ""
.. _sprout-algorithm-non_modifying-lexicographical: .. _sprout-algorithm-non_modifying-lexicographical:
Lexicographical comparison Lexicographical comparison
======================================== ========================================
================================================================================ =============================================================================== .. csv-table::
function :header: function
================================================================================ =============================================================================== :widths: 4, 8
:doc:`lexicographical_compare <./lexicographical_compare>`
:doc:`tristate_lexicographical_compare <./tristate_lexicographical_compare>` :doc:`lexicographical_compare <./lexicographical_compare>`, ""
================================================================================ =============================================================================== :doc:`tristate_lexicographical_compare <./tristate_lexicographical_compare>`, ""
.. _sprout-algorithm-non_modifying-clamp: .. _sprout-algorithm-non_modifying-clamp:
Clamp algorithm Clamp algorithm
======================================== ========================================
======================================== =============================================================================== .. csv-table::
function :header: function
======================================== =============================================================================== :widths: 4, 8
:doc:`clamp <./clamp>`
======================================== =============================================================================== :doc:`clamp <./clamp>`, ""
Header Header
======================================== ========================================

1
docs/_sources/libs/algorithm/is_decreasing.txt
View file

@ -1,4 +1,5 @@
.. _sprout-algorithm-is_decreasing: .. _sprout-algorithm-is_decreasing:
############################################################################### ###############################################################################
is_decreasing is_decreasing
############################################################################### ###############################################################################

1
docs/_sources/libs/algorithm/is_heap.txt
View file

@ -1,4 +1,5 @@
.. _sprout-algorithm-is_heap: .. _sprout-algorithm-is_heap:
############################################################################### ###############################################################################
is_heap is_heap
############################################################################### ###############################################################################

1
docs/_sources/libs/algorithm/is_heap_until.txt
View file

@ -1,4 +1,5 @@
.. _sprout-algorithm-is_heap_until: .. _sprout-algorithm-is_heap_until:
############################################################################### ###############################################################################
is_heap_until is_heap_until
############################################################################### ###############################################################################

1
docs/_sources/libs/algorithm/is_increasing.txt
View file

@ -1,4 +1,5 @@
.. _sprout-algorithm-is_increasing: .. _sprout-algorithm-is_increasing:
############################################################################### ###############################################################################
is_increasing is_increasing
############################################################################### ###############################################################################

1
docs/_sources/libs/algorithm/is_permutation.txt
View file

@ -1,4 +1,5 @@
.. _sprout-algorithm-is_permutation: .. _sprout-algorithm-is_permutation:
############################################################################### ###############################################################################
is_permutation is_permutation
############################################################################### ###############################################################################

1
docs/_sources/libs/algorithm/is_sorted.txt
View file

@ -1,4 +1,5 @@
.. _sprout-algorithm-is_sorted: .. _sprout-algorithm-is_sorted:
############################################################################### ###############################################################################
is_sorted is_sorted
############################################################################### ###############################################################################

1
docs/_sources/libs/algorithm/is_sorted_until.txt
View file

@ -1,4 +1,5 @@
.. _sprout-algorithm-is_sorted_until: .. _sprout-algorithm-is_sorted_until:
############################################################################### ###############################################################################
is_sorted_until is_sorted_until
############################################################################### ###############################################################################

1
docs/_sources/libs/algorithm/is_strictly_decreasing.txt
View file

@ -1,4 +1,5 @@
.. _sprout-algorithm-is_strictly_decreasing: .. _sprout-algorithm-is_strictly_decreasing:
############################################################################### ###############################################################################
is_strictly_decreasing is_strictly_decreasing
############################################################################### ###############################################################################

1
docs/_sources/libs/algorithm/is_strictly_increasing.txt
View file

@ -1,4 +1,5 @@
.. _sprout-algorithm-is_strictly_increasing: .. _sprout-algorithm-is_strictly_increasing:
############################################################################### ###############################################################################
is_strictly_increasing is_strictly_increasing
############################################################################### ###############################################################################

1
docs/_sources/libs/algorithm/lexicographical_compare.txt
View file

@ -1,4 +1,5 @@
.. _sprout-algorithm-lexicographical_compare: .. _sprout-algorithm-lexicographical_compare:
############################################################################### ###############################################################################
lexicographical_compare lexicographical_compare
############################################################################### ###############################################################################

1
docs/_sources/libs/algorithm/lower_bound.txt
View file

@ -1,4 +1,5 @@
.. _sprout-algorithm-lower_bound: .. _sprout-algorithm-lower_bound:
############################################################################### ###############################################################################
lower_bound lower_bound
############################################################################### ###############################################################################

1
docs/_sources/libs/algorithm/max.txt
View file

@ -1,4 +1,5 @@
.. _sprout-algorithm-max: .. _sprout-algorithm-max:
############################################################################### ###############################################################################
max max
############################################################################### ###############################################################################

1
docs/_sources/libs/algorithm/max_element.txt
View file

@ -1,4 +1,5 @@
.. _sprout-algorithm-max_element: .. _sprout-algorithm-max_element:
############################################################################### ###############################################################################
max_element max_element
############################################################################### ###############################################################################

1
docs/_sources/libs/algorithm/min.txt
View file

@ -1,4 +1,5 @@
.. _sprout-algorithm-min: .. _sprout-algorithm-min:
############################################################################### ###############################################################################
min min
############################################################################### ###############################################################################

1
docs/_sources/libs/algorithm/min_element.txt
View file

@ -1,4 +1,5 @@
.. _sprout-algorithm-min_element: .. _sprout-algorithm-min_element:
############################################################################### ###############################################################################
min_element min_element
############################################################################### ###############################################################################

1
docs/_sources/libs/algorithm/minmax.txt
View file

@ -1,4 +1,5 @@
.. _sprout-algorithm-minmax: .. _sprout-algorithm-minmax:
############################################################################### ###############################################################################
minmax minmax
############################################################################### ###############################################################################

1
docs/_sources/libs/algorithm/minmax_element.txt
View file

@ -1,4 +1,5 @@
.. _sprout-algorithm-minmax_element: .. _sprout-algorithm-minmax_element:
############################################################################### ###############################################################################
minmax_element minmax_element
############################################################################### ###############################################################################

1
docs/_sources/libs/algorithm/mismatch.txt
View file

@ -1,4 +1,5 @@
.. _sprout-algorithm-mismatch: .. _sprout-algorithm-mismatch:
############################################################################### ###############################################################################
mismatch mismatch
############################################################################### ###############################################################################

1
docs/_sources/libs/algorithm/none_of.txt
View file

@ -1,4 +1,5 @@
.. _sprout-algorithm-none_of: .. _sprout-algorithm-none_of:
############################################################################### ###############################################################################
none_of none_of
############################################################################### ###############################################################################

1
docs/_sources/libs/algorithm/none_of_equal.txt
View file

@ -1,4 +1,5 @@
.. _sprout-algorithm-none_of_equal: .. _sprout-algorithm-none_of_equal:
############################################################################### ###############################################################################
none_of_equal none_of_equal
############################################################################### ###############################################################################

1
docs/_sources/libs/algorithm/one_of.txt
View file

@ -1,4 +1,5 @@
.. _sprout-algorithm-one_of: .. _sprout-algorithm-one_of:
############################################################################### ###############################################################################
one_of one_of
############################################################################### ###############################################################################

1
docs/_sources/libs/algorithm/one_of_equal.txt
View file

@ -1,4 +1,5 @@
.. _sprout-algorithm-one_of_equal: .. _sprout-algorithm-one_of_equal:
############################################################################### ###############################################################################
one_of_equal one_of_equal
############################################################################### ###############################################################################

1
docs/_sources/libs/algorithm/search.txt
View file

@ -1,4 +1,5 @@
.. _sprout-algorithm-search: .. _sprout-algorithm-search:
############################################################################### ###############################################################################
search search
############################################################################### ###############################################################################

1
docs/_sources/libs/algorithm/search_n.txt
View file

@ -1,4 +1,5 @@
.. _sprout-algorithm-search_n: .. _sprout-algorithm-search_n:
############################################################################### ###############################################################################
search_n search_n
############################################################################### ###############################################################################

1
docs/_sources/libs/algorithm/tristate_lexicographical_compare.txt
View file

@ -1,4 +1,5 @@
.. _sprout-algorithm-tristate_lexicographical_compare: .. _sprout-algorithm-tristate_lexicographical_compare:
############################################################################### ###############################################################################
tristate_lexicographical_compare tristate_lexicographical_compare
############################################################################### ###############################################################################

1
docs/_sources/libs/algorithm/upper_bound.txt
View file

@ -1,4 +1,5 @@
.. _sprout-algorithm-upper_bound: .. _sprout-algorithm-upper_bound:
############################################################################### ###############################################################################
upper_bound upper_bound
############################################################################### ###############################################################################

1
docs/_sources/libs/array/array/assign.txt
View file

@ -1,4 +1,5 @@
.. _sprout-array-array-assign: .. _sprout-array-array-assign:
############################################################################### ###############################################################################
assign assign
############################################################################### ###############################################################################

1
docs/_sources/libs/array/array/at.txt
View file

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

1
docs/_sources/libs/array/array/back.txt
View file

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

1
docs/_sources/libs/array/array/begin.txt
View file

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

1
docs/_sources/libs/array/array/c_array.txt
View file

@ -1,4 +1,5 @@
.. _sprout-array-array-c_array: .. _sprout-array-array-c_array:
############################################################################### ###############################################################################
c_array c_array
############################################################################### ###############################################################################

1
docs/_sources/libs/array/array/cbegin.txt
View file

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

1
docs/_sources/libs/array/array/cend.txt
View file

@ -1,4 +1,5 @@
.. _sprout-array-array-cend: .. _sprout-array-array-cend:
############################################################################### ###############################################################################
cend cend
############################################################################### ###############################################################################

1
docs/_sources/libs/array/array/crbegin.txt
View file

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

1
docs/_sources/libs/array/array/crend.txt
View file

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

1
docs/_sources/libs/array/array/data.txt
View file

@ -1,4 +1,5 @@
.. _sprout-array-array-data: .. _sprout-array-array-data:
############################################################################### ###############################################################################
data data
############################################################################### ###############################################################################

1
docs/_sources/libs/array/array/empty.txt
View file

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

1
docs/_sources/libs/array/array/end.txt
View file

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

1
docs/_sources/libs/array/array/fill.txt
View file

@ -1,4 +1,5 @@
.. _sprout-array-array-fill: .. _sprout-array-array-fill:
############################################################################### ###############################################################################
fill fill
############################################################################### ###############################################################################

1
docs/_sources/libs/array/array/front.txt
View file

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

1
docs/_sources/libs/array/array/hash_value.txt
View file

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

129
docs/_sources/libs/array/array/index.txt
View file

@ -1,4 +1,5 @@
.. _sprout-array-array: .. _sprout-array-array:
############################################################################### ###############################################################################
array array
############################################################################### ###############################################################################
@ -42,24 +43,24 @@ Description
Member types Member types
---------------------------------------- ----------------------------------------
======================================== =============================================================================== ======================================= .. csv-table::
type definition note :header: type, definition, note
======================================== =============================================================================== ======================================= :widths: 4, 4, 4
reference T&
const_reference T const& reference, T&, ""
iterator **ConstexprRandomAccessIterator** convertible to const_iterator, const_reference, T const&, ""
convertible to pointer iterator, **ConstexprRandomAccessIterator**, "| convertible to const_iterator
const_iterator **ConstexprRandomAccessIterator** convertible to const_pointer convertible to pointer"
size_type std::size_t const_iterator, **ConstexprRandomAccessIterator**, convertible to const_pointer
difference_type std::ptrdiff_t size_type, std::size_t, ""
value_type T difference_type, std::ptrdiff_t, ""
pointer T* value_type, T, ""
const_pointer T const* pointer, T*, ""
reverse_iterator sprout::reverse_iterator<iterator>, const_pointer, T const*, ""
**ConstexprRandomAccessIterator** reverse_iterator, "| sprout::reverse_iterator<iterator>
const_reverse_iterator sprout::reverse_iterator<const_iterator>, **ConstexprRandomAccessIterator**", ""
**ConstexprRandomAccessIterator** const_reverse_iterator, "| sprout::reverse_iterator<const_iterator>
======================================== =============================================================================== ======================================= **ConstexprRandomAccessIterator**", ""
Member functions Member functions
---------------------------------------- ----------------------------------------
@ -67,72 +68,72 @@ Member functions
(initializer) (initializer)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
======================================== =============================================================================== .. csv-table::
function :header: function
======================================== =============================================================================== :widths: 4, 8
:doc:`(initializer) <./initializer->`
======================================== =============================================================================== :doc:`(initializer) <./initializer->`, ""
construct/copy/destroy construct/copy/destroy
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
======================================== =============================================================================== .. csv-table::
function :header: function
======================================== =============================================================================== :widths: 4, 8
:doc:`operator= <./operator-assign>`
======================================== =============================================================================== :doc:`operator= <./operator-assign>`, ""
modifiers modifiers
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
======================================== =============================================================================== .. csv-table::
function :header: function
======================================== =============================================================================== :widths: 4, 8
:doc:`fill <./fill>`
:doc:`assign <./assign>` :doc:`fill <./fill>`, ""
:doc:`swap <./swap>` :doc:`assign <./assign>`, ""
======================================== =============================================================================== :doc:`swap <./swap>`, ""
iterators iterators
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
======================================== =============================================================================== .. csv-table::
function :header: function
======================================== =============================================================================== :widths: 4, 8
:doc:`begin <./begin>`
:doc:`end <./end>` :doc:`begin <./begin>`, ""
:doc:`rbegin <./rbegin>` :doc:`end <./end>`, ""
:doc:`rend <./rend>` :doc:`rbegin <./rbegin>`, ""
:doc:`cbegin <./cbegin>` :doc:`rend <./rend>`, ""
:doc:`cend <./cend>` :doc:`cbegin <./cbegin>`, ""
:doc:`crbegin <./crbegin>` :doc:`cend <./cend>`, ""
:doc:`crend <./crend>` :doc:`crbegin <./crbegin>`, ""
======================================== =============================================================================== :doc:`crend <./crend>`, ""
capacity capacity
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
======================================== =============================================================================== .. csv-table::
function :header: function
======================================== =============================================================================== :widths: 4, 8
:doc:`size <./size>`
:doc:`max_size <./max_size>` :doc:`size <./size>`, ""
:doc:`empty <./empty>` :doc:`max_size <./max_size>`, ""
======================================== =============================================================================== :doc:`empty <./empty>`, ""
element access element access
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
======================================== =============================================================================== .. csv-table::
function :header: function
======================================== =============================================================================== :widths: 4, 8
:doc:`operator[] <./operator-subscript>`
:doc:`at <./at>` :doc:`operator[] <./operator-subscript>`, ""
:doc:`front <./front>` :doc:`at <./at>`, ""
:doc:`back <./back>` :doc:`front <./front>`, ""
:doc:`data <./data>` :doc:`back <./back>`, ""
:doc:`c_array <./c_array>` :doc:`data <./data>`, ""
======================================== =============================================================================== :doc:`c_array <./c_array>`, ""
Header Header
======================================== ========================================

1
docs/_sources/libs/array/array/initializer-.txt
View file

@ -1,4 +1,5 @@
.. _sprout-array-array-initializer-: .. _sprout-array-array-initializer-:
############################################################################### ###############################################################################
(initializer) (initializer)
############################################################################### ###############################################################################

1
docs/_sources/libs/array/array/max_size.txt
View file

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

1
docs/_sources/libs/array/array/operator-assign.txt
View file

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

1
docs/_sources/libs/array/array/operator-equal_to.txt
View file

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

1
docs/_sources/libs/array/array/operator-greater.txt
View file

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

1
docs/_sources/libs/array/array/operator-greater_equal.txt
View file

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

1
docs/_sources/libs/array/array/operator-less.txt
View file

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

1
docs/_sources/libs/array/array/operator-less_equal.txt
View file

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

1
docs/_sources/libs/array/array/operator-not_equal_to.txt
View file

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

1
docs/_sources/libs/array/array/operator-subscript.txt
View file

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

1
docs/_sources/libs/array/array/rbegin.txt
View file

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

1
docs/_sources/libs/array/array/rend.txt
View file

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

1
docs/_sources/libs/array/array/size.txt
View file

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

1
docs/_sources/libs/array/array/std-hash.txt
View file

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

1
docs/_sources/libs/array/array/std-tuple_element.txt
View file

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

1
docs/_sources/libs/array/array/std-tuple_size.txt
View file

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

1
docs/_sources/libs/array/array/swap-global.txt
View file

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

1
docs/_sources/libs/array/array/swap.txt
View file

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

1
docs/_sources/libs/array/array/tuple_get.txt
View file

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

99
docs/_sources/libs/array/index.txt
View file

@ -1,4 +1,5 @@
.. _sprout-array: .. _sprout-array:
############################################################################### ###############################################################################
Sprout.Array Sprout.Array
############################################################################### ###############################################################################
@ -16,6 +17,7 @@ Sprout.Array
array/operator-greater_equal array/operator-greater_equal
to_array to_array
make_array make_array
make_array_without_narrowing
make_common_array make_common_array
array/std-tuple_size array/std-tuple_size
array/std-tuple_element array/std-tuple_element
@ -29,11 +31,11 @@ Description
Classes Classes
---------------------------------------- ----------------------------------------
======================================== =============================================================================== .. csv-table::
class :header: class
======================================== =============================================================================== :widths: 4, 8
:doc:`array <./array/index>`
======================================== =============================================================================== :doc:`array <./array/index>`, ""
Non-member functions Non-member functions
---------------------------------------- ----------------------------------------
@ -41,67 +43,68 @@ Non-member functions
specialized algorithms specialized algorithms
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
======================================== =============================================================================== .. csv-table::
function :header: function
======================================== =============================================================================== :widths: 4, 8
:doc:`swap <./array/swap-global>`
======================================== =============================================================================== :doc:`swap <./array/swap-global>`, ""
comparisons comparisons
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
============================================================ =============================================================================== .. csv-table::
function :header: function
============================================================ =============================================================================== :widths: 4, 8
:doc:`operator== <./array/operator-equal_to>`
:doc:`operator!= <./array/operator-not_equal_to>` :doc:`operator== <./array/operator-equal_to>`, ""
:doc:`operator\< <./array/operator-less>` :doc:`operator!= <./array/operator-not_equal_to>`, ""
:doc:`operator\> <./array/operator-greater>` :doc:`operator\< <./array/operator-less>`, ""
:doc:`operator\<= <./array/operator-less_equal>` :doc:`operator\> <./array/operator-greater>`, ""
:doc:`operator\>= <./array/operator-greater_equal>` :doc:`operator\<= <./array/operator-less_equal>`, ""
============================================================ =============================================================================== :doc:`operator\>= <./array/operator-greater_equal>`, ""
array generators array generators
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
============================================================ =============================================================================== .. csv-table::
function :header: function
============================================================ =============================================================================== :widths: 4, 8
:doc:`to_array <./to_array>`
:doc:`make_array <./make_array>` :doc:`to_array <./to_array>`, ""
:doc:`make_common_array <./make_common_array>` :doc:`make_array <./make_array>`, ""
============================================================ =============================================================================== :doc:`make_array_without_narrowing <./make_array_without_narrowing>`, ""
:doc:`make_common_array <./make_common_array>`, ""
Tuple interface Tuple interface
---------------------------------------- ----------------------------------------
============================================================ =============================================================================== .. csv-table::
matafunction :header: matafunction
============================================================ =============================================================================== :widths: 4, 8
:doc:`std::tuple_size <./array/std-tuple_size>`
:doc:`std::tuple_element <./array/std-tuple_element>`
============================================================ ===============================================================================
============================================================ =============================================================================== :doc:`std::tuple_size <./array/std-tuple_size>`, ""
function :doc:`std::tuple_element <./array/std-tuple_element>`, ""
============================================================ ===============================================================================
:doc:`tuple_get <./array/tuple_get>` .. csv-table::
============================================================ =============================================================================== :header: function
:widths: 4, 8
:doc:`tuple_get <./array/tuple_get>`, ""
Hash support Hash support
---------------------------------------- ----------------------------------------
============================================================ =============================================================================== .. csv-table::
class :header: class
============================================================ =============================================================================== :widths: 4, 8
:doc:`std::hash <./array/std-hash>`
============================================================ ===============================================================================
======================================== =============================================================================== :doc:`std::hash <./array/std-hash>`, ""
function
======================================== =============================================================================== .. csv-table::
:doc:`hash_value <./array/hash_value>` :header: function
======================================== =============================================================================== :widths: 4, 8
:doc:`hash_value <./array/hash_value>`, ""
Header Header
======================================== ========================================

4
docs/_sources/libs/array/make_array.txt
View file

@ -1,4 +1,5 @@
.. _sprout-array-make_array: .. _sprout-array-make_array:
############################################################################### ###############################################################################
make_array make_array
############################################################################### ###############################################################################
@ -25,6 +26,9 @@ Remarks
| A first version needs to be specified in the template parameters explicitly type T of the elements in the array. | A first version needs to be specified in the template parameters explicitly type T of the elements in the array.
| And, the type of the elements in the array is a decayed common type of all arguments in the second version. | And, the type of the elements in the array is a decayed common type of all arguments in the second version.
|
| Narrowing conversion is **not** prohibited in this make_array function. (It behaves like a static_cast)
| If you want to prohibit narrowing conversion, use :doc:`make_array_without_narrowing <./make_array_without_narrowing>` function.
Examples Examples
======================================== ========================================

51
docs/_sources/libs/array/make_array_without_narrowing.txt Normal file
View file

@ -0,0 +1,51 @@
.. _sprout-array-make_array_without_narrowing:
###############################################################################
make_array_without_narrowing
###############################################################################
Interface
========================================
.. sourcecode:: c++
template<typename T, typename... Types>
inline SPROUT_CONSTEXPR sprout::array<typename std::remove_cv<T>::type, sizeof...(Types)>
make_array_without_narrowing(Types&&... args);
template</*implementation-defined*/, typename... Types>
inline SPROUT_CONSTEXPR sprout::array<typename sprout::common_decay<Types...>::type, sizeof...(Types)>
make_array_without_narrowing(Types&&... args);
Returns
========================================
| Returns an array object initialized with the argument all elements.
Remarks
========================================
| A first version needs to be specified in the template parameters explicitly type T of the elements in the array.
| And, the type of the elements in the array is a decayed common type of all arguments in the second version.
|
| Narrowing conversion is prohibited in this make_array_without_narrowing function.
Examples
========================================
.. sourcecode:: c++
#include <sprout/array.hpp>
SPROUT_STATIC_CONSTEXPR auto x = sprout::make_array_without_narrowing<int>(1, 2, 3, 4, 5, 6, 7, 8, 9, 10);
static_assert(x.size() == 10, "array x initialized with 10 elements.");
Complexity
========================================
| Recursive function invocations in *O(1)* (constant) depth.
Header
========================================
| ``sprout/array/make_array.hpp``
| Convenience header: ``sprout/array.hpp``

1
docs/_sources/libs/array/make_common_array.txt
View file

@ -1,4 +1,5 @@
.. _sprout-array-make_common_array: .. _sprout-array-make_common_array:
############################################################################### ###############################################################################
make_common_array make_common_array
############################################################################### ###############################################################################

1
docs/_sources/libs/array/to_array.txt
View file

@ -1,4 +1,5 @@
.. _sprout-array-to_array: .. _sprout-array-to_array:
############################################################################### ###############################################################################
to_array to_array
############################################################################### ###############################################################################

19
docs/_sources/libs/index.txt
View file

@ -1,4 +1,5 @@
.. _sprout-libraries: .. _sprout-libraries:
############################################################################### ###############################################################################
Libraries Libraries
############################################################################### ###############################################################################
@ -9,8 +10,10 @@ Libraries
array/index array/index
algorithm/index algorithm/index
string/index string/index
index_tuple/index
.. _sprout-listed_by_alphabetically: .. _sprout-listed_by_alphabetically:
******************************************************************************* *******************************************************************************
Libraries Listed Alphabetically Libraries Listed Alphabetically
******************************************************************************* *******************************************************************************
@ -18,13 +21,16 @@ Libraries Listed Alphabetically
* :doc:`algorithm <./algorithm/index>` - Standard library like generic algorithms. * :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:`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. * :doc:`string <./string/index>` - Compile-time string of fixed-length buffer.
* :doc:`index_tuple <./index_tuple/index>` - Compile-time integer sequences and generators.
.. _sprout-listed_by_category: .. _sprout-listed_by_category:
******************************************************************************* *******************************************************************************
Libraries Listed by Category Libraries Listed by Category
******************************************************************************* *******************************************************************************
.. _sprout-listed_by_category-containers: .. _sprout-listed_by_category-containers:
Containers and Data structures Containers and Data structures
======================================= =======================================
@ -36,6 +42,7 @@ Containers and Data structures
* :doc:`bitset <./bitset/index>` * :doc:`bitset <./bitset/index>`
.. _sprout-listed_by_category-algorithms: .. _sprout-listed_by_category-algorithms:
Algorithms Algorithms
======================================= =======================================
@ -46,6 +53,7 @@ Algorithms
* :doc:`range_adaptor <./range/adaptor/index>` * :doc:`range_adaptor <./range/adaptor/index>`
.. _sprout-listed_by_category-container_supports: .. _sprout-listed_by_category-container_supports:
Container supports Container supports
======================================= =======================================
@ -55,18 +63,21 @@ Container supports
* :doc:`container <./container/index>` * :doc:`container <./container/index>`
.. _sprout-listed_by_category-function_objects: .. _sprout-listed_by_category-function_objects:
Function Objects Function Objects
======================================= =======================================
* :doc:`functional <./functional/index>` * :doc:`functional <./functional/index>`
.. _sprout-listed_by_category-iterators: .. _sprout-listed_by_category-iterators:
Iterators Iterators
======================================= =======================================
* :doc:`iterator <./iterator/index>` * :doc:`iterator <./iterator/index>`
.. _sprout-listed_by_category-mathematics: .. _sprout-listed_by_category-mathematics:
Mathematics Mathematics
======================================= =======================================
@ -76,6 +87,7 @@ Mathematics
* :doc:`rational <./rational/index>` * :doc:`rational <./rational/index>`
.. _sprout-listed_by_category-template_metaprogramming: .. _sprout-listed_by_category-template_metaprogramming:
Template Metaprogramming Template Metaprogramming
======================================= =======================================
@ -84,12 +96,14 @@ Template Metaprogramming
* :doc:`type <./type/index>` * :doc:`type <./type/index>`
.. _sprout-listed_by_category-preprocessor_metaprogramming: .. _sprout-listed_by_category-preprocessor_metaprogramming:
Preprocessor Metaprogramming Preprocessor Metaprogramming
======================================= =======================================
* :doc:`preprocessor <./preprocessor/index>` * :doc:`preprocessor <./preprocessor/index>`
.. _sprout-listed_by_category-domain_specific: .. _sprout-listed_by_category-domain_specific:
Domain specific Domain specific
======================================= =======================================
@ -97,24 +111,28 @@ Domain specific
* :doc:`checksum <./checksum/index>` * :doc:`checksum <./checksum/index>`
.. _sprout-listed_by_category-parsing: .. _sprout-listed_by_category-parsing:
Parsing Parsing
======================================= =======================================
* :doc:`weed <./weed/index>` * :doc:`weed <./weed/index>`
.. _sprout-listed_by_category-ray_tracing: .. _sprout-listed_by_category-ray_tracing:
Ray tracing Ray tracing
======================================= =======================================
* :doc:`darkroom <./darkroom/index>` * :doc:`darkroom <./darkroom/index>`
.. _sprout-listed_by_category-synthesizer: .. _sprout-listed_by_category-synthesizer:
Synthesizer Synthesizer
======================================= =======================================
* :doc:`compost <./compost/index>` * :doc:`compost <./compost/index>`
.. _sprout-listed_by_category-miscellaneous: .. _sprout-listed_by_category-miscellaneous:
Miscellaneous Miscellaneous
======================================= =======================================
@ -122,6 +140,7 @@ Miscellaneous
* :doc:`bit_operation <./bit_operation/index>` * :doc:`bit_operation <./bit_operation/index>`
.. _sprout-listed_by_category-c-compatible: .. _sprout-listed_by_category-c-compatible:
C-compatible C-compatible
======================================= =======================================

128
docs/_sources/libs/index_tuple/index.txt Normal file
View file

@ -0,0 +1,128 @@
.. _sprout-index_tuple:
###############################################################################
Sprout.IndexTuple
###############################################################################
.. toctree::
:hidden:
index_t
uindex_t
integer_sequence/index
index_tuple
uindex_tuple
index_sequence
make_integer_sequence
make_index_tuple
make_uindex_tuple
integer_pack
index_pack
uindex_pack
integer_range
index_range
uindex_range
integer_n
index_n
uindex_n
make_index_sequence
index_sequence_for
enable_make_indexes
literal-_indexes
literal-_uindexes
integer_sequence/std-tuple_size
integer_sequence/std-tuple_element
integer_sequence/tuple_get
Description
========================================
Index types
----------------------------------------
.. csv-table::
:header: type
:widths: 4, 8
:doc:`index_t <./index_t>`, ""
:doc:`uindex_t <./uindex_t>`, ""
Integer sequence class
----------------------------------------
.. csv-table::
:header: class
:widths: 4, 8
:doc:`integer_sequence <./integer_sequence/index>`, ""
integer_sequence aliases
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. csv-table::
:header: alias
:widths: 4, 8
:doc:`index_tuple <./index_tuple>`, ""
:doc:`uindex_tuple <./uindex_tuple>`, ""
:doc:`index_sequence <./index_sequence>`, ""
Generator metafunctions
----------------------------------------
.. csv-table::
:header: metafunction
:widths: 4, 8
:doc:`make_integer_sequence <./make_integer_sequence>`, ""
:doc:`make_index_tuple <./make_index_tuple/index>`, ""
:doc:`make_uindex_tuple <./make_uindex_tuple/index>`, ""
:doc:`integer_pack <./integer_pack>`, ""
:doc:`index_pack <./index_pack>`, ""
:doc:`uindex_pack <./uindex_pack>`, ""
:doc:`integer_range <./integer_range>`, ""
:doc:`index_range <./uindex_range>`, ""
:doc:`uindex_range <./uindex_range>`, ""
:doc:`integer_n <./integer_n>`, ""
:doc:`index_n <./uindex_range>`, ""
:doc:`uindex_n <./uindex_range>`, ""
:doc:`make_index_sequence <./make_index_sequence>`, ""
:doc:`index_sequence_for <./index_sequence_for>`, ""
Integer sequence utilities
----------------------------------------
.. csv-table::
:header: class
:widths: 4, 8
:doc:`enable_make_indexes <./enable_make_indexes>`, ""
.. csv-table::
:header: user-defined literal
:widths: 4, 8
:doc:`operator"" _indexes <./literal-_indexes>`, ""
:doc:`operator"" _uindexes <./literal-_uindexes>`, ""
Tuple interface
----------------------------------------
.. csv-table::
:header: matafunction
:widths: 4, 8
:doc:`std::tuple_size <./integer_sequence/std-tuple_size>`, ""
:doc:`std::tuple_element <./integer_sequence/std-tuple_element>`, ""
.. csv-table::
:header: function
:widths: 4, 8
:doc:`tuple_get <./integer_sequence/tuple_get>`, ""
Header
========================================
``sprout/index_tuple.hpp``

3
docs/_sources/libs/string/basic_string/assign-iterator.txt
View file

@ -1,4 +1,5 @@
.. _sprout-string-basic_string-assign-iterator: .. _sprout-string-basic_string-assign-iterator:
############################################################################### ###############################################################################
assign assign
############################################################################### ###############################################################################
@ -18,7 +19,7 @@ Requires
Effects 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 Returns
======================================== ========================================

3
docs/_sources/libs/string/basic_string/assign.txt
View file

@ -1,4 +1,5 @@
.. _sprout-string-basic_string-assign: .. _sprout-string-basic_string-assign:
############################################################################### ###############################################################################
assign assign
############################################################################### ###############################################################################
@ -80,7 +81,7 @@ Requires
Effects 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 Returns
======================================== ========================================

1
docs/_sources/libs/string/basic_string/at.txt
View file

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

1
docs/_sources/libs/string/basic_string/back.txt
View file

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

1
docs/_sources/libs/string/basic_string/begin.txt
View file

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

1
docs/_sources/libs/string/basic_string/c_array.txt
View file

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

1
docs/_sources/libs/string/basic_string/cbegin.txt
View file

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

9
docs/_sources/libs/string/basic_string/cend.txt
View file

@ -1,13 +1,14 @@
.. _sprout-string-basic_string-cbegin: .. _sprout-string-basic_string-cend:
############################################################################### ###############################################################################
cbegin cend
############################################################################### ###############################################################################
Interface Interface
======================================== ========================================
.. sourcecode:: c++ .. sourcecode:: c++
SPROUT_CONSTEXPR const_iterator cbegin() const SPROUT_NOEXCEPT; SPROUT_CONSTEXPR const_iterator cend() const SPROUT_NOEXCEPT;
Returns Returns
======================================== ========================================
@ -22,7 +23,7 @@ Examples
using namespace sprout; using namespace sprout;
SPROUT_STATIC_CONSTEXPR auto input = string<8>("homuhomu"); 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 Complexity
======================================== ========================================

1
docs/_sources/libs/string/basic_string/clear.txt
View file

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

1
docs/_sources/libs/string/basic_string/compare-iterator.txt
View file

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

1
docs/_sources/libs/string/basic_string/compare.txt
View file

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

1
docs/_sources/libs/string/basic_string/constructor-.txt
View file

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

1
docs/_sources/libs/string/basic_string/crbegin.txt
View file

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

1
docs/_sources/libs/string/basic_string/crend.txt
View file

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

Some files were not shown because too many files have changed in this diff Show more