source: proiecte/hpl/openmpi_compiled/share/man/man3/MPI_Type_size.3 @ 97

Last change on this file since 97 was 97, checked in by (none), 14 years ago

Adding compiled files

File size: 1.8 KB
Line 
1.\"Copyright 2006-2008 Sun Microsystems, Inc.
2.\" Copyright (c) 1996 Thinking Machines Corporation
3.TH MPI_Type_size 3 "Dec 08, 2009" "1.4" "Open MPI"
4.SH NAME
5\fBMPI_Type_size\fP \- Returns the number of bytes occupied by entries in a data type.
6
7.SH SYNTAX
8.ft R
9.SH C Syntax
10.nf
11#include <mpi.h>
12int MPI_Type_size(MPI_Datatype \fIdatatype\fP, int\fI *size\fP)
13
14.SH Fortran Syntax
15.nf
16INCLUDE 'mpif.h'
17MPI_TYPE_SIZE(\fIDATATYPE, SIZE, IERROR\fP)
18        INTEGER \fIDATATYPE, SIZE, IERROR\fP
19
20.SH C++ Syntax
21.nf
22#include <mpi.h>
23int Datatype::Get_size() const
24
25.SH INPUT PARAMETER
26.ft R
27.TP 1i
28datatype     
29Datatype (handle).
30.sp
31
32.SH OUTPUT PARAMETERS
33.ft R
34.TP 1i
35size     
36Datatype size (integer).
37.sp
38.ft R
39.TP 1i
40IERROR
41Fortran only: Error status (integer).
42
43.SH DESCRIPTION
44.ft R
45MPI_Type_size returns the total size, in bytes, of the entries in the type signature associated with datatype; i.e., the total size of the data in a message that would be created with this datatype. Entries that occur multiple times in the datatype are counted with their multiplicity. 
46
47.SH ERRORS
48Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument. C++ functions 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.
49.sp
50Before the error value is returned, the current MPI error handler is
51called. 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. 
52
53
Note: See TracBrowser for help on using the repository browser.