Shuenhoy/vtk-m
1
0
Fork 0
mirror of https://gitlab.kitware.com/vtk/vtk-m synced 2024-10-05 01:49:02 +00:00
Code Issues 2 Actions Packages Projects Releases Wiki Activity

Clarify ScanExtended

Browse Source 
Make it more clear that ScanExtended increases the array size by
1, what ranges the exclusive and inclusive scan cover, and the
features of the first and last entries.
This commit is contained in:
Kenneth Moreland 2021-09-17 09:09:38 -06:00
parent b168c2003b
commit 35b6460110
1 changed files with 16 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
vtkm/cont/DeviceAdapterAlgorithm.h
View File

@ -370,11 +370,14 @@ struct DeviceAdapterAlgorithm
/// \brief Compute an extended prefix sum operation on the input ArrayHandle.
///
/// Computes an extended prefix sum operation on the \c input ArrayHandle,
/// storing the results in the \c output ArrayHandle. This produces an output
/// array that contains both an inclusive scan (in elements [1, size)) and an
/// exclusive scan (in elements [0, size-1)). By using ArrayHandleView,
/// arrays containing both inclusive and exclusive scans can be generated
/// from an extended scan with minimal memory usage.
/// storing the results in the \c output ArrayHandle. The output array is one
/// element longer than the input array. This produces an output array that
/// contains both an inclusive scan (in elements [1, size]) and an exclusive
/// scan (in elements [0, size-1]). As such, the first element of the output
/// array always has the initial value and the last element of the output
/// array always has the total sum. By using ArrayHandleView, arrays
/// containing both inclusive and exclusive scans can be generated from an
/// extended scan with minimal memory usage.
///
/// This algorithm may also be more efficient than ScanInclusive and
/// ScanExclusive on some devices, since it may be able to avoid copying the
@ -395,11 +398,14 @@ struct DeviceAdapterAlgorithm
/// \brief Compute an extended prefix sum operation on the input ArrayHandle.
///
/// Computes an extended prefix sum operation on the \c input ArrayHandle,
/// storing the results in the \c output ArrayHandle. This produces an output
/// array that contains both an inclusive scan (in elements [1, size)) and an
/// exclusive scan (in elements [0, size-1)). By using ArrayHandleView,
/// arrays containing both inclusive and exclusive scans can be generated
/// from an extended scan with minimal memory usage.
/// storing the results in the \c output ArrayHandle. The output array is one
/// element longer than the input array. This produces an output array that
/// contains both an inclusive scan (in elements [1, size]) and an exclusive
/// scan (in elements [0, size-1]). As such, the first element of the output
/// array always has the initial value and the last element of the output
/// array always has the total sum. By using ArrayHandleView, arrays
/// containing both inclusive and exclusive scans can be generated from an
/// extended scan with minimal memory usage.
///
/// This algorithm may also be more efficient than ScanInclusive and
/// ScanExclusive on some devices, since it may be able to avoid copying the