xref: /oneTBB/doc/main/reference/reference.rst (revision 9e62b047)
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    parallel_for_each_semantics
20    parallel_sort_ranges_extension
21    scalable_memory_pools/malloc_replacement_log
22
23Preview features
24****************
25
26A preview feature is a component of oneTBB introduced to receive early feedback from
27users.
28
29The key properties of a preview feature are:
30
31- It is off by default and must be explicitly enabled.
32- It is intended to have a high quality implementation.
33- There is no guarantee of future existence or compatibility.
34- It may have limited or no support in tools such as correctness analyzers, profilers and debuggers.
35
36
37.. caution::
38    A preview feature is subject to change in future. It might be removed or significantly
39    altered in future releases. Changes to a preview feature do NOT require
40    usual deprecation and removal process. Therefore, using preview features in production code
41    is strongly discouraged.
42
43.. toctree::
44    :titlesonly:
45
46    type_specified_message_keys
47    scalable_memory_pools
48    helpers_for_expressing_graphs
49    concurrent_lru_cache_cls
50    task_group_extensions
51    custom_mutex_chmap
52