Intel(R) SHMEM Library (ISHMEM) 1.1.0 doc pages

oneapi-src · Jun 28, 2024 · 53a39a0 · 53a39a0
1 parent 8252d27
commit 53a39a0
Show file tree

Hide file tree

Showing 27 changed files with 52 additions and 38 deletions.
diff --git a/docs/_sources/execution_model.rst b/docs/_sources/execution_model.rst
@@ -24,7 +24,7 @@ library<ishmemx_runtime_type_t>`.
    Programs<compiling_and_running_programs>`.
 
 .. note:: Intel® Data Center GPU Max Series devices utilize a multi-tile
-   architecture (as of Intel®  SHMEM |version| with 1 or 2 tiles).  By default,
+   architecture (as of Intel®  SHMEM v1.0.0 with 1 or 2 tiles).  By default,
    the Intel® SHMEM runtime considers each individual `tile` to make up
    a single SYCL device.  However, setting the environment variable
    **enableImplicitScaling=1** enables implicit scaling mode, where each

diff --git a/docs/_sources/teams.rst b/docs/_sources/teams.rst
@@ -330,11 +330,20 @@ A valid triplet is one such that:
    i \in \mathbb{Z}_{size-1}
 
 where :math:`\mathbb{Z}` is the set of natural numbers (:math:`0, 1, \dots`),
-:math:`N` is the number of PEs in the parent team and :math:`size` is a
-positive number indicating the number of PEs in the new team.
+:math:`N` is the number of PEs in the parent team, :math:`size` is a positive
+number indicating the number of PEs in the new team, and :math:`stride` is an integer.
 The index :math:`i` specifies the number of the given PE in the new team.
-Thus, PEs in the new team remain in the same relative order as in the parent
-team.
+When :math:`stride` is greater than zero, PEs in the new team remain in the
+same relative order as in the parent team.
+When :math:`stride` is less than zero, PEs in the new team are in *reverse*
+relative order with respect to the parent team.
+If a :math:`stride` value equal to 0 is passed to
+``ishmem_team_split_strided``, then the `size` argument passed must be 1, or
+the behavior is undefined.
+
+.. A valid :math:`(start, stride, size)` triplet passed to ``ishmem_team_split_strided``
+.. must produce a subset of PEs from the parent team with no duplicate members;
+.. otherwise, the triplet is invalid.
 
 This routine must be called by all PEs in the parent team.
 All PEs must provide the same values for the PE triplet.

diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '1.0.0',
+    VERSION: '1.1.0',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/acknowledgements.html b/docs/acknowledgements.html
@@ -466,7 +466,7 @@ <h1>Copyright<a class="headerlink" href="#copyright" title="Permalink to this he
 
   <p class="copyright">
 
-      © Copyright 2023 Intel Corporation licensed under Creative Commons BY 4.0.
+      © Copyright 2024 Intel Corporation licensed under Creative Commons BY 4.0.
       <br/>
 
   </p>

diff --git a/docs/atomics.html b/docs/atomics.html
@@ -1433,7 +1433,7 @@ <h3>ISHMEM_ATOMIC_FETCH_XOR_NBI<a class="headerlink" href="#ishmem-atomic-fetch-
 
   <p class="copyright">
 
-      © Copyright 2023 Intel Corporation licensed under Creative Commons BY 4.0.
+      © Copyright 2024 Intel Corporation licensed under Creative Commons BY 4.0.
       <br/>
 
   </p>

diff --git a/docs/collectives.html b/docs/collectives.html
@@ -1462,7 +1462,7 @@ <h2>ISHMEMX_REDUCE_WORK_GROUP<a class="headerlink" href="#ishmemx-reduce-work-gr
 
   <p class="copyright">
 
-      © Copyright 2023 Intel Corporation licensed under Creative Commons BY 4.0.
+      © Copyright 2024 Intel Corporation licensed under Creative Commons BY 4.0.
       <br/>
 
   </p>

diff --git a/docs/compiling_and_running_programs.html b/docs/compiling_and_running_programs.html
@@ -407,7 +407,7 @@ <h1>Compiling and Running Programs</h1>
 
   <p class="copyright">
 
-      © Copyright 2023 Intel Corporation licensed under Creative Commons BY 4.0.
+      © Copyright 2024 Intel Corporation licensed under Creative Commons BY 4.0.
       <br/>
 
   </p>

diff --git a/docs/execution_model.html b/docs/execution_model.html
@@ -362,7 +362,7 @@ <h2> Contents </h2>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>Intel® Data Center GPU Max Series devices utilize a multi-tile
-architecture (as of Intel®  SHMEM version 1.0.0 with 1 or 2 tiles).  By default,
+architecture (as of Intel®  SHMEM v1.0.0 with 1 or 2 tiles).  By default,
 the Intel® SHMEM runtime considers each individual <cite>tile</cite> to make up
 a single SYCL device.  However, setting the environment variable
 <strong>enableImplicitScaling=1</strong> enables implicit scaling mode, where each
@@ -504,7 +504,7 @@ <h2>Invoking Intel® SHMEM Operations<a class="headerlink" href="#invoking-intel
 
   <p class="copyright">
 
-      © Copyright 2023 Intel Corporation licensed under Creative Commons BY 4.0.
+      © Copyright 2024 Intel Corporation licensed under Creative Commons BY 4.0.
       <br/>
 
   </p>

diff --git a/docs/genindex.html b/docs/genindex.html
@@ -815,7 +815,7 @@ <h2 id="R">R</h2>
 
   <p class="copyright">
 
-      © Copyright 2023 Intel Corporation licensed under Creative Commons BY 4.0.
+      © Copyright 2024 Intel Corporation licensed under Creative Commons BY 4.0.
       <br/>
 
   </p>

diff --git a/docs/index.html b/docs/index.html
@@ -588,7 +588,7 @@ <h1>Intel® SHMEM<a class="headerlink" href="#intel-shmem" title="Permalink to t
 
   <p class="copyright">
 
-      © Copyright 2023 Intel Corporation licensed under Creative Commons BY 4.0.
+      © Copyright 2024 Intel Corporation licensed under Creative Commons BY 4.0.
       <br/>
 
   </p>

diff --git a/docs/intro.html b/docs/intro.html
@@ -466,7 +466,7 @@ <h2> Contents </h2>
 
   <p class="copyright">
 
-      © Copyright 2023 Intel Corporation licensed under Creative Commons BY 4.0.
+      © Copyright 2024 Intel Corporation licensed under Creative Commons BY 4.0.
       <br/>
 
   </p>

diff --git a/docs/library_constants.html b/docs/library_constants.html
@@ -576,7 +576,7 @@ <h2> Contents </h2>
 
   <p class="copyright">
 
-      © Copyright 2023 Intel Corporation licensed under Creative Commons BY 4.0.
+      © Copyright 2024 Intel Corporation licensed under Creative Commons BY 4.0.
       <br/>
 
   </p>

diff --git a/docs/library_setup_exit_query.html b/docs/library_setup_exit_query.html
@@ -405,7 +405,7 @@ <h2>ISHMEM_INIT<a class="headerlink" href="#id1" title="Permalink to this headin
 OpenSHMEM, MPI, or PMI.</p>
 <div class="admonition important">
 <p class="admonition-title">Important</p>
-<p>As of Intel® SHMEM version 1.0.0 only ISHMEM_RUNTIME_OPENSHMEM is supported.</p>
+<p>As of Intel® SHMEM 1.1.0 only ISHMEM_RUNTIME_OPENSHMEM is supported.</p>
 </div>
 <span class="target" id="ishmemx-attr-t"></span><dl class="cpp struct">
 <dt class="sig sig-object cpp" id="_CPPv414ishmemx_attr_t">
@@ -707,7 +707,7 @@ <h2>ISHMEM_INFO_GET_NAME<a class="headerlink" href="#ishmem-info-get-name" title
 
   <p class="copyright">
 
-      © Copyright 2023 Intel Corporation licensed under Creative Commons BY 4.0.
+      © Copyright 2024 Intel Corporation licensed under Creative Commons BY 4.0.
       <br/>
 
   </p>

diff --git a/docs/memory_management.html b/docs/memory_management.html
@@ -560,7 +560,7 @@ <h2>ISHMEM_CALLOC<a class="headerlink" href="#ishmem-calloc" title="Permalink to
 
   <p class="copyright">
 
-      © Copyright 2023 Intel Corporation licensed under Creative Commons BY 4.0.
+      © Copyright 2024 Intel Corporation licensed under Creative Commons BY 4.0.
       <br/>
 
   </p>

diff --git a/docs/memory_model.html b/docs/memory_model.html
@@ -510,7 +510,7 @@ <h2> Contents </h2>
 
   <p class="copyright">
 
-      © Copyright 2023 Intel Corporation licensed under Creative Commons BY 4.0.
+      © Copyright 2024 Intel Corporation licensed under Creative Commons BY 4.0.
       <br/>
 
   </p>

