feedc0de/boost_algorithm
1
0
Fork 0
forked from boostorg/algorithm
Code Pull Requests Activity

Add documentation to transform_inclusive_scan

Browse Source 
Problem:
- There is no documentation for the existing functions. This will make
  it harder for users to consume these functions, especially as new
  variants are added.

Solution:
- Add documentation.
This commit is contained in:
Jonathan Gopel
2022-06-05 14:03:16 +00:00
parent da8ea581eb
commit 02f436c25d
2 changed files with 34 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
doc/algorithm.qbk
View File

@ -106,6 +106,11 @@ Generate an increasing series
Apply a functor to the elements of a sequence
[endsect:for_each_n]
[section:transform_inclusive_scan transform_inclusive_scan]
[*[^[link boost.algorithm.transform_inclusive_scan transform_inclusive_scan] ] ]
Transform each element in a range then combine adjacent elements to create an output range. Inclusive scaning means that the nth input is present in the nth output.
[endsect:transform_inclusive_scan]
[endsect:CXX17_inner_algorithms]
[endsect:CXX17]
@ -235,7 +240,6 @@ Raise a value to an integral power ([^constexpr] since C++14)
* [*[^[link header.boost.algorithm.cxx17.inclusive_scan_hpp inclusive_scan] ] ]
* [*[^[link header.boost.algorithm.cxx17.reduce_hpp reduce] ] ]
* [*[^[link header.boost.algorithm.cxx17.transform_exclusive_scan_hpp transform_exclusive_scan] ] ]
* [*[^[link header.boost.algorithm.cxx17.transform_inclusive_scan_hpp transform_inclusive_scan] ] ]
* [*[^[link header.boost.algorithm.cxx17.transform_reduce_hpp transform_reduce] ] ]
[endsect:not_yet_documented_cxx17_algos]