GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  MPI_TYPE_FREE (3)

NAME

MPI_Type_free - Frees a data type.

CONTENTS

Syntax
C Syntax
Fortran Syntax
C++ Syntax
Input/output Parameter
Output Parameter
Description
Errors

SYNTAX

C Syntax

#include <mpi.h>
int MPI_Type_free(MPI_Datatype *datatype)

Fortran Syntax

INCLUDE ’mpif.h’
MPI_TYPE_FREE(DATATYPE, IERROR)
        INTEGER DATATYPE, IERROR

C++ Syntax

#include <mpi.h>
void Datatype::Free()

INPUT/OUTPUT PARAMETER

datatype
  Datatype that is freed (handle).

OUTPUT PARAMETER

IERROR Fortran only: Error status (integer).

DESCRIPTION

Marks the datatype object associated with datatype for de-allocation and sets datatype to MPI_DATATYPE_NULL. Any communication that is currently using this datatype will complete normally. Derived datatypes that were defined from the freed datatype are not affected.

Freeing a datatype does not affect any other datatype that was built from the freed datatype. The system behaves as if input datatype arguments to derived datatype constructors are passed by value.

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++ 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.

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.

Search for    or go to Top of page |  Section 3 |  Main Index


1.10.2 MPI_TYPE_FREE (3) Jan 21, 2016

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.