Skip to content

Commit

Permalink
Updating Sphinx docs - branch (html)
Browse files Browse the repository at this point in the history
  • Loading branch information
StellarBot committed Nov 4, 2024
1 parent e614a2d commit 1ceeb63
Show file tree
Hide file tree
Showing 487 changed files with 247 additions and 180,414 deletions.
64 changes: 32 additions & 32 deletions branches/master/html/api/public_api.html

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions branches/master/html/api/public_distributed_api.html
Original file line number Diff line number Diff line change
Expand Up @@ -4593,7 +4593,7 @@ <h2> Contents </h2>
provided by <em>HPX</em>.</p>
<section id="hpx-barrier-hpp">
<span id="public-distr-api-header-barrier"></span><h2><code class="docutils literal notranslate"><span class="pre">hpx/barrier.hpp</span></code><a class="headerlink" href="#hpx-barrier-hpp" title="Permalink to this headline">#</a></h2>
<p>The header <a class="reference external" href="http://github.com/STEllAR-GROUP/hpx/blob/183bd6e99d29bedcc18f648bc0b74f15cf758607/libs/full/include/include/hpx/barrier.hpp">hpx/barrier.hpp</a> includes
<p>The header <a class="reference external" href="http://github.com/STEllAR-GROUP/hpx/blob/fb989a0a6af98206fa3d2c8c4650c49fc4f62037/libs/full/include/include/hpx/barrier.hpp">hpx/barrier.hpp</a> includes
a distributed barrier implementation. For information regarding the C++ standard
library header <a class="reference external" href="http://en.cppreference.com/w/cpp/header/barrier">barrier</a>, see <a class="reference internal" href="public_api.html#public-api"><span class="std std-ref">Public API</span></a>.</p>
<section id="classes">
Expand Down Expand Up @@ -4635,7 +4635,7 @@ <h3>Functions<a class="headerlink" href="#functions" title="Permalink to this he
</section>
<section id="hpx-collectives-hpp">
<span id="public-distr-api-header-collectives"></span><h2><code class="docutils literal notranslate"><span class="pre">hpx/collectives.hpp</span></code><a class="headerlink" href="#hpx-collectives-hpp" title="Permalink to this headline">#</a></h2>
<p>The header <a class="reference external" href="http://github.com/STEllAR-GROUP/hpx/blob/183bd6e99d29bedcc18f648bc0b74f15cf758607/libs/full/include/include/hpx/collectives.hpp">hpx/collectives.hpp</a>
<p>The header <a class="reference external" href="http://github.com/STEllAR-GROUP/hpx/blob/fb989a0a6af98206fa3d2c8c4650c49fc4f62037/libs/full/include/include/hpx/collectives.hpp">hpx/collectives.hpp</a>
contains definitions and implementations related to the collectives operations.</p>
<section id="id3">
<h3>Classes<a class="headerlink" href="#id3" title="Permalink to this headline">#</a></h3>
Expand Down Expand Up @@ -4732,7 +4732,7 @@ <h3>Functions<a class="headerlink" href="#id4" title="Permalink to this headline
</section>
<section id="hpx-latch-hpp">
<span id="public-distr-api-header-latch"></span><h2><code class="docutils literal notranslate"><span class="pre">hpx/latch.hpp</span></code><a class="headerlink" href="#hpx-latch-hpp" title="Permalink to this headline">#</a></h2>
<p>The header <a class="reference external" href="http://github.com/STEllAR-GROUP/hpx/blob/183bd6e99d29bedcc18f648bc0b74f15cf758607/libs/full/include/include/hpx/latch.hpp">hpx/latch.hpp</a> includes
<p>The header <a class="reference external" href="http://github.com/STEllAR-GROUP/hpx/blob/fb989a0a6af98206fa3d2c8c4650c49fc4f62037/libs/full/include/include/hpx/latch.hpp">hpx/latch.hpp</a> includes
a distributed latch implementation. For information regarding the C++ standard
library header <a class="reference external" href="http://en.cppreference.com/w/cpp/header/latch">latch</a>, see <a class="reference internal" href="public_api.html#public-api"><span class="std std-ref">Public API</span></a>.</p>
<section id="id5">
Expand Down Expand Up @@ -4782,7 +4782,7 @@ <h4>Member functions<a class="headerlink" href="#member-functions" title="Permal
</section>
<section id="hpx-async-hpp">
<span id="public-distr-api-header-async"></span><h2><code class="docutils literal notranslate"><span class="pre">hpx/async.hpp</span></code><a class="headerlink" href="#hpx-async-hpp" title="Permalink to this headline">#</a></h2>
<p>The header <a class="reference external" href="http://github.com/STEllAR-GROUP/hpx/blob/183bd6e99d29bedcc18f648bc0b74f15cf758607/libs/full/async_distributed/include/hpx/async.hpp">hpx/async.hpp</a>
<p>The header <a class="reference external" href="http://github.com/STEllAR-GROUP/hpx/blob/fb989a0a6af98206fa3d2c8c4650c49fc4f62037/libs/full/async_distributed/include/hpx/async.hpp">hpx/async.hpp</a>
includes distributed implementations of <a class="reference internal" href="../libs/core/async_base/api/async.html#_CPPv4I0DpEN3hpx5asyncEDcRR1FDpRR2Ts" title="hpx::async"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">hpx::async</span></code></a>,
<a class="reference internal" href="../libs/core/async_base/api/post.html#_CPPv4I0DpEN3hpx4postEbRR1FDpRR2Ts" title="hpx::post"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">hpx::post</span></code></a>, <a class="reference internal" href="../libs/core/async_base/api/sync.html#_CPPv4I0DpEN3hpx4syncEDcRR1FDpRR2Ts" title="hpx::sync"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">hpx::sync</span></code></a>, and <a class="reference internal" href="../libs/core/async_base/api/dataflow.html#_CPPv4I0DpEN3hpx8dataflowEDcRR1FDpRR2Ts" title="hpx::dataflow"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">hpx::dataflow</span></code></a>.
For information regarding the C++ standard library header, see <a class="reference internal" href="public_api.html#public-api"><span class="std std-ref">Public API</span></a>.</p>
Expand Down Expand Up @@ -4812,7 +4812,7 @@ <h3>Functions<a class="headerlink" href="#id6" title="Permalink to this headline
</section>
<section id="hpx-components-hpp">
<span id="public-distr-api-header-components"></span><h2><code class="docutils literal notranslate"><span class="pre">hpx/components.hpp</span></code><a class="headerlink" href="#hpx-components-hpp" title="Permalink to this headline">#</a></h2>
<p>The header <a class="reference external" href="http://github.com/STEllAR-GROUP/hpx/blob/183bd6e99d29bedcc18f648bc0b74f15cf758607/libs/full/include/include/hpx/include/components.hpp">hpx/include/components.hpp</a>
<p>The header <a class="reference external" href="http://github.com/STEllAR-GROUP/hpx/blob/fb989a0a6af98206fa3d2c8c4650c49fc4f62037/libs/full/include/include/hpx/include/components.hpp">hpx/include/components.hpp</a>
includes the components implementation. A component in <cite>hpx</cite> is a C++ class
which can be created remotely and for which its member functions can be invoked
remotely as well. More information about how components can be defined,
Expand Down
18 changes: 9 additions & 9 deletions branches/master/html/examples/accumulator.html
Original file line number Diff line number Diff line change
Expand Up @@ -4610,7 +4610,7 @@ <h3>Walkthrough<a class="headerlink" href="#walkthrough" title="Permalink to thi
<section id="the-server-class">
<h4>The server class<a class="headerlink" href="#the-server-class" title="Permalink to this headline">#</a></h4>
<p>The following code is from
<a class="reference external" href="http://github.com/STEllAR-GROUP/hpx/blob/183bd6e99d29bedcc18f648bc0b74f15cf758607/examples/accumulators/server/accumulator.hpp">server/accumulator.hpp</a>.</p>
<a class="reference external" href="http://github.com/STEllAR-GROUP/hpx/blob/fb989a0a6af98206fa3d2c8c4650c49fc4f62037/examples/accumulators/server/accumulator.hpp">server/accumulator.hpp</a>.</p>
<p>All <em>HPX</em> component server classes must inherit publicly from the <em>HPX</em>
component base class: <a class="reference internal" href="../libs/full/components_base/api/components_base_fwd.html#_CPPv4I0EN3hpx10components14component_baseE" title="hpx::components::component_base"><code class="xref cpp cpp-class docutils literal notranslate"><span class="pre">hpx::components::component_base</span></code></a></p>
<p>The accumulator component inherits from
Expand Down Expand Up @@ -4666,7 +4666,7 @@ <h4>The server class<a class="headerlink" href="#the-server-class" title="Permal
<p>The code above must be placed in the global namespace.</p>
</div>
<p>The rest of the registration code is in
<a class="reference external" href="http://github.com/STEllAR-GROUP/hpx/blob/183bd6e99d29bedcc18f648bc0b74f15cf758607/examples/accumulators/accumulator.cpp">accumulator.cpp</a></p>
<a class="reference external" href="http://github.com/STEllAR-GROUP/hpx/blob/fb989a0a6af98206fa3d2c8c4650c49fc4f62037/examples/accumulators/accumulator.cpp">accumulator.cpp</a></p>
<div class="highlight-c++ notranslate"><div class="highlight"><pre><span></span><span class="c1">///////////////////////////////////////////////////////////////////////////////</span>
<span class="c1">// Add factory registration functionality.</span>
<span class="n">HPX_REGISTER_COMPONENT_MODULE</span><span class="p">()</span><span class="w"></span>
Expand Down Expand Up @@ -4695,7 +4695,7 @@ <h4>The server class<a class="headerlink" href="#the-server-class" title="Permal
<section id="the-client-class">
<h4>The client class<a class="headerlink" href="#the-client-class" title="Permalink to this headline">#</a></h4>
<p>The following code is from
<a class="reference external" href="http://github.com/STEllAR-GROUP/hpx/blob/183bd6e99d29bedcc18f648bc0b74f15cf758607/examples/accumulators/accumulator.hpp">accumulator.hpp</a></p>
<a class="reference external" href="http://github.com/STEllAR-GROUP/hpx/blob/fb989a0a6af98206fa3d2c8c4650c49fc4f62037/examples/accumulators/accumulator.hpp">accumulator.hpp</a></p>
<p>The client class is the primary interface to a component instance. Client classes
are used to create components:</p>
<div class="highlight-cpp notranslate"><div class="highlight"><pre><span></span><span class="c1">// Create a component on this locality.</span>
Expand Down Expand Up @@ -4783,7 +4783,7 @@ <h3>Walkthrough<a class="headerlink" href="#id2" title="Permalink to this headli
<section id="id3">
<h4>The server class<a class="headerlink" href="#id3" title="Permalink to this headline">#</a></h4>
<p>The following code is from
<a class="reference external" href="http://github.com/STEllAR-GROUP/hpx/blob/183bd6e99d29bedcc18f648bc0b74f15cf758607/examples/accumulators/server/template_accumulator.hpp">server/template_accumulator.hpp</a>.</p>
<a class="reference external" href="http://github.com/STEllAR-GROUP/hpx/blob/fb989a0a6af98206fa3d2c8c4650c49fc4f62037/examples/accumulators/server/template_accumulator.hpp">server/template_accumulator.hpp</a>.</p>
<p>Similarly to the accumulator example, the component server class
inherits publicly from <a class="reference internal" href="../libs/full/components_base/api/components_base_fwd.html#_CPPv4I0EN3hpx10components14component_baseE" title="hpx::components::component_base"><code class="xref cpp cpp-class docutils literal notranslate"><span class="pre">hpx::components::component_base</span></code></a> and from
<code class="xref cpp cpp-class docutils literal notranslate"><span class="pre">hpx::components::locking_hook</span></code> ensuring thread-safe method invocations.</p>
Expand Down Expand Up @@ -4878,13 +4878,13 @@ <h4>The server class<a class="headerlink" href="#id3" title="Permalink to this h
<p>The code above must be placed in the global namespace.</p>
</div>
<p>Finally, <cite>HPX_REGISTER_COMPONENT_MODULE()</cite> in file
<a class="reference external" href="http://github.com/STEllAR-GROUP/hpx/blob/183bd6e99d29bedcc18f648bc0b74f15cf758607/examples/accumulators/server/template_accumulator.cpp">server/template_accumulator.cpp</a>
<a class="reference external" href="http://github.com/STEllAR-GROUP/hpx/blob/fb989a0a6af98206fa3d2c8c4650c49fc4f62037/examples/accumulators/server/template_accumulator.cpp">server/template_accumulator.cpp</a>
adds the factory registration functionality.</p>
</section>
<section id="id4">
<h4>The client class<a class="headerlink" href="#id4" title="Permalink to this headline">#</a></h4>
<p>The client class of the template accumulator can be found in
<a class="reference external" href="http://github.com/STEllAR-GROUP/hpx/blob/183bd6e99d29bedcc18f648bc0b74f15cf758607/examples/accumulators/template_accumulator.hpp">template_accumulator.hpp</a> and is very similar to
<a class="reference external" href="http://github.com/STEllAR-GROUP/hpx/blob/fb989a0a6af98206fa3d2c8c4650c49fc4f62037/examples/accumulators/template_accumulator.hpp">template_accumulator.hpp</a> and is very similar to
the client class of the accumulator with the only difference that it uses templates
and hence can work with different types.</p>
</section>
Expand All @@ -4897,7 +4897,7 @@ <h3>Walkthrough<a class="headerlink" href="#id5" title="Permalink to this headli
<section id="id6">
<h4>The server class<a class="headerlink" href="#id6" title="Permalink to this headline">#</a></h4>
<p>The following code is from
<a class="reference external" href="http://github.com/STEllAR-GROUP/hpx/blob/183bd6e99d29bedcc18f648bc0b74f15cf758607/examples/accumulators/server/template_function_accumulator.hpp">server/template_function_accumulator.hpp</a>.</p>
<a class="reference external" href="http://github.com/STEllAR-GROUP/hpx/blob/fb989a0a6af98206fa3d2c8c4650c49fc4f62037/examples/accumulators/server/template_function_accumulator.hpp">server/template_function_accumulator.hpp</a>.</p>
<p>The component server class inherits publicly from <a class="reference internal" href="../libs/full/components_base/api/components_base_fwd.html#_CPPv4I0EN3hpx10components14component_baseE" title="hpx::components::component_base"><code class="xref cpp cpp-class docutils literal notranslate"><span class="pre">hpx::components::component_base</span></code></a>.</p>
<div class="highlight-c++ notranslate"><div class="highlight"><pre><span></span><span class="w"> </span><span class="k">class</span><span class="w"> </span><span class="nc">template_function_accumulator</span><span class="w"></span>
<span class="w"> </span><span class="o">:</span><span class="w"> </span><span class="k">public</span><span class="w"> </span><span class="n">hpx</span><span class="o">::</span><span class="n">components</span><span class="o">::</span><span class="n">component_base</span><span class="o">&lt;</span><span class="n">template_function_accumulator</span><span class="o">&gt;</span><span class="w"></span>
Expand Down Expand Up @@ -4979,7 +4979,7 @@ <h4>The server class<a class="headerlink" href="#id6" title="Permalink to this h
<p>The code above must be placed in the global namespace.</p>
</div>
<p>The rest of the registration code is in
<a class="reference external" href="http://github.com/STEllAR-GROUP/hpx/blob/183bd6e99d29bedcc18f648bc0b74f15cf758607/examples/accumulators/accumulator.cpp">accumulator.cpp</a></p>
<a class="reference external" href="http://github.com/STEllAR-GROUP/hpx/blob/fb989a0a6af98206fa3d2c8c4650c49fc4f62037/examples/accumulators/accumulator.cpp">accumulator.cpp</a></p>
<div class="highlight-c++ notranslate"><div class="highlight"><pre><span></span><span class="c1">///////////////////////////////////////////////////////////////////////////////</span>
<span class="c1">// Add factory registration functionality.</span>
<span class="n">HPX_REGISTER_COMPONENT_MODULE</span><span class="p">()</span><span class="w"></span>
Expand Down Expand Up @@ -5007,7 +5007,7 @@ <h4>The server class<a class="headerlink" href="#id6" title="Permalink to this h
<section id="id7">
<h4>The client class<a class="headerlink" href="#id7" title="Permalink to this headline">#</a></h4>
<p>The client class of the template accumulator can be found in
<a class="reference external" href="http://github.com/STEllAR-GROUP/hpx/blob/183bd6e99d29bedcc18f648bc0b74f15cf758607/examples/accumulators/template_function_accumulator.hpp">template_function_accumulator.hpp</a> and is very similar
<a class="reference external" href="http://github.com/STEllAR-GROUP/hpx/blob/fb989a0a6af98206fa3d2c8c4650c49fc4f62037/examples/accumulators/template_function_accumulator.hpp">template_function_accumulator.hpp</a> and is very similar
to the client class of the accumulator with the only difference that it uses templates
and hence can work with different types.</p>
</section>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4346,7 +4346,7 @@ <h1>hpx::adjacent_difference</h1>

