Commit c72d72a3 by Tobias Fuchs

Merge branch 'development' into embb390_algorithms

parents 5d1a3416 030d515c
......@@ -58,7 +58,7 @@ typedef embb::base::Function<void> InvokeFunctionType;
template<typename Function1, ...>
void Invoke(
Function1 func1,
/**< [in] First function to invoke */
/**< [in] First function object to invoke */
...);
/**
......@@ -72,7 +72,7 @@ void Invoke(
template<typename Function1, ...>
void Invoke(
Function1 func1,
/**< [in] Function to invoke */
/**< [in] Function object to invoke */
...,
const embb::mtapi::ExecutionPolicy & policy
/**< [in] embb::mtapi::ExecutionPolicy to use */
......
......@@ -68,10 +68,10 @@ namespace algorithms {
* \tparam RAI Random access iterator
* \tparam ReturnType Type of result of reduction operation, deduced from
* \c neutral
* \tparam ReductionFunction Binary reduction function with signature
* \tparam ReductionFunction Binary reduction function object with signature
* <tt>ReturnType ReductionFunction(ReturnType, ReturnType)</tt>.
* \tparam TransformationFunction Unary transformation function with signature
* <tt>ReturnType TransformationFunction(typename
* \tparam TransformationFunction Unary transformation function object with
* signature <tt>ReturnType TransformationFunction(typename
* std::iterator_traits<RAI>::value_type)</tt>
*/
template<typename RAI, typename ReturnType, typename ReductionFunction,
......
......@@ -71,10 +71,10 @@ namespace algorithms {
* \tparam RAIOut Random access iterator type of output range
* \tparam ReturnType Type of output elements of scan operation, deduced from
* \c neutral
* \tparam ScanFunction Binary scan function with signature
* \tparam ScanFunction Binary scan function object with signature
* <tt>ReturnType ScanFunction(ReturnType, ReturnType)</tt>
* \tparam TransformationFunction Unary transformation function with signature
* <tt>ReturnType TransformationFunction(typename
* \tparam TransformationFunction Unary transformation function object with
* signature <tt>ReturnType TransformationFunction(typename
* std::iterator_traits<RAIIn>::value_type)</tt>.
*/
template<typename RAIIn, typename RAIOut, typename ReturnType,
......
......@@ -36,8 +36,8 @@ namespace internal {
/**
* Thread closure for thread start function with no arguments.
*
* Provides a thread start function calling a callable entity such as a function
* pointer or functor.
* Provides a thread start function from which a priorly stored function object
* is called.
*/
template<typename Function>
struct ThreadClosure {
......@@ -56,8 +56,8 @@ struct ThreadClosure {
/**
* Thread closure for thread start function with one argument.
*
* Provides a thread start function calling a callable entity such as a function
* pointer or functor.
* Provides a thread start function from which a priorly stored function object
* is called.
*/
template<typename Function, typename Arg1>
struct ThreadClosureArg1 {
......@@ -78,8 +78,8 @@ struct ThreadClosureArg1 {
/**
* Thread closure for thread start function with two arguments.
*
* Provides a thread start function calling a callable entity such as a function
* pointer or functor.
* Provides a thread start function from which a priorly stored function object
* is called.
*/
template<typename Function, typename Arg1, typename Arg2>
struct ThreadClosureArg2 {
......
......@@ -154,12 +154,12 @@ class Thread {
* \memory A small constant amount of memory to store the function. This
* memory is freed the thread is joined.
* \notthreadsafe
* \tparam Function Type of callable
* \tparam Function Function object type
*/
template<typename Function>
explicit Thread(
Function function
/**< [IN] Callable (without arguments, must be copyable) */
/**< [IN] Copyable function object, callable without arguments */
);
/**
......@@ -174,14 +174,14 @@ class Thread {
* \memory A small constant amount of memory to store the function. This
* memory is freed the thread is joined.
* \notthreadsafe
* \tparam Function Type of callable
* \tparam Function Function object type
*/
template<typename Function>
explicit Thread(
CoreSet& core_set,
/**< [IN] Set of cores on which the thread shall be executed. */
Function function
/**< [IN] Callable (without arguments, must be copyable) */
/**< [IN] Copyable function object, callable without arguments */
);
/**
......@@ -196,13 +196,13 @@ class Thread {
* \memory A small constant amount of memory to store the function. This
* memory is freed the thread is joined.
* \notthreadsafe
* \tparam Function Type of callable
* \tparam Function Function object type
* \tparam Argument Type of argument
*/
template<typename Function, typename Arg>
Thread(
Function function,
/**< [IN] Callable (with one argument, must be copyable) */
/**< [IN] Copyable function object, callable with one argument */
Arg arg
/**< [IN] Argument for function (must be copyable) */
);
......@@ -219,14 +219,14 @@ class Thread {
* \memory A small constant amount of memory to store the function. This
* memory is freed the thread is joined.
* \notthreadsafe
* \tparam Function Type of callable
* \tparam Function Function object type
* \tparam Arg1 Type of first argument
* \tparam Arg2 Type of second argument
*/
template<typename Function, typename Arg1, typename Arg2>
Thread(
Function function,
/**< [IN] Callable (with two arguments, must be copyable) */
/**< [IN] Copyable function object, callable with two arguments */
Arg1 arg1,
/**< [IN] First argument for function (must be copyable) */
Arg2 arg2
......
......@@ -68,7 +68,7 @@
* </tr>
* <tr>
* <td>Action Function</td>
* <td>The callable, an executable function of an action, invoked by the
* <td>The executable function of an action, invoked by the
* MTAPI runtime when a task is started.</td>
* </tr>
* <tr>
......
......@@ -51,13 +51,13 @@ class Action {
}
/**
* Constructs an Action from any entity that provides an
* operator() (TaskContext &).
* Constructs an Action from a function object.
*
* \tparam Function Function object
*/
template <typename Function>
Action(
Function func /**< [in] Anything that provides an
operator() (TaskContext &). */
Function func /**< [in] Function object */
)
: function_(func)
, execution_policy_() {
......@@ -65,13 +65,13 @@ class Action {
}
/**
* Constructs an Action from any entity that provides an
* operator() (TaskContext &) and an Affinity.
* Constructs an Action from a function object and an Affinity.
*
* \tparam Function Function object
*/
template <typename Function>
Action(
Function func, /**< [in] Anything that provides an
operator() (TaskContext &). */
Function func, /**< [in] Function object */
ExecutionPolicy execution_policy /**< [in] Execution policy */
)
: function_(func)
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or sign in to comment