xref: /oneTBB/doc/main/reference/reference.rst (revision 9e62b047)
167c11716SAlexey Oralov.. _reference:
267c11716SAlexey Oralov
367c11716SAlexey Oralov|short_name| API Reference
467c11716SAlexey Oralov==========================
567c11716SAlexey Oralov
667c11716SAlexey OralovFor oneTBB API Reference, refer to `oneAPI Specification <https://spec.oneapi.com/>`_. The current supported
767c11716SAlexey Oralovversion of oneAPI Specification is 1.0.
867c11716SAlexey Oralov
967c11716SAlexey OralovSpecification extensions
1067c11716SAlexey Oralov************************
1167c11716SAlexey Oralov
1267c11716SAlexey Oralov|full_name| implements the `oneTBB specification <https://spec.oneapi.com/versions/latest/elements/oneTBB/source/nested-index.html>`_.
1367c11716SAlexey OralovThis document provides additional details or restrictions where necessary.
1467c11716SAlexey OralovIt also describes features that are not included in the oneTBB specification.
1567c11716SAlexey Oralov
1667c11716SAlexey Oralov.. toctree::
1767c11716SAlexey Oralov    :titlesonly:
1867c11716SAlexey Oralov
1967c11716SAlexey Oralov    parallel_for_each_semantics
20b95bbc9cSIvan Kochin    parallel_sort_ranges_extension
21*a6a884adSAlexandra    scalable_memory_pools/malloc_replacement_log
2267c11716SAlexey Oralov
2367c11716SAlexey OralovPreview features
2467c11716SAlexey Oralov****************
2567c11716SAlexey Oralov
2667c11716SAlexey OralovA preview feature is a component of oneTBB introduced to receive early feedback from
2767c11716SAlexey Oralovusers.
2867c11716SAlexey Oralov
2967c11716SAlexey OralovThe key properties of a preview feature are:
3067c11716SAlexey Oralov
3167c11716SAlexey Oralov- It is off by default and must be explicitly enabled.
3267c11716SAlexey Oralov- It is intended to have a high quality implementation.
3367c11716SAlexey Oralov- There is no guarantee of future existence or compatibility.
3467c11716SAlexey Oralov- It may have limited or no support in tools such as correctness analyzers, profilers and debuggers.
3567c11716SAlexey Oralov
3667c11716SAlexey Oralov
3767c11716SAlexey Oralov.. caution::
3867c11716SAlexey Oralov    A preview feature is subject to change in future. It might be removed or significantly
3967c11716SAlexey Oralov    altered in future releases. Changes to a preview feature do NOT require
4067c11716SAlexey Oralov    usual deprecation and removal process. Therefore, using preview features in production code
4167c11716SAlexey Oralov    is strongly discouraged.
4267c11716SAlexey Oralov
4367c11716SAlexey Oralov.. toctree::
4467c11716SAlexey Oralov    :titlesonly:
4567c11716SAlexey Oralov
4667c11716SAlexey Oralov    type_specified_message_keys
4767c11716SAlexey Oralov    scalable_memory_pools
4867c11716SAlexey Oralov    helpers_for_expressing_graphs
4967c11716SAlexey Oralov    concurrent_lru_cache_cls
5067c11716SAlexey Oralov    task_group_extensions
5167c11716SAlexey Oralov    custom_mutex_chmap
52