Skip to content

Commit 1105332

Browse files
committed
update documentation
1 parent a6b8e77 commit 1105332

File tree

10 files changed

+17
-17
lines changed

10 files changed

+17
-17
lines changed

Diff for: docs/_static/documentation_options.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
var DOCUMENTATION_OPTIONS = {
22
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
3-
VERSION: '1.0.0',
3+
VERSION: '1.0.1',
44
LANGUAGE: 'None',
55
COLLAPSE_INDEX: false,
66
FILE_SUFFIX: '.html',

Diff for: docs/faq/faq.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
<meta name="viewport" content="width=device-width, initial-scale=1.0">
1010

11-
<title>Frequently Asked Questions &mdash; GridTools 1.0.0 documentation</title>
11+
<title>Frequently Asked Questions &mdash; GridTools 1.0.1 documentation</title>
1212

1313

1414

Diff for: docs/genindex.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
<meta name="viewport" content="width=device-width, initial-scale=1.0">
1111

12-
<title>Index &mdash; GridTools 1.0.0 documentation</title>
12+
<title>Index &mdash; GridTools 1.0.1 documentation</title>
1313

1414

1515

Diff for: docs/getting_started/getting_started.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
<meta name="viewport" content="width=device-width, initial-scale=1.0">
1010

11-
<title>Getting Started &mdash; GridTools 1.0.0 documentation</title>
11+
<title>Getting Started &mdash; GridTools 1.0.1 documentation</title>
1212

1313

1414

@@ -667,7 +667,7 @@ <h3>Full GridTools Laplacian<a class="headerlink" href="#full-gridtools-laplacia
667667

668668
<span class="n">project</span><span class="p">(</span><span class="n">GridTools</span><span class="o">-</span><span class="n">laplacian</span> <span class="n">LANGUAGES</span> <span class="n">CXX</span><span class="p">)</span>
669669

670-
<span class="n">find_package</span><span class="p">(</span><span class="n">GridTools</span> <span class="mf">0.22</span><span class="o">.</span><span class="mi">0</span> <span class="n">REQUIRED</span><span class="p">)</span>
670+
<span class="n">find_package</span><span class="p">(</span><span class="n">GridTools</span> <span class="mf">1.0</span><span class="o">.</span><span class="mi">1</span> <span class="n">REQUIRED</span><span class="p">)</span>
671671

672672
<span class="n">add_executable</span><span class="p">(</span><span class="n">gt_laplacian</span> <span class="n">test_gt_laplacian</span><span class="o">.</span><span class="n">cpp</span><span class="p">)</span>
673673
<span class="n">target_link_libraries</span><span class="p">(</span><span class="n">gt_laplacian</span> <span class="n">GridTools</span><span class="p">::</span><span class="n">gridtools</span><span class="p">)</span>

Diff for: docs/glossary/glossary.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
<meta name="viewport" content="width=device-width, initial-scale=1.0">
1010

11-
<title>Glossary &mdash; GridTools 1.0.0 documentation</title>
11+
<title>Glossary &mdash; GridTools 1.0.1 documentation</title>
1212

1313

1414

Diff for: docs/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
<meta name="viewport" content="width=device-width, initial-scale=1.0">
1010

11-
<title>GridTools &mdash; GridTools 1.0.0 documentation</title>
11+
<title>GridTools &mdash; GridTools 1.0.1 documentation</title>
1212

1313

1414

Diff for: docs/internal/internal.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
<meta name="viewport" content="width=device-width, initial-scale=1.0">
1010

11-
<title>Internal Documentation &mdash; GridTools 1.0.0 documentation</title>
11+
<title>Internal Documentation &mdash; GridTools 1.0.1 documentation</title>
1212

1313

1414

Diff for: docs/introduction/introduction.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
<meta name="viewport" content="width=device-width, initial-scale=1.0">
1010

11-
<title>Introduction &mdash; GridTools 1.0.0 documentation</title>
11+
<title>Introduction &mdash; GridTools 1.0.1 documentation</title>
1212

1313

1414

Diff for: docs/search.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
<meta name="viewport" content="width=device-width, initial-scale=1.0">
1010

11-
<title>Search &mdash; GridTools 1.0.0 documentation</title>
11+
<title>Search &mdash; GridTools 1.0.1 documentation</title>
1212

1313

1414

Diff for: docs/user_manual/user_manual.html

+7-7
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
<meta name="viewport" content="width=device-width, initial-scale=1.0">
1010

11-
<title>User Manual &mdash; GridTools 1.0.0 documentation</title>
11+
<title>User Manual &mdash; GridTools 1.0.1 documentation</title>
1212

1313

1414

@@ -372,17 +372,17 @@
372372
</div>
373373
<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>
374374
<ul class="simple">
375-
<li><p><code class="docutils literal notranslate"><span class="pre">template</span> <span class="pre">&lt;uint_t</span> <span class="pre">D&gt;</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">&lt;uint_t</span> <span class="pre">D&gt;</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
376376
<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">&lt;int</span> <span class="pre">D&gt;</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">&lt;int</span> <span class="pre">D&gt;</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>
378378
<li><p><code class="docutils literal notranslate"><span class="pre">const</span> <span class="pre">array&lt;uint_t,</span> <span class="pre">ndims&gt;</span> <span class="pre">&amp;total_lengths()</span> <span class="pre">const</span></code>: return the array of total number of data points in each
379379
direction</p></li>
380380
<li><p><code class="docutils literal notranslate"><span class="pre">const</span> <span class="pre">array&lt;uint_t,</span> <span class="pre">ndims&gt;</span> <span class="pre">&amp;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">&lt;uint_t</span> <span class="pre">D&gt;</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">&lt;uint_t</span> <span class="pre">D&gt;</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">&lt;uint_t</span> <span class="pre">D&gt;</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">&lt;uint_t</span> <span class="pre">D&gt;</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">&lt;uint_t</span> <span class="pre">D&gt;</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">&lt;uint_t</span> <span class="pre">D&gt;</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
384384
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">&lt;uint_t</span> <span class="pre">D&gt;</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">&lt;uint_t</span> <span class="pre">D&gt;</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
386386
halo point) in dimension <code class="docutils literal notranslate"><span class="pre">D</span></code></p></li>
387387
</ul>
388388
</div>

0 commit comments

Comments
 (0)