-
-
Notifications
You must be signed in to change notification settings - Fork 421
/
hpx.qbk
351 lines (295 loc) · 20.6 KB
/
hpx.qbk
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
[/==============================================================================
Copyright (C) 2007-2016 Hartmut Kaiser
Copyright (C) 2012 Bryce Adelstein-Lelbach
Copyright (c) 2012-2016 Adrian Serio
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)
===============================================================================/]
[article HPX
[quickbook 1.7]
[id hpx]
[authors [STE||AR Group, The]]
[version 1.0.0]
[copyright 2011 2012 2013 2014 2015 2016 The STE||AR Group (http://stellar-group.org)]
[license
Distributed under the Boost Software License, Version 1.0. (See
accompanying file [@http://www.boost.org/LICENSE_1_0.txt LICENSE_1_0.txt]
or copy at [@http://www.boost.org/LICENSE_1_0.txt])
]
]
[/ Definitions which are controlled by commandline macros]
[? __hpx_enable_fixme__ [template fixme[s] [*FIXME: [s]]] ]
[? __hpx_disable_fixme__ [template fixme[s] ] ]
[/ Definitions]
[def __0_7_0__ [link hpx.whats_new.hpx_previous.hpx_0_7_0 V0.7.0]]
[def __0_8_0__ [link hpx.whats_new.hpx_previous.hpx_0_8_0 V0.8.0]]
[def __0_8_1__ [link hpx.whats_new.hpx_previous.hpx_0_8_1 V0.8.1]]
[def __0_9_0__ [link hpx.whats_new.hpx_previous.hpx_0_9_0 V0.9.0]]
[def __0_9_5__ [link hpx.whats_new.hpx_previous.hpx_0_9_5 V0.9.5]]
[def __0_9_6__ [link hpx.whats_new.hpx_previous.hpx_0_9_6 V0.9.6]]
[def __0_9_7__ [link hpx.whats_new.hpx_previous.hpx_0_9_7 V0.9.7]]
[def __0_9_8__ [link hpx.whats_new.hpx_previous.hpx_0_9_8 V0.9.8]]
[def __0_9_9__ [link hpx.whats_new.hpx_previous.hpx_0_9_9 V0.9.9]]
[def __0_9_10__ [link hpx.whats_new.hpx_previous.hpx_0_9_10 V0.9.10]]
[def __0_9_11__ [link hpx.whats_new.hpx_previous.hpx_0_9_11 V0.9.11]]
[def __0_9_99__ [link hpx.whats_new.hpx_previous.hpx_0_9_99 V0.9.99]]
[def __1_0_0__ [link hpx.whats_new.hpx_1_0_0 V1.0.0]]
[def __version__ __1_0_0__]
[def __hpx__ /HPX/]
[def __hpx_compute__ /HPX.Compute/]
[def __stellar__ [@http://stellar-group.org STE||AR]]
[def __stellar_list__ [@email:hpx-users@stellar.cct.lsu.edu hpx-users@stellar.cct.lsu.edu]]
[def __stellar_irc__ [@irc://irc.freenode.net:6667/#ste||ar #ste||ar at Freenode]]
[def __stellar_hpx_download__ [@http://stellar-group.org/downloads/ __hpx__ Downloads]]
[def __stellar_hpx_github__ [@http://github.com/STEllAR-GROUP/hpx/ Github]]
[def __stellar_hpx_github_issues__ [@http://github.com/STEllAR-GROUP/hpx/issues __hpx__ Issues]]
[def __stellar_hpx_buildbot__ [@http://hermione.cct.lsu.edu/ __hpx__ Buildbot Website]]
[def __stellar_support__ [@http://stellar.cct.lsu.edu/support/ Support Website]]
[def __hpxpi__ [@http://github.com/STEllAR-GROUP/hpxpi/ HPXPI]]
[def __xpi_spec__ [@https://github.com/STEllAR-GROUP/hpxpi/blob/master/spec.pdf?raw=true XPI specification]]
[def __hpxcl__ [@http://github.com/STEllAR-GROUP/hpxcl/ HPXCL]]
[def __lsu__ [@http://www.lsu.edu Louisiana State University (LSU)]]
[def __cct__ [@http://www.cct.lsu.edu Center for Computation and Technology (CCT)]]
[def __iu__ [@http://www.iu.edu Indiana University (IU)]]
[def __crest__ [@http://pti.iu.edu Center for Research in Extreme Scale Technologies (CREST)]]
[def __fau__ [@http://www.fau.de Friedrich-Alexander University Erlangen-Nuremberg (FAU)]]
[def __inf3__ [@http://www3.cs.fau.de Department of Computer Science 3 - Computer Architecture]]
[def __sandia__ [@http://www.sandia.gov Sandia National Labs (Albuquerque)]]
[def __tue__ [@http://www.tui.nl Technische Universiteit Eindhoven]]
[def __nmsu__ [@http://www.nmsu.edu New Mexico State University]]
[def __unlv__ [@http://www.unlv.edu University of Nevada, Las Vegas]]
[def __cscs__ [@http://www.cscs.ch Swiss National Supercomputing Centre]]
[def __ou__ [@http://uoregon.edu/ University of Oregon]]
[def __lbnl__ [@http://www.lbl.gov/ Lawrence Berkley National Laboratory (LBNL)]]
[def __gsoc__ [@https://developers.google.com/open-source/soc/ Google Summer of Code]]
[def __boost__ [@http://www.boost.org/ Boost]]
[def __boost_libraries__ [@http://www.boost.org/ Boost C++ Libraries]]
[def __boost_tools__ [@http://www.boost.org/tools/index.html Boost Tools]]
[def __boost_quickbook__ [@http://www.boost.org/doc/libs/release/doc/html/quickbook.html QuickBook]]
[def __boost_auto_index__ [@http://www.boost.org/doc/libs/release/tools/auto_index/doc/html/index.html AutoIndex]]
[def __boost_getting_started__ [@http://www.boost.org/doc/libs/release/more/getting_started/index.html Getting Started]]
[def __boost_doc__ [@http://www.boost.org/doc/ Boost Documentation]]
[def __boost_downloads__ [@http://www.boost.org/users/download/ Boost Downloads]]
[def __boost_license__ [@http://www.boost.org/LICENSE_1_0.txt Boost Software License]]
[def __boost_wave__ [@http://www.boost.org/doc/libs/release/libs/wave/doc/wave_driver.html Boost Wave]]
[def __boost_program_options__ [@http://www.boost.org/doc/html/program_options.html Boost.Program Options]]
[def __boost_atomic__ [@http://www.boost.org/doc/libs/release/doc/html/atomic.html Boost.Atomic]]
[def __boost_serialization__ [@http://www.boost.org/doc/libs/release/libs/serialization/doc/index.html Boost.Serialization]]
[def __hwloc_downloads__ [@http://www.open-mpi.org/software/hwloc/v1.7/ hwloc]]
[def __doxygen__ [@http://www.doxygen.org Doxygen]]
[def __macports__ [@http://www.macports.org/ MacPorts]]
[/ External dependencies]
[def __cmake__ [@http://www.cmake.org CMake]]
[def __ctest__ [@http://cmake.org/Wiki/CMake/Testing_With_CTest CTest]]
[def __ctest_doc__ [@http://www.cmake.org/cmake/help/v2.8.11/ctest.html CTest Documentation]]
[def __cmake_download__ [@http://www.cmake.org/cmake/resources/software.html CMake Downloads]]
[def __gcc__ [@http://gcc.gnu.org GNU Compiler Collection (g++)]]
[def __clang__ [@http://clang.llvm.org/ clang: a C language family frontend for LLVM]]
[def __icpc__ [@http://software.intel.com/en-us/intel-composer-xe/ Intel Composer XE Suites]]
[def __gmake__ [@http://www.gnu.org/software/make GNU Make (gmake)]]
[def __eglibc__ [@http://eglibc.org/home Embedded GLIBC (EGLIBC)]]
[def __glibc__ [@http://gnu.org/s/libc GNU C Library (GLIBC)]]
[def __libstdcxx__ [@http://gcc.gnu.org/libstdc++ GNU Standard C++ Library]]
[def __rnpl__ [@http://relativity.phys.lsu.edu/postdocs/matt/software.html RNPL]]
[def __google_perftools__ [@http://code.google.com/p/gperftools google-perftools]]
[def __visual_cxx__ [@http://msdn.microsoft.com/en-us/visualc/default.aspx Visual C++]]
[def __jemalloc__ [@http://www.canonware.com/jemalloc jemalloc]]
[def __libunwind__ [@http://www.nongnu.org/libunwind libunwind]]
[def __hdf5__ [@http://www.hdfgroup.org/HDF5 Hierarchical Data Format V5 (HDF5)]]
[def __lorene__ [@http://www.lorene.obspm.fr LORENE]]
[def __papi__ [@http://icl.cs.utk.edu/papi/ Performance Application Programming Interface (PAPI)]]
[def __sodium__ [@http://nacl.cr.yp.to/ Networking and Cryptography library (NaCl)]]
[def __lapack__ [@http://math-atlas.sourceforge.net/ Linear Algebra PACKage (LAPACK)]]
[def __blas__ [@http://math-atlas.sourceforge.net/ Basic Linear Algebra Subroutines 3 (BLAS)]]
[def __gsl__ [@http://www.gnu.org/software/gsl/ GNU Scientific Library (GSL)]]
[def __zlib__ [@http://www.zlib.net/ ZLib]]
[def __bzip2__ [@http://www.bzip.org/ BZip2]]
[def __snappy__ [@http://code.google.com/p/snappy/ Snappy]]
[def __qsub__ [@http://www.clusterresources.com/torquedocs21/commands/qsub.shtml qsub]]
[def __qstat__ [@http://www.clusterresources.com/torquedocs21/commands/qstat.shtml qstat]]
[def __pbsdsh__ [@http://www.clusterresources.com/torquedocs21/commands/pbsdsh.shtml pbsdsh]]
[def __pgas__ [@http://www.pgas.org/]]
[def __apgas__ [@https://researcher.ibm.com/researcher/files/us-groved/amp2010.pdf]]
[def __slurm__ [@http://slurm.net/ SLURM]]
[def __srun__ [@http://slurm.schedmd.com/srun.html srun]]
[def __sbatch__ [@http://slurm.schedmd.com/sbatch.html sbatch]]
[def __linda__ [@http://en.wikipedia.org/wiki/Linda_(coordination_language) The Linda Coordination Language]]
[def __opencl__ [@https://www.khronos.org/opencl/ OpenCL]]
[def __openmpi__ [@https://www.open-mpi.org Open MPI]]
[def __pocl__ [@http://portablecl.org/ POCL]]
[def __cuda__ [@http://www.nvidia.com/object/cuda_home_new.html CUDA]]
[def __nt2__ [@http://www.numscale.com/nt2/ NT2]]
[def __lgd__ [@http://www.libgeodecomp.org/ LibGeoDecomp]]
[def __conan__ [@https://www.conan.io/ Conan]]
[def __cpp11__ [@http://www.open-std.org/jtc1/sc22/wg21 C++11 Standard]]
[def __cpp11_n3632__ [@http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2013/n3632.html N3632]]
[def __cpp11_n3634__ [@http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2014/n3857.pdf N3857]]
[def __cpp11_n3562__ [@http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2013/n3562.pdf N3562]]
[def __cpp11_n4088__ [@http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2015/n4411.pdf N4411]]
[def __cpp11_n4104__ [@http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2015/n4409.pdf N4409]]
[def __cpp11_n4107__ [@http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2014/n4313.html N4313]]
[def __cpp11_n4406__ [@http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2015/n4406.pdf N4406]]
[def __cpp17_n4399__ [@http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2015/n4399.html N4399]]
[def __cpp17_n4560__ [@http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2015/n4560.pdf N4560]]
[def __cpp20_p0075r1__ [@http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2016/p0075r1.pdf P0075R1]]
[def __ini_file_format__ [@http://en.wikipedia.org/wiki/INI_file Windows INI file format]]
[/ Optional external dependencies]
[def __hwloc__ [@http://www.open-mpi.org/projects/hwloc/ Portable Hardware Locality (HWLOC)]]
[def __tbb__ [@http://threadingbuildingblocks.org/ Intel Threading Building Blocks (TBB)]]
[def __ppl__ [@http://msdn.microsoft.com/en-us/library/dd492418.aspx Microsoft Parallel Patterns Library (PPL)]]
[def __cilk_pp__ [@http://software.intel.com/en-us/articles/intel-cilk-plus/ Cilk++]]
[def __swarm__ [@http://www.etinternational.com/index.php/products/swarmbeta/ ETI SWift Adaptive Runtime Machine (SWARM)]]
[def __qthreads__ [@http://www.cs.sandia.gov/qthreads/ Sandia National Labs Qthreads]]
[def __mpi__ [@http://en.wikipedia.org/wiki/Message_Passing_Interface MPI]]
[def __openmp__ [@http://openmp.org/wp/ OpenMP]]
[def __charm_pp__ [@http://charm.cs.uiuc.edu/ Charm++]]
[def __pgas__ [@http://www.pgas.org/ PGAS]]
[def __chapel__ [@http://chapel.cray.com/ Chapel]]
[def __x10__ [@http://x10-lang.org/ X10]]
[def __upc__ [@http://upc.lbl.gov/ UPC]]
[def __fortress__ [@http://labs.oracle.com/projects/plrg/Publications/index.html Fortress]]
[/ Some images]
[def __note__ [$./images/note.png [contentwidth 32px]]]
[def __tip__ [$./images/tip.png [contentwidth 32px]]]
[def __important__ [$./images/important.png [contentwidth 32px]]]
[def __caution__ [$./images/caution.png [contentwidth 32px]]]
[/ template definitions]
[template cxx_crtp [@http://en.wikipedia.org/wiki/Curiously_recurring_template_pattern [str]]]
[/ Section link shortcuts]
[def __boost_installation__ [link hpx.manual.build_system.prerequisites.boost_installation Installing Boost Libraries]]
[def __prerequisites__ [link hpx.manual.build_system.prerequisites Build Prerequisites]]
[def __unix_installation__ [link hpx.manual.build_system.building_hpx.build_recipes.unix_installation How to Install __hpx__ on Unix Variants]]
[def __macos_installation__ [link hpx.manual.build_system.building_hpx.build_recipes.macos_installation How to Install __hpx__ on Mac OS]]
[def __windows_installation__ [link hpx.manual.build_system.building_hpx.build_recipes.windows_installation How to Install __hpx__ on Windows]]
[def __using_pbs__ [link hpx.tutorial.getting_started.unix_pbs Using PBS]]
[def __using_slurm__ [link hpx.tutorial.getting_started.unix_slurm Using SLURM]]
[def __fibonacci_example__ [link hpx.tutorial.examples.fibonacci Fibonacci Example]]
[def __hello_world_example__ [link hpx.tutorial.examples.hello_world Hello World Example]]
[def __accumulator_example__ [link hpx.tutorial.examples.accumulator Accumulator Example]]
[def __futurization_example__ [link hpx.tutorial.futurization_example Futurization Example]]
[def __people__ [link hpx.people People]]
[def __getting_started__ [link hpx.tutorial.getting_started Getting Started]]
[def __intro__ [link hpx.tutorial.intro Introduction]]
[def __configuration__ [link hpx.manual.init.configuration Configure __hpx__ Applications]]
[def __config_defaults__ [link hpx.manual.init.configuration.config_defaults Built-in Default Configuration Settings]]
[def __iniformat__ [link hpx.manual.init.configuration.ini_format The __hpx__ INI File Format]]
[def __loading_ini__ [link hpx.manual.init.configuration.loading_ini_files Loading INI Files]]
[def __loading_components__ [link hpx.manual.init.configuration.loading_components Loading Components]]
[def __component_example__ [link hpx.manual.init.configuration.component_example Application Specific Component Example]]
[def __exceptions__ [link hpx.manual.error_handling Error Handling]]
[def __commandline__ [link hpx.manual.init.commandline __hpx__ Command Line Options]]
[def __counter_names__ [link hpx.manual.performance_counters.names Performance Counter Names]]
[def __consuming_counters__ [link hpx.manual.performance_counters.consuming Consuming Performance Counters]]
[def __existing_counters__ [link hpx.manual.performance_counters.counters Existing Performance Counters]]
[def __action_type_definition__ [link hpx.manual.applying_actions.action_type_definition Action Type Definition]]
[def __action_invocation__ [link hpx.manual.applying_actions.action_invocation Action Invocation]]
[def __action_error_handling__ [link hpx.manual.applying_actions.action_error_handling Action Error Handling ]]
[def __scheduling__ [link hpx.manual.schedulers __hpx__ Thread Scheduling Policies]]
[def __cmake_hpx__ [link hpx.manual.build_system.building_hpx Building __hpx__ with CMake]]
[def __cmake_quick_start__ [link hpx.manual.build_system.cmake_basics CMake Quick Start]]
[def __cmake_basic_usage__ [link hpx.build_system.basic_cmake_usage Basic CMake Usage]]
[def __cmake_options__ [link hpx.manual.build_system.building_hpx.cmake_variables CMake Variables used to configure __hpx__]]
[def __cmake_doc_tools__ [link hpx.manual.cmake.doc_tools Setting up the __hpx__ Documentation Tool Chain]]
[def __pkg_config__ [link hpx.manual.build_system.using_hpx.pkgconfig.comps How to Build __hpx__ Components with pkg-config]]
[/ Do not add any whitespace between [str]and the template body, it ends up in the
generated docs, which may cause unwanted effects.]
[template hpx_cmdline[str][link hpx.manual.init.commandline [str]]]
[template hpx_link[url txt] '''<ulink url="'''__hpx_source_dir__'''/'''[url]'''">'''[txt]'''</ulink>''']
[template git_commit_link[commit] '''<ulink url="https://github.com/STEllAR-GROUP/hpx/commit/'''[commit]'''">'''[commit]'''</ulink>''']
[template issue[num] '''<ulink url="http://github.com/STEllAR-GROUP/hpx/issues/'''[num]'''">'''`IS#`[num]'''</ulink>''']
[template pr[num] '''<ulink url="http://github.com/STEllAR-GROUP/hpx/issues/'''[num]'''">'''`PR#`[num]'''</ulink>''']
[/ fig[ref title label]
Image element with a title.
ref := Reference to the image file.
title := The title to associate with this figure.
label := the id to use to be able to reference this picture
]
[template fig[ref title label]'''
<figure id="'''[label]'''">
<title>'''[title]'''</title>
<inlinemediaobject>
<imageobject>
<imagedata fileref="./images/'''[ref]'''"></imagedata>
</imageobject>
<textobject>
<phrase role="alt">'''[title]'''</phrase>
</textobject>
</inlinemediaobject>
</figure>
''']
[/ Indexing support]
[template index[title]'''
<index>
<title id="hpx.index">'''[title]'''</title>
</index>
''']
[template indexterm1 [primary]'''
<indexterm>
<primary>'''[primary]'''</primary>
</indexterm>
''']
[template indexterm2 [primary secondary]'''
<indexterm type="hpx_index">
<primary>'''[primary]'''</primary>
<secondary>'''[secondary]'''</secondary>
</indexterm>
''']
[template indexterm3 [primary secondary tertiary]'''
<indexterm type="hpx_index">
<primary>'''[primary]'''</primary>
<secondary>'''[secondary]'''</secondary>
<tertiary>'''[tertiary]'''</tertiary>
</indexterm>
''']
[template copymark[]'''©''']
[template regmark[]'''®''']
[template trademark[]'''™''']
[template algoref[name] [funcref hpx::parallel::v1::[name] hpx::parallel::[name]]]
[template algorefv2[name] [funcref hpx::parallel::v2::[name] hpx::parallel::[name]]]
[/ CONTENT]
The __stellar__ Group ([*S]ystems [*T]echnology, [*E]mergent Para[*ll]elism,
and [*A]lgorithm [*R]esearch) is an international research group with the
goal of promoting the development of scalable parallel applications by
providing a community for ideas, a framework for collaboration, and a platform
for communicating these concepts to the broader community.
The main contributors to __hpx__ in the __stellar__ Group are researchers
from __lsu__'s __cct__ and the __fau__'s __inf3__. For a full list of people
working in this group and participating in writing this documentation see
__people__.
This documentation is automatically generated for __hpx__ __version__ (from Git
commit: [git_commit_link __hpx_git_commit__]) by the Boost __boost_quickbook__
and __boost_auto_index__ documentation tools. __boost_quickbook__ and
__boost_auto_index__ can be found in the collection of __boost_tools__.
[include preface.qbk]
[include whats_new.qbk]
[/////////////////////////////////////////////////////////////////////////////]
[section:tutorial Tutorial]
[include tutorial/gettingstarted.qbk]
[include tutorial/introduction.qbk]
[include tutorial/examples.qbk]
[include tutorial/futurization_example.qbk]
[endsect] [/ Tutorial]
[/////////////////////////////////////////////////////////////////////////////]
[section:manual Manual]
[include manual/build_system.qbk]
[include manual/testing.qbk]
[include manual/init.qbk]
[include manual/system_components.qbk]
[include manual/applications.qbk]
[include manual/names.qbk]
[include manual/applying_actions.qbk]
[/ include manual/plain_actions.qbk]
[include manual/components.qbk]
[include manual/lcos.qbk]
[include manual/parallel_algorithms.qbk]
[include manual/exceptions.qbk]
[include manual/performance_counters.qbk]
[include manual/scheduling_policies.qbk]
[endsect] [/ Manual]
[? __use_auto_index__
[index Index]
]
[? __hpx_doxygen__ [xinclude __hpx_docs_dir__/hpx_autodoc.xml]]
[include terminology.qbk]
[/////////////////////////////////////////////////////////////////////////////]
[include people.qbk]