Updating docs

STEllAR-GROUP · Mar 19, 2018 · 0fb5c0a · 0fb5c0a
1 parent 92fc807
commit 0fb5c0a
Show file tree

Hide file tree

Showing 637 changed files with 5,582 additions and 4,777 deletions.
diff --git a/docs/html/HPX_DEFINE_COMPONENT_ACTION.html b/docs/html/HPX_DEFINE_COMPONENT_ACTION.html
@@ -26,7 +26,7 @@ <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="re
 
 </span>HPX_DEFINE_COMPONENT_ACTION(...)</pre></div>
 <div class="refsect1">
-<a name="idm139813841748880"></a><h2>Description</h2>
+<a name="idm139635496173904"></a><h2>Description</h2>
 <p>The macro <span class="emphasis"><em>HPX_DEFINE_COMPONENT_ACTION</em></span> can be used to register a member function of a component as an action type named <span class="emphasis"><em>action_type</em></span>.</p>
 <p>The parameter <span class="emphasis"><em>component</em></span> is the type of the component exposing the member function <span class="emphasis"><em>func</em></span> which should be associated with the newly defined action type. The parameter <code class="computeroutput">action_type</code> is the name of the action type to register with HPX.</p>
 <p><b>Example:&#160;</b></p>

diff --git a/docs/html/HPX_DEFINE_PLAIN_ACTION.html b/docs/html/HPX_DEFINE_PLAIN_ACTION.html
@@ -26,7 +26,7 @@ <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="re
 
 </span>HPX_DEFINE_PLAIN_ACTION(...)</pre></div>
 <div class="refsect1">
-<a name="idm139813841688816"></a><h2>Description</h2>
+<a name="idm139635496113712"></a><h2>Description</h2>
 <p><b>Example:&#160;</b></p>
 <p>
 </p>

diff --git a/docs/html/HPX_PLAIN_ACTION.html b/docs/html/HPX_PLAIN_ACTION.html
@@ -26,7 +26,7 @@ <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="re
 
 </span>HPX_PLAIN_ACTION(...)</pre></div>
 <div class="refsect1">
-<a name="idm139813841652032"></a><h2>Description</h2>
+<a name="idm139635496076864"></a><h2>Description</h2>
 <p>The macro <span class="emphasis"><em>HPX_PLAIN_ACTION</em></span> can be used to define a plain action (e.g. an action encapsulating a global or free function) based on the given function <span class="emphasis"><em>func</em></span>. It defines the action type <span class="emphasis"><em>name</em></span> representing the given function. This macro additionally registers the newly define action type with HPX.</p>
 <p>The parameter <code class="computeroutput">func</code> is a global or free (non-member) function which should be encapsulated into a plain action. The parameter <code class="computeroutput">name</code> is the name of the action type defined by this macro.</p>
 <p><b>Example:&#160;</b></p>

diff --git a/docs/html/HPX_PLAIN_ACTION_ID.html b/docs/html/HPX_PLAIN_ACTION_ID.html
@@ -26,7 +26,7 @@ <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="re
 
 </span>HPX_PLAIN_ACTION_ID(func, name, id)</pre></div>
 <div class="refsect1">
-<a name="idm139813841613040"></a><h2>Description</h2>
+<a name="idm139635496037936"></a><h2>Description</h2>
 <p>The macro <span class="emphasis"><em>HPX_PLAIN_ACTION_ID</em></span> can be used to define a plain action (e.g. an action encapsulating a global or free function) based on the given function <span class="emphasis"><em>func</em></span>. It defines the action type <span class="emphasis"><em>actionname</em></span> representing the given function. The parameter <span class="emphasis"><em>actionid</em></span> </p>
 <p>The parameter <span class="emphasis"><em>actionid</em></span> specifies an unique integer value which will be used to represent the action during serialization.</p>
 <p>The parameter <code class="computeroutput">func</code> is a global or free (non-member) function which should be encapsulated into a plain action. The parameter <code class="computeroutput">name</code> is the name of the action type defined by this macro.</p>

