update README to include a section on OpenMP#205
Merged
Conversation
sterrettm2
approved these changes
May 19, 2025
sterrettm2
left a comment
sterrettm2
left a comment
Contributor
There was a problem hiding this comment.
LGTM, definitely was needed. Thanks!
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This pull request adds documentation on how to enable and use OpenMP for parallel sorting in the project. It explains the configuration steps, performance benefits, and thread control options.
Documentation Updates:
README.mdtitled "Build using OpenMP." This section details how to enable OpenMP support using the-Duse_openmp=trueflag in Meson, describes potential performance improvements (up to 3x speedup), and explains how to configure the number of threads using theOMP_NUM_THREADSenvironment variable. It also specifies that OpenMP-based routines are applied to large arrays where threading is beneficial.