Skip to content

Commit

Permalink
Updating docs
Browse files Browse the repository at this point in the history
  • Loading branch information
StellarBot committed May 29, 2017
1 parent c4ad1cd commit 44d94aa
Show file tree
Hide file tree
Showing 614 changed files with 4,314 additions and 4,424 deletions.
2 changes: 1 addition & 1 deletion docs/html/HPX_DEFINE_COMPONENT_ACTION.html
Expand Up @@ -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="idm140463660037984"></a><h2>Description</h2>
<a name="idm139944799664992"></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>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/HPX_DEFINE_PLAIN_ACTION.html
Expand Up @@ -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="idm140463659977728"></a><h2>Description</h2>
<a name="idm139944799604800"></a><h2>Description</h2>
<p><b>Example:&#160;</b></p>
<p>
</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/HPX_PLAIN_ACTION.html
Expand Up @@ -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="idm140463659940480"></a><h2>Description</h2>
<a name="idm139944799567984"></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>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/HPX_PLAIN_ACTION_ID.html
Expand Up @@ -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="idm140463659901488"></a><h2>Description</h2>
<a name="idm139944799528960"></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>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/HPX_REGISTER_ACTION.html
Expand Up @@ -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="idm140463660063760"></a><h2>Description</h2>
<a name="idm139944799690768"></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>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/HPX_REGISTER_ACTION_DECLARATION.html
Expand Up @@ -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="idm140463660123312"></a><h2>Description</h2>
<a name="idm139944799750336"></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>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/HPX_REGISTER_ACTION_ID.html
Expand Up @@ -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="idm140463660053264"></a><h2>Description</h2>
<a name="idm139944799680208"></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>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/HPX_REGISTER_COMPONENT.html
Expand Up @@ -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="idm140463658732944"></a><h2>Description</h2>
<a name="idm139944798359952"></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>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/HPX_THROWS_IF.html
Expand Up @@ -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="idm140463653717248"></a><h2>Description</h2>
<a name="idm139944793346640"></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>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/HPX_THROW_EXCEPTION.html
Expand Up @@ -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="idm140463653747088"></a><h2>Description</h2>
<a name="idm139944793376448"></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>
Expand Down
4 changes: 2 additions & 2 deletions docs/html/code/hpx/exception.hpp
Expand Up @@ -87,7 +87,7 @@ namespace hpx
/// from.
///
/// \throws nothing
error get_error() const HPX_NOEXCEPT;
error get_error() const noexcept;

/// The function \a get_error_code() returns a hpx::error_code which
/// represents the same error condition as this hpx::exception instance.
Expand All @@ -97,7 +97,7 @@ namespace hpx
/// \a hpx_category (if mode is \a plain, this is the
/// default) or to the category \a hpx_category_rethrow
/// (if mode is \a rethrow).
error_code get_error_code(throwmode mode = plain) const HPX_NOEXCEPT;
error_code get_error_code(throwmode mode = plain) const noexcept;
};

///////////////////////////////////////////////////////////////////////////
Expand Down
6 changes: 3 additions & 3 deletions docs/html/code/hpx/exception_list.hpp
Expand Up @@ -66,22 +66,22 @@ namespace hpx
/// exception_list.
///
/// \note Complexity: Constant time.
std::size_t size() const HPX_NOEXCEPT
std::size_t size() const noexcept
{
std::lock_guard<mutex_type> l(mtx_);
return exceptions_.size();
}

/// An iterator referring to the first exception_ptr object contained
/// within the exception_list.
exception_list_type::const_iterator begin() const HPX_NOEXCEPT
exception_list_type::const_iterator begin() const noexcept
{
std::lock_guard<mutex_type> l(mtx_);
return exceptions_.begin();
}

