Manual Reference Pages  - atomic_ref (3fortran)

NAME

ATOMIC_REF(3) - [ATOMIC] Obtaining the value of a variable atomically

SYNOPSIS

call atomic_ref(value, atom [,stat] )

         subroutine atomic_ref(value,atom,stat)

integer(atomic_int_kind),intent(in) :: value integer(atomic_int_kind) :: atom[*] integer,intent(out),intent(out) :: stat

CHARACTERISTICS

o ATOM is a scalar coarray or coindexed variable of either integer type with atomic_int_kind kind or logical type with atomic_logical_kind kind.
o VALUE is a scalar of the same type as ATOM. If the kind is different, the value is converted to the kind of ATOM.
o STAT is a Scalar default-kind integer variable.

DESCRIPTION

ATOMIC_REF(3) atomically assigns the value of the variable ATOM to VALUE. When STAT is present and the invocation was successful, it is assigned the value 0. If it is present and the invocation has failed, it is assigned a positive value; in particular, for a coindexed ATOM, if the remote image has stopped, it is assigned the value of iso_fortran_env’s STAT_STOPPED_IMAGE and if the remote image has failed, the value STAT_FAILED_IMAGE.

OPTIONS

o VALUE : Scalar of the same type as ATOM. If the kind is different, the value is converted to the kind of ATOM.
o ATOM : Scalar coarray or coindexed variable of either integer type with atomic_int_kind kind or logical type with atomic_logical_kind kind.
o STAT : (optional) Scalar default-kind integer variable.

EXAMPLES

Sample program:

    program demo_atomic_ref
    use iso_fortran_env
    implicit none
    logical(atomic_logical_kind) :: atom[*]
    logical :: val
       call atomic_ref( val, atom[1] )
       if (val) then
          print *, "Obtained"
       endif
    end program demo_atomic_ref

STANDARD

Fortran 2008 ; with STAT, TS 18508

SEE ALSO

ATOMIC_DEFINE(3), ATOMIC_CAS(3), ISO_FORTRAN_ENV(3),

ATOMIC_FETCH_ADD(3), ATOMIC_FETCH_AND(3),

ATOMIC_FETCH_OR(3), ATOMIC_FETCH_XOR(3)

Fortran intrinsic descriptions


Nemo Release 3.1 atomic_ref (3fortran) November 02, 2024
Generated by manServer 1.08 from cb9ac451-c41d-4f5c-884d-9bc612916a47 using man macros.