RTOpPack::TOpUnaryFuncPtr< Scalar > Class Template Reference

RTOpT subclass for unary transformation functions using a function pointer. More...

#include <RTOpPack_TOpUnaryFuncPtrDecl.hpp>

Inheritance diagram for RTOpPack::TOpUnaryFuncPtr< Scalar >:

Inheritance graph
[legend]
List of all members.

Overridden from RTOpT

const char * op_name () const
 
void apply_op (const int num_vecs, const ConstSubVectorView< Scalar > sub_vecs[], const int num_targ_vecs, const SubVectorView< Scalar > targ_sub_vecs[], ReductTarget *reduct_obj) const
 

Public Types

typedef void(*) unary_func_ptr_t (const Scalar x[], int x_dim, Scalar out[])
 

Public Member Functions

 TOpUnaryFuncPtr ()
 Construct to uninitialized.
 TOpUnaryFuncPtr (unary_func_ptr_t unary_func_ptr, const std::string &op_name)
 Calls initialize().
void initialize (unary_func_ptr_t unary_func_ptr, const std::string &op_name)
 Initialize.
void set_initialized (unary_func_ptr_t *unary_func_ptr=NULL, std::string *op_name=NULL)
 Set uninitialized.

Detailed Description

template<class Scalar>
class RTOpPack::TOpUnaryFuncPtr< Scalar >

RTOpT subclass for unary transformation functions using a function pointer.

ToDo: Finish documentation!

Definition at line 45 of file RTOpPack_TOpUnaryFuncPtrDecl.hpp.


Member Typedef Documentation

template<class Scalar>
typedef void(*) RTOpPack::TOpUnaryFuncPtr< Scalar >::unary_func_ptr_t(const Scalar x[], int x_dim, Scalar out[])

Definition at line 49 of file RTOpPack_TOpUnaryFuncPtrDecl.hpp.


Constructor & Destructor Documentation

template<class Scalar>
RTOpPack::TOpUnaryFuncPtr< Scalar >::TOpUnaryFuncPtr (  ) 

Construct to uninitialized.

Definition at line 38 of file RTOpPack_TOpUnaryFuncPtr.hpp.

template<class Scalar>
RTOpPack::TOpUnaryFuncPtr< Scalar >::TOpUnaryFuncPtr ( unary_func_ptr_t  unary_func_ptr,
const std::string &  op_name 
)

Calls initialize().

Definition at line 45 of file RTOpPack_TOpUnaryFuncPtr.hpp.


Member Function Documentation

template<class Scalar>
void RTOpPack::TOpUnaryFuncPtr< Scalar >::initialize ( unary_func_ptr_t  unary_func_ptr,
const std::string &  op_name 
)

Initialize.

Parameters:
unary_func_ptr [in] Pointer to function that actually performs the unary operation.
op_name [in] Name of the operation (for debugging mostly by clients)
Preconditions:

Definition at line 55 of file RTOpPack_TOpUnaryFuncPtr.hpp.

template<class Scalar>
void RTOpPack::TOpUnaryFuncPtr< Scalar >::set_initialized ( unary_func_ptr_t unary_func_ptr = NULL,
std::string *  op_name = NULL 
)

Set uninitialized.

Parameters:
unary_func_ptr [out] If unary_func_ptr!=NULL then *unary_func_ptr is set to pointer to function that was passed in to initialize().
op_name [out] If op_name!=NULL then *op_name is set to the operation name that was passed in to initialize().

Definition at line 66 of file RTOpPack_TOpUnaryFuncPtr.hpp.

template<class Scalar>
const char * RTOpPack::TOpUnaryFuncPtr< Scalar >::op_name (  )  const

Reimplemented from RTOpPack::RTOpT< Scalar >.

Definition at line 81 of file RTOpPack_TOpUnaryFuncPtr.hpp.

template<class Scalar>
void RTOpPack::TOpUnaryFuncPtr< Scalar >::apply_op ( const int  num_vecs,
const ConstSubVectorView< Scalar >  sub_vecs[],
const int  num_targ_vecs,
const SubVectorView< Scalar >  targ_sub_vecs[],
ReductTarget reduct_obj 
) const

Reimplemented from RTOpPack::RTOpT< Scalar >.

Definition at line 87 of file RTOpPack_TOpUnaryFuncPtr.hpp.


The documentation for this class was generated from the following files:
Generated on Wed May 12 21:41:19 2010 for Support Software for Vector Reduction/Transformation Operators by  doxygen 1.4.7