diff --git a/algorithms_cpp/include/embb/algorithms/invoke.h b/algorithms_cpp/include/embb/algorithms/invoke.h index b3ed429..1484d5a 100644 --- a/algorithms_cpp/include/embb/algorithms/invoke.h +++ b/algorithms_cpp/include/embb/algorithms/invoke.h @@ -58,7 +58,7 @@ typedef embb::base::Function InvokeFunctionType; template void Invoke( Function1 func1, - /**< [in] First function to invoke */ + /**< [in] First function object to invoke */ ...); /** @@ -72,7 +72,7 @@ void Invoke( template void Invoke( Function1 func1, - /**< [in] Function to invoke */ + /**< [in] Function object to invoke */ ..., const embb::mtapi::ExecutionPolicy & policy /**< [in] embb::mtapi::ExecutionPolicy to use */ diff --git a/algorithms_cpp/include/embb/algorithms/reduce.h b/algorithms_cpp/include/embb/algorithms/reduce.h index 5cdb732..9058ee9 100644 --- a/algorithms_cpp/include/embb/algorithms/reduce.h +++ b/algorithms_cpp/include/embb/algorithms/reduce.h @@ -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 * ReturnType ReductionFunction(ReturnType, ReturnType). - * \tparam TransformationFunction Unary transformation function with signature - * ReturnType TransformationFunction(typename + * \tparam TransformationFunction Unary transformation function object with + * signature ReturnType TransformationFunction(typename * std::iterator_traits::value_type) */ templateReturnType ScanFunction(ReturnType, ReturnType) - * \tparam TransformationFunction Unary transformation function with signature - * ReturnType TransformationFunction(typename + * \tparam TransformationFunction Unary transformation function object with + * signature ReturnType TransformationFunction(typename * std::iterator_traits::value_type). */ template 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 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 struct ThreadClosureArg2 { diff --git a/base_cpp/include/embb/base/thread.h b/base_cpp/include/embb/base/thread.h index 7691020..a2278ea 100644 --- a/base_cpp/include/embb/base/thread.h +++ b/base_cpp/include/embb/base/thread.h @@ -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 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 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 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 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 diff --git a/mtapi_c/include/embb/mtapi/c/mtapi.h b/mtapi_c/include/embb/mtapi/c/mtapi.h index 51460cc..5347046 100644 --- a/mtapi_c/include/embb/mtapi/c/mtapi.h +++ b/mtapi_c/include/embb/mtapi/c/mtapi.h @@ -68,7 +68,7 @@ * * * Action Function - * The callable, an executable function of an action, invoked by the + * The executable function of an action, invoked by the * MTAPI runtime when a task is started. * * diff --git a/mtapi_cpp/include/embb/mtapi/action.h b/mtapi_cpp/include/embb/mtapi/action.h index fc92f8f..68e9776 100644 --- a/mtapi_cpp/include/embb/mtapi/action.h +++ b/mtapi_cpp/include/embb/mtapi/action.h @@ -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 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 Action( - Function func, /**< [in] Anything that provides an - operator() (TaskContext &). */ + Function func, /**< [in] Function object */ ExecutionPolicy execution_policy /**< [in] Execution policy */ ) : function_(func)