Muesli
 All Classes Namespaces Files Functions Typedefs Enumerations
Public Member Functions | Protected Attributes | List of all members
msl::AMapStencilFunctor< T, R > Class Template Referenceabstract

Class AMapStencilFunctor represents a functor for the mapStencil skeleton of the distributed array. More...

#include <functors.h>

Inheritance diagram for msl::AMapStencilFunctor< T, R >:
msl::detail::ArrayFunctorBase msl::detail::FunctorBase

Public Member Functions

 AMapStencilFunctor ()
 Default Constructor. More...
 
virtual MSL_USERFUNC R operator() (int index, const PLArray< T > &input) const =0
 Function call operator has to be implemented by the user. Here, the actual function is implemented. More...
 
int getStencilSize ()
 Returns the stencil size. More...
 
void setStencilSize (int value)
 Sets the stencil size. More...
 
virtual ~AMapStencilFunctor ()
 Destructor.
 
- Public Member Functions inherited from msl::detail::ArrayFunctorBase
void init (int nl, int f)
 Initializes its attributes. More...
 
- Public Member Functions inherited from msl::detail::FunctorBase
 FunctorBase ()
 Default constructor.
 
bool useLocalIndices () const
 Checks whether indices are local or global. More...
 
void setLocalIndices (bool value)
 Use this function to configure your functor to use local indices instead of global indices. More...
 
int getTileWidth () const
 Returns the tile_width. If tiling is not used, -1 will be returned. More...
 
void setTileWidth (int value)
 Sets the tile width. More...
 
void notify ()
 Notifies all observed objects (additional arguments) to update.
 
void addArgument (ArgumentType *arg)
 Adds an additional argument to the functor. More...
 
virtual ~FunctorBase ()
 Destructor.
 

Protected Attributes

int stencil_size
 
- Protected Attributes inherited from msl::detail::ArrayFunctorBase
int nLocal
 
int first
 
- Protected Attributes inherited from msl::detail::FunctorBase
std::vector< ArgumentType * > args
 
int tile_width
 
bool local_indices
 

Detailed Description

template<typename T, typename R>
class msl::AMapStencilFunctor< T, R >

Class AMapStencilFunctor represents a functor for the mapStencil skeleton of the distributed array.

Template Parameters
TInput data type.
ROutput data type.

Constructor & Destructor Documentation

template<typename T , typename R >
msl::AMapStencilFunctor< T, R >::AMapStencilFunctor ( )
inline

Default Constructor.

Sets a default stencil size of 1.

Member Function Documentation

template<typename T , typename R >
int msl::AMapStencilFunctor< T, R >::getStencilSize ( )
inline

Returns the stencil size.

Returns
The stencil size.
template<typename T , typename R >
virtual MSL_USERFUNC R msl::AMapStencilFunctor< T, R >::operator() ( int  index,
const PLArray< T > &  input 
) const
pure virtual

Function call operator has to be implemented by the user. Here, the actual function is implemented.

Parameters
indexGlobal index of the input value.
inputInput for the map stencil function.
Returns
Output of the map stencil function.
template<typename T , typename R >
void msl::AMapStencilFunctor< T, R >::setStencilSize ( int  value)
inline

Sets the stencil size.

Parameters
valueThe new stencil size.

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