xref: /oneTBB/README.md (revision f6b7cb1b)
149e08aacStbbdev# oneAPI Threading Building Blocks
2a497817cSAlexey Veprev[![Apache License Version 2.0](https://img.shields.io/badge/license-Apache_2.0-green.svg)](LICENSE.txt) [![oneTBB CI](https://github.com/oneapi-src/oneTBB/actions/workflows/ci.yml/badge.svg)](https://github.com/oneapi-src/oneTBB/actions/workflows/ci.yml?query=branch%3Amaster)
3d238c1f3Stbbdev
46563a222SAlexandraoneTBB is a flexible C++ library that simplifies the work of adding parallelism
56563a222SAlexandrato complex applications, even if you are not a threading expert.
66563a222SAlexandra
76563a222SAlexandraThe library lets you easily write parallel programs that take full advantage of the multi-core performance. Such programs are portable,
86563a222SAlexandracomposable and have a future-proof scalability. oneTBB provides you with functions, interfaces, and classes to parallelize and scale the code.
96563a222SAlexandraAll you have to do is to use the templates.
106563a222SAlexandra
116563a222SAlexandraThe library differs from typical threading packages in the following ways:
126563a222SAlexandra* oneTBB enables you to specify logical parallelism instead of threads.
136563a222SAlexandra* oneTBB targets threading for performance.
146563a222SAlexandra* oneTBB is compatible with other threading packages.
156563a222SAlexandra* oneTBB emphasizes scalable, data parallel programming.
166563a222SAlexandra* oneTBB relies on generic programming.
176563a222SAlexandra
186563a222SAlexandra
196563a222SAlexandraRefer to oneTBB [examples](examples) and [samples](https://github.com/oneapi-src/oneAPI-samples/tree/master/Libraries/oneTBB) to see how you can use the library.
206563a222SAlexandra
216563a222SAlexandraoneTBB is a part of [oneAPI](https://oneapi.io). The current branch implements version 1.1 of oneAPI Specification.
22d238c1f3Stbbdev
23797dfaa7SAlexandra> **_NOTE:_** Threading Building Blocks (TBB) is now called oneAPI Threading Building Blocks (oneTBB) to highlight that the tool is a part of the oneAPI ecosystem.
24797dfaa7SAlexandra
2551c0b2f7Stbbdev## Release Information
26*f6b7cb1bSAlexandra
27*f6b7cb1bSAlexandraSee [Release Notes](RELEASE_NOTES.md) and [System Requirements](SYSTEM_REQUIREMENTS.md).
28d238c1f3Stbbdev
2951c0b2f7Stbbdev## Documentation
302526dcf1SAlexandra* [oneTBB Specification](https://spec.oneapi.com/versions/latest/elements/oneTBB/source/nested-index.html)
317b3cb674SAlexandra* [oneTBB Developer Guide and Reference](https://oneapi-src.github.io/oneTBB)
32603d9f7eSAnton Potapov* [Migrating from TBB to oneTBB](https://oneapi-src.github.io/oneTBB/main/tbb_userguide/Migration_Guide.html)
33e386c96dSIvan Kochin* [README for the CMake build system](cmake/README.md)
34104fb5c9SAlexandra* [oneTBB Testing Approach](https://oneapi-src.github.io/oneTBB/main/intro/testing_approach.html)
3561640445SVertexwahn* [Basic support for the Bazel build system](Bazel.md)
367b3cb674SAlexandra* [oneTBB Discussions](https://github.com/oneapi-src/oneTBB/discussions)
37f4082a4cSAlexandra* [WASM Support](WASM_Support.md)
38d238c1f3Stbbdev
393692900cSAlexandra## Installation
403692900cSAlexandraSee [Installation from Sources](INSTALL.md) to learn how to install oneTBB.
413692900cSAlexandra
4251c0b2f7Stbbdev## Support
43*f6b7cb1bSAlexandraSee our [documentation](./SUPPORT.md) to learn how to request help.
44d238c1f3Stbbdev
4551c0b2f7Stbbdev## How to Contribute
466563a222SAlexandraWe welcome community contributions, so check our [Contributing Guidelines](CONTRIBUTING.md)
47a6b90fc9SAlexandrato learn more.
488dcbd5b1Stbbdev
498dcbd5b1Stbbdev## License
5051c0b2f7StbbdevoneAPI Threading Building Blocks is licensed under [Apache License, Version 2.0](LICENSE.txt).
5151c0b2f7StbbdevBy its terms, contributions submitted to the project are also done under that license.
52d238c1f3Stbbdev
5351c0b2f7Stbbdev## Engineering team contacts
547b3cb674SAlexandra* [Email us.](mailto:[email protected])
55b0df353aStbbdev
56d238c1f3Stbbdev------------------------------------------------------------------------
577b3cb674SAlexandra\* All names and brands may be claimed as the property of others.
58