Document vectorized STL algorithms #5789

AlexGuteniev · 2025-09-19T17:25:39Z

The intention is to make users aware of manual vectorization and _USE_STD_VECTOR_ALGORITHMS and _USE_STD_VECTOR_FLOATING_ALGORITHMS macros.

prmerger-automator · 2025-09-19T17:25:53Z

@AlexGuteniev : Thanks for your contribution! The author(s) and reviewer(s) have been notified to review your proposed change.

learn-build-service-prod · 2025-09-19T17:28:04Z

Learn Build status updates of commit 814cd8f:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File	Status	Preview URL	Details
docs/standard-library/toc.yml	❌Error		Details
docs/standard-library/vectorized-stl-algoritms.md	💡Suggestion		Details

docs/standard-library/toc.yml

Line 1654, Column 11: [Error: yaml-syntax-error - See documentation] While scanning a plain scalar value, found invalid mapping.

docs/standard-library/vectorized-stl-algoritms.md

Line 2, Column 1: [Suggestion: description-missing - See documentation] Missing required attribute: 'description'.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

learn-build-service-prod · 2025-09-19T17:33:07Z

Learn Build status updates of commit 4272d7e:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File	Status	Preview URL	Details
docs/standard-library/toc.yml	❌Error		Details

docs/standard-library/toc.yml

Line 1654, Column 12: [Error: yaml-syntax-error - See documentation] While scanning a plain scalar value, found invalid mapping.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

learn-build-service-prod · 2025-09-19T17:40:16Z

Learn Build status updates of commit cc385c5:

⚠️ Validation status: warnings

File	Status	Preview URL	Details
docs/standard-library/toc.yml	⚠️Warning		Details
docs/standard-library/vectorized-stl-algoritms.md	✅Succeeded

docs/standard-library/toc.yml

Line 1654, Column 9: [Warning: file-not-found - See documentation] Invalid file link: 'vectorized-stl-algorithms.md'.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

learn-build-service-prod · 2025-09-19T17:46:09Z

Learn Build status updates of commit 86a3e29:

✅ Validation status: passed

File	Status	Preview URL	Details
docs/standard-library/toc.yml	✅Succeeded
docs/standard-library/vectorized-stl-algorithms.md	✅Succeeded

For more details, please refer to the build report.

prmerger-automator · 2025-09-19T17:46:13Z

PRMerger Results

Issue	Description
Added File(s)	This PR contains added files. New files require human review.
Yaml File(s)	This PR includes changes to .yml file(s) owned by another author.
File Change Percent	This PR contains file(s) with more than 30% file change.

Alcaro

why does github subscribe me to the issue when I start writing a review, not at the end when it's public?

docs/standard-library/vectorized-stl-algoritms.md

Alcaro · 2025-09-19T17:43:23Z

docs/standard-library/vectorized-stl-algoritms.md

+
+Generally, programs either benefit in performance from this manual vectorization or are unaffected by it. In case of any problem, you can disable manual vectorization by defining `_USE_STD_VECTOR_ALGORITHMS` macro set to 0.
+
+The following algorithms have manual vectorization controlled via `_USE_STD_VECTOR_ALGORITHMS` macro:


Having such a list kinda makes me nervous; if someone vectorizes a new function and forgets adding it here, we've got problems. This is very easy when it isn't even in the ms-stl repo.

Also what kind of sorting is that

I know,
Plus it is accurate for like the latest Preview, not latest production.
But I still think providing an approximation here is useful and better than no list.

Approximately standard order or cppreference.com order.

docs/standard-library/vectorized-stl-algoritms.md

learn-build-service-prod · 2025-09-19T17:58:07Z

Learn Build status updates of commit 53ae06f:

✅ Validation status: passed

File	Status	Preview URL	Details
docs/standard-library/toc.yml	✅Succeeded
docs/standard-library/vectorized-stl-algorithms.md	✅Succeeded

For more details, please refer to the build report.

prmerger-automator · 2025-09-19T17:58:11Z

PRMerger Results

