mpi_type_contiguous(3openmpi) [osx man page]

MPI_Type_contiguous(3OpenMPI)											     MPI_Type_contiguous(3OpenMPI)

NAME

       MPI_Type_contiguous - Creates a contiguous datatype.

SYNTAX

C Syntax
       #include <mpi.h>
       int MPI_Type_contiguous(int count, MPI_Datatype oldtype,
	    MPI_Datatype *newtype)

Fortran Syntax
       INCLUDE 'mpif.h'
       MPI_TYPE_CONTIGUOUS(COUNT, OLDTYPE, NEWTYPE, IERROR)
	    INTEGER   COUNT, OLDTYPE, NEWTYPE, IERROR

C++ Syntax
       #include <mpi.h>
       Datatype Datatype::Create_contiguous(int count) const

INPUT PARAMETERS

       count	 Replication count (nonnegative integer).

       oldtype	 Old datatype (handle).

OUTPUT PARAMETERS

       newtype	 New datatype (handle).

       IERROR	 Fortran only: Error status (integer).

DESCRIPTION

       The simplest datatype constructor is MPI_Type_contiguous, which allows replication of a datatype into contiguous locations.

       newtype is the datatype obtained by concatenating count copies of oldtype. Concatenation is defined using the extent of oldtype as the size
       of the concatenated copies.

       Example: Let oldtype have type map {(double, 0), (char, 8)}, with extent 16, and let count = 3. The type map of the  datatype  returned	by
       newtype is

	   {(double, 0), (char, 8), (double, 16), (char, 24),
	   (double, 32), (char, 40)];

       i.e., alternating double and char elements, with displacements 0, 8, 16, 24, 32, 40.

       In general, assume that the type map of oldtype is

	   {(type(0), disp(0)),...,(type(n-1), disp(n-1))},

       with extent ex. Then newtype has a type map with count times n entries defined by:

	   {(type(0), disp(0)), ...,(type(n-1), disp(n-1)),
	   (type(0), disp(0) + ex), ...,(type(n-1),
	   disp(n-1) + ex), ...,(type(0), disp(0) + ex * (count - 1)),
	   ...,(type(n-1), disp(n-1) + ex * (count - 1))}.

       For more information about derived datatypes, see Section 3.12 of the MPI-1 Standard.

ERRORS

       Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument. C++ func-
       tions do not return errors. If the default error handler is set to MPI::ERRORS_THROW_EXCEPTIONS, then on error the C++ exception  mechanism
       will be used to throw an MPI:Exception object.

       Before  the error value is returned, the current MPI error handler is called. By default, this error handler aborts the MPI job, except for
       I/O function errors. The error handler may be changed with MPI_Comm_set_errhandler; the predefined error handler MPI_ERRORS_RETURN  may	be
       used to cause error values to be returned. Note that MPI does not guarantee that an MPI program can continue past an error.

Open MPI 1.2							  September 2006				     MPI_Type_contiguous(3OpenMPI)

Check Out this Related Man Page

MPI_Type_contiguous(3)							MPI						    MPI_Type_contiguous(3)

NAME

       MPI_Type_contiguous -  Creates a contiguous datatype

SYNOPSIS

       int MPI_Type_contiguous(int count,
			     MPI_Datatype old_type,
			     MPI_Datatype *new_type_p)

INPUT PARAMETERS

       count  - replication count (nonnegative integer)
       oldtype
	      - old datatype (handle)

OUTPUT PARAMETER

       newtype
	      - new datatype (handle)

THREAD AND INTERRUPT SAFETY

       This  routine  is  thread-safe.	This means that this routine may be safely used by multiple threads without the need for any user-provided
       thread locks.  However, the routine is not interrupt safe.  Typically, this is due to the use of memory allocation routines such as  malloc
       or other non-MPICH runtime routines that are themselves not interrupt-safe.

NOTES FOR FORTRAN

       All  MPI  routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have an additional argument ierr at the end of the argument list.  ierr
       is an integer and has the same meaning as the return value of the routine in C.	In Fortran, MPI routines are subroutines, and are  invoked
       with the call statement.

       All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in Fortran.

ERRORS

       All  MPI  routines (except MPI_Wtime and MPI_Wtick ) return an error value; C routines as the value of the function and Fortran routines in
       the last argument.  Before the value is returned, the current MPI error handler is called.  By default, this error handler aborts  the  MPI
       job.   The  error  handler  may	be  changed  with  MPI_Comm_set_errhandler  (for  communicators), MPI_File_set_errhandler (for files), and
       MPI_Win_set_errhandler (for RMA windows).  The MPI-1 routine MPI_Errhandler_set may be used but its  use  is  deprecated.   The	predefined
       error handler MPI_ERRORS_RETURN may be used to cause error values to be returned.  Note that MPI does not guarentee that an MPI program can
       continue past an error; however, MPI implementations will attempt to continue whenever possible.

       MPI_SUCCESS
	      - No error; MPI routine completed successfully.
       MPI_ERR_TYPE
	      - Invalid datatype argument.  May be an uncommitted MPI_Datatype (see MPI_Type_commit ).
       MPI_ERR_COUNT
	      - Invalid count argument.  Count arguments must be non-negative; a count of zero is often valid.
       MPI_ERR_INTERN
	      - This error is returned when some part of the MPICH implementation is unable to acquire memory.

LOCATION

       type_contiguous.c

								     7/30/2010						    MPI_Type_contiguous(3)

Linux and UNIX Man Pages

mpi_type_contiguous(3openmpi) [osx man page]

Check Out this Related Man Page