Update Sphinx documentation, commit b50a116 [skip ci].

_sources/breaking_changes.rst

@@ -13,6 +13,22 @@ heyoka 4 includes several backwards-incompatible changes.
 API/behaviour changes
 ~~~~~~~~~~~~~~~~~~~~~
 
+Changes to :cpp:func:`~heyoka::make_vars()`
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The :cpp:func:`~heyoka::make_vars()` function now returns a single expression (rather than an array of expressions)
+if a single argument is passed in input. This means that code such as
+
+.. code-block:: c++
+
+    auto [x] = make_vars("x")
+
+needs to be rewritten like this:
+
+.. code-block:: c++
+
+    auto x = make_vars("x")
+
 Terminal events callbacks
 ^^^^^^^^^^^^^^^^^^^^^^^^^
 

_sources/changelog.rst

@@ -23,6 +23,11 @@ New
 Changes
 ~~~~~~~
 
+- **BREAKING**: the :cpp:func:`~heyoka::make_vars()` function
+  now returns a single expression (rather than an array of expressions)
+  if a single argument is passed in input
+  (`#386 <https://github.com/bluescarni/heyoka/pull/386>`__).
+  This is a :ref:`breaking change <bchanges_4_0_0>`.
 - **BREAKING**: the signature of callbacks for terminal events
   has been simplified
   (`#385 <https://github.com/bluescarni/heyoka/pull/385>`__).

_sources/exceptions.rst

@@ -3,10 +3,10 @@
 Exceptions
 ==========
 
-*#include <heyoka/exceptions.hpp>*
-
 .. cpp:namespace-push:: heyoka
 
+*#include <heyoka/exceptions.hpp>*
+
 .. cpp:class:: not_implemented_error final : public std::runtime_error
 
    Exception to signal that a feature/functionality is not implemented.

_sources/expression.rst

@@ -1,11 +1,16 @@
 Expressions
 ===========
 
-*#include <heyoka/expression.hpp>*
+.. cpp:namespace-push:: heyoka
 
-The :cpp:class:`~heyoka::expression` class
-------------------------------------------
+*#include <heyoka/expression.hpp>*
 
-.. cpp:namespace-push:: heyoka
+The :cpp:class:`expression` class
+---------------------------------
 
 .. cpp:class:: expression
+
+Functions
+---------
+
+.. cpp:function:: template <typename Arg0, typename... Args> auto make_vars(const Arg0 &str, const Args &...strs)

_sources/func.rst

@@ -1,13 +1,13 @@
-Functions
-=========
+N-ary functions
+===============
+
+.. cpp:namespace-push:: heyoka
 
 *#include <heyoka/func.hpp>*
 
 The :cpp:class:`~heyoka::func_base` class
 -----------------------------------------
 
-.. cpp:namespace-push:: heyoka
-
 .. cpp:class:: func_base
 
    This is the base class of all functions implemented in the :ref:`expression system<expression_system>`.

_sources/number.rst

@@ -1,13 +1,13 @@
 Numerical constants
 ===================
 
+.. cpp:namespace-push:: heyoka
+
 *#include <heyoka/number.hpp>*
 
 The :cpp:class:`~heyoka::number` class
 --------------------------------------
 
-.. cpp:namespace-push:: heyoka
-
 .. cpp:class:: number
 
    This class is used to represent numerical constants in heyoka's expression

_sources/param.rst

@@ -1,13 +1,13 @@
 Runtime parameters
 ==================
 
+.. cpp:namespace-push:: heyoka
+
 *#include <heyoka/param.hpp>*
 
 The :cpp:class:`~heyoka::param` class
 -------------------------------------
 
-.. cpp:namespace-push:: heyoka
-
 .. cpp:class:: param
 
    This class is used to represent numerical parameters in heyoka's expression

_sources/variable.rst

@@ -1,13 +1,13 @@
 Variables
 =========
 
+.. cpp:namespace-push:: heyoka
+
 *#include <heyoka/variable.hpp>*
 
 The :cpp:class:`~heyoka::variable` class
 ----------------------------------------
 
-.. cpp:namespace-push:: heyoka
-
 .. cpp:class:: variable
 
    This class is used to represent symbolic variables in heyoka's expression

