Lockless Inc

NAME

MPI_Type_create_hvector - Construct a new type using a vector of contiguous blocks of another type with strides in bytes

SYNOPSIS

#include <mpi.h> int MPI_Type_hvector(int count , int b_len , MPI_Aint stride , MPI_Datatype oldtype , MPI_Datatype *newtype ); int MPI_Type_create_hvector(int count , int b_len , MPI_Aint stride , MPI_Datatype oldtype , MPI_Datatype *newtype );

#include <pmpi.h> int PMPI_Type_hvector(int count , int b_len , MPI_Aint stride , MPI_Datatype oldtype , MPI_Datatype *newtype ); int PMPI_Type_create_hvector(int count , int b_len , MPI_Aint stride , MPI_Datatype oldtype , MPI_Datatype *newtype );

INPUT PARAMETERS

count - number of vector elements (integer)

b_len - block length of each vector element (integer)

stride - offset between the start of each vector element in bytes (integer)

oldtype - component type (handle)

OUTPUT PARAMETER

newtype - newly constructed type (handle)

DESCRIPTION

The MPI_Type_hvector() and MPI_Type_create_hvector() functions are used to create a new type that describes count series of blocks of b_len contiguous copies of the type oldtype separated by stride - b_len * oldtype.extent bytes apart. In other words, the start of each block is stride bytes apart.

Note that MPI_Type_hvector() and MPI_Type_create_hvector() are aliases to each other. This is due to the MPI FORTRAN ABI incorrectly specifying the strides as integer sized rather than MPI_Aint for MPI_Type_hvector(). Since this version of MPI currently does not support FORTRAN, the two functions are identical. MPI_Type_hvector() has been marked as depreciated by the MPI committee.

The type newtype created by this function should be commited with MPI_Type_commit() if it is to be used with message passing functions. The type should be eventually freed with the MPI_Type_free() function.

PMPI_Type_hvector() and PMPI_Type_create_hvector() are the profiling versions of this function.

ERRORS

All MPI routines except for MPI_Wtime and MPI_Wtick return an error value. The the current MPI error handler is invoked if this return value is not MPI_SUCCESS. The default error handler aborts, but this may be changed with by using the MPI_Errhandler_set() function. The predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned instead. Note that MPI does not guarentee that an MPI program can continue past an error. In this implementation, all errors except MPI_ERR_INTERN or MPI_ERR_OTHER should always be recoverable.

MPI_SUCCESS - No error;

MPI_ERR_COUNT - Invalid count;

MPI_ERR_ARG - Invalid pointer;

MPI_ERR_TYPE - Invalid type;

MPI_ERR_INTERN - Out of Memory.

SEE ALSO

MPI_Type_free (3) MPI_Type_struct (3) MPI_Type_create_struct (3) MPI_Type_contiguous (3) MPI_Type_indexed (3) MPI_Type_hindexed (3) MPI_Type_create_hindexed (3) MPI_Type_hvector (3) MPI_Type_create_hvector (3)

About Us Returns Policy Privacy Policy Send us Feedback
Company Info | Product Index | Category Index | Help | Terms of Use
Copyright © Lockless Inc All Rights Reserved.
My Account View Cart