SkelCL
SkelCL is a high level multi GPU skeleton library developed at the university of M√ľnster, Germany.
 All Classes Namespaces Files Functions Variables Typedefs Groups
Public Member Functions | List of all members
skelcl::Map< Tout(Index)> Class Template Reference

This version of the Map<Tout(Tin)> skeleton is executed over an one-dimensional index space defined by an IndexVector. More...

#include <Map.h>

Inheritance diagram for skelcl::Map< Tout(Index)>:

Public Member Functions

 Map (const Source &source, const std::string &funcName=std::string("func"))
 Constructor taking the source code used of the user-defined function as argument. More...
 
template<typename... Args>
Vector< Tout > operator() (const Vector< Index > &input, Args &&...args) const
 Executes the skeleton on the index space described by the input Vector. The resulting data is stored in a newly created output Vector and the Vector is returned. More...
 
template<typename... Args>
Vector< Tout > & operator() (Out< Vector< Tout >> output, const Vector< Index > &input, Args &&...args) const
 Executes the skeleton on the index space described by the input Vector. The resulting data is stored in the provided output Vector and a reference to this Vector is returned. More...
 

Detailed Description

template<typename Tout>
class skelcl::Map< Tout(Index)>

This version of the Map<Tout(Tin)> skeleton is executed over an one-dimensional index space defined by an IndexVector.

This is a more specialized version of the general Map<Tout(Tin)> skeleton. It can be customized with a user-defined function taking an Index (an integer value) and producing an arbitrary typed output for every element of the index space.

On creation the Map skeleton is customized with source code defining a unary function. An instance of this class is a function object, i.e. it can be called like a function. When this happens a container is passed as input to the Map skeleton which then invokes the provided function on every element of the container in a parallel fashion on one or more devices (depending of the distribution of the container).

More formally: When c is a container of length n with items c[0] .. c[n-1], and f is the provided unary function, the Map skeleton performs the calculation f(x[i]) for ever i in 0 .. n-1.

As all skeletons, the Map skeleton allows for passing additional arguments, i.e. arguments besides the input container, to the user defined function. The user-defined function has to written in such a way, that it expects more than just one argument (it is no unary function any more). Accordingly the number, types and order of arguments used when calling the map skeleton has to match the declaration of the user-defined function.

Template Parameters
ToutThe type of the elements stored in the output Vector.

Definition at line 321 of file Map.h.

Constructor & Destructor Documentation

template<typename Tout >
skelcl::Map< Tout(Index)>::Map ( const Source source,
const std::string &  funcName = std::string("func") 
)

Constructor taking the source code used of the user-defined function as argument.

Parameters
sourceThe source code of the user-defined function.
funcNameThe name of the user-defined function which should be invoked by the Map skeleton.

Member Function Documentation

template<typename Tout >
template<typename... Args>
Vector<Tout> skelcl::Map< Tout(Index)>::operator() ( const Vector< Index > &  input,
Args &&...  args 
) const

Executes the skeleton on the index space described by the input Vector. The resulting data is stored in a newly created output Vector and the Vector is returned.

Template Parameters
ArgsThe types of the arguments which are passed to the user-defined function in addition to the input Vector.
Parameters
inputThe input Vector describing an index space on which the user-defined function is invoked.
argsThe values of the arguments which are passed to the user-defined function in addition to the input Vector.
Returns
A newly created Vector storing the elements which get computed after invoking the user-defined function on the input Vector and the additionally provided arguments.
template<typename Tout >
template<typename... Args>
Vector<Tout>& skelcl::Map< Tout(Index)>::operator() ( Out< Vector< Tout >>  output,
const Vector< Index > &  input,
Args &&...  args 
) const

Executes the skeleton on the index space described by the input Vector. The resulting data is stored in the provided output Vector and a reference to this Vector is returned.

Template Parameters
ArgsThe types of the arguments which are passed to the user-defined function in addition to the input Vector.
Parameters
outputThe output Vector in which the resulting data is stored. The type of this argument is not the type of the Vector itself, but instead a wrapping class tagging that this Vector is written into. The utility function skelcl::out() can be used to create this wrapper for an arbitrary Vector.
inputThe input Vector describing an index space on which the user-defined function is invoked.
argsThe values of the arguments which are passed to the user-defined function in addition to the input Vector.
Returns
A reference to the provided output Vector. This Vector contains the elements which get computed after invoking the user-defined function on the input Vector and the additionally provided arguments.

The documentation for this class was generated from the following file: