diff options
| author |  Axel Huebl <axel.huebl@plasma.ninja>
| 2021-10-27 15:55:19 -0700 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2021-10-27 15:55:19 -0700 |
| commit | 2ed3f418ce358e4b7331f2239139a4157ae9382c (patch) | |
| tree | 9fca04d6e0d5c84aa87273ff99655fc645eb43c1 /Source/Particles/Sorting | |
| parent | 8fa7cf0e5ed3051466c70ba593b3713b8a61298d (diff) | |
| download | WarpX-2ed3f418ce358e4b7331f2239139a4157ae9382c.tar.gz WarpX-2ed3f418ce358e4b7331f2239139a4157ae9382c.tar.zst WarpX-2ed3f418ce358e4b7331f2239139a4157ae9382c.zip | |
Fix Doxygen: Particles (#2486)
* Fix Doxygen: Particles
Fix doxygen errors & warnings.
* Apply suggestions from code review
Co-authored-by: Luca Fedeli <luca.fedeli@for.unipi.it>
Co-authored-by: Neïl Zaim <49716072+NeilZaim@users.noreply.github.com>
* Apply suggestions from code review
* Document ForwardIterator
* Fix tparam and comma
Co-authored-by: Neïl Zaim <49716072+NeilZaim@users.noreply.github.com>
Co-authored-by: Luca Fedeli <luca.fedeli@for.unipi.it>
Co-authored-by: Neïl Zaim <49716072+NeilZaim@users.noreply.github.com>
Diffstat (limited to 'Source/Particles/Sorting')
| -rw-r--r-- | Source/Particles/Sorting/SortingUtils.H | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/Source/Particles/Sorting/SortingUtils.H b/Source/Particles/Sorting/SortingUtils.H index f07ac450d..e2b8276a7 100644 --- a/Source/Particles/Sorting/SortingUtils.H +++ b/Source/Particles/Sorting/SortingUtils.H @@ -35,11 +35,12 @@ void fillWithConsecutiveIntegers( amrex::Gpu::DeviceVector<long>& v ) /** \brief Find the indices that would reorder the elements of `predicate` * so that the elements with non-zero value precede the other elements * + * \tparam ForwardIterator An iterator that supports std::advance * \param[in, out] index_begin Point to the beginning of the vector which is * to be filled with these indices - * \param[in, out] index_begin Point to the end of the vector which is + * \param[in, out] index_end Point to the end of the vector which is * to be filled with these indices - * \param[in] Vector that indicates the elements that need to be reordered first + * \param[in] predicate that indicates the elements that need to be reordered first */ template< typename ForwardIterator > ForwardIterator stablePartition(ForwardIterator const index_begin, @@ -67,7 +68,8 @@ ForwardIterator stablePartition(ForwardIterator const index_begin, /** \brief Return the number of elements between `first` and `last` * - * \param[in] fist Points to a position in a vector + * \tparam ForwardIterator An iterator that supports std::distance + * \param[in] first Points to a position in a vector * \param[in] last Points to another position in a vector * \return The number of elements between `first` and `last` */ |