From 677c3d908ad8a627fe111578cf1f373e15164876 Mon Sep 17 00:00:00 2001 From: Bruno Turcksin Date: Fri, 14 Aug 2015 14:04:34 -0500 Subject: [PATCH] Add documentation for SynchronousIterator. --- include/deal.II/base/synchronous_iterator.h | 26 +++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/include/deal.II/base/synchronous_iterator.h b/include/deal.II/base/synchronous_iterator.h index 2159a09dd1..53d612440c 100644 --- a/include/deal.II/base/synchronous_iterator.h +++ b/include/deal.II/base/synchronous_iterator.h @@ -38,6 +38,10 @@ DEAL_II_NAMESPACE_OPEN * The template argument of the current class shall be of type * std_cxx11::tuple with arguments equal to the iterator types. * + * The individual iterators can be accessed using + * std_cxx11::get(synchronous_iterator.iterators) where X is the + * number corresponding to the desired iterator. + * * This type, and the helper functions associated with it, are used as the * Value concept for the blocked_range type of the Threading Building Blocks. * @@ -88,6 +92,8 @@ SynchronousIterators (const SynchronousIterators &i) * first element of the second argument. Since the objects compared march * forward all elements at the same time, comparing the first element is * sufficient. + * + * @relates SynchronousIterators */ template inline @@ -104,6 +110,8 @@ operator< (const SynchronousIterators &a, * Return the distance between the first and the second argument. Since the * objects compared march forward all elements at the same time, differencing * the first element is sufficient. + * + * @relates SynchronousIterators */ template inline @@ -121,6 +129,8 @@ operator- (const SynchronousIterators &a, /** * Advance a tuple of iterators by $n$. + * + * @relates SynchronousIterators */ template inline @@ -133,6 +143,8 @@ void advance (std_cxx11::tuple &t, /** * Advance a tuple of iterators by $n$. + * + * @relates SynchronousIterators */ template inline @@ -146,6 +158,8 @@ void advance (std_cxx11::tuple &t, /** * Advance a tuple of iterators by $n$. + * + * @relates SynchronousIterators */ template @@ -163,6 +177,8 @@ void advance (std_cxx11::tuple &t, /** * Advance a tuple of iterators by 1. + * + * @relates SynchronousIterators */ template inline @@ -174,6 +190,8 @@ void advance_by_one (std_cxx11::tuple &t) /** * Advance a tuple of iterators by 1. + * + * @relates SynchronousIterators */ template inline @@ -186,6 +204,8 @@ void advance_by_one (std_cxx11::tuple &t) /** * Advance a tuple of iterators by 1. + * + * @relates SynchronousIterators */ template @@ -202,6 +222,8 @@ void advance_by_one (std_cxx11::tuple &t) /** * Advance the elements of this iterator by $n$. + * + * @relates SynchronousIterators */ template inline @@ -216,6 +238,8 @@ operator + (const SynchronousIterators &a, /** * Advance the elements of this iterator by 1. + * + * @relates SynchronousIterators */ template inline @@ -230,6 +254,8 @@ operator ++ (SynchronousIterators &a) /** * Compare synch iterators for inequality. Since they march in synch, * comparing only the first element is sufficient. + * + * @relates SynchronousIterators */ template inline -- 2.39.5