escript  Revision_
Public Member Functions | Private Attributes | List of all members
escript::DataAlgorithmAdapter< BinaryFunction > Class Template Reference

Adapt binary algorithms so they may be used in DataArrayView reduction operations. More...

#include <DataAlgorithm.h>

Public Member Functions

 DataAlgorithmAdapter (double initialValue)
 
 DataAlgorithmAdapter (const DataAlgorithmAdapter &other)
 
void operator() (double value)
 
void resetResult ()
 
double getResult () const
 

Private Attributes

double m_initialValue
 
double m_currentValue
 
BinaryFunction operation
 

Detailed Description

template<class BinaryFunction>
class escript::DataAlgorithmAdapter< BinaryFunction >

Adapt binary algorithms so they may be used in DataArrayView reduction operations.

Description: This functor adapts the given BinaryFunction operation by starting with the given inital value applying this operation to successive values, storing the rolling result in m_currentValue - which can be accessed or reset by getResult and resetResult respectively.

Constructor & Destructor Documentation

template<class BinaryFunction >
escript::DataAlgorithmAdapter< BinaryFunction >::DataAlgorithmAdapter ( double  initialValue)
inline
template<class BinaryFunction >
escript::DataAlgorithmAdapter< BinaryFunction >::DataAlgorithmAdapter ( const DataAlgorithmAdapter< BinaryFunction > &  other)
inline

Member Function Documentation

template<class BinaryFunction >
double escript::DataAlgorithmAdapter< BinaryFunction >::getResult ( ) const
inline
template<class BinaryFunction >
void escript::DataAlgorithmAdapter< BinaryFunction >::operator() ( double  value)
inline
template<class BinaryFunction >
void escript::DataAlgorithmAdapter< BinaryFunction >::resetResult ( )
inline

Member Data Documentation

template<class BinaryFunction >
double escript::DataAlgorithmAdapter< BinaryFunction >::m_currentValue
private
template<class BinaryFunction >
double escript::DataAlgorithmAdapter< BinaryFunction >::m_initialValue
private
template<class BinaryFunction >
BinaryFunction escript::DataAlgorithmAdapter< BinaryFunction >::operation
private

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