acknowledgement.html

@@ -189,7 +189,7 @@
 <li class="toctree-l3"><a class="reference internal" href="variable.html">Variables</a></li>
 <li class="toctree-l3"><a class="reference internal" href="number.html">Numerical constants</a></li>
 <li class="toctree-l3"><a class="reference internal" href="param.html">Runtime parameters</a></li>
-<li class="toctree-l3"><a class="reference internal" href="func.html">Functions</a></li>
+<li class="toctree-l3"><a class="reference internal" href="func.html">N-ary functions</a></li>
 <li class="toctree-l3"><a class="reference internal" href="expression.html">Expressions</a></li>
 </ul>
 </li>

ad_notes.html

@@ -190,7 +190,7 @@
 <li class="toctree-l3"><a class="reference internal" href="variable.html">Variables</a></li>
 <li class="toctree-l3"><a class="reference internal" href="number.html">Numerical constants</a></li>
 <li class="toctree-l3"><a class="reference internal" href="param.html">Runtime parameters</a></li>
-<li class="toctree-l3"><a class="reference internal" href="func.html">Functions</a></li>
+<li class="toctree-l3"><a class="reference internal" href="func.html">N-ary functions</a></li>
 <li class="toctree-l3"><a class="reference internal" href="expression.html">Expressions</a></li>
 </ul>
 </li>

advanced_tutorials.html

@@ -187,7 +187,7 @@
 <li class="toctree-l3"><a class="reference internal" href="variable.html">Variables</a></li>
 <li class="toctree-l3"><a class="reference internal" href="number.html">Numerical constants</a></li>
 <li class="toctree-l3"><a class="reference internal" href="param.html">Runtime parameters</a></li>
-<li class="toctree-l3"><a class="reference internal" href="func.html">Functions</a></li>
+<li class="toctree-l3"><a class="reference internal" href="func.html">N-ary functions</a></li>
 <li class="toctree-l3"><a class="reference internal" href="expression.html">Expressions</a></li>
 </ul>
 </li>

api_reference.html

@@ -187,7 +187,7 @@
 <li class="toctree-l3"><a class="reference internal" href="variable.html">Variables</a></li>
 <li class="toctree-l3"><a class="reference internal" href="number.html">Numerical constants</a></li>
 <li class="toctree-l3"><a class="reference internal" href="param.html">Runtime parameters</a></li>
-<li class="toctree-l3"><a class="reference internal" href="func.html">Functions</a></li>
+<li class="toctree-l3"><a class="reference internal" href="func.html">N-ary functions</a></li>
 <li class="toctree-l3"><a class="reference internal" href="expression.html">Expressions</a></li>
 </ul>
 </li>
@@ -413,7 +413,7 @@ <h1>API Reference</h1>
 <li class="toctree-l2"><a class="reference internal" href="variable.html">Variables</a></li>
 <li class="toctree-l2"><a class="reference internal" href="number.html">Numerical constants</a></li>
 <li class="toctree-l2"><a class="reference internal" href="param.html">Runtime parameters</a></li>
-<li class="toctree-l2"><a class="reference internal" href="func.html">Functions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="func.html">N-ary functions</a></li>
 <li class="toctree-l2"><a class="reference internal" href="expression.html">Expressions</a></li>
 </ul>
 </li>

basic_tutorials.html

@@ -187,7 +187,7 @@
 <li class="toctree-l3"><a class="reference internal" href="variable.html">Variables</a></li>
 <li class="toctree-l3"><a class="reference internal" href="number.html">Numerical constants</a></li>
 <li class="toctree-l3"><a class="reference internal" href="param.html">Runtime parameters</a></li>
-<li class="toctree-l3"><a class="reference internal" href="func.html">Functions</a></li>
+<li class="toctree-l3"><a class="reference internal" href="func.html">N-ary functions</a></li>
 <li class="toctree-l3"><a class="reference internal" href="expression.html">Expressions</a></li>
 </ul>
 </li>

benchmarks.html

@@ -190,7 +190,7 @@
 <li class="toctree-l3"><a class="reference internal" href="variable.html">Variables</a></li>
 <li class="toctree-l3"><a class="reference internal" href="number.html">Numerical constants</a></li>
 <li class="toctree-l3"><a class="reference internal" href="param.html">Runtime parameters</a></li>