diff --git a/docs/memory_ordering.html b/docs/memory_ordering.html
@@ -580,7 +580,7 @@ <h2>ISHMEMX_FENCE_WORK_GROUP<a class="headerlink" href="#ishmemx-fence-work-grou
 
   <p class="copyright">
 
-      © Copyright 2023 Intel Corporation licensed under Creative Commons BY 4.0.
+      © Copyright 2024 Intel Corporation licensed under Creative Commons BY 4.0.
       <br/>
 
   </p>

diff --git a/docs/objects.inv b/docs/objects.inv
diff --git a/docs/programming_model.html b/docs/programming_model.html
@@ -373,7 +373,7 @@ <h2>The Intel® SHMEM APIs Overview<a class="headerlink" href="#the-intel-shmem-
 <p>Intel® SHMEM does not yet support all of the
 following routines. Please refer to the <a class="reference internal" href="supported_features.html#supported-features"><span class="std std-ref">Supported
 Features</span></a> section to see which interfaces are supported
-in the 1.0.0 version of Intel® SHMEM.</p>
+in the 1.1.0 version of Intel® SHMEM.</p>
 </div>
 <p>An overview of the Intel® SHMEM routines is described below:</p>
 <ol class="arabic">
@@ -675,7 +675,7 @@ <h2>The <code class="docutils literal notranslate"><span class="pre">work_group<
 
   <p class="copyright">
 
-      © Copyright 2023 Intel Corporation licensed under Creative Commons BY 4.0.
+      © Copyright 2024 Intel Corporation licensed under Creative Commons BY 4.0.
       <br/>
 
   </p>

diff --git a/docs/pt2pt_sync.html b/docs/pt2pt_sync.html
@@ -1374,7 +1374,7 @@ <h2>ISHMEMX_SIGNAL_WAIT_UNTIL_WORK_GROUP<a class="headerlink" href="#ishmemx-sig
 
   <p class="copyright">
 
-      © Copyright 2023 Intel Corporation licensed under Creative Commons BY 4.0.
+      © Copyright 2024 Intel Corporation licensed under Creative Commons BY 4.0.
       <br/>
 
   </p>

diff --git a/docs/rma.html b/docs/rma.html
@@ -1413,7 +1413,7 @@ <h3>ISHMEMX_GET_NBI_WORK_GROUP<a class="headerlink" href="#ishmemx-get-nbi-work-
 
   <p class="copyright">
 
-      © Copyright 2023 Intel Corporation licensed under Creative Commons BY 4.0.
+      © Copyright 2024 Intel Corporation licensed under Creative Commons BY 4.0.
       <br/>
 
   </p>

diff --git a/docs/search.html b/docs/search.html
@@ -331,7 +331,7 @@ <h1>Search</h1>
 
   <p class="copyright">
 
-      © Copyright 2023 Intel Corporation licensed under Creative Commons BY 4.0.
+      © Copyright 2024 Intel Corporation licensed under Creative Commons BY 4.0.
       <br/>
 
   </p>

diff --git a/docs/searchindex.js b/docs/searchindex.js
diff --git a/docs/signaling.html b/docs/signaling.html
@@ -854,7 +854,7 @@ <h2>ISHMEMX_SIGNAL_SET<a class="headerlink" href="#ishmemx-signal-set" title="Pe
 
   <p class="copyright">
 
-      © Copyright 2023 Intel Corporation licensed under Creative Commons BY 4.0.
+      © Copyright 2024 Intel Corporation licensed under Creative Commons BY 4.0.
       <br/>
 
   </p>

diff --git a/docs/supported_features.html b/docs/supported_features.html
@@ -330,7 +330,7 @@ <h1>Supported/Unsupported Features</h1>
   <section id="supported-unsupported-features">
 <span id="supported-features"></span><h1>Supported/Unsupported Features<a class="headerlink" href="#supported-unsupported-features" title="Permalink to this heading">#</a></h1>
 <p>The following tables indicate which APIs are supported in Intel® SHMEM as of
-the 1.0.0 release.
+the 1.1.0 release.
 The Intel® SHMEM development team strives to eventually support all OpenSHMEM
 APIs.
 Currently unsupported interfaces are targeted for implementation in future
@@ -1005,7 +1005,7 @@ <h1>Supported/Unsupported Features</h1>
 
   <p class="copyright">
 
