-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Added specification to doc directory #2017
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
vossmjp
wants to merge
5
commits into
master
Choose a base branch
from
dev/vossmjp/add_spec
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
bd2d546
Added specification to doc directory
vossmjp dc681e9
Removed unused variable
vossmjp 4a9ed7d
Include specification only for OSS builds
vossmjp c61b63b
Fixed spelling errors
vossmjp d04394e
Removed reference to specific specification version
vossmjp File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,14 +3,19 @@ | |
| |short_name| API Reference | ||
| ========================== | ||
|
|
||
| For oneTBB API Reference, refer to `oneAPI Specification <https://github.com/uxlfoundation/oneAPI-spec>`_. The current supported | ||
| version of oneAPI Specification is 1.0. | ||
| .. only:: oss | ||
|
|
||
| For oneTBB API Reference, refer to the :doc:`oneTBB Specification </main/specification/source/index>`. | ||
|
|
||
| .. only:: not oss | ||
|
|
||
| For oneTBB API Reference, refer to the `oneTBB Specification <https://uxlfoundation.github.io/oneTBB/main/specification/source/index.html>`_. | ||
| The current supported version of the oneTBB specification is 1.5. | ||
|
Comment on lines
+10
to
+13
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do we need this? |
||
|
|
||
| Specification extensions | ||
| ************************ | ||
|
|
||
| |full_name| implements the `oneTBB specification <https://oneapi-spec.uxlfoundation.org/specifications/oneapi/latest/elements/onetbb/source/nested-index>`_. | ||
| This document provides additional details or restrictions where necessary. | ||
| |full_name| implements the oneTBB specification. This document provides additional details or restrictions beyond the specification. | ||
| It also describes features that are not included in the oneTBB specification. | ||
|
|
||
| .. toctree:: | ||
|
|
||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| .. SPDX-FileCopyrightText: 2019-2021 Intel Corporation | ||
| .. | ||
| .. SPDX-License-Identifier: CC-BY-4.0 | ||
|
|
||
| ========== | ||
| Algorithms | ||
| ========== | ||
| **[algorithms]** | ||
|
|
||
| oneAPI Threading Building Blocks provides a set of generic parallel algorithms. | ||
|
|
||
| Parallel Functions | ||
| ------------------ | ||
|
|
||
| .. toctree:: | ||
| :titlesonly: | ||
|
|
||
| algorithms/functions/collaborative_call_once_func.rst | ||
|
|
||
| algorithms/functions/parallel_for_func.rst | ||
| algorithms/functions/parallel_reduce_func.rst | ||
| algorithms/functions/parallel_deterministic_reduce_func.rst | ||
| algorithms/functions/parallel_scan_func.rst | ||
|
|
||
| algorithms/functions/parallel_for_each_func.rst | ||
|
|
||
| algorithms/functions/parallel_invoke_func.rst | ||
| algorithms/functions/parallel_pipeline_func.rst | ||
| algorithms/functions/parallel_sort_func.rst | ||
|
|
||
| Blocked Ranges | ||
| -------------- | ||
|
|
||
| Types that meet the :doc:`Range requirements <named_requirements/algorithms/range>`. | ||
|
|
||
| .. toctree:: | ||
| :titlesonly: | ||
|
|
||
| algorithms/blocked_ranges/blocked_range_cls.rst | ||
| algorithms/blocked_ranges/blocked_range2d_cls.rst | ||
| algorithms/blocked_ranges/blocked_range3d_cls.rst | ||
| algorithms/blocked_ranges/blocked_nd_range_cls.rst | ||
|
|
||
| .. _Partitioners: | ||
|
|
||
| Partitioners | ||
| ------------ | ||
|
|
||
| A partitioner specifies how a loop template should partition its work among threads. | ||
|
|
||
| .. toctree:: | ||
| :titlesonly: | ||
|
|
||
| algorithms/partitioners/auto_partitioner.rst | ||
| algorithms/partitioners/affinity_partitioner.rst | ||
| algorithms/partitioners/static_partitioner.rst | ||
| algorithms/partitioners/simple_partitioner.rst | ||
|
|
||
| Split Tags | ||
| ---------- | ||
|
|
||
| .. toctree:: | ||
| :titlesonly: | ||
|
|
||
| algorithms/split_tags/proportional_split_cls.rst | ||
| algorithms/split_tags/split_cls.rst |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we decide to keep it, I'd recommend renaming it to tbb_spec_version to avoid misunderstanding.