Skip to content
Toggle navigation
P
Projects
G
Groups
S
Snippets
Help
FORMUS3IC_LAS3
/
embb
This project
Loading...
Sign in
Toggle navigation
Go to a project
Project
Repository
Issues
0
Merge Requests
0
Pipelines
Wiki
Members
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Commit
0682909e
authored
Feb 27, 2015
by
Bernhard Gatzhammer
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Modified doxygen comments to consistently use the function object concept
Ticket EMBB-349
parent
64ec5c7e
Hide whitespace changes
Inline
Side-by-side
Showing
7 changed files
with
31 additions
and
31 deletions
+31
-31
algorithms_cpp/include/embb/algorithms/invoke.h
+2
-2
algorithms_cpp/include/embb/algorithms/reduce.h
+3
-3
algorithms_cpp/include/embb/algorithms/scan.h
+3
-3
base_cpp/include/embb/base/internal/thread_closures.h
+6
-6
base_cpp/include/embb/base/thread.h
+8
-8
mtapi_c/include/embb/mtapi/c/mtapi.h
+1
-1
mtapi_cpp/include/embb/mtapi/action.h
+8
-8
No files found.
algorithms_cpp/include/embb/algorithms/invoke.h
View file @
0682909e
...
...
@@ -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 */
...
...
algorithms_cpp/include/embb/algorithms/reduce.h
View file @
0682909e
...
...
@@ -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
,
...
...
algorithms_cpp/include/embb/algorithms/scan.h
View file @
0682909e
...
...
@@ -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
,
...
...
base_cpp/include/embb/base/internal/thread_closures.h
View file @
0682909e
...
...
@@ -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
{
...
...
base_cpp/include/embb/base/thread.h
View file @
0682909e
...
...
@@ -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 callabl
e
* \tparam Function
Function object typ
e
*/
template
<
typename
Function
>
explicit
Thread
(
Function
function
/**< [IN] C
allable (without arguments, must be copyable)
*/
/**< [IN] C
opyable 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 callabl
e
* \tparam Function
Function object typ
e
*/
template
<
typename
Function
>
explicit
Thread
(
CoreSet
&
core_set
,
/**< [IN] Set of cores on which the thread shall be executed. */
Function
function
/**< [IN] C
allable (without arguments, must be copyable)
*/
/**< [IN] C
opyable 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 callabl
e
* \tparam Function
Function object typ
e
* \tparam Argument Type of argument
*/
template
<
typename
Function
,
typename
Arg
>
Thread
(
Function
function
,
/**< [IN] C
allable (with one argument, must be copyable)
*/
/**< [IN] C
opyable 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 callabl
e
* \tparam Function
Function object typ
e
* \tparam Arg1 Type of first argument
* \tparam Arg2 Type of second argument
*/
template
<
typename
Function
,
typename
Arg1
,
typename
Arg2
>
Thread
(
Function
function
,
/**< [IN] C
allable (with two arguments, must be copyable)
*/
/**< [IN] C
opyable function object, callable with two arguments
*/
Arg1
arg1
,
/**< [IN] First argument for function (must be copyable) */
Arg2
arg2
...
...
mtapi_c/include/embb/mtapi/c/mtapi.h
View file @
0682909e
...
...
@@ -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>
...
...
mtapi_cpp/include/embb/mtapi/action.h
View file @
0682909e
...
...
@@ -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
)
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment