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< void(Tin)> Class Template Reference

This version of the Map<Tout(Tin)> skeleton is used, when the user-defined function has the return type void, i.e. it doesn't produce a return value. More...

#include <Map.h>

Inheritance diagram for skelcl::Map< void(Tin)>:

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<template< typename > class C, typename... Args>
void operator() (const C< Tin > &input, Args &&...args) const
 Executes the skeleton on the provided input container. More...
 

Detailed Description

template<typename Tin>
class skelcl::Map< void(Tin)>

This version of the Map<Tout(Tin)> skeleton is used, when the user-defined function has the return type void, i.e. it doesn't produce a return value.

This is a more specialized version of the general Map<Tout(Tin)> skeleton. It can be customized with a user-defined function taking an arbitrary types argument (no classes are currently possible) and produces no output.

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
TinThe type of the elements stored in the input container.

Definition at line 246 of file Map.h.

Constructor & Destructor Documentation

template<typename Tin >
skelcl::Map< void(Tin)>::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 Tin >
template<template< typename > class C, typename... Args>
void skelcl::Map< void(Tin)>::operator() ( const C< Tin > &  input,
Args &&...  args 
) const

Executes the skeleton on the provided input container.

Template Parameters
CThe incomplete type of the input container. The complete type is C<Tin>. C is either Vector or Matrix.
ArgsThe types of the arguments which are passed to the user-defined function in addition to the input container.
Parameters
inputThe input container 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 container.

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