Skip to content

Commit 4b15e1a

Browse files
committed
Add documentation
1 parent 6f3357e commit 4b15e1a

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

nestkernel/per_thread_bool_indicator.h

+6
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,11 @@
3838
namespace nest
3939
{
4040

41+
/**
42+
* A wrapper class for an integer that is only allowed to take the
43+
* values 0 and 1. Used by PerThreadBoolIndicator to create a
44+
* thread-safe vector indicating per-thread status. See issue #1394.
45+
*/
4146
class BoolIndicatorUInt64
4247
{
4348
public:
@@ -92,6 +97,7 @@ BoolIndicatorUInt64::logical_and( const bool status )
9297
* A thread-safe vector to keep track of the status across threads,
9398
* for example during gather operations. Uses a vector of integers
9499
* instead of a vector of bools to guarantee thread safety.
100+
* See issue #1394.
95101
*/
96102
class PerThreadBoolIndicator
97103
{

0 commit comments

Comments
 (0)