shmem_atomic_fetch_or.tex

\apisummary{
  Atomically perform a fetching bitwise OR operation on a remote data object.
}

\begin{apidefinition}

\begin{C11synopsis}
TYPE shmem_atomic_fetch_or(TYPE *dest, TYPE value, int pe);
\end{C11synopsis}
where \TYPE{} is one of the bitwise \ac{AMO} types specified by
Table~\ref{bitamotypes}.

\begin{Csynopsis}
TYPE shmem_<TYPENAME>_atomic_fetch_or(TYPE *dest, TYPE value, int pe);
\end{Csynopsis}
where \TYPE{} is one of the bitwise \ac{AMO} types and has a corresponding
\TYPENAME{} specified by Table~\ref{bitamotypes}.

\begin{apiarguments}

  \apiargument{OUT}{dest}{A pointer to the remotely accessible data object to
    be updated.}
  \apiargument{IN}{value}{The operand to the bitwise OR operation.}
  \apiargument{IN}{pe}{An integer value for the \ac{PE} on which \VAR{dest}
    is to be updated.}

\end{apiarguments}

\apidescription{
  \FUNC{shmem\_atomic\_fetch\_or} atomically performs a fetching bitwise OR
  on the remotely accessible data object pointed to by \VAR{dest} at PE
  \VAR{pe} with the operand \VAR{value}.
}

\apireturnvalues{
  The value pointed to by \VAR{dest} on PE \VAR{pe} immediately before the
  operation is performed.
}

\apinotes{
  None.
}

\end{apidefinition}