Updating docs

STEllAR-GROUP · Jan 23, 2018 · 8376734 · 8376734
1 parent ac8357a
commit 8376734
Show file tree

Hide file tree

Showing 606 changed files with 4,623 additions and 4,432 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="idm140476910743424"></a><h2>Description</h2>
+<a name="idm140715789864368"></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="idm140476910683344"></a><h2>Description</h2>
+<a name="idm140715789804240"></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="idm140476910646432"></a><h2>Description</h2>
+<a name="idm140715789767392"></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="idm140476910607504"></a><h2>Description</h2>
+<a name="idm140715789728464"></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="idm140476910769152"></a><h2>Description</h2>
+<a name="idm140715789890144"></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="idm140476910828720"></a><h2>Description</h2>
+<a name="idm140715789949760"></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="idm140476910758656"></a><h2>Description</h2>
+<a name="idm140715789879648"></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="idm140476909492000"></a><h2>Description</h2>
+<a name="idm140715788563936"></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="idm140476928259904"></a><h2>Description</h2>
+<a name="idm140715807466800"></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__idm140538353168960.html" title="Function template gather_there">
+<link rel="prev" href="hpx/lcos/gather__idm140305901662768.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__idm140538353168960.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__idm140305901662768.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="idm140476928270096"></a><h2>Description</h2>
+<a name="idm140715807476992"></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__idm140538353168960.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__idm140305901662768.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="idm140476904280368"></a><h2>Description</h2>
+<a name="idm140715783403648"></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="idm140476904310272"></a><h2>Description</h2>
+<a name="idm140715783433552"></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/examples/performance_counters/simplest_performance_counter.cpp b/docs/html/code/examples/performance_counters/simplest_performance_counter.cpp
@@ -18,6 +18,7 @@ std::atomic<std::int64_t> counter(0);
 
 std::int64_t some_performance_data(bool reset)
 {
+    ++counter;
     return hpx::util::get_and_reset_value(counter, reset);
 }
 

diff --git a/docs/html/code/hpx/performance_counters/manage_counter_type.hpp b/docs/html/code/hpx/performance_counters/manage_counter_type.hpp
@@ -1,5 +1,5 @@
 ////////////////////////////////////////////////////////////////////////////////
-//  Copyright (c) 2007-2013 Hartmut Kaiser
+//  Copyright (c) 2007-2018 Hartmut Kaiser
 //  Copyright (c) 2011 Bryce Adelstein-Lelbach
 //
 //  Distributed under the Boost Software License, Version 1.0. (See accompanying
@@ -19,6 +19,7 @@
 #include <cstddef>
 #include <cstdint>
 #include <string>
+#include <vector>
 
 namespace hpx { namespace performance_counters
 {
@@ -68,6 +69,55 @@ namespace hpx { namespace performance_counters
         std::string const& helptext = "", std::string const& uom = "",
         error_code& ec = throws);
 
+    /// Install a new generic performance counter type returning an
+    /// array of values in a way, that will uninstall it automatically during
+    /// shutdown.
+    ///
+    /// The function \a install_counter_type will register a new generic
+    /// counter type that returns an array of values based on the provided
+    /// function. The counter
+    /// type will be automatically unregistered during system shutdown. Any
+    /// consumer querying any instance of this this counter type will cause the
+    /// provided function to be called and the returned array value to be
+    /// exposed as the counter value.
+    ///
+    /// The counter type is registered such that there can be one counter
+    /// instance per locality. The expected naming scheme for the counter
+    /// instances is: \c '/objectname{locality#<*>/total}/countername' where
+    /// '<*>' is a zero based integer identifying the locality the counter
+    /// is created on.
+    ///
+    /// \param name   [in] The global virtual name of the counter type. This
+    ///               name is expected to have the format /objectname/countername.
+    /// \param counter_value [in] The function to call whenever the counter
+    ///               value (array of values) is requested by a consumer.
+    /// \param helptext [in, optional] A longer descriptive text shown to the
+    ///               user to explain the nature of the counters created from
+    ///               this type.
+    /// \param uom    [in] The unit of measure for the new performance counter
+    ///               type.
+    /// \param ec     [in,out] this represents the error status on exit,
+    ///               if this is pre-initialized to \a hpx#throws
+    ///               the function will throw on error instead.
+    ///
+    /// \note As long as \a ec is not pre-initialized to \a hpx::throws this
+    ///       function doesn't throw but returns the result code using the
+    ///       parameter \a ec. Otherwise it throws an instance of hpx::exception.
+    ///
+    /// \returns      If successful, this function returns \a status_valid_data,
+    ///               otherwise it will either throw an exception or return an
+    ///               error_code from the enum \a counter_status (also, see
+    ///               note related to parameter \a ec).
+    ///
+    /// \note The counter type registry is a locality based service. You will
+    ///       have to register each counter type on every locality where a
+    ///       corresponding performance counter will be created.
+    HPX_EXPORT counter_status install_counter_type(std::string const& name,
+        hpx::util::function_nonser<std::vector<std::int64_t>(bool)> const&
+            counter_value,
+        std::string const& helptext = "", std::string const& uom = "",
+        error_code& ec = throws);
+
     /// \brief Install a new performance counter type in a way, which will
     ///        uninstall it automatically during shutdown.
     ///