Skip to content

Latest commit

 

History

History
91 lines (61 loc) · 2.01 KB

MPI_Type_get_extent.3.rst

File metadata and controls

91 lines (61 loc) · 2.01 KB
Raw

MPI_Type_get_extent

:ref:`MPI_Type_get_extent`, :ref:`MPI_Type_get_extent_x` - Returns the lower bound and extent of a data type.

SYNTAX

C Syntax

#include <mpi.h>

int MPI_Type_get_extent(MPI_Datatype datatype, MPI_Aint *lb,
     MPI_Aint *extent)
int MPI_Type_get_extent_x(MPI_Datatype datatype, MPI_Count *lb,
     MPI_Count *extent)

Fortran Syntax

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_TYPE_GET_EXTENT(DATATYPE, LB, EXTENT, IERROR)
     INTEGER DATATYPE, IERROR
     INTEGER(KIND=MPI_ADDRESS_KIND) LB, EXTENT
MPI_TYPE_GET_EXTENT_X(DATATYPE, LB, EXTENT, IERROR)
     INTEGER DATATYPE, IERROR
     INTEGER(KIND=MPI_COUNT_KIND) LB, EXTENT

Fortran 2008 Syntax

USE mpi_f08
MPI_Type_get_extent(datatype, lb, extent, ierror)
     TYPE(MPI_Datatype), INTENT(IN) :: datatype
     INTEGER(KIND=MPI_ADDRESS_KIND), INTENT(OUT) :: lb, extent
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror
MPI_Type_get_extent_x(datatype, lb, extent, ierror)
     TYPE(MPI_Datatype), INTENT(IN) :: datatype
     INTEGER(KIND = MPI_COUNT_KIND), INTENT(OUT) :: lb, extent
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

INPUT PARAMETER

  • datatype: Data type (handle).

OUTPUT PARAMETERS

  • lb: Lower bound of data type (integer).
  • extent: Data type extent (integer).
  • ierror: Fortran only: Error status (integer).

DESCRIPTION

:ref:`MPI_Type_get_extent` returns the lower bound and the extent of datatype. For either function, if either the lb or extent parameter cannot express the value to be returned (e.g., if the parameter is too small to hold the output value), it is set to MPI_UNDEFINED.

NOTE

Use of :ref:`MPI_Type_get_extent` is strongly recommended over the legacy MPI-1 functions :ref:`MPI_Type_extent` and :ref:`MPI_Type_lb`.

ERRORS