Issue	Description
Added File(s)	This PR contains added files. New files require human review.
Yaml File(s)	This PR includes changes to .yml file(s) owned by another author.
File Change Percent	This PR contains file(s) with more than 30% file change.

Rageking8 · 2025-09-19T18:33:18Z

AFAIK new topics can't be added via the public repo and needs to be ported manually. Could check with @TylerMSFT for further comments.

Court72 · 2025-09-19T21:01:06Z

@TylerMSFT

If you approve the new content in this PR, the commits must be moved to the private repository for automated checks and publishing. After you move the commits, close this PR (#please-close). If you need help moving the commits, contact the publicprs alias.

#label:"aq-pr-triaged"
@MicrosoftDocs/public-repo-pr-review-team

TylerMSFT · 2025-09-19T22:24:40Z

Thank you for the content, @AlexGuteniev. Appreciate you taking the time to contribute to the docs.
It's true that we can't add content from the public repo. It's no problem because I'll port it and get it published after we do some review.
I have some things in my queue but will return to this.
Thanks again.

learn-build-service-prod · 2025-09-20T13:22:44Z

Learn Build status updates of commit 6c10dc3:

✅ Validation status: passed

File	Status	Preview URL	Details
docs/standard-library/toc.yml	✅Succeeded
docs/standard-library/vectorized-stl-algorithms.md	✅Succeeded

For more details, please refer to the build report.

prmerger-automator · 2025-09-20T13:22:48Z

PRMerger Results

Issue	Description
Added File(s)	This PR contains added files. New files require human review.
Yaml File(s)	This PR includes changes to .yml file(s) owned by another author.
File Change Percent	This PR contains file(s) with more than 30% file change.

docs/standard-library/vectorized-stl-algorithms.md

Co-authored-by: Rageking8 <[email protected]>

learn-build-service-prod · 2025-09-20T14:29:36Z

Learn Build status updates of commit b1600d8:

✅ Validation status: passed

File	Status	Preview URL	Details
docs/standard-library/toc.yml	✅Succeeded
docs/standard-library/vectorized-stl-algorithms.md	✅Succeeded

For more details, please refer to the build report.

prmerger-automator · 2025-09-20T14:29:40Z

PRMerger Results

Issue	Description
Added File(s)	This PR contains added files. New files require human review.
Yaml File(s)	This PR includes changes to .yml file(s) owned by another author.
File Change Percent	This PR contains file(s) with more than 30% file change.

Co-authored-by: Rageking8 <[email protected]>

learn-build-service-prod · 2025-09-20T14:33:10Z

Learn Build status updates of commit becc300:

✅ Validation status: passed

File	Status	Preview URL	Details
docs/standard-library/toc.yml	✅Succeeded
docs/standard-library/vectorized-stl-algorithms.md	✅Succeeded

For more details, please refer to the build report.

prmerger-automator · 2025-09-20T14:33:13Z

PRMerger Results

Issue	Description
Added File(s)	This PR contains added files. New files require human review.
Yaml File(s)	This PR includes changes to .yml file(s) owned by another author.
File Change Percent	This PR contains file(s) with more than 30% file change.

davidmrdavid

Thanks a lot for this contribution!
I did a preliminary pass, focused primarily on the clarity of the text.
I'll defer to @StephanTLavavej for the technical details.

docs/standard-library/vectorized-stl-algorithms.md

Co-authored-by: David Justo <[email protected]>

learn-build-service-prod · 2025-09-22T17:21:50Z

Learn Build status updates of commit 053dac2:

✅ Validation status: passed

File	Status	Preview URL	Details
docs/standard-library/toc.yml	✅Succeeded
docs/standard-library/vectorized-stl-algorithms.md	✅Succeeded

For more details, please refer to the build report.

prmerger-automator · 2025-09-22T17:21:57Z

PRMerger Results

Issue	Description
Added File(s)	This PR contains added files. New files require human review.
Yaml File(s)	This PR includes changes to .yml file(s) owned by another author.
File Change Percent	This PR contains file(s) with more than 30% file change.

Co-authored-by: David Justo <[email protected]>

learn-build-service-prod · 2025-09-22T17:26:12Z

Learn Build status updates of commit 8f4b39f:

✅ Validation status: passed

File	Status	Preview URL	Details
docs/standard-library/toc.yml	✅Succeeded
docs/standard-library/vectorized-stl-algorithms.md	✅Succeeded

For more details, please refer to the build report.

prmerger-automator · 2025-09-22T17:26:17Z

PRMerger Results

Issue	Description
Added File(s)	This PR contains added files. New files require human review.
Yaml File(s)	This PR includes changes to .yml file(s) owned by another author.
File Change Percent	This PR contains file(s) with more than 30% file change.

docs/standard-library/vectorized-stl-algorithms.md

Co-authored-by: StephanTLavavej <[email protected]>

learn-build-service-prod · 2025-09-24T17:41:56Z

Learn Build status updates of commit 6d98a0e:

✅ Validation status: passed

File	Status	Preview URL	Details
docs/standard-library/toc.yml	✅Succeeded
docs/standard-library/vectorized-stl-algorithms.md	✅Succeeded

For more details, please refer to the build report.

prmerger-automator · 2025-09-24T17:42:00Z

PRMerger Results

Issue	Description
Added File(s)	This PR contains added files. New files require human review.
Yaml File(s)	This PR includes changes to .yml file(s) owned by another author.
File Change Percent	This PR contains file(s) with more than 30% file change.

learn-build-service-prod · 2025-09-24T18:04:44Z

Learn Build status updates of commit 59f9977:

✅ Validation status: passed

File	Status	Preview URL	Details
docs/standard-library/toc.yml	✅Succeeded
docs/standard-library/vectorized-stl-algorithms.md	✅Succeeded

For more details, please refer to the build report.

prmerger-automator · 2025-09-24T18:04:48Z

PRMerger Results

Issue	Description
Added File(s)	This PR contains added files. New files require human review.
Yaml File(s)	This PR includes changes to .yml file(s) owned by another author.
File Change Percent	This PR contains file(s) with more than 30% file change.

learn-build-service-prod · 2025-09-25T12:00:44Z

Learn Build status updates of commit ce5dca4:

✅ Validation status: passed

File	Status	Preview URL	Details
docs/standard-library/toc.yml	✅Succeeded
docs/standard-library/vectorized-stl-algorithms.md	✅Succeeded

For more details, please refer to the build report.

prmerger-automator · 2025-09-25T12:00:48Z

PRMerger Results

Issue	Description
Added File(s)	This PR contains added files. New files require human review.
Yaml File(s)	This PR includes changes to .yml file(s) owned by another author.
File Change Percent	This PR contains file(s) with more than 30% file change.

TylerMSFT · 2025-09-30T20:55:41Z

docs/standard-library/vectorized-stl-algorithms.md


 Generally, programs either benefit in performance from this manual vectorization or are unaffected by it. In case of any problem, you can disable manual vectorization by defining the `_USE_STD_VECTOR_ALGORITHMS` macro set to 0. It defaults to 1 on x64 and x86, which means that manually vectorized algorithms are enabled by default.

+When overriding `_USE_STD_VECTOR_ALGORITHMS` make sure to set the same value for all linked translation units that use algorithms. Reliable way to achieve that is using project properties rather than defining it in the source.


Could you provide the steps for how to set this in the project. Since that's the main direction we want them to go, we should show them how. It also helps reassure the reader that they are doing it right if they aren't totally clear on what it means to set project properties.

TylerMSFT · 2025-09-30T20:59:31Z

@AlexGuteniev , I very much appreciate you doing the work to write this new topic.

Please @mention me when you are ready for me to port this to the private repo so I can stage it and get it published.

Document vectorized STL algorithms

814cd8f

prmerger-automator bot added the do-not-merge label Sep 19, 2025

prmerger-automator bot assigned TylerMSFT Sep 19, 2025

prmerger-automator bot requested a review from TylerMSFT September 19, 2025 17:25

prmerger-automator bot added Change sent to author standard-libraries/subsvc visual-cpp/svc labels Sep 19, 2025

validation errors fix

4272d7e

Un-nest to make that work

cc385c5

Typo in file name

86a3e29

prmerger-automator bot added the needs-human-review label Sep 19, 2025

Alcaro reviewed Sep 19, 2025

View reviewed changes

Typoes

53ae06f

AlexGuteniev requested a review from Alcaro September 19, 2025 17:53

prmerger-automator bot added the aq-pr-triaged Tracking label for the PR review team label Sep 19, 2025

AlexGuteniev added 2 commits September 20, 2025 16:14

Spelling

a36c5a8

Complete the lists

6c10dc3

Rageking8 suggested changes Sep 20, 2025

View reviewed changes

Update docs/standard-library/vectorized-stl-algorithms.md

b1600d8

Co-authored-by: Rageking8 <[email protected]>

Review comments

becc300

Co-authored-by: Rageking8 <[email protected]>

davidmrdavid reviewed Sep 22, 2025

View reviewed changes

Update docs/standard-library/vectorized-stl-algorithms.md

053dac2

Co-authored-by: David Justo <[email protected]>

Review feedback

8f4b39f

Co-authored-by: David Justo <[email protected]>

StephanTLavavej reviewed Sep 24, 2025

View reviewed changes

STL review feedback

6d98a0e

Co-authored-by: StephanTLavavej <[email protected]>

Spelling

59f9977

Global macro

ce5dca4

AlexGuteniev requested a review from StephanTLavavej September 25, 2025 11:58

TylerMSFT reviewed Sep 30, 2025

View reviewed changes


		Generally, programs either benefit in performance from this manual vectorization or are unaffected by it. In case of any problem, you can disable manual vectorization by defining `_USE_STD_VECTOR_ALGORITHMS` macro set to 0.

		The following algorithms have manual vectorization controlled via `_USE_STD_VECTOR_ALGORITHMS` macro:


		Generally, programs either benefit in performance from this manual vectorization or are unaffected by it. In case of any problem, you can disable manual vectorization by defining the `_USE_STD_VECTOR_ALGORITHMS` macro set to 0. It defaults to 1 on x64 and x86, which means that manually vectorized algorithms are enabled by default.

		When overriding `_USE_STD_VECTOR_ALGORITHMS` make sure to set the same value for all linked translation units that use algorithms. Reliable way to achieve that is using project properties rather than defining it in the source.

Document vectorized STL algorithms #5789

Are you sure you want to change the base?

Document vectorized STL algorithms #5789

Conversation

AlexGuteniev commented Sep 19, 2025

Uh oh!

prmerger-automator bot commented Sep 19, 2025

Uh oh!

learn-build-service-prod bot commented Sep 19, 2025

❌ Validation status: errors

Uh oh!

learn-build-service-prod bot commented Sep 19, 2025

❌ Validation status: errors

Uh oh!

learn-build-service-prod bot commented Sep 19, 2025

⚠️ Validation status: warnings

Uh oh!

learn-build-service-prod bot commented Sep 19, 2025

✅ Validation status: passed

Uh oh!

prmerger-automator bot commented Sep 19, 2025

PRMerger Results

Uh oh!

Alcaro left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

learn-build-service-prod bot commented Sep 19, 2025

✅ Validation status: passed

Uh oh!

prmerger-automator bot commented Sep 19, 2025

PRMerger Results

Uh oh!

Rageking8 commented Sep 19, 2025

Uh oh!

Court72 commented Sep 19, 2025

Uh oh!

TylerMSFT commented Sep 19, 2025

Uh oh!

learn-build-service-prod bot commented Sep 20, 2025

✅ Validation status: passed

Uh oh!

prmerger-automator bot commented Sep 20, 2025

PRMerger Results

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

learn-build-service-prod bot commented Sep 20, 2025

✅ Validation status: passed

Uh oh!

prmerger-automator bot commented Sep 20, 2025

PRMerger Results

Uh oh!

learn-build-service-prod bot commented Sep 20, 2025

✅ Validation status: passed

Uh oh!

prmerger-automator bot commented Sep 20, 2025

PRMerger Results

Uh oh!

davidmrdavid left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Alcaro left a comment •

edited

Loading