Skip to content

Commit ca2b5ff

Browse files
docs(rocprim): add missing docs to transform output iterator (#1775)
This PR adds missing docs for transform_output_iterator. Co-authored-by: Nara Prasetya <[email protected]>
1 parent 20651c3 commit ca2b5ff

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

rocprim/include/rocprim/iterator/transform_output_iterator.hpp

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,16 @@ class transform_output_iterator_proxy
5151
};
5252
} // namespace detail
5353

54+
/// \class transform_output_iterator
55+
/// \brief A random-access output (write-only) iterator adaptor for transforming assigned values.
56+
///
57+
/// \par Overview
58+
/// * A transform_output_iterator uses a functor of type \p UnaryFunction to transform a
59+
/// value written to it before writing it out to the underlying iterator.
60+
///
61+
/// \tparam OutputIterator type of the underlying random-access output iterator. Must be
62+
/// a random-access iterator.
63+
/// \tparam UnaryFunction type of the transform functor.
5464
template<class OutputIterator, class UnaryFunction>
5565
class transform_output_iterator
5666
{
@@ -75,6 +85,8 @@ class transform_output_iterator
7585
/// The type of unary function used to transform input range.
7686
using unary_function = UnaryFunction;
7787

88+
/// A proxy type that is assignable which will transform the new value
89+
/// and write it to the underlying iterator.
7890
using proxy_type = detail::transform_output_iterator_proxy<OutputIterator, unary_function>;
7991

8092
#ifndef DOXYGEN_SHOULD_SKIP_THIS

0 commit comments

Comments
 (0)