Develop stream 2025-01-28 (#607)

* Set c++ version to 17 and create warning

* Fix no_discard warning c++17

* Build for both c++ 14 and 17

* Add to changelog

* Fix warnings when generating sphinx docs

* Replace GitHub URL with its issue number

* Update documentation generation instructions

* Fix CI on rocm/dev-ubuntu

* Make rocRAND usable from FetchContent

* Remove extra dashes in the documentation its \param and \tparam

* Documentation to CI upload

* Match cuRAND benchmarks with rocRAND ones

* Replace download_project with FetchContent

* fix: missing err stream

* Resolve "Some tests create discrete_distribution but do not use it"

* docs(changelog): move c++14 deprecation notice to upcoming changes

* Deprecate sobol constants and vectors

---------

Co-authored-by: Nick Breed <[email protected]>
Co-authored-by: Sander Bos <[email protected]>
Co-authored-by: Anton Gorenko <[email protected]>
Co-authored-by: Robin Voetter <[email protected]>
Co-authored-by: Borys Petrov <[email protected]>
Co-authored-by: Beatriz Navidad Vilches <[email protected]>

Author: 7 people

.gitlab-ci.yml

@@ -1,6 +1,6 @@
 # MIT License
 #
-# Copyright (c) 2017-2024 Advanced Micro Devices, Inc. All rights reserved.
+# Copyright (c) 2017-2025 Advanced Micro Devices, Inc. All rights reserved.
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -163,6 +163,7 @@ copyright-date:
       -D DISABLE_WERROR=OFF
       -D CMAKE_C_COMPILER_LAUNCHER=phc_sccache_c
       -D CMAKE_CXX_COMPILER_LAUNCHER=phc_sccache_cxx
+      -D CMAKE_CXX_STANDARD="$BUILD_VERSION"
     - cmake --build $CI_PROJECT_DIR/build
     - if [[ "${BUILD_SHARED_LIBS}" = "ON" ]]; then cmake --build $CI_PROJECT_DIR/build --target package; fi
 
@@ -189,6 +190,7 @@ copyright-date:
       -D CMAKE_C_COMPILER_LAUNCHER=phc_sccache_c
       -D CMAKE_CXX_COMPILER_LAUNCHER=phc_sccache_cxx
       -D CMAKE_CUDA_COMPILER_LAUNCHER=phc_sccache_cuda
+      -D CMAKE_CXX_STANDARD=14
     - cmake --build $CI_PROJECT_DIR/build
     - if [[ "${BUILD_SHARED_LIBS}" = "ON" ]]; then cmake --build $CI_PROJECT_DIR/build --target package; fi
 
@@ -200,11 +202,9 @@ copyright-date:
       - $CI_PROJECT_DIR/build/test/test_*
       - $CI_PROJECT_DIR/build/**/CTestTestfile.cmake
       - $CI_PROJECT_DIR/build/benchmark/benchmark_*
-      - $CI_PROJECT_DIR/build/deps/googlebenchmark/
       - $CI_PROJECT_DIR/build/CMakeCache.txt
       - $CI_PROJECT_DIR/build/*.deb
       - $CI_PROJECT_DIR/build/*.zip
-    expire_in: 2 weeks
 
 build:rocm-cmake-minimum:
   tags:
@@ -217,6 +217,7 @@ build:rocm-cmake-minimum:
   variables:
     BUILD_SHARED_LIBS: "ON"
     BUILD_BENCHMARK_TUNING: "ON"
+    BUILD_VERSION: 14
 
 build:rocm-hipcc-cmake-minimum:
   tags:
@@ -228,6 +229,7 @@ build:rocm-hipcc-cmake-minimum:
     - .save-artifacts
   variables:
     BUILD_SHARED_LIBS: "ON"
+    BUILD_VERSION: 14
 
 build:rocm-static-cmake-minimum:
   tags:
@@ -238,6 +240,7 @@ build:rocm-static-cmake-minimum:
     - .rocm:build
   variables:
     BUILD_SHARED_LIBS: "OFF"
+    BUILD_VERSION: 14
 
 build:rocm-cmake-latest:
   tags:
@@ -248,6 +251,10 @@ build:rocm-cmake-latest:
     - .rocm:build
   variables:
     BUILD_SHARED_LIBS: "ON"
+  parallel:
+    matrix:
+      - BUILD_VERSION: [14, 17]
+
 
 build:nvcc-cmake-minimum:
   tags:
@@ -324,13 +331,13 @@ benchmark:benchmark-tuning:
       -D BENCHMARK_TUNING_BLOCK_OPTIONS="${BENCHMARK_TUNING_BLOCK_OPTIONS}"
       -D CMAKE_C_COMPILER_LAUNCHER=phc_sccache_c
       -D CMAKE_CXX_COMPILER_LAUNCHER=phc_sccache_cxx
+      -D CMAKE_CXX_STANDARD=14
     - cmake --build $CI_PROJECT_DIR/build --target benchmark_rocrand_tuning
     - $CI_PROJECT_DIR/build/benchmark/tuning/benchmark_rocrand_tuning --benchmark_out_format=json --benchmark_out=$CI_PROJECT_DIR/build/rocrand_config_tuning_${GPU_TARGET}_${CI_JOB_ID}.json
   artifacts:
     paths:
       - $CI_PROJECT_DIR/build/library/
       - $CI_PROJECT_DIR/build/benchmark/
-      - $CI_PROJECT_DIR/build/deps/googlebenchmark/
       - $CI_PROJECT_DIR/build/CMakeCache.txt
       - $CI_PROJECT_DIR/build/*.json
     expire_in: 2 weeks
@@ -420,17 +427,17 @@ benchmark:nvcc:
     - .rules:test
   script:
     - $SUDO_CMD apt-get update -qq
-    - $SUDO_CMD apt-get install -y -qq python3 python3-pip python3-numpy
-    - $SUDO_CMD apt-get install -y -qq wget
-    - pip3 install setuptools
+    - $SUDO_CMD apt-get install -y -qq python3 python3-pip python3-venv
     - export ROCRAND_PATH=$CI_PROJECT_DIR/build/library/
     # rocRAND Wrapper with Python 3
-    - pip3 --version
     - cd $CI_PROJECT_DIR/python/rocrand
-    - python3 setup.py test
-    - pip3 install . --user
+    - python3 -m venv rocrand-venv
+    - source rocrand-venv/bin/activate
+    - python3 -m pip install setuptools numpy
+    - python3 -m pip install .
     - python3 tests/rocrand_test.py
-    - pip3 uninstall --yes rocrand
+    - python3 -m pip uninstall --yes rocrand
+    - deactivate
 
 test:rocm-python:
   tags:
@@ -514,7 +521,11 @@ test:cpp-wrapper:
       -D BUILD_FORTRAN_WRAPPER=OFF
       -D BUILD_FILE_REORG_BACKWARD_COMPATIBILITY=OFF
       -D CMAKE_CXX_COMPILER=${COMPILER}
-    - $SUDO_CMD cmake --build $CI_PROJECT_DIR/build_only_install --target install
+      -D CMAKE_C_COMPILER_LAUNCHER=phc_sccache_c
+      -D CMAKE_CXX_COMPILER_LAUNCHER=phc_sccache_cxx
+      -D CMAKE_CUDA_COMPILER_LAUNCHER=phc_sccache_cuda
+    # Preserve $PATH when sudoing
+    - $SUDO_CMD env PATH="$PATH" cmake --build $CI_PROJECT_DIR/build_only_install --target install
     - cmake
       -S $CI_PROJECT_DIR/test/package/
       -B $CI_PROJECT_DIR/install_test
@@ -546,6 +557,10 @@ test:doc:
   extends:
     - .rules:test
     - .build:docs
+  artifacts:
+    paths:
+      - $DOCS_DIR/_build/html/
+    expire_in: 2 weeks
 
 .test:parity:
   stage: test
@@ -604,6 +619,7 @@ test:nvcc-parity:
       -D CMAKE_INSTALL_PREFIX:PATH="$CI_PROJECT_DIR/build/install"
       -D CMAKE_PREFIX_PATH:PATH="${env:HIP_PATH}/lib/cmake"
       -D DISABLE_WERROR=OFF *>&1
+      -D CMAKE_CXX_STANDARD=14
     # Building
     - cmake --build "$CI_PROJECT_DIR/build" *>&1
 
@@ -632,6 +648,7 @@ test:windows:
       -D CMAKE_BUILD_TYPE=Release
       -D CMAKE_CXX_COMPILER:FILEPATH="${env:HIP_PATH}/bin/clang++.exe"
       -D CMAKE_PREFIX_PATH:FILEPATH="${env:HIP_PATH}/lib/cmake;$CI_PROJECT_DIR/build/install" *>&1
+      -D CMAKE_CXX_STANDARD=14
     # Build package test
     - cmake --build "$CI_PROJECT_DIR/build_install_test"
     # Copy rocRAND.dll to the package test build directory
@@ -663,14 +680,15 @@ test:windows:
       -D CMAKE_CXX_COMPILER=${COMPILER}
       -D CMAKE_C_COMPILER_LAUNCHER=phc_sccache_c
       -D CMAKE_CXX_COMPILER_LAUNCHER=phc_sccache_cxx
+      -D CMAKE_CXX_STANDARD=14
     - cmake --build ${ROCRAND_STAT_TESTS_DIR}/build
     - mkdir ${LOGS_DIR}
     - cd ${ROCRAND_STAT_TESTS_DIR}/build
     - nproc
   artifacts:
     paths:
       - ${LOGS_DIR}/*
-    expire_in: never
+    expire_in: 3 months
 
 # TestU01 SmallCrush, 10 tests, 15 statistics, takes about 5 seconds
 statistical-test:crush-small:

CHANGELOG.md

@@ -12,6 +12,19 @@ Documentation for rocRAND is available at
 ### Changed
 
 * Updated several `gfx942` auto tuning parameters.
+* Deprecated C++14 and set the default target to C++17.
+* Directly accessing the (scrambled) sobol32 and sobol64 constants and direction vectors is deprecated:
+  * `h_scrambled_sobol32_constants`, use `rocrand_get_scramble_constants32` instead.
+  * `h_scrambled_sobol64_constants`, use `rocrand_get_scramble_constants64` instead.
+  * `rocrand_h_sobol32_direction_vectors`, use `rocrand_get_direction_vectors32` instead.
+  * `rocrand_h_sobol64_direction_vectors`, use `rocrand_get_direction_vectors64` instead.
+  * `rocrand_h_scrambled_sobol32_direction_vectors`, use `rocrand_get_direction_vectors32` instead.
+  * `rocrand_h_scrambled_sobol64_direction_vectors`, use `rocrand_get_direction_vectors64` instead.
+
+### Upcoming changes
+* C++14 will be removed in the next major release.
+* Directly accessing the (scrambled) sobol32 and sobol64 constants and direction vectors will be removed in the next major release.
+
 
 ### Fixed
 

CMakeLists.txt

@@ -142,7 +142,9 @@ include(cmake/VerifyCompiler.cmake)
 option(DISABLE_WERROR "Disable building with Werror" ON)
 
 # Build CXX flags
-set(CMAKE_CXX_STANDARD 11)
+if (NOT DEFINED CMAKE_CXX_STANDARD)
+  set(CMAKE_CXX_STANDARD 17)
+endif()
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 set(CMAKE_CXX_EXTENSIONS OFF)
 if(DISABLE_WERROR)
@@ -154,6 +156,12 @@ if(CODE_COVERAGE)
     set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fprofile-instr-generate -fcoverage-mapping")
 endif()
 
+if (CMAKE_CXX_STANDARD EQUAL 14)
+  message(WARNING "C++14 will be deprecated in the next major release")
+elseif(NOT CMAKE_CXX_STANDARD EQUAL 17)
+  message(FATAL_ERROR "Only C++14 and C++17 are supported")
+endif()
+
 # HIP on Windows: xhip is required with clang++ to get __half defined
 if (WIN32)
   add_compile_options("$<$<COMPILE_LANGUAGE:CXX>:-xhip>")

README.md

@@ -1,5 +1,8 @@
 # rocRAND
 
+> [!NOTE]
+> The published rocRAND documentation is available [here](https://rocm.docs.amd.com/projects/rocRAND/en/latest/) in an organized, easy-to-read format, with search and a table of contents. The documentation source files reside in the `docs` folder of this repository. As with all ROCm projects, the documentation is open source. For more information on contributing to the documentation, see [Contribute to ROCm documentation](https://rocm.docs.amd.com/en/latest/contribute/contributing.html).
+
 The rocRAND project provides functions that generate pseudorandom and quasirandom numbers.
 The rocRAND library is implemented in the [HIP](https://github.com/ROCm/HIP)
 programming language and optimized for AMD's latest discrete GPUs. It is designed to run on top
@@ -24,28 +27,6 @@ split into a separate library. As of version 6.0, hipRAND can no longer be built
 * Scrambled Sobol64
 * ThreeFry
 
-## Documentation
-
-> [!NOTE]
-> The published rocRAND documentation is available at [rocRAND](https://rocm.docs.amd.com/projects/rocRAND/en/latest/) in an organized, easy-to-read format, with search and a table of contents. The documentation source files reside in the rocRAND/docs folder of this repository. As with all ROCm projects, the documentation is open source. For more information, see [Contribute to ROCm documentation](https://rocm.docs.amd.com/en/latest/contribute/contributing.html).
-
-To build documentation locally, use the following code:
-
-```sh
-# Go to the docs directory
-cd docs
-
-# Install Python dependencies
-python3 -m pip install -r sphinx/requirements.txt
-
-# Build the documentation
-python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html
-
-# E.g. serve the HTML docs locally
-cd _build/html
-python3 -m http.server
-```
-
 ## Requirements
 
 * CMake (3.16 or later)
@@ -225,6 +206,58 @@ been migrated to the new framework.
 * [Fortran wrappers](./library/src/fortran/).
 * [Python wrappers](./python/): [rocRAND](./python/rocrand).
 
+## Building the documentation locally
+
+### Requirements
+
+#### Doxygen
+
+The build system uses Doxygen [version 1.9.4](https://github.com/doxygen/doxygen/releases/tag/Release_1_9_4). You can try using a newer version, but that might cause issues.
+
+After you have downloaded Doxygen version 1.9.4:
+
+```shell
+# Add doxygen to your PATH
+echo 'export PATH=<doxygen 1.9.4 path>/bin:$PATH' >> ~/.bashrc
+
+# Apply the updated .bashrc
+source ~/.bashrc
+
+# Confirm that you are using version 1.9.4
+doxygen --version
+```
+
+#### Python
+
+The build system uses Python version 3.10. You can try using a newer version, but that might cause issues.
+
+You can install Python 3.10 alongside your other Python versions using [pyenv](https://github.com/pyenv/pyenv?tab=readme-ov-file#installation):
+
+```shell
+# Install Python 3.10
+pyenv install 3.10
+
+# Create a Python 3.10 virtual environment
+pyenv virtualenv 3.10 venv_rocrand
+
+# Activate the virtual environment
+pyenv activate venv_rocrand
+```
+
+### Building
+
+After cloning this repository, and `cd`ing into it:
+
+```shell
+# Install Python dependencies
+python3 -m pip install -r docs/sphinx/requirements.txt
+
+# Build the documentation
+python3 -m sphinx -T -E -b html -d docs/_build/doctrees -D language=en docs docs/_build/html
+```
+
+You can then open `docs/_build/html/index.html` in your browser to view the documentation.
+
 ## Support
 
 Bugs and feature requests can be reported through the