<section id="hpx-adjacent-difference">
<span id="modules-hpx-parallel-algorithms-adjacent-difference-hpp-api"></span><h1>hpx::adjacent_difference<a class="headerlink" href="#hpx-adjacent-difference" title="Permalink to this headline">#</a></h1>
<p>Defined in header <a class="reference external" href="http://github.com/STEllAR-GROUP/hpx/blob/183bd6e99d29bedcc18f648bc0b74f15cf758607/libs/full/include/include/hpx/algorithm.hpp">hpx/algorithm.hpp</a>.</p>
<p>Defined in header <a class="reference external" href="http://github.com/STEllAR-GROUP/hpx/blob/fb989a0a6af98206fa3d2c8c4650c49fc4f62037/libs/full/include/include/hpx/algorithm.hpp">hpx/algorithm.hpp</a>.</p>
<p>See <a class="reference internal" href="../../../../api/public_api.html#public-api"><span class="std std-ref">Public API</span></a> for a list of names and headers that are part of the public
<em>HPX</em> API.</p>
<dl class="cpp type">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4346,7 +4346,7 @@ <h1>hpx::adjacent_find</h1>

<section id="hpx-adjacent-find">
<span id="modules-hpx-parallel-algorithms-adjacent-find-hpp-api"></span><h1>hpx::adjacent_find<a class="headerlink" href="#hpx-adjacent-find" title="Permalink to this headline">#</a></h1>
<p>Defined in header <a class="reference external" href="http://github.com/STEllAR-GROUP/hpx/blob/183bd6e99d29bedcc18f648bc0b74f15cf758607/libs/full/include/include/hpx/algorithm.hpp">hpx/algorithm.hpp</a>.</p>
<p>Defined in header <a class="reference external" href="http://github.com/STEllAR-GROUP/hpx/blob/fb989a0a6af98206fa3d2c8c4650c49fc4f62037/libs/full/include/include/hpx/algorithm.hpp">hpx/algorithm.hpp</a>.</p>
<p>See <a class="reference internal" href="../../../../api/public_api.html#public-api"><span class="std std-ref">Public API</span></a> for a list of names and headers that are part of the public
<em>HPX</em> API.</p>
<dl class="cpp type">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4346,7 +4346,7 @@ <h1>hpx::all_of, hpx::any_of, hpx::none_of</h1>