-      © Copyright 2023 Intel Corporation licensed under Creative Commons BY 4.0.
+      © Copyright 2024 Intel Corporation licensed under Creative Commons BY 4.0.
       <br/>
 
   </p>

diff --git a/docs/teams.html b/docs/teams.html
@@ -499,7 +499,7 @@ <h2>ISHMEM_TEAM_N_PES<a class="headerlink" href="#ishmem-team-n-pes" title="Perm
 <span id="id1"></span><h2>ISHMEM_TEAM_CONFIG_T<a class="headerlink" href="#ishmem-team-config-t" title="Permalink to this heading">#</a></h2>
 <div class="admonition important">
 <p class="admonition-title">Important</p>
-<p>Intel® SHMEM 1.0.0 ignores <code class="docutils literal notranslate"><span class="pre">ishmem_team_config_t</span></code>, because
+<p>Intel® SHMEM 1.1.0 ignores <code class="docutils literal notranslate"><span class="pre">ishmem_team_config_t</span></code>, because
 communication contexts are not yet supported.</p>
 </div>
 <p>A structure type representing team configuration arguments.</p>
@@ -665,11 +665,16 @@ <h2>ISHMEM_TEAM_SPLIT_STRIDED<a class="headerlink" href="#ishmem-team-split-stri
 \;
 i \in \mathbb{Z}_{size-1}\]</div>
 <p>where <span class="math notranslate nohighlight">\(\mathbb{Z}\)</span> is the set of natural numbers (<span class="math notranslate nohighlight">\(0, 1, \dots\)</span>),
-<span class="math notranslate nohighlight">\(N\)</span> is the number of PEs in the parent team and <span class="math notranslate nohighlight">\(size\)</span> is a
-positive number indicating the number of PEs in the new team.
+<span class="math notranslate nohighlight">\(N\)</span> is the number of PEs in the parent team, <span class="math notranslate nohighlight">\(size\)</span> is a positive
+number indicating the number of PEs in the new team, and <span class="math notranslate nohighlight">\(stride\)</span> is an integer.
 The index <span class="math notranslate nohighlight">\(i\)</span> specifies the number of the given PE in the new team.
-Thus, PEs in the new team remain in the same relative order as in the parent
-team.</p>
+When <span class="math notranslate nohighlight">\(stride\)</span> is greater than zero, PEs in the new team remain in the
+same relative order as in the parent team.
+When <span class="math notranslate nohighlight">\(stride\)</span> is less than zero, PEs in the new team are in <em>reverse</em>
+relative order with respect to the parent team.
+If a <span class="math notranslate nohighlight">\(stride\)</span> value equal to 0 is passed to
+<code class="docutils literal notranslate"><span class="pre">ishmem_team_split_strided</span></code>, then the <cite>size</cite> argument passed must be 1, or
+the behavior is undefined.</p>
 <p>This routine must be called by all PEs in the parent team.
 All PEs must provide the same values for the PE triplet.
 On successful creation of the new team:</p>
@@ -949,7 +954,7 @@ <h2>ISHMEM_TEAM_DESTROY<a class="headerlink" href="#ishmem-team-destroy" title="
 
   <p class="copyright">
 
-      © Copyright 2023 Intel Corporation licensed under Creative Commons BY 4.0.
+      © Copyright 2024 Intel Corporation licensed under Creative Commons BY 4.0.
       <br/>
 
   </p>

diff --git a/docs/utility.html b/docs/utility.html
@@ -491,7 +491,7 @@ <h2>ISHMEMX_PRINT<a class="headerlink" href="#ishmemx-print" title="Permalink to
 
   <p class="copyright">
 
-      © Copyright 2023 Intel Corporation licensed under Creative Commons BY 4.0.
+      © Copyright 2024 Intel Corporation licensed under Creative Commons BY 4.0.
       <br/>
 
   </p>

diff --git a/docs/writing_programs.html b/docs/writing_programs.html
@@ -470,7 +470,7 @@ <h1>Writing Intel® SHMEM Programs</h1>
 
   <p class="copyright">
 
-      © Copyright 2023 Intel Corporation licensed under Creative Commons BY 4.0.
+      © Copyright 2024 Intel Corporation licensed under Creative Commons BY 4.0.
       <br/>
 
   </p>
-Original file line number
+Diff line change
@@ Expand Up @@
       <p class="copyright">
-          © Copyright 2023 Intel Corporation licensed under Creative Commons BY 4.0.
+          © Copyright 2024 Intel Corporation licensed under Creative Commons BY 4.0.
           <br/>
       </p>
@@ Expand Down @@