Skip to content

Commit e59f11f

Browse files
[oneTBB] - Fix wording on [function.objects] requirements from ISO C++ (#372)
Signed-off-by: Anton Potapov <anton.potapov@intel.com>
1 parent 277329d commit e59f11f

8 files changed

Lines changed: 14 additions & 14 deletions

File tree

source/elements/oneTBB/source/algorithms/functions/collaborative_call_once_func.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ Function template that executes function exactly once.
2424
2525
Requirements:
2626

27-
* ``Func`` type must meet the ``Function Objects``
28-
requirements from the [function.objects] section of the ISO C++ Standard section.
27+
* ``Func`` type must meet the `Function Objects`
28+
requirements described in the [function.objects] section of the ISO C++ standard.
2929

3030
Executes the ``Func`` object only once, even if it is called concurrently. It allows other threads
3131
blocked on the same ``collaborative_once_flag`` to join oneTBB parallel construction called

source/elements/oneTBB/source/algorithms/functions/parallel_invoke_func.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ Function template that evaluates several functions in parallel.
2525
2626
Requirements:
2727

28-
* All members of ``Functions`` parameter pack must meet ``Function Objects``
29-
requirements from the [function.objects] ISO C++ Standard section or be a pointer to a function.
28+
* All members of ``Functions`` parameter pack must meet `Function Objects`
29+
requirements described in the [function.objects] section of the ISO C++ standard.
3030
* Last member of ``Functions`` parameter pack may be a ``task_group_context&`` type.
3131

3232
Evaluates each member passed to ``parallel_invoke`` possibly in parallel. Return values are ignored.

source/elements/oneTBB/source/named_requirements/algorithms/par_for_each_body.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ParallelForEachBody
88
**[req.parallel_for_each_body]**
99

1010
A type `Body` satisfies `ParallelForBody` if it meets the `Function Objects`
11-
requirements from the [function.objects] ISO C++ Standard section.
11+
requirements described in the [function.objects] section of the ISO C++ standard.
1212
It should also meet one of the following requirements:
1313

1414
----------------------------------------------------------------

source/elements/oneTBB/source/task_scheduler/task_arena/task_arena_cls.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ Member functions
214214
.. cpp:function:: template<F> void enqueue(F&& f)
215215

216216
Enqueues a task into the ``task_arena`` to process the specified functor and immediately returns.
217-
The ``F`` type must meet the `Function Objects` requirements from the [function.objects] ISO C++ Standard section.
217+
The ``F`` type must meet the `Function Objects` requirements described in the [function.objects] section of the ISO C++ standard.
218218
The task is scheduled for eventual execution by a worker thread even if no thread ever explicitly waits for the task to complete.
219219
If the total number of worker threads is zero, a special additional worker thread is created to execute enqueued tasks.
220220

@@ -235,7 +235,7 @@ Member functions
235235
.. cpp:function:: template<F> auto execute(F&& f) -> decltype(f())
236236

237237
Executes the specified functor in the ``task_arena`` and returns the value returned by the functor.
238-
The ``F`` type must meet the `Function Objects` requirements from [function.objects] ISO C++ Standard section.
238+
The ``F`` type must meet the `Function Objects` requirements described in the [function.objects] section of the ISO C++ standard.
239239

240240
The calling thread joins the ``task_arena`` if possible, and executes the functor.
241241
Upon return it restores the previous task scheduler state and floating-point settings.

source/elements/oneTBB/source/task_scheduler/task_arena/this_task_arena_ns.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ with the ``task_arena`` currently used by the calling thread.
6767

6868
Runs the specified functor in isolation by restricting the calling thread to process only tasks
6969
scheduled in the scope of the functor (also called the isolation region). The function returns the value returned by the functor.
70-
The ``F`` type must meet the `Function Objects` requirements from the [function.objects] ISO C++ Standard section.
70+
The ``F`` type must meet the `Function Objects` requirements described in the [function.objects] section of the ISO C++ standard.
7171

7272
.. caution::
7373

source/elements/oneTBB/source/task_scheduler/task_group/task_group_cls.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ Member functions
8181
.. cpp:function:: template<typename Func> void run(Func&& f)
8282

8383
Adds a task to compute ``f()`` and returns immediately.
84-
The ``Func`` type must meet the `Function Objects` requirements from [function.objects] ISO C++ Standard section.
84+
The ``Func`` type must meet the `Function Objects` requirements described in the [function.objects] section of the ISO C++ standard.
8585

8686
.. cpp:function:: void run(task_handle&& h)
8787
@@ -95,7 +95,7 @@ Member functions
9595
.. cpp:function:: template<typename Func> task_group_status run_and_wait(const Func& f)
9696

9797
Equivalent to ``{run(f); return wait();}``.
98-
The ``Func`` type must meet the `Function Objects` requirements from the [function.objects] ISO C++ Standard section.
98+
The ``Func`` type must meet the `Function Objects` requirements described in the [function.objects] section of the ISO C++ standard.
9999

100100
**Returns**: The status of ``task_group``. See :doc:`task_group_status <task_group_status_enum>`.
101101

source/elements/oneTBB/source/thread_local_storage/combinable_cls.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ Member functions
106106

107107
.. cpp:function:: template<typename BinaryFunc> T combine(BinaryFunc f)
108108

109-
**Requires**: A ``BinaryFunc`` must meet the `Function Objects` requirements from the [function.objects] ISO C++ Standard section.
109+
**Requires**: A ``BinaryFunc`` must meet the `Function Objects` requirements described in the [function.objects] section of the ISO C++ standard.
110110
Specifically, the type should be an associative binary functor with the signature ``T BinaryFunc(T,T)`` or ``T BinaryFunc(const T&,const T&)``.
111111
A ``T`` type must be the same as a corresponding template parameter for the ``combinable`` object.
112112

@@ -118,7 +118,7 @@ Member functions
118118

119119
.. cpp:function:: template<typename UnaryFunc> void combine_each(UnaryFunc f)
120120

121-
**Requires**: An ``UnaryFunc`` must meet the `Function Objects` requirements from the [function.objects] ISO C++ Standard section.
121+
**Requires**: An ``UnaryFunc`` must meet the `Function Objects` requirements described in the [function.objects] section of the ISO C++ standard.
122122
Specifically, the type should be an unary functor with the one of the signatures: ``void UnaryFunc(T)``, ``void UnaryFunc(T&)``, or ``void UnaryFunc(const T&)``
123123
A ``T`` type must be the same as a corresponding template parameter for the ``enumerable_thread_specific`` object.
124124

source/elements/oneTBB/source/thread_local_storage/enumerable_thread_specific_cls/combining.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The member functions in this section iterate across the entire container sequent
1212

1313
.. cpp:function:: template<typename BinaryFunc> T combine(BinaryFunc f)
1414

15-
**Requires**: A ``BinaryFunc`` must meet the `Function Objects` requirements from the [function.objects] ISO C++ Standard section.
15+
**Requires**: A ``BinaryFunc`` must meet the `Function Objects` requirements described in the [function.objects] section of the ISO C++ standard.
1616
Specifically, the type should be an associative binary functor with the signature ``T BinaryFunc(T,T)`` or ``T BinaryFunc(const T&,const T&)``.
1717
A ``T`` type must be the same as a corresponding template parameter for ``enumerable_thread_specific`` object.
1818

@@ -23,7 +23,7 @@ The member functions in this section iterate across the entire container sequent
2323

2424
.. cpp:function:: template<typename UnaryFunc> void combine_each(UnaryFunc f)
2525

26-
**Requires**: An ``UnaryFunc`` must meet the `Function Objects` requirements from the [function.objects] ISO C++ Standard section.
26+
**Requires**: An ``UnaryFunc`` must meet the `Function Objects` requirements described in the [function.objects] section of the ISO C++ standard.
2727
Specifically, the type should be an unary functor with one of signatures: ``void UnaryFunc(T)``, ``void UnaryFunc(T&)``, or ``void UnaryFunc(const T&)``
2828
A ``T`` type must be the same as a corresponding template parameter for the ``enumerable_thread_specific`` object.
2929

0 commit comments

Comments
 (0)