-<li class="toctree-l3"><a class="reference internal" href="func.html">Functions</a></li>
+<li class="toctree-l3"><a class="reference internal" href="func.html">N-ary functions</a></li>
 <li class="toctree-l3"><a class="reference internal" href="expression.html">Expressions</a></li>
 </ul>
 </li>

bibliography.html

@@ -188,7 +188,7 @@
 <li class="toctree-l3"><a class="reference internal" href="variable.html">Variables</a></li>
 <li class="toctree-l3"><a class="reference internal" href="number.html">Numerical constants</a></li>
 <li class="toctree-l3"><a class="reference internal" href="param.html">Runtime parameters</a></li>
-<li class="toctree-l3"><a class="reference internal" href="func.html">Functions</a></li>
+<li class="toctree-l3"><a class="reference internal" href="func.html">N-ary functions</a></li>
 <li class="toctree-l3"><a class="reference internal" href="expression.html">Expressions</a></li>
 </ul>
 </li>

breaking_changes.html

@@ -189,7 +189,7 @@
 <li class="toctree-l3"><a class="reference internal" href="variable.html">Variables</a></li>
 <li class="toctree-l3"><a class="reference internal" href="number.html">Numerical constants</a></li>
 <li class="toctree-l3"><a class="reference internal" href="param.html">Runtime parameters</a></li>
-<li class="toctree-l3"><a class="reference internal" href="func.html">Functions</a></li>
+<li class="toctree-l3"><a class="reference internal" href="func.html">N-ary functions</a></li>
 <li class="toctree-l3"><a class="reference internal" href="expression.html">Expressions</a></li>
 </ul>
 </li>
@@ -399,6 +399,7 @@ <h2> Contents </h2>
                 <ul class="visible nav section-nav flex-column">
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#bchanges-4-0-0">4.0.0</a><ul class="nav section-nav flex-column">
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#api-behaviour-changes">API/behaviour changes</a><ul class="nav section-nav flex-column">
+<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#changes-to-make-vars">Changes to <code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">make_vars()</span></code></a></li>
 <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#terminal-events-callbacks">Terminal events callbacks</a></li>
 <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#step-callbacks-and-propagate">Step callbacks and <code class="docutils literal notranslate"><span class="pre">propagate_*()</span></code></a></li>
 <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#propagate-grid"><code class="docutils literal notranslate"><span class="pre">propagate_grid()</span></code></a></li>
@@ -431,6 +432,18 @@ <h2> Contents </h2>
 <p>heyoka 4 includes several backwards-incompatible changes.</p>
 <section id="api-behaviour-changes">
 <h3>API/behaviour changes<a class="headerlink" href="#api-behaviour-changes" title="Link to this heading">#</a></h3>
