File: MPI_Get_library_version.3.rst

package info (click to toggle)
openmpi 5.0.8-10
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 201,692 kB
  • sloc: ansic: 613,078; makefile: 42,351; sh: 11,194; javascript: 9,244; f90: 7,052; java: 6,404; perl: 5,179; python: 1,859; lex: 740; fortran: 61; cpp: 20; tcl: 12
file content (83 lines) | stat: -rw-r--r-- 1,951 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
.. _mpi_get_library_version:

MPI_Get_library_version
=======================

.. include_body

:ref:`MPI_Get_library_version` |mdash| Returns a string of the current Open MPI
version

SYNTAX
------

C Syntax
^^^^^^^^

.. code-block:: c

   #include <mpi.h>

   int MPI_Get_library_version(char *version, int *resultlen)

Fortran Syntax
^^^^^^^^^^^^^^

.. code-block:: fortran

   USE MPI
   ! or the older form: INCLUDE 'mpif.h'

   MPI_GET_LIBRARY_VERSION(VERSION, RESULTLEN, IERROR)
       CHARACTER*(*)   NAME
       INTEGER RESULTLEN, IERROR

Fortran 2008 Syntax
^^^^^^^^^^^^^^^^^^^

.. code-block:: fortran

   USE mpi_f08

   MPI_Get_library_version(version, resulten, ierror)
       CHARACTER(LEN=MPI_MAX_LIBRARY_VERSION_STRING), INTENT(OUT) :: version
       INTEGER, INTENT(OUT) :: resultlen
       INTEGER, OPTIONAL, INTENT(OUT) :: ierror

OUTPUT PARAMETERS
-----------------

* ``version`` : A string containing the Open MPI version (string).
* ``resultlen`` : Length (in characters) of result returned in version
   (integer).
* ``ierror`` : Fortran only: Error status (integer).

DESCRIPTION
-----------

This routine returns a string representing the version of the MPI
library. The version argument is a character string for maximum
flexibility.

The number of characters actually written is returned in the output
argument, resultlen. In C, a '0' character is additionally stored at
version[resultlen]. The resultlen cannot be larger than
(MPI_MAX_LIBRARY_VERSION_STRING - 1). In Fortran, version is padded on
the right with blank characters. The resultlen cannot be larger than
MPI_MAX_LIBRARY_VERSION_STRING.

NOTE
----

The version string that is passed must be at least
MPI_MAX_LIBRARY_VERSION_STRING characters long.

:ref:`MPI_Get_library_version` is one of the few functions that can be called
before :ref:`MPI_Init` and after :ref:`MPI_Finalize`.

ERRORS
------

.. include:: ./ERRORS.rst

.. seealso:: :ref:`MPI_Get_version`