<section id="hpx-all-of-hpx-any-of-hpx-none-of">
<span id="modules-hpx-parallel-algorithms-all-any-none-hpp-api"></span><h1>hpx::all_of, hpx::any_of, hpx::none_of<a class="headerlink" href="#hpx-all-of-hpx-any-of-hpx-none-of" title="Permalink to this headline">#</a></h1>
<p>Defined in header <a class="reference external" href="http://github.com/STEllAR-GROUP/hpx/blob/183bd6e99d29bedcc18f648bc0b74f15cf758607/libs/full/include/include/hpx/algorithm.hpp">hpx/algorithm.hpp</a>.</p>
<p>Defined in header <a class="reference external" href="http://github.com/STEllAR-GROUP/hpx/blob/fb989a0a6af98206fa3d2c8c4650c49fc4f62037/libs/full/include/include/hpx/algorithm.hpp">hpx/algorithm.hpp</a>.</p>
<p>See <a class="reference internal" href="../../../../api/public_api.html#public-api"><span class="std std-ref">Public API</span></a> for a list of names and headers that are part of the public
<em>HPX</em> API.</p>
<dl class="cpp type">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4346,7 +4346,7 @@ <h1>hpx::ranges::adjacent_difference</h1>

<section id="hpx-ranges-adjacent-difference">
<span id="modules-hpx-parallel-container-algorithms-adjacent-difference-hpp-api"></span><h1>hpx::ranges::adjacent_difference<a class="headerlink" href="#hpx-ranges-adjacent-difference" title="Permalink to this headline">#</a></h1>
<p>Defined in header <a class="reference external" href="http://github.com/STEllAR-GROUP/hpx/blob/183bd6e99d29bedcc18f648bc0b74f15cf758607/libs/full/include/include/hpx/algorithm.hpp">hpx/algorithm.hpp</a>.</p>
<p>Defined in header <a class="reference external" href="http://github.com/STEllAR-GROUP/hpx/blob/fb989a0a6af98206fa3d2c8c4650c49fc4f62037/libs/full/include/include/hpx/algorithm.hpp">hpx/algorithm.hpp</a>.</p>
<p>See <a class="reference internal" href="../../../../api/public_api.html#public-api"><span class="std std-ref">Public API</span></a> for a list of names and headers that are part of the public
<em>HPX</em> API.</p>
<dl class="cpp type">
Expand Down
Loading

0 comments on commit 1ceeb63

Please sign in to comment.