diff --git a/docs/html/HPX_REGISTER_ACTION.html b/docs/html/HPX_REGISTER_ACTION.html
@@ -26,7 +26,7 @@ <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="re
 
 </span>HPX_REGISTER_ACTION(...)</pre></div>
 <div class="refsect1">
-<a name="idm139813841774592"></a><h2>Description</h2>
+<a name="idm139635496199616"></a><h2>Description</h2>
 <p>The macro <span class="emphasis"><em>HPX_REGISTER_ACTION</em></span> can be used to define all the boilerplate code which is required for proper functioning of component actions in the context of HPX.</p>
 <p>The parameter <span class="emphasis"><em>action</em></span> is the type of the action to define the boilerplate for.</p>
 <p>This macro can be invoked with an optional second parameter. This parameter specifies a unique name of the action to be used for serialization purposes. The second parameter has to be specified if the first parameter is not usable as a plain (non-qualified) C++ identifier, i.e. the first parameter contains special characters which cannot be part of a C++ identifier, such as '&lt;', '&gt;', or ':'.</p>

diff --git a/docs/html/HPX_REGISTER_ACTION_DECLARATION.html b/docs/html/HPX_REGISTER_ACTION_DECLARATION.html
@@ -26,7 +26,7 @@ <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="re
 
 </span>HPX_REGISTER_ACTION_DECLARATION(...)</pre></div>
 <div class="refsect1">
-<a name="idm139813841834144"></a><h2>Description</h2>
+<a name="idm139635496259120"></a><h2>Description</h2>
 <p>The macro <span class="emphasis"><em>HPX_REGISTER_ACTION_DECLARATION</em></span> can be used to declare all the boilerplate code which is required for proper functioning of component actions in the context of HPX.</p>
 <p>The parameter <span class="emphasis"><em>action</em></span> is the type of the action to declare the boilerplate for.</p>
 <p>This macro can be invoked with an optional second parameter. This parameter specifies a unique name of the action to be used for serialization purposes. The second parameter has to be specified if the first parameter is not usable as a plain (non-qualified) C++ identifier, i.e. the first parameter contains special characters which cannot be part of a C++ identifier, such as '&lt;', '&gt;', or ':'.</p>

diff --git a/docs/html/HPX_REGISTER_ACTION_ID.html b/docs/html/HPX_REGISTER_ACTION_ID.html
@@ -26,7 +26,7 @@ <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="re
 
 </span>HPX_REGISTER_ACTION_ID(action, actionname, actionid)</pre></div>
 <div class="refsect1">
-<a name="idm139813841764096"></a><h2>Description</h2>
+<a name="idm139635496189120"></a><h2>Description</h2>
 <p>The macro <span class="emphasis"><em>HPX_REGISTER_ACTION</em></span> can be used to define all the boilerplate code which is required for proper functioning of component actions in the context of HPX.</p>
 <p>The parameter <span class="emphasis"><em>action</em></span> is the type of the action to define the boilerplate for.</p>
 <p>The parameter <span class="emphasis"><em>actionname</em></span> specifies an unique name of the action to be used for serialization purposes. The second parameter has to be usable as a plain (non-qualified) C++ identifier, it should not contain special characters which cannot be part of a C++ identifier, such as '&lt;', '&gt;', or ':'.</p>

diff --git a/docs/html/HPX_REGISTER_COMPONENT.html b/docs/html/HPX_REGISTER_COMPONENT.html
@@ -26,7 +26,7 @@ <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="re
 
 </span>HPX_REGISTER_COMPONENT(type, name, mode)</pre></div>
 <div class="refsect1">
-<a name="idm139813840498576"></a><h2>Description</h2>
+<a name="idm139635494923664"></a><h2>Description</h2>
 <p>This macro is used create and to register a minimal component factory for a component type which allows it to be remotely created using the <span class="emphasis"><em>hpx::new_&lt;&gt;</em></span> function.</p>
 <p>This macro can be invoked with one, two or three arguments</p>
 <p>

