Skip to content

update README to include a section on OpenMP #205

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

Merged
merged 1 commit into from
May 19, 2025

Conversation

r-devulap
Copy link
Contributor

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:

  • Added a new section in README.md titled "Build using OpenMP." This section details how to enable OpenMP support using the -Duse_openmp=true flag in Meson, describes potential performance improvements (up to 3x speedup), and explains how to configure the number of threads using the OMP_NUM_THREADS environment variable. It also specifies that OpenMP-based routines are applied to large arrays where threading is beneficial.

Copy link
Contributor

@sterrettm2 sterrettm2 left a comment

Choose a reason for hiding this comment

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

LGTM, definitely was needed. Thanks!

@r-devulap r-devulap merged commit 8a72081 into intel:main May 19, 2025
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants