Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@havogt
havogt committed May 16, 2019
1 parent a6b8e77 commit 1105332
Show file tree
Hide file tree
Showing 10 changed files with 17 additions and 17 deletions.
2 changes: 1 addition & 1 deletion docs/_static/documentation_options.js
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '1.0.0',
VERSION: '1.0.1',
LANGUAGE: 'None',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
Expand Down
2 changes: 1 addition & 1 deletion docs/faq/faq.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

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

<title>Frequently Asked Questions &mdash; GridTools 1.0.0 documentation</title>
<title>Frequently Asked Questions &mdash; GridTools 1.0.1 documentation</title>



Expand Down
2 changes: 1 addition & 1 deletion docs/genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

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

<title>Index &mdash; GridTools 1.0.0 documentation</title>
<title>Index &mdash; GridTools 1.0.1 documentation</title>



Expand Down
4 changes: 2 additions & 2 deletions docs/getting_started/getting_started.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

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

<title>Getting Started &mdash; GridTools 1.0.0 documentation</title>
<title>Getting Started &mdash; GridTools 1.0.1 documentation</title>



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

<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>

<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>
<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>

<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>
<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>
Expand Down
2 changes: 1 addition & 1 deletion docs/glossary/glossary.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

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

<title>Glossary &mdash; GridTools 1.0.0 documentation</title>
<title>Glossary &mdash; GridTools 1.0.1 documentation</title>



Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

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

<title>GridTools &mdash; GridTools 1.0.0 documentation</title>
<title>GridTools &mdash; GridTools 1.0.1 documentation</title>



Expand Down
2 changes: 1 addition & 1 deletion docs/internal/internal.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

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

<title>Internal Documentation &mdash; GridTools 1.0.0 documentation</title>
<title>Internal Documentation &mdash; GridTools 1.0.1 documentation</title>



Expand Down
2 changes: 1 addition & 1 deletion docs/introduction/introduction.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

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

<title>Introduction &mdash; GridTools 1.0.0 documentation</title>
<title>Introduction &mdash; GridTools 1.0.1 documentation</title>



Expand Down
2 changes: 1 addition & 1 deletion docs/search.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

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

<title>Search &mdash; GridTools 1.0.0 documentation</title>
<title>Search &mdash; GridTools 1.0.1 documentation</title>



Expand Down
14 changes: 7 additions & 7 deletions docs/user_manual/user_manual.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

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

<title>User Manual &mdash; GridTools 1.0.0 documentation</title>
<title>User Manual &mdash; GridTools 1.0.1 documentation</title>



Expand Down Expand Up @@ -372,17 +372,17 @@
</div>
<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>
<ul class="simple">
<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
<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
<code class="docutils literal notranslate"><span class="pre">D</span></code> dimensions</p></li>
<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>
<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>
<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
direction</p></li>
<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>
<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>
<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>
<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
<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>
<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>
<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
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>
<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
<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
halo point) in dimension <code class="docutils literal notranslate"><span class="pre">D</span></code></p></li>
</ul>
</div>
Expand Down

0 comments on commit 1105332

Please sign in to comment.