Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Collectives Section Committee RC2 changes #549

Merged
merged 10 commits into from
Nov 1, 2024
1 change: 1 addition & 0 deletions content/collective_intro.tex
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ \subsubsection*{Team-based collectives}
\item \FUNC{shmem\_[\FuncParam{TYPENAME}\_]collect[mem]}
\item \FUNC{shmem\_[\FuncParam{TYPENAME}\_]fcollect[mem]}
\item \FUNC{shmem\_[\FuncParam{TYPENAME}\_]\{and, or, xor, max, min, sum, prod\}\_reduce}
\item \FUNC{shmem\_[\FuncParam{TYPENAME}\_]sum\_\{in, ex\}scan}
\end{itemize}

In addition, all team creation functions are collective operations. In addition to the ordering
Expand Down
2 changes: 1 addition & 1 deletion content/shmem_alltoall.tex
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@
If \VAR{team} compares equal to \LibConstRef{SHMEM\_TEAM\_INVALID} or is
otherwise invalid, the behavior is undefined.

Before any \ac{PE} calls a \FUNC{shmem\_alltoall} routine, the following
Before the local \ac{PE} calls a \FUNC{shmem\_alltoall} routine, the following
conditions must be ensured, otherwise the behavior is undefined:
\begin{itemize}
\item The \dest{} array on all \acp{PE} in the team is ready to
Expand Down
2 changes: 1 addition & 1 deletion content/shmem_broadcast.tex
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@
the team.
\end{itemize}

Before any \ac{PE} calls a broadcast routine, the following conditions
Before the local \ac{PE} calls a broadcast routine, the following conditions
must be ensured, otherwise the behavior is undefined:
\begin{itemize}
\item The \dest{} array on all \acp{PE} in the team is ready to
Expand Down
2 changes: 1 addition & 1 deletion content/shmem_collect.tex
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@
If \VAR{team} compares equal to \LibConstRef{SHMEM\_TEAM\_INVALID} or is
otherwise invalid, the behavior is undefined.

Before any \ac{PE} calls a collect routine, the following conditions must
Before the local \ac{PE} calls a collect routine, the following conditions must
be ensured, otherwise the behavior is undefined:
\begin{itemize}
\item The \dest{} array on all \acp{PE} in the team is ready to
Expand Down
16 changes: 14 additions & 2 deletions content/shmem_reductions.tex
Original file line number Diff line number Diff line change
Expand Up @@ -295,7 +295,7 @@ \subsubsubsection{PROD}
If \VAR{team} compares equal to \LibConstRef{SHMEM\_TEAM\_INVALID} or is
otherwise invalid, the behavior is undefined.

Before any \ac{PE} calls a reduction routine, the following conditions
Before the local \ac{PE} calls a reduction routine, the following conditions
must be ensured, otherwise the behavior is undefined:
\begin{itemize}
\item The \dest{} array on all \acp{PE} in the team is ready to
Expand Down Expand Up @@ -373,7 +373,19 @@ \subsubsubsection{PROD}
}

\apireturnvalues{
Zero on successful local completion. Nonzero otherwise.
Zero on successful local completion. Nonzero otherwise.
}

\apinotes{
The binary operations performed by \openshmem reductions are intended to be
associative and commutative.
However, floating point arithmetic is not associative or commutative due to
the inherent inaccuracies of floating-point representations caused by
rounding errors and finite precision.
This can lead to variations in the result of \openshmem arithmetic
reduction operations on floating-point datatypes, including NaN values.
A future version of the \openshmem specification may clarify the behavior
of reductions on floating point datatypes.
}

\begin{apiexamples}
Expand Down
2 changes: 1 addition & 1 deletion content/shmem_scan.tex
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@
\LibConstRef{SHMEM\_TEAM\_INVALID} or is otherwise invalid, the
behavior is undefined.

Before any \ac{PE} calls a scan routine, the following conditions must be
Before the local \ac{PE} calls a scan routine, the following conditions must be
ensured, otherwise the behavior is undefined:
\begin{itemize}
\item The \dest{} array on all \acp{PE} in the team is ready to accept
Expand Down