xref: /oneTBB/doc/main/reference/reference.rst (revision 0a2b3987)
1.. _reference:
2
3|short_name| API Reference
4==========================
5
6For oneTBB API Reference, refer to `oneAPI Specification <https://spec.oneapi.com/>`_. The current supported
7version of oneAPI Specification is 1.0.
8
9Specification extensions
10************************
11
12|full_name| implements the `oneTBB specification <https://spec.oneapi.com/versions/latest/elements/oneTBB/source/nested-index.html>`_.
13This document provides additional details or restrictions where necessary.
14It also describes features that are not included in the oneTBB specification.
15
16.. toctree::
17    :titlesonly:
18
19    info_namespace
20    parallel_for_each_semantics
21
22Preview features
23****************
24
25A preview feature is a component of oneTBB introduced to receive early feedback from
26users.
27
28The key properties of a preview feature are:
29
30- It is off by default and must be explicitly enabled.
31- It is intended to have a high quality implementation.
32- There is no guarantee of future existence or compatibility.
33- It may have limited or no support in tools such as correctness analyzers, profilers and debuggers.
34
35
36.. caution::
37    A preview feature is subject to change in future. It might be removed or significantly
38    altered in future releases. Changes to a preview feature do NOT require
39    usual deprecation and removal process. Therefore, using preview features in production code
40    is strongly discouraged.
41
42.. toctree::
43    :titlesonly:
44
45    type_specified_message_keys
46    blocking_terminate
47    scalable_memory_pools
48    helpers_for_expressing_graphs
49    concurrent_lru_cache_cls
50    constraints_extensions
51    info_namespace_extensions
52    task_group_extensions
53    task_arena_extensions
54    this_task_arena_extensions
55    mutex_cls
56    rw_mutex_cls
57    heterogeneous_extensions_chmap
58    custom_mutex_chmap
59