Skip to content

Commit

Permalink
Update documentation for oneTBB 2022.0.0 (#1544)
Browse files Browse the repository at this point in the history
  • Loading branch information
omalyshe authored Oct 31, 2024
1 parent c89df93 commit 0c0ff19
Show file tree
Hide file tree
Showing 10 changed files with 369 additions and 29 deletions.
27 changes: 26 additions & 1 deletion doc/GSG/get_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,36 @@ It is helpful for new users of parallel programming and experienced developers t

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

|full_name| is a runtime-based parallel programming model for C++ code that uses tasks.
The template-based runtime library can help you harness the latent performance of multi-core processors.

oneTBB enables you to simplify parallel programming by breaking computation into parallel running tasks. Within a single process,
parallelism is carried out by mapping tasks to threads. Threads are an operating system mechanism that allows the same or different sets of instructions
to be executed simultaneously. Using threads can make your program work faster and more efficiently.

Here you can see one of the possible executions of tasks by threads.

.. figure:: Images/how-oneTBB-works.png
:scale: 70%
:align: center

Use oneTBB to write scalable applications that:

* Specify logical parallel structure instead of threads.
* Emphasize data-parallel programming.
* Take advantage of concurrent collections and parallel algorithms.

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.

oneTBB is used in different areas, such as scientific simulations, gaming, data analysis, etc.

It is available as a stand-alone product and as part of the |base_tk|.


To start using oneTBB, follow the next steps:
*********************************************

#. Learn what :ref:`oneTBB is<intro>` and see the :ref:`System Requirements<system_requirements>`.
#. See the :ref:`System Requirements<system_requirements>`.
#. :ref:`Install oneTBB<installation>`.
#. Run your program using oneTBB following the :ref:`Next Steps <next_steps>`.
#. Learn how to :ref:`Integrate oneTBB into your project <integrate>` using CMake* and pkg-config tool.
Expand Down
10 changes: 2 additions & 8 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -140,9 +140,7 @@
}

if BUILD_TYPE != 'oneapi' and BUILD_TYPE != 'dita':
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>"
}
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>"


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

html_theme_options = {
"logo": {
"text": "oneTBB Documentation",
}
}
html_theme_options["logo"] = {"text": "oneTBB Documentation"}

html_logo = '_static/oneAPI-rgb-rev-100.png'
html_favicon = '_static/favicons.png'
Expand Down
1 change: 0 additions & 1 deletion doc/index/toctree.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@
:maxdepth: 2

/GSG/get_started
/GSG/intro
/GSG/system_requirements
/GSG/installation
/GSG/next_steps
Expand Down
1 change: 1 addition & 0 deletions doc/main/reference/reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,4 @@ The key properties of a preview feature are:
concurrent_lru_cache_cls
task_group_extensions
custom_mutex_chmap
try_put_and_wait
4 changes: 3 additions & 1 deletion doc/main/reference/rvalue_reduce.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ or

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

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>_`.
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>`_.
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>`_.

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

.. code:: cpp
// C++17
#include <oneapi/tbb/parallel_reduce.h>
#include <oneapi/tbb/blocked_range.h>
Expand Down
Loading

0 comments on commit 0c0ff19

Please sign in to comment.