|
8 | 8 |
|
9 | 9 | <meta name="viewport" content="width=device-width, initial-scale=1.0">
|
10 | 10 |
|
11 |
| - <title>User Manual — GridTools 1.0.0 documentation</title> |
| 11 | + <title>User Manual — GridTools 1.0.1 documentation</title> |
12 | 12 |
|
13 | 13 |
|
14 | 14 |
|
|
372 | 372 | </div>
|
373 | 373 | <p><strong>Interface</strong>: A <code class="docutils literal notranslate"><span class="pre">storage_info</span></code> object provides methods for querying the meta data.</p>
|
374 | 374 | <ul class="simple">
|
375 |
| -<li><p><code class="docutils literal notranslate"><span class="pre">template</span> <span class="pre"><uint_t</span> <span class="pre">D></span> <span class="pre">constexpr</span> <span class="pre">uint_t</span> <span class="pre">total_length()</span> <span class="pre">const</span></code>: retrieve the total number of data points in dimension |
| 375 | +<li><p><code class="docutils literal notranslate"><span class="pre">template</span> <span class="pre"><uint_t</span> <span class="pre">D></span> <span class="pre">uint_t</span> <span class="pre">total_length()</span> <span class="pre">const</span></code>: retrieve the total number of data points in dimension |
376 | 376 | <code class="docutils literal notranslate"><span class="pre">D</span></code> dimensions</p></li>
|
377 |
| -<li><p><code class="docutils literal notranslate"><span class="pre">template</span> <span class="pre"><int</span> <span class="pre">D></span> <span class="pre">constexpr</span> <span class="pre">int</span> <span class="pre">stride()</span> <span class="pre">const</span></code>: retrieve the stride in dimension <code class="docutils literal notranslate"><span class="pre">D</span></code></p></li> |
| 377 | +<li><p><code class="docutils literal notranslate"><span class="pre">template</span> <span class="pre"><int</span> <span class="pre">D></span> <span class="pre">int</span> <span class="pre">stride()</span> <span class="pre">const</span></code>: retrieve the stride in dimension <code class="docutils literal notranslate"><span class="pre">D</span></code></p></li> |
378 | 378 | <li><p><code class="docutils literal notranslate"><span class="pre">const</span> <span class="pre">array<uint_t,</span> <span class="pre">ndims></span> <span class="pre">&total_lengths()</span> <span class="pre">const</span></code>: return the array of total number of data points in each
|
379 | 379 | direction</p></li>
|
380 | 380 | <li><p><code class="docutils literal notranslate"><span class="pre">const</span> <span class="pre">array<uint_t,</span> <span class="pre">ndims></span> <span class="pre">&strides()</span> <span class="pre">const</span></code>: return the array of (aligned) strides.</p></li>
|
381 |
| -<li><p><code class="docutils literal notranslate"><span class="pre">template</span> <span class="pre"><uint_t</span> <span class="pre">D></span> <span class="pre">constexpr</span> <span class="pre">uint_t</span> <span class="pre">begin()</span> <span class="pre">const</span></code>: retrieve the position of the first non halo point in dimension <cite>D</cite></p></li> |
382 |
| -<li><p><code class="docutils literal notranslate"><span class="pre">template</span> <span class="pre"><uint_t</span> <span class="pre">D></span> <span class="pre">constexpr</span> <span class="pre">uint_t</span> <span class="pre">end()</span> <span class="pre">const</span></code>: retrieve the position of the last non halo point in dimension <cite>D</cite></p></li> |
383 |
| -<li><p><code class="docutils literal notranslate"><span class="pre">template</span> <span class="pre"><uint_t</span> <span class="pre">D></span> <span class="pre">constexpr</span> <span class="pre">uint_t</span> <span class="pre">total_begin()</span> <span class="pre">const</span></code>: retrieve the position of the first point (can also be a |
| 381 | +<li><p><code class="docutils literal notranslate"><span class="pre">template</span> <span class="pre"><uint_t</span> <span class="pre">D></span> <span class="pre">uint_t</span> <span class="pre">begin()</span> <span class="pre">const</span></code>: retrieve the position of the first non halo point in dimension <cite>D</cite></p></li> |
| 382 | +<li><p><code class="docutils literal notranslate"><span class="pre">template</span> <span class="pre"><uint_t</span> <span class="pre">D></span> <span class="pre">uint_t</span> <span class="pre">end()</span> <span class="pre">const</span></code>: retrieve the position of the last non halo point in dimension <cite>D</cite></p></li> |
| 383 | +<li><p><code class="docutils literal notranslate"><span class="pre">template</span> <span class="pre"><uint_t</span> <span class="pre">D></span> <span class="pre">uint_t</span> <span class="pre">total_begin()</span> <span class="pre">const</span></code>: retrieve the position of the first point (can also be a |
384 | 384 | halo point) in dimension <code class="docutils literal notranslate"><span class="pre">D</span></code> (always <code class="docutils literal notranslate"><span class="pre">0</span></code>)</p></li>
|
385 |
| -<li><p><code class="docutils literal notranslate"><span class="pre">template</span> <span class="pre"><uint_t</span> <span class="pre">D></span> <span class="pre">constexpr</span> <span class="pre">uint_t</span> <span class="pre">total_end()</span> <span class="pre">const</span></code>: retrieve the position of the last point (can also be a |
| 385 | +<li><p><code class="docutils literal notranslate"><span class="pre">template</span> <span class="pre"><uint_t</span> <span class="pre">D></span> <span class="pre">uint_t</span> <span class="pre">total_end()</span> <span class="pre">const</span></code>: retrieve the position of the last point (can also be a |
386 | 386 | halo point) in dimension <code class="docutils literal notranslate"><span class="pre">D</span></code></p></li>
|
387 | 387 | </ul>
|
388 | 388 | </div>
|
|
0 commit comments