Muesli
 All Classes Namespaces Files Functions Typedefs Enumerations
Public Member Functions | Protected Attributes | List of all members
msl::detail::FunctorBase Class Reference

Class FunctorBase represents the base class for all functor classes. More...

#include <functor_base.h>

Inheritance diagram for msl::detail::FunctorBase:
msl::detail::ArrayFunctorBase msl::detail::MatrixFunctorBase msl::AFoldFunctor< T, R > msl::AMapFunctor< T, R > msl::AMapIndexFunctor< T, R > msl::AMapStencilFunctor< T, R > msl::AZipFunctor< T1, T2, R > msl::AZipIndexFunctor< T1, T2, R > msl::MFoldFunctor< T, R > msl::MMapFunctor< T, R > msl::MMapIndexFunctor< T, R > msl::MMapStencilFunctor< T, R > msl::MZipFunctor< T1, T2, R > msl::MZipIndexFunctor< T1, T2, R >

Public Member Functions

 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

std::vector< ArgumentType * > args
 
int tile_width
 
bool local_indices
 

Detailed Description

Class FunctorBase represents the base class for all functor classes.

Class FunctorBase represents the base class for all functor classes. It includes methods to configure a user implemented functor. Additioally it acts as a observer for additional arguments.

Member Function Documentation

void msl::detail::FunctorBase::addArgument ( ArgumentType arg)
inline

Adds an additional argument to the functor.

Parameters
argThe additional argument.
int msl::detail::FunctorBase::getTileWidth ( ) const
inline

Returns the tile_width. If tiling is not used, -1 will be returned.

Returns
The tile width.
void msl::detail::FunctorBase::setLocalIndices ( bool  value)
inline

Use this function to configure your functor to use local indices instead of global indices.

Parameters
valueTrue for local indices, false for global indices.
void msl::detail::FunctorBase::setTileWidth ( int  value)
inline

Sets the tile width.

Parameters
valueThe tile_width.
bool msl::detail::FunctorBase::useLocalIndices ( ) const
inline

Checks whether indices are local or global.

Returns
True if indices passed to the functor are local indices, false otherwise.

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