+<section id="changes-to-make-vars">
+<h4>Changes to <a class="reference internal" href="expression.html#_CPPv4I0DpEN6heyoka9make_varsEDaRK4Arg0DpRK4Args" title="heyoka::make_vars"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">make_vars()</span></code></a><a class="headerlink" href="#changes-to-make-vars" title="Link to this heading">#</a></h4>
+<p>The <a class="reference internal" href="expression.html#_CPPv4I0DpEN6heyoka9make_varsEDaRK4Arg0DpRK4Args" title="heyoka::make_vars"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">make_vars()</span></code></a> function now returns a single expression (rather than an array of expressions)
+if a single argument is passed in input. This means that code such as</p>
+<div class="highlight-c++ notranslate"><div class="highlight"><pre><span></span><span class="k">auto</span><span class="w"> </span><span class="p">[</span><span class="n">x</span><span class="p">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">make_vars</span><span class="p">(</span><span class="s">&quot;x&quot;</span><span class="p">)</span>
+</pre></div>
+</div>
+<p>needs to be rewritten like this:</p>
+<div class="highlight-c++ notranslate"><div class="highlight"><pre><span></span><span class="k">auto</span><span class="w"> </span><span class="n">x</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">make_vars</span><span class="p">(</span><span class="s">&quot;x&quot;</span><span class="p">)</span>
+</pre></div>
+</div>
+</section>
 <section id="terminal-events-callbacks">
 <h4>Terminal events callbacks<a class="headerlink" href="#terminal-events-callbacks" title="Link to this heading">#</a></h4>
 <p>The second argument in the signature of callbacks for terminal events, a <code class="docutils literal notranslate"><span class="pre">bool</span></code> conventionally
@@ -612,6 +625,7 @@ <h3>General<a class="headerlink" href="#general" title="Link to this heading">#<
     <ul class="visible nav section-nav flex-column">
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#bchanges-4-0-0">4.0.0</a><ul class="nav section-nav flex-column">
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#api-behaviour-changes">API/behaviour changes</a><ul class="nav section-nav flex-column">
+<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#changes-to-make-vars">Changes to <code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">make_vars()</span></code></a></li>
 <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#terminal-events-callbacks">Terminal events callbacks</a></li>
 <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#step-callbacks-and-propagate">Step callbacks and <code class="docutils literal notranslate"><span class="pre">propagate_*()</span></code></a></li>
 <li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link" href="#propagate-grid"><code class="docutils literal notranslate"><span class="pre">propagate_grid()</span></code></a></li>

changelog.html

@@ -190,7 +190,7 @@
 <li class="toctree-l3"><a class="reference internal" href="variable.html">Variables</a></li>
 <li class="toctree-l3"><a class="reference internal" href="number.html">Numerical constants</a></li>
 <li class="toctree-l3"><a class="reference internal" href="param.html">Runtime parameters</a></li>
-<li class="toctree-l3"><a class="reference internal" href="func.html">Functions</a></li>
+<li class="toctree-l3"><a class="reference internal" href="func.html">N-ary functions</a></li>
 <li class="toctree-l3"><a class="reference internal" href="expression.html">Expressions</a></li>
 </ul>
 </li>
@@ -589,6 +589,11 @@ <h3>New<a class="headerlink" href="#new" title="Link to this heading">#</a></h3>
 <section id="changes">
 <h3>Changes<a class="headerlink" href="#changes" title="Link to this heading">#</a></h3>
 <ul class="simple">
+<li><p><strong>BREAKING</strong>: the <a class="reference internal" href="expression.html#_CPPv4I0DpEN6heyoka9make_varsEDaRK4Arg0DpRK4Args" title="heyoka::make_vars"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">make_vars()</span></code></a> function
+now returns a single expression (rather than an array of expressions)
+if a single argument is passed in input
+(<a class="reference external" href="https://github.com/bluescarni/heyoka/pull/386">#386</a>).
+This is a <a class="reference internal" href="breaking_changes.html#bchanges-4-0-0"><span class="std std-ref">breaking change</span></a>.</p></li>
 <li><p><strong>BREAKING</strong>: the signature of callbacks for terminal events
 has been simplified
 (<a class="reference external" href="https://github.com/bluescarni/heyoka/pull/385">#385</a>).

definitions.html

@@ -187,7 +187,7 @@
 <li class="toctree-l3"><a class="reference internal" href="variable.html">Variables</a></li>
 <li class="toctree-l3"><a class="reference internal" href="number.html">Numerical constants</a></li>
 <li class="toctree-l3"><a class="reference internal" href="param.html">Runtime parameters</a></li>
-<li class="toctree-l3"><a class="reference internal" href="func.html">Functions</a></li>
+<li class="toctree-l3"><a class="reference internal" href="func.html">N-ary functions</a></li>
 <li class="toctree-l3"><a class="reference internal" href="expression.html">Expressions</a></li>
 </ul>
 </li>

exceptions.html

@@ -187,7 +187,7 @@
 <li class="toctree-l3"><a class="reference internal" href="variable.html">Variables</a></li>
 <li class="toctree-l3"><a class="reference internal" href="number.html">Numerical constants</a></li>
 <li class="toctree-l3"><a class="reference internal" href="param.html">Runtime parameters</a></li>
-<li class="toctree-l3"><a class="reference internal" href="func.html">Functions</a></li>
+<li class="toctree-l3"><a class="reference internal" href="func.html">N-ary functions</a></li>
 <li class="toctree-l3"><a class="reference internal" href="expression.html">Expressions</a></li>
 </ul>
 </li>