pomerol  2.1
Public Member Functions | Data Fields
pMPI::ComputeWrap< PartType > Struct Template Reference

Wrapper around a computable object that calls the compute() method of the wrapped object and carries information about the complexity of a call to that method. More...

#include <mpi_skel.hpp>

Public Member Functions

 ComputeWrap (PartType &x, int complexity=1)
 
void run ()
 Call compute() of the wrapped object x. More...
 

Data Fields

PartType & x
 Reference to the wrapped object. More...
 
int complexity
 Complexity of a call to x.compute(). More...
 

Detailed Description

template<typename PartType>
struct pMPI::ComputeWrap< PartType >

Wrapper around a computable object that calls the compute() method of the wrapped object and carries information about the complexity of a call to that method.

Template Parameters
PartTypeType of the wrapped object.

Definition at line 39 of file mpi_skel.hpp.

Constructor & Destructor Documentation

◆ ComputeWrap()

template<typename PartType >
pMPI::ComputeWrap< PartType >::ComputeWrap ( PartType &  x,
int  complexity = 1 
)
inlineexplicit

Constructor.

Parameters
[in]xReference to the wrapped object.
[in]complexityComplexity of a call to x.compute().

Definition at line 48 of file mpi_skel.hpp.

Member Function Documentation

◆ run()

template<typename PartType >
void pMPI::ComputeWrap< PartType >::run ( )
inline

Call compute() of the wrapped object x.

Definition at line 50 of file mpi_skel.hpp.

Field Documentation

◆ complexity

template<typename PartType >
int pMPI::ComputeWrap< PartType >::complexity

Complexity of a call to x.compute().

Definition at line 43 of file mpi_skel.hpp.

◆ x

template<typename PartType >
PartType& pMPI::ComputeWrap< PartType >::x

Reference to the wrapped object.

Definition at line 41 of file mpi_skel.hpp.


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