doc: cleaned fortran examples

Changed from .EQ. to == and other bools.
Also fixed a couple of wrong codes and beautified in general.

Signed-off-by: Nick Papior <[email protected]>

Author: zerothi

docs/man-openmpi/man3/MPI_Alloc_mem.3.rst

@@ -74,6 +74,33 @@ pointer object for this parameter. The provided argument should be a
 pointer to a pointer of arbitrary type (e.g., ``void **``).
 
 
+Fortran NOTES
+-------------
+
+The :ref:`MPI_Alloc_mem` calls require the use of the ``iso_c_binding`` module
+for due to the use of ``TYPE(C_PTR)``.
+
+.. code-block:: fortran
+
+   use iso_c_binding
+
+   type(c_ptr) :: alloc_ptr
+   integer :: size, ierr
+   double precision, pointer :: array(:,:)
+
+   ! A 2D array of 100 elements
+   size = 10 * 10
+   call MPI_Alloc_Mem(size * 8, MPI_INFO_NULL, alloc_ptr, ierr)
+
+   ! Point to the array
+   call c_f_pointer(alloc_ptr, array, [10, 10])
+
+   ! ... use the array ...
+
+   ! Free the memory, no need for the alloc_ptr
+   call MPI_Free_mem(array, ierr)
+
+
 ERRORS
 ------
 

docs/man-openmpi/man3/MPI_Probe.3.rst

@@ -115,17 +115,17 @@ problem.
    CALL MPI_COMM_RANK(comm, rank, ierr)
    IF (rank == 0) THEN
       CALL MPI_SEND(i, 1, MPI_INTEGER, 2, 0, comm, ierr)
-   ELSE IF(rank.EQ.1) THEN
+   ELSE IF(rank == 1) THEN
       CALL MPI_SEND(x, 1, MPI_REAL, 2, 0, comm, ierr)
    ELSE
       DO i=1, 2
          CALL MPI_PROBE(MPI_ANY_SOURCE, 0,
                         comm, status, ierr)