/// An iterator which is the past-the-end value for the exception_list.
exception_list_type::const_iterator end() const HPX_NOEXCEPT
exception_list_type::const_iterator end() const noexcept
{
std::lock_guard<mutex_type> l(mtx_);
return exceptions_.end();
Expand Down
4 changes: 0 additions & 4 deletions docs/html/code/hpx/lcos/split_future.hpp
Expand Up @@ -8,9 +8,6 @@
#if !defined(HPX_LCOS_SPLIT_FUTURE_JUL_08_2016_0824AM)
#define HPX_LCOS_SPLIT_FUTURE_JUL_08_2016_0824AM

// sadly, MSVC12 is not able to cope with split_future
#if !defined(HPX_MSVC) || HPX_MSVC >= 1900

#if defined(DOXYGEN)
namespace hpx
{
Expand Down Expand Up @@ -369,4 +366,3 @@ namespace hpx

#endif
#endif
#endif
Expand Up @@ -13,7 +13,6 @@
#include <hpx/util/zip_iterator.hpp>

#include <hpx/parallel/algorithms/detail/dispatch.hpp>
#include <hpx/parallel/config/inline_namespace.hpp>
#include <hpx/parallel/execution_policy.hpp>
#include <hpx/parallel/util/detail/algorithm_result.hpp>
#include <hpx/parallel/util/loop.hpp>
Expand All @@ -28,7 +27,7 @@
#include <utility>
#include <vector>

namespace hpx { namespace parallel { HPX_INLINE_NAMESPACE(v1)
namespace hpx { namespace parallel { inline namespace v1
{
///////////////////////////////////////////////////////////////////////////
// adjacent_difference
Expand Down
2 changes: 1 addition & 1 deletion docs/html/code/hpx/parallel/algorithms/adjacent_find.hpp
Expand Up @@ -26,7 +26,7 @@
#include <utility>
#include <vector>

namespace hpx { namespace parallel { HPX_INLINE_NAMESPACE(v1)
namespace hpx { namespace parallel { inline namespace v1
{
///////////////////////////////////////////////////////////////////////////
// adjacent_find
Expand Down
3 changes: 1 addition & 2 deletions docs/html/code/hpx/parallel/algorithms/all_any_none.hpp
Expand Up @@ -13,7 +13,6 @@
#include <hpx/util/void_guard.hpp>

#include <hpx/parallel/algorithms/detail/dispatch.hpp>
#include <hpx/parallel/config/inline_namespace.hpp>
#include <hpx/parallel/execution_policy.hpp>
#include <hpx/parallel/util/detail/algorithm_result.hpp>
#include <hpx/parallel/util/loop.hpp>
Expand All @@ -29,7 +28,7 @@
#include <utility>
#include <vector>

namespace hpx { namespace parallel { HPX_INLINE_NAMESPACE(v1)
namespace hpx { namespace parallel { inline namespace v1
{
///////////////////////////////////////////////////////////////////////////
// none_of
Expand Down
2 changes: 1 addition & 1 deletion docs/html/code/hpx/parallel/algorithms/copy.hpp
Expand Up @@ -43,7 +43,7 @@

#include <boost/shared_array.hpp>

namespace hpx { namespace parallel { HPX_INLINE_NAMESPACE(v1)
namespace hpx { namespace parallel { inline namespace v1
{
///////////////////////////////////////////////////////////////////////////
// copy
Expand Down
6 changes: 2 additions & 4 deletions docs/html/code/hpx/parallel/algorithms/count.hpp
Expand Up @@ -15,7 +15,6 @@
#include <hpx/util/unwrapped.hpp>

#include <hpx/parallel/algorithms/detail/dispatch.hpp>
#include <hpx/parallel/config/inline_namespace.hpp>
#include <hpx/parallel/execution_policy.hpp>
#include <hpx/parallel/traits/vector_pack_count_bits.hpp>
#include <hpx/parallel/util/detail/algorithm_result.hpp>
Expand All @@ -32,7 +31,7 @@
#include <utility>
#include <vector>

namespace hpx { namespace parallel { HPX_INLINE_NAMESPACE(v1)
namespace hpx { namespace parallel { inline namespace v1
{
///////////////////////////////////////////////////////////////////////////
// count
Expand All @@ -57,8 +56,7 @@ namespace hpx { namespace parallel { HPX_INLINE_NAMESPACE(v1)
: op_(std::forward<Op_>(op))
{}

#if defined(HPX_HAVE_CXX11_DEFAULTED_FUNCTIONS) && !defined(__NVCC__) && \
!defined(__CUDACC__)
#if !defined(__NVCC__) && !defined(__CUDACC__)
count_iteration(count_iteration const&) = default;
count_iteration(count_iteration&&) = default;
#else
Expand Down
3 changes: 1 addition & 2 deletions docs/html/code/hpx/parallel/algorithms/equal.hpp
Expand Up @@ -13,7 +13,6 @@

#include <hpx/parallel/algorithms/detail/dispatch.hpp>
#include <hpx/parallel/algorithms/detail/predicates.hpp>
#include <hpx/parallel/config/inline_namespace.hpp>
#include <hpx/parallel/execution_policy.hpp>
#include <hpx/parallel/util/detail/algorithm_result.hpp>
#include <hpx/parallel/util/loop.hpp>
Expand All @@ -30,7 +29,7 @@
#include <utility>
#include <vector>

namespace hpx { namespace parallel { HPX_INLINE_NAMESPACE(v1)
namespace hpx { namespace parallel { inline namespace v1
{
///////////////////////////////////////////////////////////////////////////
// equal (binary)
Expand Down
3 changes: 1 addition & 2 deletions docs/html/code/hpx/parallel/algorithms/exclusive_scan.hpp
Expand Up @@ -17,7 +17,6 @@

#include <hpx/parallel/algorithms/detail/dispatch.hpp>
#include <hpx/parallel/algorithms/inclusive_scan.hpp>
#include <hpx/parallel/config/inline_namespace.hpp>
#include <hpx/parallel/execution_policy.hpp>
#include <hpx/parallel/util/detail/algorithm_result.hpp>
#include <hpx/parallel/util/loop.hpp>
Expand All @@ -33,7 +32,7 @@
#include <utility>
#include <vector>

namespace hpx { namespace parallel { HPX_INLINE_NAMESPACE(v1)
namespace hpx { namespace parallel { inline namespace v1
{
///////////////////////////////////////////////////////////////////////////
// exclusive_scan
Expand Down
3 changes: 1 addition & 2 deletions docs/html/code/hpx/parallel/algorithms/fill.hpp
Expand Up @@ -16,7 +16,6 @@
#include <hpx/parallel/algorithms/for_each.hpp>
#include <hpx/parallel/algorithms/detail/dispatch.hpp>
#include <hpx/parallel/algorithms/detail/is_negative.hpp>
#include <hpx/parallel/config/inline_namespace.hpp>
#include <hpx/parallel/execution_policy.hpp>
#include <hpx/parallel/util/detail/algorithm_result.hpp>
#include <hpx/parallel/util/projection_identity.hpp>
Expand All @@ -27,7 +26,7 @@
#include <type_traits>
#include <utility>

namespace hpx { namespace parallel { HPX_INLINE_NAMESPACE(v1)
namespace hpx { namespace parallel { inline namespace v1
{
///////////////////////////////////////////////////////////////////////////
// fill
Expand Down
2 changes: 1 addition & 1 deletion docs/html/code/hpx/parallel/algorithms/find.hpp
Expand Up @@ -25,7 +25,7 @@
#include <utility>
#include <vector>

namespace hpx { namespace parallel { HPX_INLINE_NAMESPACE(v1)
namespace hpx { namespace parallel { inline namespace v1
{
///////////////////////////////////////////////////////////////////////////
// find
Expand Down
10 changes: 4 additions & 6 deletions docs/html/code/hpx/parallel/algorithms/for_each.hpp
Expand Up @@ -24,7 +24,6 @@

#include <hpx/parallel/algorithms/detail/dispatch.hpp>
#include <hpx/parallel/algorithms/detail/is_negative.hpp>
#include <hpx/parallel/config/inline_namespace.hpp>
#include <hpx/parallel/execution_policy.hpp>
#include <hpx/parallel/traits/projected.hpp>
#include <hpx/parallel/util/detail/algorithm_result.hpp>
Expand All @@ -39,7 +38,7 @@
#include <type_traits>
#include <utility>

namespace hpx { namespace parallel { HPX_INLINE_NAMESPACE(v1)
namespace hpx { namespace parallel { inline namespace v1
{
///////////////////////////////////////////////////////////////////////////
// for_each_n
Expand Down Expand Up @@ -106,8 +105,7 @@ namespace hpx { namespace parallel { HPX_INLINE_NAMESPACE(v1)
, proj_(std::forward<Proj_>(proj))
{}

#if defined(HPX_HAVE_CXX11_DEFAULTED_FUNCTIONS) && !defined(__NVCC__) && \
!defined(__CUDACC__)
#if !defined(__NVCC__) && !defined(__CUDACC__)
for_each_iteration(for_each_iteration const&) = default;
for_each_iteration(for_each_iteration&&) = default;
#else
Expand Down Expand Up @@ -487,7 +485,7 @@ namespace hpx { namespace traits
{
static std::size_t call(
parallel::v1::detail::for_each_iteration<ExPolicy, F, Proj> const& f)
HPX_NOEXCEPT
noexcept
{
return get_function_address<
typename hpx::util::decay<F>::type
Expand All @@ -501,7 +499,7 @@ namespace hpx { namespace traits
{
static char const* call(
parallel::v1::detail::for_each_iteration<ExPolicy, F, Proj> const& f)
HPX_NOEXCEPT
noexcept
{
return get_function_annotation<
typename hpx::util::decay<F>::type
Expand Down
7 changes: 3 additions & 4 deletions docs/html/code/hpx/parallel/algorithms/for_loop.hpp
Expand Up @@ -27,7 +27,6 @@
#include <hpx/parallel/algorithms/detail/predicates.hpp>
#include <hpx/parallel/algorithms/for_loop_induction.hpp>
#include <hpx/parallel/algorithms/for_loop_reduction.hpp>
#include <hpx/parallel/config/inline_namespace.hpp>
#include <hpx/parallel/execution_policy.hpp>
#include <hpx/parallel/util/detail/algorithm_result.hpp>
#include <hpx/parallel/util/loop.hpp>
Expand All @@ -41,7 +40,7 @@
#include <utility>
#include <vector>

namespace hpx { namespace parallel { HPX_INLINE_NAMESPACE(v2)
namespace hpx { namespace parallel { inline namespace v2
{
// for_loop
namespace detail
Expand Down Expand Up @@ -1130,7 +1129,7 @@ namespace hpx { namespace traits
{
static std::size_t call(
parallel::v2::detail::part_iterations<F, S, Tuple> const& f)
HPX_NOEXCEPT
noexcept
{
return get_function_address<
typename hpx::util::decay<F>::type
Expand All @@ -1144,7 +1143,7 @@ namespace hpx { namespace traits
{
static char const* call(
parallel::v2::detail::part_iterations<F, S, Tuple> const& f)
HPX_NOEXCEPT
noexcept
{
return get_function_annotation<
typename hpx::util::decay<F>::type
Expand Down

0 comments on commit 44d94aa

Please sign in to comment.