Public declarations, typedefs and misc functions.
[Interfaces for generalized vector]

Collaboration diagram for Public declarations, typedefs and misc functions.:


struct  RTOp_SubVector
struct  RTOp_MutableSubVector

Error codes returned from various RTOp functions and interfaces.



#define RTOp_REDUCT_OBJ_NULL   0
#define RTOp_NUM_DATA_TYPES   3


typedef void * RTOp_ReductTarget
typedef void(*) RTOp_reduct_op_func_ptr_t (void *, void *, int *, RTOp_Datatype *)


void RTOp_sub_vector (RTOp_index_type global_offset, RTOp_index_type sub_dim, const RTOp_value_type values[], ptrdiff_t values_stride, struct RTOp_SubVector *sub_vec)
void RTOp_sub_vector_null (struct RTOp_SubVector *sub_vec)
void RTOp_mutable_sub_vector (RTOp_index_type global_offset, RTOp_index_type sub_dim, RTOp_value_type values[], ptrdiff_t values_stride, struct RTOp_MutableSubVector *sub_vec)
void RTOp_mutable_sub_vector_null (struct RTOp_MutableSubVector *sub_vec)

Detailed Description

See RTOp_config.h for the definition of platform specific data types RTOp_value_type, RTOp_index_type and RTOp_char_type.

Define Documentation

#define RTOp_REDUCT_OBJ_NULL   0

Definition at line 173 of file RTOp.h.

#define RTOp_NUM_DATA_TYPES   3

Definition at line 174 of file RTOp.h.


Definition at line 243 of file RTOp.h.


Definition at line 245 of file RTOp.h.


Definition at line 247 of file RTOp.h.


Definition at line 249 of file RTOp.h.


Definition at line 251 of file RTOp.h.


Definition at line 253 of file RTOp.h.

Typedef Documentation

typedef void* RTOp_ReductTarget

Definition at line 172 of file RTOp.h.

typedef void(*) RTOp_reduct_op_func_ptr_t(void *, void *, int *, RTOp_Datatype *)

The prototype for an external reduction operator function (MPI complient).

This is a typedef for a function pointer that gets past to MPI_Reduce(...) and MPI_Allreduce(...). Therefore, this is the only MPI specific part of this design. Function pointers of this type are returned from RTOp_get_reduct_op(). The prototype for this function is:

array_in [in] (void *) Array, length len
array_inout [in/out] (void *) Array, length len
len [in] (int *)
datatype [in] (RTOp_Datatype*) Pointer to reduction object datatype (ala MPI)
It is very important to note that the reduction objects passed in in array_in and array_inout are of a special form of the externalized object states. The arrays of the externalized state passed in and out of RTOp_extract_reduct_obj_state() and RTOp_load_reduct_obj_state(). The state arrays for a single reduction object must be compacted into a sinlge object reduct_obj_ext as follows:
   *num_values  = (RTOp_value_type*)reduct_obj_ext,      // Number of elements in values[] 
   *num_indexes = num_values  + sizeof(RTOp_value_type), // Number of elements in indexes[] 
   *num_chars   = num_indexes + sizeof(RTOp_value_type); // Number of elements in chars[] 
   *values  = num_chars + sizeof(RTOp_value_type);       // Array of num_values values 
   *indexes = (RTOp_index_type*)(values+num_values);     // Array of num_indexes indexes 
   *chars   = (RTOp_char_type*)(indexes+num_indexes);    // Array of num_char characters 
It may seem silly to delcare integer numbers as floating point numbers but the above specification should ensure that the object pointed to by reduct_obj_ext will be portable in any heterogeneous environment if we assume that sizeof(RTOp_value_type) >= sizeof(RTOp_index_type) >= sizeof(RTOp_char_type) which will be true on most platforms. Arranging the members this way will ensure that none of the individual members will be out of alignment. It is the responsibility of the vector implementation to create a compacted version of the externalized states of the reduction objects. The only portable way to ensure that the object pointed to by obj will be compatible with the above specification is to allocate it as:
 void *obj = mallac(
               sizeof(RTOp_value_type)*(3 + num_values) +
               sizeof(RTOp_index_type)*num_indexes +
Allocating objects in the above way (or by some means equivalent) and explicitly casting the get the individual members may be a little tedious but it is the only way to insure that the object will be layed out properly. On most platforms with most C compilers however, is may be possible to define structs that will be consistent with the above memory layout of its members but this is not guaranteed by the C standard.

Definition at line 238 of file RTOp.h.

Function Documentation

void RTOp_sub_vector ( RTOp_index_type  global_offset,
RTOp_index_type  sub_dim,
const RTOp_value_type  values[],
ptrdiff_t  values_stride,
struct RTOp_SubVector sub_vec 

Set the members for a non-mutable sub-vector.

Definition at line 39 of file RTOp.c.

void RTOp_sub_vector_null ( struct RTOp_SubVector sub_vec  ) 

Initialize a sub-vector argument to null.

Definition at line 56 of file RTOp.c.

void RTOp_mutable_sub_vector ( RTOp_index_type  global_offset,
RTOp_index_type  sub_dim,
RTOp_value_type  values[],
ptrdiff_t  values_stride,
struct RTOp_MutableSubVector sub_vec 

Set the members for a mutable dense sub-vector.

Definition at line 64 of file RTOp.c.

void RTOp_mutable_sub_vector_null ( struct RTOp_MutableSubVector sub_vec  ) 

Initialize a sub-vector argument to null.

Definition at line 82 of file RTOp.c.

Generated on Tue Oct 20 12:54:02 2009 for MOOCHO (Single Doxygen Collection) by doxygen 1.4.7