Permalink
Browse files

Updating docs

  • Loading branch information...
1 parent 5e60138 commit 79cc34ca84b645b8a7815268378284e3c773161e @StellarBot StellarBot committed Sep 14, 2017
Showing 579 changed files with 4,263 additions and 4,177 deletions.
@@ -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="idm140394773572592"></a><h2>Description</h2>
+<a name="idm140406765619904"></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>
@@ -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="idm140394773512384"></a><h2>Description</h2>
+<a name="idm140406765559936"></a><h2>Description</h2>
<p><b>Example:&#160;</b></p>
<p>
</p>
@@ -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="idm140394773475600"></a><h2>Description</h2>
+<a name="idm140406765523088"></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>
@@ -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="idm140394773436608"></a><h2>Description</h2>
+<a name="idm140406765484160"></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>
@@ -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="idm140394773598432"></a><h2>Description</h2>
+<a name="idm140406765645568"></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>
@@ -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="idm140394773656464"></a><h2>Description</h2>
+<a name="idm140406765705072"></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>
@@ -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="idm140394773587872"></a><h2>Description</h2>
+<a name="idm140406765635072"></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>
@@ -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="idm140394772267648"></a><h2>Description</h2>
+<a name="idm140406764316624"></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>
@@ -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="idm140394790170160"></a><h2>Description</h2>
+<a name="idm140406782265872"></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>
@@ -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__idm139867291161872.html" title="Function template gather_there">
+<link rel="prev" href="hpx/lcos/gather__idm140071066495296.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__idm139867291161872.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__idm140071066495296.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="idm140394790180352"></a><h2>Description</h2>
+<a name="idm140406782276064"></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>
@@ -52,7 +52,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__idm139867291161872.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__idm140071066495296.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>
@@ -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="idm140394767115104"></a><h2>Description</h2>
+<a name="idm140406759212768"></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>
@@ -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="idm140394767145008"></a><h2>Description</h2>
+<a name="idm140406759242608"></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>
Oops, something went wrong.

0 comments on commit 79cc34c

Please sign in to comment.