Skip to content
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

Add documentation for blocked_nd_range CTAD #1641

Merged
merged 9 commits into from
Mar 6, 2025

Conversation

kboyarinov
Copy link
Contributor

Description

Extend reference with the information about blocked_range deduction guides (preview feature).

Fixes # - issue number(s) if exists

Type of change

Choose one or multiple, leave empty if none of the other choices apply

Add a respective label(s) to PR if you have permissions

  • bug fix - change that fixes an issue
  • new feature - change that adds functionality
  • tests - change in tests
  • infrastructure - change in infrastructure and CI
  • documentation - documentation update

Tests

  • added - required for new features and some bug fixes
  • not needed

Documentation

  • updated in # - add PR number
  • needs to be updated
  • not needed

Breaks backward compatibility

  • Yes
  • No
  • Unknown

Notify the following users

List users with @ to send notifications

Other information

aepanchi
aepanchi previously approved these changes Feb 27, 2025
Copy link
Contributor

@aepanchi aepanchi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM just one typo

Co-authored-by: Alexandra <alexandra.epanchinzeva@intel.com>
aepanchi
aepanchi previously approved these changes Feb 27, 2025
=========================================

.. note::
To enable this feature, define the ``TBB_PREVIEW_BLOCKED_ND_RANGE_DEDUCTION_GUIDES`` macro to 1.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe add link to RFC so people know where to leave feedback and what the exit conditions are.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done as a separate note in the description

Deduction (starting from C++17). With that, you do not need to specify template arguments explicitly
while creating a ``blocked_nd_range`` object if they can be inferred from the constructor arguments:

.. literalinclude:: ./examples/blocked_nd_range_ctad_example.cpp
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the blocked_nd_range_ctad_example.cpp file missing?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think so. I cannot find this file in ./examples subdirectory

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added

Co-authored-by: Mike Voss <michaelj.voss@intel.com>
Copy link
Contributor

@aleksei-fedotov aleksei-fedotov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, except for the comment below.

Deduction (starting from C++17). With that, you do not need to specify template arguments explicitly
while creating a ``blocked_nd_range`` object if they can be inferred from the constructor arguments:

.. literalinclude:: ./examples/blocked_nd_range_ctad_example.cpp
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think so. I cannot find this file in ./examples subdirectory

Copy link
Contributor

@vossmjp vossmjp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

@kboyarinov kboyarinov merged commit 2b39fda into master Mar 6, 2025
28 checks passed
@kboyarinov kboyarinov deleted the dev/kboyarinov/blocked_nd_range_ctad_reference branch March 6, 2025 20:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants