File: shmem_int_inc.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 (78 lines) | stat: -rw-r--r-- 1,508 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
.. _shmem_int_inc:


shmem_int_inc
=============

.. include_body

shmem_int4_inc\ (3), shmem_int8_inc\ (3), :ref:`shmem_int_inc`\ (3),
:ref:`shmem_long_inc`\ (3), :ref:`shmem_longlong_inc`\ (3) - These routines
perform an atomic increment operation on a remote data object.


SYNOPSIS
--------

C or C++:

.. code-block:: c++

   #include <mpp/shmem.h>

   int shmem_int_inc(int *target, int pe)

   long shmem_long_inc(long *target, int pe)

   long long shmem_longlong_inc(long long *target, int pe)

Fortran:

.. code-block:: fortran

   INCLUDE "mpp/shmem.fh"

   INTEGER pe
   INTEGER(KIND=4) SHMEM_INT4_INC, target4
   INTEGER(KIND=8) SHMEM_INT8_INC, target8

   ires4 = SHMEM_INT4_INC(target4, pe)

   ires8 = SHMEM_INT8_INC(target8, pe)


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

The atomic increment routines replace the value of **target** with its
value incremented by one. The operation must be completed without the
possibility of another process updating **target** between the time of
the fetch and the update.

The arguments are as follows:

target
   The remotely accessible integer data object to be updated on the
   remote PE. The type of target should match that implied in the
   SYNOPSIS section.

pe
   An integer that indicates the PE number upon which target is to be
   updated. If you are using Fortran, it must be a default integer
   value.


NOTES
-----

The term remotely accessible is defined in *intro_shmem*\ (3).


RETURN VALUES
-------------

None.


.. seealso::
   *intro_shmem*\ (3)