diff --git a/docs/html/HPX_REGISTER_GATHER.html b/docs/html/HPX_REGISTER_GATHER.html
@@ -26,7 +26,7 @@ <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="re
 
 </span>HPX_REGISTER_GATHER(type, name)</pre></div>
 <div class="refsect1">
-<a name="idm139813860353536"></a><h2>Description</h2>
+<a name="idm139635514783712"></a><h2>Description</h2>
 <p>The macro <span class="emphasis"><em>HPX_REGISTER_GATHER</em></span> can be used to define all facilities necessary for a (possibly remote) gather operation.</p>
 <p>The parameter <span class="emphasis"><em>type</em></span> specifies for which data type the gather operations should be enabled.</p>
 <p>The (optional) parameter <span class="emphasis"><em>name</em></span> should be a unique C-style identifier which will be internally used to identify a particular gather operation. If this defaults to <span class="emphasis"><em>&lt;type&gt;_gather</em></span> if not specified.</p>

diff --git a/docs/html/HPX_REGISTER_GATHER_DECLARATION.html b/docs/html/HPX_REGISTER_GATHER_DECLARATION.html
@@ -6,14 +6,14 @@
 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
 <link rel="home" href="index.html" title="HPX 1.1.0">
 <link rel="up" href="header/hpx/lcos/gather_hpp.html" title="Header &lt;hpx/lcos/gather.hpp&gt;">
-<link rel="prev" href="hpx/lcos/gather__idm139646653616064.html" title="Function template gather_there">
+<link rel="prev" href="hpx/lcos/gather__idm140482636752320.html" title="Function template gather_there">
 <link rel="next" href="HPX_REGISTER_GATHER.html" title="Macro HPX_REGISTER_GATHER">
 </head>
 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 <table cellpadding="2" width="100%"><tr><td valign="top"><img alt="HPX" width="531" height="105" src="images/hpx_1_1_0_draft.png"></td></tr></table>
 <hr>
 <div class="spirit-nav">
-<a accesskey="p" href="hpx/lcos/gather__idm139646653616064.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="header/hpx/lcos/gather_hpp.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="HPX_REGISTER_GATHER.html"><img src="images/next.png" alt="Next"></a>
+<a accesskey="p" href="hpx/lcos/gather__idm140482636752320.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="header/hpx/lcos/gather_hpp.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="HPX_REGISTER_GATHER.html"><img src="images/next.png" alt="Next"></a>
 </div>
 <div class="refentry">
 <a name="HPX_REGISTER_GATHER_DECLARATION"></a><div class="titlepage"></div>
@@ -26,7 +26,7 @@ <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="re
 
 </span>HPX_REGISTER_GATHER_DECLARATION(type, name)</pre></div>
 <div class="refsect1">
-<a name="idm139813860363728"></a><h2>Description</h2>
+<a name="idm139635514793904"></a><h2>Description</h2>
 <p>The macro <span class="emphasis"><em>HPX_REGISTER_GATHER_DECLARATION</em></span> can be used to declare all facilities necessary for a (possibly remote) gather operation.</p>
 <p>The parameter <span class="emphasis"><em>type</em></span> specifies for which data type the gather operations should be enabled.</p>
 <p>The (optional) parameter <span class="emphasis"><em>name</em></span> should be a unique C-style identifier which will be internally used to identify a particular gather operation. If this defaults to <span class="emphasis"><em>&lt;type&gt;_gather</em></span> if not specified.</p>
@@ -53,7 +53,7 @@ <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="re
 </tr></table>
 <hr>
 <div class="spirit-nav">
-<a accesskey="p" href="hpx/lcos/gather__idm139646653616064.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="header/hpx/lcos/gather_hpp.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="HPX_REGISTER_GATHER.html"><img src="images/next.png" alt="Next"></a>
+<a accesskey="p" href="hpx/lcos/gather__idm140482636752320.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="header/hpx/lcos/gather_hpp.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="HPX_REGISTER_GATHER.html"><img src="images/next.png" alt="Next"></a>
 </div>
 </body>
 </html>
diff --git a/docs/html/HPX_THROWS_IF.html b/docs/html/HPX_THROWS_IF.html
@@ -26,7 +26,7 @@ <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="re
 
 </span>HPX_THROWS_IF(ec, errcode, f, msg)</pre></div>
 <div class="refsect1">
-<a name="idm139813834939248"></a><h2>Description</h2>
+<a name="idm139635489361456"></a><h2>Description</h2>
 <p>The macro <span class="emphasis"><em>HPX_THROWS_IF</em></span> can be used to either throw a <span class="emphasis"><em><a class="link" href="hpx/exception.html" title="Class exception">hpx::exception</a></em></span> or to initialize a <span class="emphasis"><em><a class="link" href="hpx/error_code.html" title="Class error_code">hpx::error_code</a></em></span> from the given parameters. If &amp;ec == &amp;hpx::throws, the semantics of this macro are equivalent to <span class="emphasis"><em>HPX_THROW_EXCEPTION</em></span>. If &amp;ec != &amp;hpx::throws, the <span class="emphasis"><em><a class="link" href="hpx/error_code.html" title="Class error_code">hpx::error_code</a></em></span> instance <code class="computeroutput">ec</code> is initialized instead.</p>
 <p>The parameter <code class="computeroutput">errcode</code> holds the hpx::error code from which the new exception should be initialized. The parameter <code class="computeroutput">f</code> is expected to hold the name of the function exception is thrown from and the parameter <code class="computeroutput">msg</code> holds the error message the new exception should encapsulate. </p>
 </div>

diff --git a/docs/html/HPX_THROW_EXCEPTION.html b/docs/html/HPX_THROW_EXCEPTION.html
@@ -26,7 +26,7 @@ <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="re
 
 </span>HPX_THROW_EXCEPTION(errcode, f, msg)</pre></div>
 <div class="refsect1">
-<a name="idm139813834969088"></a><h2>Description</h2>
+<a name="idm139635489391360"></a><h2>Description</h2>
 <p>The macro <span class="emphasis"><em>HPX_THROW_EXCEPTION</em></span> can be used to throw a <a class="link" href="hpx/exception.html" title="Class exception">hpx::exception</a>. The purpose of this macro is to prepend the source file name and line number of the position where the exception is thrown to the error message. Moreover, this associates additional diagnostic information with the exception, such as file name and line number, locality id and thread id, and stack backtrace from the point where the exception was thrown.</p>
 <p>The parameter <code class="computeroutput">errcode</code> holds the hpx::error code the new exception should encapsulate. The parameter <code class="computeroutput">f</code> is expected to hold the name of the function exception is thrown from and the parameter <code class="computeroutput">msg</code> holds the error message the new exception should encapsulate.</p>
 <p><b>Example:&#160;</b></p>

diff --git a/docs/html/code/hpx/parallel/algorithms/search.hpp b/docs/html/code/hpx/parallel/algorithms/search.hpp
@@ -197,7 +197,7 @@ namespace hpx {namespace parallel { inline namespace v1
     ///                     that objects of types \a FwdIter1 and \a FwdIter2 can
     ///                     be dereferenced and then implicitly converted to
     ///                     \a Type1 and \a Type2 respectively
-    /// param proj1         Specifies the function (or function object) which
+    /// \param proj1        Specifies the function (or function object) which
     ///                     will be invoked for each of the elements of type
     ///                     dereferenced \a FwdIter1 as a projection operation
     ///                     before the actual predicate \a is invoked.
@@ -419,6 +419,14 @@ namespace hpx {namespace parallel { inline namespace v1
     ///                     that objects of types \a FwdIter1 and \a FwdIter2 can
     ///                     be dereferenced and then implicitly converted to
     ///                     \a Type1 and \a Type2 respectively
+    /// \param proj1        Specifies the function (or function object) which
+    ///                     will be invoked for each of the elements of type
+    ///                     dereferenced \a FwdIter1 as a projection operation
+    ///                     before the actual predicate \a is invoked.
+    /// \param proj2        Specifies the function (or function object) which
+    ///                     will be invoked for each of the elements of type
+    ///                     dereferenced \a FwdIter2 as a projection operation
+    ///                     before the actual predicate \a is invoked.
     ///
     /// The comparison operations in the parallel \a search_n algorithm invoked
     /// with an execution policy object of type \a sequenced_policy

diff --git a/docs/html/code/hpx/parallel/container_algorithms/merge.hpp b/docs/html/code/hpx/parallel/container_algorithms/merge.hpp
@@ -187,8 +187,6 @@ namespace hpx { namespace parallel { inline namespace v1
     /// \param middle       Refers to the end of the first sorted range and
     ///                     the beginning of the second sorted range
     ///                     the algorithm will be applied to.
-    /// \param last         Refers to the end of the second sorted range
-    ///                     the algorithm will be applied to.
     /// \param comp         \a comp is a callable object which returns true if
     ///                     the first argument is less than the second,
     ///                     and false otherwise. The signature of this

diff --git a/docs/html/code/hpx/parallel/container_algorithms/search.hpp b/docs/html/code/hpx/parallel/container_algorithms/search.hpp
@@ -54,10 +54,6 @@ namespace hpx { namespace parallel { inline namespace v1
     ///
     /// \param policy       The execution policy to use for the scheduling of
     ///                     the iterations.
-    /// \param first        Refers to the beginning of the sequence of elements
-    ///                     of the first range the algorithm will be applied to.
-    /// \param last         Refers to the end of the sequence of elements of
-    ///                     the first range the algorithm will be applied to.
     /// \param rng1         Refers to the sequence of elements the algorithm
     ///                     will be examining.
     /// \param rng2         Refers to the sequence of elements the algorithm
@@ -166,12 +162,9 @@ namespace hpx { namespace parallel { inline namespace v1
     ///
     /// \param policy       The execution policy to use for the scheduling of
     ///                     the iterations.
-    /// \param first        Refers to the beginning of the sequence of elements
-    ///                     of the first range the algorithm will be applied to.
-    /// \param last         Refers to the end of the sequence of elements of
-    ///                     the first range the algorithm will be applied to.
     /// \param rng1         Refers to the sequence of elements the algorithm
     ///                     will be examining.
+    /// \param count        The number of elements to apply the algorithm on.
     /// \param rng2         Refers to the sequence of elements the algorithm
     ///                     will be searching for.
     /// \param op           Refers to the binary predicate which returns true if the

diff --git a/docs/html/code/hpx/runtime/basename_registration_fwd.hpp b/docs/html/code/hpx/runtime/basename_registration_fwd.hpp
@@ -3,7 +3,7 @@
 //  Distributed under the Boost Software License, Version 1.0. (See accompanying
 //  file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
 
-/// \file hpx/runtime/basename_registration.hpp
+/// \file hpx/runtime/basename_registration_fwd.hpp
 
 #if !defined(HPX_RUNTIME_BASENAME_REGISTRATION_FWD_AUG_17_2015_0432PM)
 #define HPX_RUNTIME_BASENAME_REGISTRATION_FWD_AUG_17_2015_0432PM

diff --git a/docs/html/code/hpx/runtime/threads/thread_helpers.hpp b/docs/html/code/hpx/runtime/threads/thread_helpers.hpp
@@ -87,6 +87,8 @@ namespace hpx { namespace threads
     ///                   be modified for.
     /// \param abs_time   [in] Absolute point in time for the new thread to be
     ///                   run
+    /// \param started    [in,out] A helper variable allowing to track the
+    ///                   state of the timer helper thread
     /// \param state      [in] The new state to be set for the thread
     ///                   referenced by the \a id parameter.
     /// \param stateex    [in] The new extended state to be set for the