-	 IF (status(MPI_SOURCE) = 0) THEN
-	    CALL MPI_RECV(i, 1, MPI_INTEGER, MPI_ANY_SOURCE,
+	 IF (status(MPI_SOURCE) == 0) THEN
+	    CALL MPI_RECV(i, 1, MPI_INTEGER, MPI_ANY_SOURCE, &
                           0, status, ierr)
 	 ELSE
-	    CALL MPI_RECV(x, 1, MPI_REAL, MPI_ANY_SOURCE,
+	    CALL MPI_RECV(x, 1, MPI_REAL, MPI_ANY_SOURCE, &
                           0, status, ierr)
 	 END IF
       END DO

docs/man-openmpi/man3/MPI_Reduce.3.rst

@@ -469,28 +469,28 @@ containing the largest value.
        ...
        ! each process has an array of 30 double: ain(30)
 
-       DOUBLE PRECISION ain(30), aout(30)
-       INTEGER ind(30);
-       DOUBLE PRECISION in(2,30), out(2,30)
-       INTEGER i, myrank, root, ierr;
-
-       MPI_COMM_RANK(MPI_COMM_WORLD, myrank);
-           DO I=1, 30
-               in(1,i) = ain(i)
-               in(2,i) = myrank    ! myrank is coerced to a double
-           END DO
+       DOUBLE PRECISION :: ain(30), aout(30)
+       INTEGER :: ind(30)
+       DOUBLE PRECISION :: in(2,30), out(2,30)
+       INTEGER :: i, myrank, root, ierr
+
+       call MPI_COMM_RANK(MPI_COMM_WORLD, myrank)
+       DO I=1, 30
+           in(1,i) = ain(i)
+           in(2,i) = myrank    ! myrank is coerced to a double
+       END DO
 
-       MPI_REDUCE( in, out, 30, MPI_2DOUBLE_PRECISION, MPI_MAXLOC, root,
-                                                                 comm, ierr );
+       call MPI_REDUCE( in, out, 30, MPI_2DOUBLE_PRECISION, MPI_MAXLOC, root, &
+                                                                 comm, ierr )
        ! At this point, the answer resides on process root
 
-       IF (myrank .EQ. root) THEN
-               ! read ranks out
-               DO I= 1, 30
-                   aout(i) = out(1,i)
-                   ind(i) = out(2,i)  ! rank is coerced back to an integer
-               END DO
-           END IF
+       IF (myrank == root) THEN
+           ! read ranks out
+           DO I= 1, 30
+               aout(i) = out(1,i)
+               ind(i) = out(2,i)  ! rank is coerced back to an integer
+           END DO
+       END IF
 
 **Example 5:** Each process has a nonempty array of values. Find the
 minimum global value, the rank of the process that holds it, and its

docs/man-openmpi/man3/MPI_Reduce_local.3.rst

@@ -276,11 +276,11 @@ datatypes:
        MPI_SHORT_INT            short and int
        MPI_LONG_DOUBLE_INT      long double and int
 
-The data type MPI_2REAL is equivalent to:
+The data type ``MPI_2REAL`` is equivalent to:
 
 .. code-block:: fortran
 
-       MPI_TYPE_CONTIGUOUS(2, MPI_REAL, MPI_2REAL)
+       call MPI_TYPE_CONTIGUOUS(2, MPI_REAL, MPI_2REAL)
 
 Similar statements apply for MPI_2INTEGER, MPI_2DOUBLE_PRECISION, and
 MPI_2INT.

docs/man-openmpi/man3/MPI_Request_free.3.rst

@@ -85,14 +85,14 @@ receive has completed and the receive buffer can be reused.
 .. code-block:: fortran
 
        CALL MPI_COMM_RANK(MPI_COMM_WORLD, rank)
-       IF(rank.EQ.0) THEN
+       IF(rank == 0) THEN
            DO i=1, n
              CALL MPI_ISEND(outval, 1, MPI_REAL, 1, 0, req, ierr)
              CALL MPI_REQUEST_FREE(req, ierr)
              CALL MPI_IRECV(inval, 1, MPI_REAL, 1, 0, req, ierr)
              CALL MPI_WAIT(req, status, ierr)
            END DO
-       ELSE    ! rank.EQ.1
+       ELSE IF (rank == 1) THEN
            CALL MPI_IRECV(inval, 1, MPI_REAL, 0, 0, req, ierr)
            CALL MPI_WAIT(req, status)
            DO I=1, n-1

docs/man-openmpi/man3/MPI_Type_commit.3.rst

@@ -67,7 +67,7 @@ different buffers, with different starting addresses.
 
 .. code-block:: fortran
 
-       INTEGER type1, type2
+       INTEGER :: type1, type2
        CALL MPI_TYPE_CONTIGUOUS(5, MPI_REAL, type1, ierr)
                      ! new type object created
        CALL MPI_TYPE_COMMIT(type1, ierr)

docs/man-openmpi/man3/MPI_Type_create_struct.3.rst

@@ -101,7 +101,7 @@ returns a datatype with type map
 
 That is, two copies of ``MPI_FLOAT`` starting at 0, followed by one copy of
 ``type1`` starting at 16, followed by three copies of ``MPI_CHAR``, starting at
-26. (We assume that a float occupies 4 bytes.)
+26.
 
 
 **Example 2:**
@@ -147,17 +147,18 @@ An example of a struct with only some components part of the type
    if ( rank == 0 ) {
        // ... initialize values
        MPI_Send(values, 3, mpi_dt_mystruct, 1, 0, MPI_COMM_WORLD);
-   } else if ( rank == 1 )
+   } else if ( rank == 1 ) {
        MPI_Recv(values, 3, mpi_dt_mystruct, 0, 0, MPI_COMM_WORLD, MPI_STATUS_IGNORE);
+   }
 
 
-For more information, see section 3.12.1 of the MPI-1.1 Standard.
+For more information, see section 5.1.2 of the MPI-4.0 Standard.
 
 
 NOTES
 -----
 
-If an upperbound is set explicitly by using the MPI datatype MPI_UB, the
+If an upper bound is set explicitly by using the MPI datatype ``MPI_UB``, the
 corresponding index must be positive.
 
 The MPI-1 Standard originally made vague statements about padding and
@@ -180,7 +181,7 @@ have allowed an implementation to make the extent an MPI datatype for
 this structure equal to ``2*sizeof(int)``. However, since different systems
 might define different paddings, a clarification to the standard made
 epsilon zero. Thus, if you define a structure datatype and wish to send
-or receive multiple items, you should explicitly include an MPI_UB entry
+or receive multiple items, you should explicitly include an ``MPI_UB`` entry
 as the last member of the structure. See the above example.
 
 

docs/man-openmpi/man3/MPI_Wait.3.rst

@@ -97,11 +97,11 @@ Example: Simple usage of nonblocking operations and :ref:`MPI_Wait`.
 .. code-block:: fortran
 
        CALL MPI_COMM_RANK(comm, rank, ierr)
-       IF(rank.EQ.0) THEN
+       IF(rank == 0) THEN
            CALL MPI_ISEND(a(1), 10, MPI_REAL, 1, tag, comm, request, ierr)
            **** do some computation ****
            CALL MPI_WAIT(request, status, ierr)
-       ELSE
+       ELSE IF (rank == 1) THEN
            CALL MPI_IRECV(a(1), 15, MPI_REAL, 0, tag, comm, request, ierr)
            **** do some computation ****
            CALL MPI_WAIT(request, status, ierr)

docs/man-openmpi/man3/MPI_Waitany.3.rst

@@ -88,20 +88,20 @@ special value for the *status* argument.
 
        CALL MPI_COMM_SIZE(comm, size, ierr)
        CALL MPI_COMM_RANK(comm, rank, ierr)
-       IF(rank .GT 0) THEN         ! client code
-           DO WHILE(.TRUE.)
+       IF(rank > 0) THEN         ! client code
+           DO
               CALL MPI_ISEND(a, n, MPI_REAL, 0, tag, comm, request, ierr)
               CALL MPI_WAIT(request, status, ierr)
            END DO
        ELSE         ! rank=0 -- server code
               DO i=1, size-1
-                 CALL MPI_IRECV(a(1,i), n, MPI_REAL, i tag,
+                 CALL MPI_IRECV(a(1,i), n, MPI_REAL, i tag, &
                           comm, request_list(i), ierr)
               END DO
-              DO WHILE(.TRUE.)
+              DO
                  CALL MPI_WAITANY(size-1, request_list, index, status, ierr)
                  CALL DO_SERVICE(a(1,index))  ! handle one message
-                 CALL MPI_IRECV(a(1, index), n, MPI_REAL, index, tag,
+                 CALL MPI_IRECV(a(1, index), n, MPI_REAL, index, tag, &
                            comm, request_list(index), ierr)
               END DO
        END IF

docs/man-openmpi/man3/MPI_Waitsome.3.rst

@@ -108,22 +108,22 @@ using :ref:`MPI_Waitsome`.
 
        CALL MPI_COMM_SIZE(comm, size, ierr)
        CALL MPI_COMM_RANK(comm, rank, ierr)
-       IF(rank .GT. 0) THEN         ! client code
-           DO WHILE(.TRUE.)
+       IF(rank > 0) THEN         ! client code
+           DO
               CALL MPI_ISEND(a, n, MPI_REAL, 0, tag, comm, request, ierr)
               CALL MPI_WAIT(request, status, ierr)
            END DO
        ELSE         ! rank=0 -- server code
            DO i=1, size-1
-              CALL MPI_IRECV(a(1,i), n, MPI_REAL, i, tag,
+              CALL MPI_IRECV(a(1,i), n, MPI_REAL, i, tag, &
                              comm, requests(i), ierr)
            END DO
-           DO WHILE(.TRUE.)
-              CALL MPI_WAITSOME(size, request_list, numdone,
+           DO
+              CALL MPI_WAITSOME(size, request_list, numdone, &
                                indices, statuses, ierr)
               DO i=1, numdone
                  CALL DO_SERVICE(a(1, indices(i)))
-                 CALL MPI_IRECV(a(1, indices(i)), n, MPI_REAL, 0, tag,
+                 CALL MPI_IRECV(a(1, indices(i)), n, MPI_REAL, i, tag, &
                               comm, requests(indices(i)), ierr)
               END DO
            END DO