Skip to content

Commit 0c0ff19

Browse files
authored
Update documentation for oneTBB 2022.0.0 (#1544)
1 parent c89df93 commit 0c0ff19

10 files changed

+369
-29
lines changed

doc/GSG/get_started.rst

+26-1
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,36 @@ It is helpful for new users of parallel programming and experienced developers t
88

99
It is recommended for you to have a basic knowledge of C++ programming and some experience with parallel programming concepts.
1010

11+
|full_name| is a runtime-based parallel programming model for C++ code that uses tasks.
12+
The template-based runtime library can help you harness the latent performance of multi-core processors.
13+
14+
oneTBB enables you to simplify parallel programming by breaking computation into parallel running tasks. Within a single process,
15+
parallelism is carried out by mapping tasks to threads. Threads are an operating system mechanism that allows the same or different sets of instructions
16+
to be executed simultaneously. Using threads can make your program work faster and more efficiently.
17+
18+
Here you can see one of the possible executions of tasks by threads.
19+
20+
.. figure:: Images/how-oneTBB-works.png
21+
:scale: 70%
22+
:align: center
23+
24+
Use oneTBB to write scalable applications that:
25+
26+
* Specify logical parallel structure instead of threads.
27+
* Emphasize data-parallel programming.
28+
* Take advantage of concurrent collections and parallel algorithms.
29+
30+
oneTBB supports nested parallelism and load balancing. It means that you can use the library without worrying about oversubscribing a system, which happens when more tasks are assigned to a system than it can handle efficiently.
31+
32+
oneTBB is used in different areas, such as scientific simulations, gaming, data analysis, etc.
33+
34+
It is available as a stand-alone product and as part of the |base_tk|.
35+
1136

1237
To start using oneTBB, follow the next steps:
1338
*********************************************
1439

15-
#. Learn what :ref:`oneTBB is<intro>` and see the :ref:`System Requirements<system_requirements>`.
40+
#. See the :ref:`System Requirements<system_requirements>`.
1641
#. :ref:`Install oneTBB<installation>`.
1742
#. Run your program using oneTBB following the :ref:`Next Steps <next_steps>`.
1843
#. Learn how to :ref:`Integrate oneTBB into your project <integrate>` using CMake* and pkg-config tool.

doc/conf.py

+2-8
Original file line numberDiff line numberDiff line change
@@ -140,9 +140,7 @@
140140
}
141141

142142
if BUILD_TYPE != 'oneapi' and BUILD_TYPE != 'dita':
143-
html_theme_options = {
144-
"extra_footer": "<div><a href='https://www.intel.com/content/www/us/en/privacy/intel-cookie-notice.html' data-cookie-notice='true'>Cookies</a> <a href='https://www.intel.com/content/www/us/en/privacy/intel-privacy-notice.html'>| Privacy</a> <a data-wap_ref='dns' id='wap_dns' href='https://www.intel.com/content/www/us/en/privacy/intel-cookie- notice.html'>| Do Not Share My Personal Information</a> </div><div>&copy; Intel Corporation. Intel, the Intel logo, and other Intel marks are trademarks of Intel Corporation or its subsidiaries. Other names and brands may be claimed as the property of others. No license (express or implied, by estoppel or otherwise) to any intellectual property rights is granted by this document, with the sole exception that code included in this document is licensed subject to the Zero-Clause BSD open source license (OBSD), <a href='http://opensource.org/licenses/0BSD'>http://opensource.org/licenses/0BSD</a>. </div><br><div>oneTBB is licensed under Apache License Version 2.0. Refer to the <a href='https://github.com/oneapi-src/oneTBB/blob/master/LICENSE.txt'>LICENSE </a> file for the full license text and copyright notice.</div>"
145-
}
143+
html_theme_options["extra_footer"]="<div><a href='https://www.intel.com/content/www/us/en/privacy/intel-cookie-notice.html' data-cookie-notice='true'>Cookies</a> <a href='https://www.intel.com/content/www/us/en/privacy/intel-privacy-notice.html'>| Privacy</a> <a data-wap_ref='dns' id='wap_dns' href='https://www.intel.com/content/www/us/en/privacy/intel-cookie- notice.html'>| Do Not Share My Personal Information</a> </div><div>&copy; Intel Corporation. Intel, the Intel logo, and other Intel marks are trademarks of Intel Corporation or its subsidiaries. Other names and brands may be claimed as the property of others. No license (express or implied, by estoppel or otherwise) to any intellectual property rights is granted by this document, with the sole exception that code included in this document is licensed subject to the Zero-Clause BSD open source license (OBSD), <a href='http://opensource.org/licenses/0BSD'>http://opensource.org/licenses/0BSD</a>. </div><br><div>oneTBB is licensed under Apache License Version 2.0. Refer to the <a href='https://github.com/oneapi-src/oneTBB/blob/master/LICENSE.txt'>LICENSE </a> file for the full license text and copyright notice.</div>"
146144

147145

148146
# Add any paths that contain custom static files (such as style sheets) here,
@@ -159,11 +157,7 @@
159157
else:
160158
html_js_files = ['custom.js']
161159

162-
html_theme_options = {
163-
"logo": {
164-
"text": "oneTBB Documentation",
165-
}
166-
}
160+
html_theme_options["logo"] = {"text": "oneTBB Documentation"}
167161

168162
html_logo = '_static/oneAPI-rgb-rev-100.png'
169163
html_favicon = '_static/favicons.png'

doc/index/toctree.rst

-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@
1717
:maxdepth: 2
1818

1919
/GSG/get_started
20-
/GSG/intro
2120
/GSG/system_requirements
2221
/GSG/installation
2322
/GSG/next_steps

doc/main/reference/reference.rst

+1
Original file line numberDiff line numberDiff line change
@@ -50,3 +50,4 @@ The key properties of a preview feature are:
5050
concurrent_lru_cache_cls
5151
task_group_extensions
5252
custom_mutex_chmap
53+
try_put_and_wait

doc/main/reference/rvalue_reduce.rst

+3-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ or
3333

3434
.. cpp:function:: Value Func::operator()(const Range& range, const Value& x) const
3535

36-
Accumulates the result for a subrange, starting with initial value ``x``. The ``Range`` type must meet the `Range requirements <https://oneapi-spec.uxlfoundation.org/specifications/oneapi/latest/elements/onetbb/source/named_requirements/algorithms/range>_`.
36+
Accumulates the result for a subrange, starting with initial value ``x``. The ``Range`` type must meet the
37+
`Range requirements <https://oneapi-spec.uxlfoundation.org/specifications/oneapi/latest/elements/onetbb/source/named_requirements/algorithms/range>`_.
3738
The ``Value`` type must be the same as a corresponding template parameter for the `parallel_reduce algorithm <https://oneapi-spec.uxlfoundation.org/specifications/oneapi/latest/elements/onetbb/source/algorithms/functions/parallel_reduce_func>`_.
3839

3940
If both ``rvalue`` and ``lvalue`` forms are provided, the ``rvalue`` is preferred.
@@ -55,6 +56,7 @@ Example
5556
*******
5657

5758
.. code:: cpp
59+
5860
// C++17
5961
#include <oneapi/tbb/parallel_reduce.h>
6062
#include <oneapi/tbb/blocked_range.h>

0 commit comments

Comments
 (0)