Merge pull request #12 from agrippa/clarify_team_invalid

Clarify behavior of shmem_sync, shmem_broadcast, shmem_reduction, shmem_alltoall(s), shmem_collect when passed invalid team
jdinan · Feb 26, 2020 · fdd9476 · fdd9476
2 parents 88f5e9a + bdda43b
commit fdd9476
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 7 deletions.
diff --git a/content/shmem_alltoall.tex b/content/shmem_alltoall.tex
@@ -92,6 +92,8 @@
 
     Team-based collect routines operate over all \acp{PE} in the provided team
     argument. All \acp{PE} in the provided team must participate in the collective.
+    If \VAR{team} compares equal to \LibConstRef{SHMEM\_TEAM\_INVALID} or is
+    otherwise invalid, the behavior is undefined.
 
     Active-set-based collective routines operate over all \acp{PE} in the active set
     defined by the \VAR{PE\_start}, \VAR{logPE\_stride}, \VAR{PE\_size} triplet.

diff --git a/content/shmem_broadcast.tex b/content/shmem_broadcast.tex
@@ -71,9 +71,8 @@
     \item The \dest{} object is updated on all \acp{PE}.
     \item All \acp{PE} in the \VAR{team} argument must participate in
       the operation.
-    \item If an invalid team handle or
-      \LibConstRef{SHMEM\_TEAM\_INVALID} is passed to this routine,
-      the behavior is undefined.
+    \item If \VAR{team} compares equal to \LibConstRef{SHMEM\_TEAM\_INVALID} or is
+      otherwise invalid, the behavior is undefined.
     \item \ac{PE} numbering is relative to the team. The specified
       root \ac{PE} must be a valid \ac{PE} number for the team,
       between \CONST{0} and \VAR{N$-$1}, where \VAR{N} is the size of

diff --git a/content/shmem_collect.tex b/content/shmem_collect.tex
@@ -82,6 +82,8 @@
 
     Team-based collect routines operate over all \acp{PE} in the provided team argument. All
     \acp{PE} in the provided team must participate in the operation.
+    If \VAR{team} compares equal to \LibConstRef{SHMEM\_TEAM\_INVALID} or is
+    otherwise invalid, the behavior is undefined.
 
     Active-set-based collective routines operate over all \acp{PE} in the active set
     defined by the \VAR{PE\_start}, \VAR{logPE\_stride}, \VAR{PE\_size} triplet.

diff --git a/content/shmem_reductions.tex b/content/shmem_reductions.tex
@@ -273,8 +273,9 @@
     completely disjoint.
 
     Team-based reduction routines operate over all \acp{PE} in the provided team argument. All
-    \acp{PE} in the provided team must participate in the reduction. If an invalid team handle
-    or \LibConstRef{SHMEM\_TEAM\_INVALID} is passed to this routine, the behavior is undefined.
+    \acp{PE} in the provided team must participate in the reduction.
+    If \VAR{team} compares equal to \LibConstRef{SHMEM\_TEAM\_INVALID} or is
+    otherwise invalid, the behavior is undefined.
 
     Active-set-based sync routines operate over all \acp{PE} in the active set
     defined by the \VAR{PE\_start}, \VAR{logPE\_stride}, \VAR{PE\_size} triplet.

diff --git a/content/shmem_sync.tex b/content/shmem_sync.tex
@@ -48,8 +48,8 @@
 
     Team-based sync routines operate over all \acp{PE} in the provided team argument. All
     \acp{PE} in the provided team must participate in the sync operation.
-    If an invalid team handle or \LibConstRef{SHMEM\_TEAM\_INVALID}
-    is passed to this routine, the behavior is undefined.
+    If \VAR{team} compares equal to \LibConstRef{SHMEM\_TEAM\_INVALID} or is
+    otherwise invalid, the behavior is undefined.
 
     Active-set-based sync routines operate over all \acp{PE} in the active set
     defined by the \VAR{PE\_start}, \VAR{logPE\_stride}, \VAR{PE\_size} triplet.