diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 962410c206..522bffc7eb 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -18,7 +18,7 @@ # Tells Gitlab to recursively update the submodules when cloning umpire # # ALLOC_NAME: -# On LLNL's quartz, this pipeline creates only one allocation shared among jobs +# On LLNL's ruby, this pipeline creates only one allocation shared among jobs # in order to save time and resources. This allocation has to be uniquely named # so that we are sure to retrieve it. # @@ -26,24 +26,31 @@ # The path to the shared resources between all jobs. The BUILD_ROOT is unique to # the pipeline, preventing any form of concurrency with other pipelines. This # also means that the BUILD_ROOT directory will never be cleaned. +# +# DEFAULT_TIME: +# Default time to let the Lassen jobs run will be 30 minutes. However, if it is +# a job that requires more time, it will be overwritten in the lassen template +# file. # TODO: add a clean-up mechanism variables: GIT_SUBMODULE_STRATEGY: recursive ALLOC_NAME: ${CI_PROJECT_NAME}_ci_${CI_PIPELINE_ID} BUILD_ROOT: ${CI_PROJECT_DIR} + DEFAULT_TIME: 30 # Normally, stages are blocking in Gitlab. However, using the keyword "needs" we # can express dependencies between job that break the ordering of stages, in # favor of a DAG. -# In practice q_*, l_* and b_* stages are independently run and start immediately. +# In practice r_*, l_* and b_* stages are independently run and start immediately. stages: - - q_allocate_resources - - q_build_and_test - - q_release_resources + - r_allocate_resources + - r_build_and_test + - r_release_resources - l_build_and_test - b_build_and_test + - c_build_and_test - multi_project # This is the rules that drives the activation of "advanced" jobs. All advanced @@ -60,13 +67,23 @@ stages: - echo ${ALLOC_NAME} - export JOBID=$(squeue -h --name=${ALLOC_NAME} --format=%A) - echo ${JOBID} - - srun $( [[ -n "${JOBID}" ]] && echo "--jobid=${JOBID}" ) -t 15 -N 1 scripts/gitlab/build_and_test.sh + - srun $( [[ -n "${JOBID}" ]] && echo "--jobid=${JOBID}" ) -t ${DEFAULT_TIME} -N 1 scripts/gitlab/build_and_test.sh + artifacts: + reports: + junit: junit.xml + +.build_toss_3_x86_64_ib_corona_script: + script: + - srun -p mi60 -t 30 -N 1 scripts/gitlab/build_and_test.sh # Lassen and Butte use a different job scheduler (spectrum lsf) that does not # allow pre-allocation the same way slurm does. .build_blueos_3_ppc64le_ib_script: script: - - lalloc 1 -W 15 scripts/gitlab/build_and_test.sh + - lalloc 1 -W ${DEFAULT_TIME} scripts/gitlab/build_and_test.sh + artifacts: + reports: + junit: junit.xml .build_blueos_3_ppc64le_ib_p9_script: extends: .build_blueos_3_ppc64le_ib_script @@ -74,10 +91,11 @@ stages: # If testing develop branch, trigger CHAI pipeline with this version of RAJA. # TODO: Once spack allows to clone a specific commit on demand, then point to the exact commit. # This will prevent from sticking to a branch (here develop). +# To turn back on chai trigger, add '$CI_COMMIT_BRANCH == "develop" to rule. trigger-chai: stage: multi_project rules: - - if: '$CI_COMMIT_BRANCH == "develop" || $MULTI_PROJECT == "ON"' #run only if ... + - if: '$MULTI_PROJECT == "ON"' #run only if ... variables: UPDATE_RAJA: develop trigger: @@ -87,7 +105,9 @@ trigger-chai: # This is where jobs are included. include: - - local: .gitlab/quartz-templates.yml - - local: .gitlab/quartz-jobs.yml + - local: .gitlab/ruby-templates.yml + - local: .gitlab/ruby-jobs.yml - local: .gitlab/lassen-templates.yml - local: .gitlab/lassen-jobs.yml + - local: .gitlab/corona-templates.yml + - local: .gitlab/corona-jobs.yml diff --git a/.gitlab/corona-jobs.yml b/.gitlab/corona-jobs.yml new file mode 100644 index 0000000000..b05e4c971f --- /dev/null +++ b/.gitlab/corona-jobs.yml @@ -0,0 +1,21 @@ +############################################################################# +# Copyright (c) 2016-21, Lawrence Livermore National Security, LLC +# and RAJA project contributors. See the RAJA/COPYRIGHT file for details. +# +# SPDX-License-Identifier: (BSD-3-Clause) +############################################################################# + +hip_4_1_gcc_8_1_0 (build and test on corona): + variables: + SPEC: "+hip~openmp %gcc@8.1.0 cxxflags='-finline-functions -finline-limit=20000' cflags='-finline-functions -finline-limit=20000' ^hip@4.1.0" + extends: .build_and_test_on_corona + +hip_4_2_gcc_8_1_0 (build and test on corona): + variables: + SPEC: "+hip~openmp %gcc@8.1.0 cxxflags='-finline-functions -finline-limit=20000' cflags='-finline-functions -finline-limit=20000' ^hip@4.2.0" + extends: .build_and_test_on_corona + +hip_4_1_clang_9_0_0 (build and test on corona): + variables: + SPEC: "+hip~openmp %clang@9.0.0 cxxflags=--gcc-toolchain=/usr/tce/packages/gcc/gcc-8.1.0 ^hip@4.1.0" + extends: .build_and_test_on_corona diff --git a/.gitlab/corona-templates.yml b/.gitlab/corona-templates.yml new file mode 100644 index 0000000000..f76a4ff691 --- /dev/null +++ b/.gitlab/corona-templates.yml @@ -0,0 +1,33 @@ +############################################################################# +# Copyright (c) 2016-21, Lawrence Livermore National Security, LLC +# and RAJA project contributors. See the RAJA/COPYRIGHT file for details. +# +# SPDX-License-Identifier: (BSD-3-Clause) +############################################################################# + +#### +# This is the share configuration of jobs for corona + +#### +# In pre-build phase, allocate a node for builds +.on_corona: + tags: + - shell + - corona + rules: + - if: '$ON_CORONA == "OFF"' #run except if ... + when: never + - if: '$CI_JOB_NAME =~ /release_resources/' + when: always + - when: on_success + +#### +# Generic corona build job, extending build script +.build_and_test_on_corona: + stage: c_build_and_test + extends: [.build_toss_3_x86_64_ib_corona_script, .on_corona] + needs: [] + +.build_and_test_on_corona_advanced: + extends: [.build_and_test_on_corona, .advanced_pipeline] + diff --git a/.gitlab/lassen-jobs.yml b/.gitlab/lassen-jobs.yml index 0e3be67753..0f7b3a879f 100644 --- a/.gitlab/lassen-jobs.yml +++ b/.gitlab/lassen-jobs.yml @@ -1,14 +1,85 @@ ############################################################################## -# Copyright (c) 2016-2020, Lawrence Livermore National Security, LLC +# Copyright (c) 2016-21, Lawrence Livermore National Security, LLC # and RAJA project contributors. See the RAJA/COPYRIGHT file for details. # # SPDX-License-Identifier: (BSD-3-Clause) ############################################################################## -#### -# All lassen build jobs -nvcc_10_clang_8_0_1 (build and test on lassen): +########## +# CPU ONLY +########## + +ibm_clang_9: + variables: + SPEC: "%clang@9.0.0ibm" + extends: .build_and_test_on_lassen + +ibm_clang_9_gcc_8: + variables: + SPEC: "%clang@9.0.0ibm cxxflags=--gcc-toolchain=/usr/tce/packages/gcc/gcc-8.3.1 cflags=--gcc-toolchain=/usr/tce/packages/gcc/gcc-8.3.1" + extends: .build_and_test_on_lassen + +gcc_8_3_1: + variables: + SPEC: "%gcc@8.3.1 cxxflags='-finline-functions -finline-limit=20000' cflags='-finline-functions -finline-limit=20000'" + extends: .build_and_test_on_lassen + +xl_16_1_1_7: + variables: + SPEC: "%xl@16.1.1.7 cxxflags='-qthreaded -std=c++14 -O3 -qxlcompatmacros -qlanglvl=extended0x -qalias=noansi -qhot -qpic -qsmp=omp -qsuppress=1500-029 -qsuppress=1500-036'" + DEFAULT_TIME: 50 + extends: .build_and_test_on_lassen + +xl_16_1_1_7_gcc_8_3_1: + variables: + SPEC: "%xl@16.1.1.7 cxxflags='--gcc-toolchain=/usr/tce/packages/gcc/gcc-8.3.1 -qthreaded -std=c++14 -O3 -qxlcompatmacros -qlanglvl=extended0x -qalias=noansi -qhot -qpic -qsmp=omp -qsuppress=1500-029 -qsuppress=1500-036' cflags=--gcc-toolchain=/usr/tce/packages/gcc/gcc-8.3.1" + DEFAULT_TIME: 50 + extends: .build_and_test_on_lassen + +########## +# CUDA +########## + +ibm_clang_9_cuda: + variables: + SPEC: "+cuda cuda_arch=70 %clang@9.0.0ibm ^cuda@10.1.168" + extends: .build_and_test_on_lassen + +ibm_clang_9_gcc_8_cuda: + variables: + SPEC: "+cuda %clang@9.0.0ibm cuda_arch=70 cxxflags=--gcc-toolchain=/usr/tce/packages/gcc/gcc-8.3.1 cflags=--gcc-toolchain=/usr/tce/packages/gcc/gcc-8.3.1 ^cuda@10.1.168" + extends: .build_and_test_on_lassen + +gcc_8_3_1_cuda: + variables: + SPEC: "+cuda %gcc@8.3.1 cuda_arch=70 ^cuda@10.1.168" + extends: .build_and_test_on_lassen + +xl_16_1_1_7_cuda: + variables: + SPEC: "+cuda %xl@16.1.1.7 cuda_arch=70 ^cuda@10.1.168 ^cmake@3.14.5" + DEFAULT_TIME: 60 + allow_failure: true + extends: .build_and_test_on_lassen + +xl_16_1_1_7_gcc_8_3_1_cuda_11: + variables: + SPEC: "+cuda %xl@16.1.1.7 cuda_arch=70 cxxflags=--gcc-toolchain=/usr/tce/packages/gcc/gcc-8.3.1 cflags=--gcc-toolchain=/usr/tce/packages/gcc/gcc-8.3.1 ^cuda@11.0.2 ^cmake@3.14.5" + DEFAULT_TIME: 60 + allow_failure: true + extends: .build_and_test_on_lassen + +########## +# EXTRAS +########## + +clang_9_0_0_libcpp (build and test on lassen): + variables: + SPEC: "%clang@9.0.0+libcpp" + extends: .build_and_test_on_lassen + +clang_9_0_0_memleak (build and test on lassen): variables: - SPEC: "%clang@8.0.1+cuda" + SPEC: "%clang@9.0.0 cxxflags=-fsanitize=address" + ASAN_OPTIONS: "detect_leaks=1" extends: .build_and_test_on_lassen - allow_failure: True diff --git a/.gitlab/lassen-templates.yml b/.gitlab/lassen-templates.yml index b169c52df8..281265c051 100644 --- a/.gitlab/lassen-templates.yml +++ b/.gitlab/lassen-templates.yml @@ -1,5 +1,5 @@ ############################################################################## -# Copyright (c) 2016-2020, Lawrence Livermore National Security, LLC +# Copyright (c) 2016-21, Lawrence Livermore National Security, LLC # and RAJA project contributors. See the RAJA/COPYRIGHT file for details. # # SPDX-License-Identifier: (BSD-3-Clause) diff --git a/.gitlab/quartz-jobs.yml b/.gitlab/quartz-jobs.yml deleted file mode 100644 index 1672a38d28..0000000000 --- a/.gitlab/quartz-jobs.yml +++ /dev/null @@ -1,13 +0,0 @@ -############################################################################## -# Copyright (c) 2016-2020, Lawrence Livermore National Security, LLC -# and RAJA project contributors. See the RAJA/COPYRIGHT file for details. -# -# SPDX-License-Identifier: (BSD-3-Clause) -############################################################################## - -#### -# Quartz build jobs -clang_9_0_0 (build and test on quartz): - variables: - SPEC: "%clang@9.0.0" - extends: .build_and_test_on_quartz diff --git a/.gitlab/ruby-jobs.yml b/.gitlab/ruby-jobs.yml new file mode 100644 index 0000000000..182c86fffb --- /dev/null +++ b/.gitlab/ruby-jobs.yml @@ -0,0 +1,48 @@ +############################################################################## +# Copyright (c) 2016-21, Lawrence Livermore National Security, LLC +# and RAJA project contributors. See the RAJA/COPYRIGHT file for details. +# +# SPDX-License-Identifier: (BSD-3-Clause) +############################################################################## + +clang_10: + variables: + SPEC: "%clang@10.0.1" + extends: .build_and_test_on_ruby + +clang_9: + variables: + SPEC: "%clang@9.0.0" + extends: .build_and_test_on_ruby + +gcc_8_1_0: + variables: + SPEC: "%gcc@8.1.0" + DEFAULT_TIME: 60 + extends: .build_and_test_on_ruby + +icpc_17_0_2: + variables: + SPEC: "%intel@17.0.2" + DEFAULT_TIME: 40 + extends: .build_and_test_on_ruby + +icpc_18_0_2: + variables: + SPEC: " tests=none %intel@18.0.2" + DEFAULT_TIME: 40 + extends: .build_and_test_on_ruby + +icpc_19_1_0: + variables: + SPEC: "%intel@19.1.0" + DEFAULT_TIME: 40 + extends: .build_and_test_on_ruby + +# EXTRAS + +gcc_4_9_3: + variables: + SPEC: "%gcc@4.9.3" + DEFAULT_TIME: 60 + extends: .build_and_test_on_ruby diff --git a/.gitlab/quartz-templates.yml b/.gitlab/ruby-templates.yml similarity index 52% rename from .gitlab/quartz-templates.yml rename to .gitlab/ruby-templates.yml index dc401537b2..a8cb6c229a 100644 --- a/.gitlab/quartz-templates.yml +++ b/.gitlab/ruby-templates.yml @@ -1,21 +1,21 @@ ############################################################################## -# Copyright (c) 2016-2020, Lawrence Livermore National Security, LLC +# Copyright (c) 2016-21, Lawrence Livermore National Security, LLC # and RAJA project contributors. See the RAJA/COPYRIGHT file for details. # # SPDX-License-Identifier: (BSD-3-Clause) ############################################################################## #### -# This is the share configuration of jobs for quartz +# This is the shared configuration of jobs for ruby #### # In pre-build phase, allocate a node for builds -.on_quartz: +.on_ruby: tags: - shell - - quartz + - ruby rules: - - if: '$CI_COMMIT_BRANCH =~ /_qnone/ || $ON_QUARTZ == "OFF"' #run except if ... + - if: '$CI_COMMIT_BRANCH =~ /_qnone/ || $ON_RUBY == "OFF"' #run except if ... when: never - if: '$CI_JOB_NAME =~ /release_resources/' when: always @@ -23,32 +23,32 @@ #### # In pre-build phase, allocate a node for builds -allocate_resources (on quartz): +# NOTE: Not specifying 'salloc -c 56' should allocate the max number of CPU cores +allocate_resources (on ruby): variables: GIT_STRATEGY: none - extends: .on_quartz - stage: q_allocate_resources + extends: .on_ruby + stage: r_allocate_resources script: - - salloc -N 1 -c 36 -p pdebug -t 20 --no-shell --job-name=${ALLOC_NAME} - needs: [] + - salloc -N 1 -p pdebug -t 45 --no-shell --job-name=${ALLOC_NAME} #### # In post-build phase, deallocate resources # Note : make sure this is run even on build phase failure -release_resources (on quartz): +release_resources (on ruby): variables: GIT_STRATEGY: none - extends: .on_quartz - stage: q_release_resources + extends: .on_ruby + stage: r_release_resources script: - export JOBID=$(squeue -h --name=${ALLOC_NAME} --format=%A) - ([[ -n "${JOBID}" ]] && scancel ${JOBID}) #### -# Generic quartz build job, extending build script -.build_and_test_on_quartz: - stage: q_build_and_test - extends: [.build_toss_3_x86_64_ib_script, .on_quartz] +# Generic ruby build job, extending build script +.build_and_test_on_ruby: + extends: [.build_toss_3_x86_64_ib_script, .on_ruby] + stage: r_build_and_test -.build_and_test_on_quartz_advanced: - extends: [.build_and_test_on_quartz, .advanced_pipeline] +.build_and_test_on_ruby_advanced: + extends: [.build_and_test_on_ruby, .advanced_pipeline] diff --git a/.travis.yml b/.travis.yml index 74a4793c3d..8e8d8e3949 100644 --- a/.travis.yml +++ b/.travis.yml @@ -39,7 +39,7 @@ matrix: env: - COMPILER=/opt/intel/bin/icpc - IMG=icc18 - - CMAKE_EXTRA_FLAGS="-DENABLE_FORCEINLINE_RECURSIVE=Off -DENABLE_TBB=On" + - CMAKE_EXTRA_FLAGS="-DENABLE_FORCEINLINE_RECURSIVE=Off -DENABLE_TBB=On -DBLT_CXX_STD=c++14" - compiler: nvcc10.2 env: - COMPILER=g++ @@ -64,12 +64,13 @@ matrix: - IMG=nvcc10.2 - CMAKE_EXTRA_FLAGS="-DCMAKE_BUILD_TYPE=Debug -DENABLE_CUDA=On -DENABLE_WARNINGS=On -DENABLE_WARNINGS_AS_ERRORS=On -DENABLE_TBB=On" - DO_TEST=no - - compiler: clang9-cuda9.1 - env: - - COMPILER=clang++-9 - - IMG=clang9 - - CMAKE_EXTRA_FLAGS="-DCMAKE_BUILD_TYPE=Release -DENABLE_OPENMP=Off -DENABLE_CLANG_CUDA=On -DBLT_CLANG_CUDA_ARCH=sm_60 -DENABLE_CUDA=On -DCUDA_ARCH=sm_60 -DCUDA_TOOLKIT_ROOT_DIR:PATH='/usr/lib/cuda'" - - DO_TEST=no +# Disable Clang Cuda until we update some things +# - compiler: clang9-cuda9.1 +# env: +# - COMPILER=clang++-9 +# - IMG=clang9 +# - CMAKE_EXTRA_FLAGS="-DCMAKE_BUILD_TYPE=Release -DENABLE_OPENMP=Off -DENABLE_CLANG_CUDA=On -DBLT_CLANG_CUDA_ARCH=sm_60 -DENABLE_CUDA=On -DCUDA_ARCH=sm_60 -DCUDA_TOOLKIT_ROOT_DIR:PATH='/usr/lib/cuda' " +# - DO_TEST=no - compiler: hip env: - COMPILER=g++ @@ -79,7 +80,7 @@ matrix: - DO_TEST=no -before_install: # don't try to build and run intel when it's impossible +before_install: # don't try to build and run intel when it's not possible - | if [[ "x$encrypted_cd1f6303bca7_key" != "x" ]] ; then openssl aes-256-cbc -K $encrypted_cd1f6303bca7_key -iv $encrypted_cd1f6303bca7_iv -in ${TRAVIS_BUILD_DIR}/travis-data/intel2016.lic.enc -out ${TRAVIS_BUILD_DIR}/travis-data/intel2016.lic -d @@ -92,6 +93,14 @@ before_install: # don't try to build and run intel when it's impossible - export ASAN_OPTIONS script: +- | + if [[ "x$DOCKER_PASSWORD" != "x" ]] ; then + echo "Attempting docker login" + echo "$DOCKER_PASSWORD" | docker login -u rajaci --password-stdin + else + echo "Docker password unavailable, fail immediately" + travis_terminate 1 + fi - docker run --rm --user='root' -v ${TRAVIS_BUILD_DIR}:/home/raja rajaorg/compiler:$IMG chown -R raja /home/raja - docker run --rm -v ${TRAVIS_BUILD_DIR}/travis-data:/opt/intel/licenses -v ${TRAVIS_BUILD_DIR}:/home/raja -e ASAN_OPTIONS -e LSAN_OPTIONS -e COMPILER -e DO_BUILD -e DO_TEST -e CMAKE_EXTRA_FLAGS -e HCC_AMDGPU_TARGET rajaorg/compiler:$IMG ./scripts/travis_build_and_test.sh diff --git a/CMakeLists.txt b/CMakeLists.txt index a8b476b62e..f825ad6556 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,7 +1,6 @@ ############################################################################### -# Copyright (c) 2016-20, Lawrence Livermore National Security, LLC +# Copyright (c) 2016-21, Lawrence Livermore National Security, LLC # and RAJA project contributors. See the RAJA/COPYRIGHT file for details. -# # SPDX-License-Identifier: (BSD-3-Clause) ############################################################################### @@ -12,9 +11,11 @@ if (APPLE) cmake_policy(SET CMP0025 NEW) endif() +include(CMakeDependentOption) + # Set version number set(RAJA_VERSION_MAJOR 0) -set(RAJA_VERSION_MINOR 13) +set(RAJA_VERSION_MINOR 14) set(RAJA_VERSION_PATCHLEVEL 0) if (RAJA_LOADED AND (NOT RAJA_LOADED STREQUAL "${RAJA_VERSION_MAJOR}.${RAJA_VERSION_MINOR}.${RAJA_VERSION_PATCHLEVEL}")) @@ -48,30 +49,38 @@ set(ENABLE_COPY_HEADERS Off CACHE BOOL "") set(ENABLE_WARNINGS_AS_ERRORS Off CACHE BOOL "") set(ENABLE_GTEST_DEATH_TESTS On CACHE BOOL "Enable tests asserting failure.") -set(RAJA_CXX_STANDARD_FLAG "default" CACHE STRING "Specific c++ standard flag to use, default attempts to autodetect the highest available") +## NOTE: CMake-dependent options are placed AFTER BLT is loaded so they +## work as intended. BLT has variables defined for these and we use +## the same names with 'RAJA_' prepended to them. + +option(ENABLE_NV_TOOLS_EXT "Build with NV_TOOLS_EXT support" Off) option(ENABLE_TBB "Build TBB support" Off) option(ENABLE_TARGET_OPENMP "Build OpenMP on target device support" Off) option(ENABLE_CLANG_CUDA "Use Clang's native CUDA support" Off) -option(ENABLE_EXTERNAL_CUB "Use an external cub for scans" Off) -option(ENABLE_EXTERNAL_ROCPRIM "Use an external rocPRIM for scans" Off) -option(ENABLE_TESTS "Build tests" On) +option(ENABLE_SYCL "Build SYCL support" Off) +option(ENABLE_EXTERNAL_CUB "Use an external cub" Off) +option(ENABLE_EXTERNAL_ROCPRIM "Use an external rocPRIM" Off) + option(ENABLE_REPRODUCERS "Build issue reproducers" Off) -option(ENABLE_EXAMPLES "Build simple examples" On) -option(ENABLE_EXERCISES "Build exercises " On) + +option(RAJA_ENABLE_EXERCISES "Build exercises " On) option(ENABLE_MODULES "Enable modules in supporting compilers (clang)" On) option(ENABLE_WARNINGS "Enable warnings as errors for CI" Off) option(ENABLE_DOCUMENTATION "Build RAJA documentation" Off) option(ENABLE_COVERAGE "Enable coverage (only supported with GCC)" Off) option(ENABLE_FORCEINLINE_RECURSIVE "Enable Forceinline recursive (only supported with Intel compilers)" On) -option(ENABLE_BENCHMARKS "Build benchmarks" Off) + option(RAJA_DEPRECATED_TESTS "Test deprecated features" Off) option(RAJA_ENABLE_BOUNDS_CHECK "Enable bounds checking in RAJA::Views/Layouts" Off) option(RAJA_TEST_EXHAUSTIVE "Build RAJA exhaustive tests" Off) +option(RAJA_TEST_OPENMP_TARGET_SUBSET "Build subset of RAJA OpenMP target tests when it is enabled" On) option(RAJA_ENABLE_RUNTIME_PLUGINS "Enable support for loading plugins at runtime" Off) set(TEST_DRIVER "" CACHE STRING "driver used to wrap test commands") +set(BLT_EXPORT_THIRDPARTY ON CACHE BOOL "") + cmake_minimum_required(VERSION 3.9) if (ENABLE_CUDA) @@ -101,27 +110,31 @@ endif() set(COMPILERS_KNOWN_TO_CMAKE33 AppleClang Clang GNU MSVC) include(CheckCXXCompilerFlag) -if(RAJA_CXX_STANDARD_FLAG MATCHES default) +if(NOT DEFINED BLT_CXX_STD) if("cxx_std_17" IN_LIST CMAKE_CXX_KNOWN_FEATURES) - #TODO set BLT_CXX_STANDARD - set(CMAKE_CXX_STANDARD 17) + set(BLT_CXX_STD c++17 CACHE STRING "Version of C++ standard") + message("Using C++ standard: ${BLT_CXX_STD}") elseif("cxx_std_14" IN_LIST CMAKE_CXX_KNOWN_FEATURES) - set(CMAKE_CXX_STANDARD 14) + set(BLT_CXX_STD c++14 CACHE STRING "Version of C++ standard") + message("Using C++ standard: ${BLT_CXX_STD}") elseif("${CMAKE_CXX_COMPILER_ID}" IN_LIST COMPILERS_KNOWN_TO_CMAKE33) - set(CMAKE_CXX_STANDARD 14) + set(BLT_CXX_STD c++14 CACHE STRING "Version of C++ standard") + message("Using C++ standard: ${BLT_CXX_STD}") else() #cmake has no idea what to do, do it ourselves... - foreach(flag_var "-std=c++17" "-std=c++1z" "-std=c++14" "-std=c++1y" "-std=c++11") - CHECK_CXX_COMPILER_FLAG(${flag_var} COMPILER_SUPPORTS_${flag_var}) + foreach(flag_var "c++17" "c++14" "c++11") + CHECK_CXX_COMPILER_FLAG("-std=${flag_var}" COMPILER_SUPPORTS_${flag_var}) if(COMPILER_SUPPORTS_${flag_var}) - set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${flag_var}") + set(BLT_CXX_STD ${flag_var} CACHE STRING "Version of C++ standard") + message("Using C++ standard: ${BLT_CXX_STD}") break() endif() endforeach(flag_var) endif() -else(RAJA_CXX_STANDARD_FLAG MATCHES default) - set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${RAJA_CXX_STANDARD_FLAG}") - message("Using C++ standard flag: ${RAJA_CXX_STANDARD_FLAG}") -endif(RAJA_CXX_STANDARD_FLAG MATCHES default) +else() #check BLT_CXX_STD is high enough by disallowing the only invalid option + if("${BLT_CXX_STD}" STREQUAL "c++98") + message(FATAL_ERROR "RAJA requires minimum C++ standard of c++11") + endif() +endif(NOT DEFINED BLT_CXX_STD) set(CMAKE_CXX_EXTENSIONS OFF) @@ -145,14 +158,21 @@ if (NOT BLT_LOADED) include(${BLT_SOURCE_DIR}/SetupBLT.cmake) endif() +## +## Here are the CMake dependent options... +## +cmake_dependent_option(RAJA_ENABLE_TESTS "Build tests" On "ENABLE_TESTS" Off) +cmake_dependent_option(RAJA_ENABLE_EXAMPLES "Build simple examples" On "ENABLE_EXAMPLES" off) +cmake_dependent_option(RAJA_ENABLE_BENCHMARKS "Build benchmarks" On "ENABLE_BENCHMARKS" Off) + + # Setup basic CMake options include(cmake/SetupBasics.cmake) # Find third-party packages include(cmake/SetupPackages.cmake) # Setup vendor-specific compiler flags include(cmake/SetupCompilers.cmake) -# Setup internal RAJA configuration options -include(cmake/SetupRajaConfig.cmake) + # Macros for building executables and libraries include (cmake/RAJAMacros.cmake) @@ -162,6 +182,7 @@ set (raja_sources src/LockFreeIndexSetBuilders.cpp src/MemUtils_CUDA.cpp src/MemUtils_HIP.cpp + src/MemUtils_SYCL.cpp src/PluginStrategy.cpp) if (RAJA_ENABLE_RUNTIME_PLUGINS) @@ -182,50 +203,51 @@ if ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "Intel" AND CMAKE_CXX_COMPILER_VERSION V message(WARNING "RAJA::simd_exec support requires Intel-17 or greater") endif() +if(ENABLE_CUDA) + if("${CUDA_VERSION_STRING}" VERSION_LESS "9.2") + message(FATAL_ERROR "Trying to use CUDA version ${CUDA_VERSION_STRING}. RAJA dependency Googletest requires CUDA version 9.2.x or newer.") + endif() +endif() + +if(ENABLE_HIP) + if("${HIP_VERSION_STRING}" VERSION_LESS "3.5") + message(FATAL_ERROR "Trying to use HIP/ROCm version ${HIP_VERSION_STRING}. RAJA requires HIP/ROCm version 3.5 or newer. ") + endif() +endif() + if (ENABLE_CUDA) - set (raja_depends + set(raja_depends ${raja_depends} cuda) + if(ENABLE_NV_TOOLS_EXT) + set(raja_depends + ${raja_depends} + nvtoolsext) + endif () endif () -if (ENABLE_CUDA) - if(ENABLE_EXTERNAL_CUB) - find_package(CUB) - if (CUB_FOUND) - blt_register_library( - NAME cub - INCLUDES $) - set(raja_depends - ${raja_depends} - cub) - else() - message(WARNING "External CUB not found.") - set(ENABLE_EXTERNAL_CUB Off) - endif() - endif () +if (ENABLE_EXTERNAL_CUB) + set(raja_depends + ${raja_depends} + cub) endif () if (ENABLE_HIP) - set (raja_depends + set(raja_depends ${raja_depends} hip) endif () -if (ENABLE_HIP) - if(ENABLE_EXTERNAL_ROCPRIM) - find_package(ROCPRIM) - if (ROCPRIM_FOUND) - blt_register_library( - NAME rocPRIM - INCLUDES ${ROCPRIM_INCLUDE_DIRS}) - set(raja_depends - ${raja_depends} - rocPRIM) - else() - message(WARNING "External rocPRIM not found.") - set(ENABLE_EXTERNAL_ROCPRIM Off) - endif() - endif () +if (ENABLE_EXTERNAL_ROCPRIM) + set(raja_depends + ${raja_depends} + rocPRIM) +endif () + +if (ENABLE_SYCL) + set (raja_depends + ${raja_depends} + sycl) endif () if (ENABLE_TBB) @@ -248,14 +270,26 @@ camp source repository") add_subdirectory(tpl/camp) else (NOT camp_FOUND) message(STATUS "Using installed CAMP from: ${camp_INSTALL_PREFIX}") + # Save the path so it can be used in raja-config.cmake + set(EXTERNAL_CAMP_INSTALL_DIR ${camp_INSTALL_PREFIX} CACHE PATH "") endif(NOT camp_FOUND) endif (EXTERNAL_CAMP_SOURCE_DIR) endif (NOT TARGET camp) +set (raja_defines) + +if (COMPILER_FAMILY_IS_MSVC AND NOT BUILD_SHARED_LIBS) + set (raja_defines + ${raja_defines} + RAJA_WIN_STATIC_BUILD) +endif () + blt_add_library( NAME RAJA SOURCES ${raja_sources} - DEPENDS_ON ${raja_depends} camp ${CMAKE_DL_LIBS}) + DEPENDS_ON ${raja_depends} camp ${CMAKE_DL_LIBS} + DEFINES ${raja_defines}) + install(TARGETS RAJA EXPORT RAJA @@ -271,16 +305,22 @@ target_include_directories(RAJA $ $ $) -target_include_directories(RAJA SYSTEM - PUBLIC - $ - $) +if (ENABLE_CUDA AND NOT ENABLE_EXTERNAL_CUB) + target_include_directories(RAJA SYSTEM + PUBLIC + $) +endif() +if (ENABLE_HIP AND NOT ENABLE_EXTERNAL_ROCPRIM) + target_include_directories(RAJA SYSTEM + PUBLIC + $) +endif() install(DIRECTORY include/ DESTINATION include FILES_MATCHING PATTERN *.hpp) -if(NOT ENABLE_EXTERNAL_CUB) - install(DIRECTORY tpl/cub/ DESTINATION include FILES_MATCHING PATTERN *.cuh) +if (ENABLE_CUDA AND NOT ENABLE_EXTERNAL_CUB) + install(DIRECTORY tpl/cub/cub/ DESTINATION include/cub FILES_MATCHING PATTERN *.cuh) endif() -if(NOT ENABLE_EXTERNAL_ROCPRIM) +if (ENABLE_HIP AND NOT ENABLE_EXTERNAL_ROCPRIM) install(DIRECTORY tpl/rocPRIM/rocprim/include/ DESTINATION include FILES_MATCHING PATTERN *.hpp) endif() @@ -290,7 +330,11 @@ install(FILES include/RAJA/module.private.modulemap DESTINATION "include/RAJA/") -if(ENABLE_TESTS) + +# Setup internal RAJA configuration options +include(cmake/SetupRajaConfig.cmake) + +if(RAJA_ENABLE_TESTS) add_subdirectory(test) endif() @@ -298,11 +342,11 @@ if(ENABLE_REPRODUCERS) add_subdirectory(reproducers) endif() -if(ENABLE_EXAMPLES) +if(RAJA_ENABLE_EXAMPLES) add_subdirectory(examples) endif() -if(ENABLE_EXERCISES) +if(RAJA_ENABLE_EXERCISES) add_subdirectory(exercises) endif() @@ -310,6 +354,6 @@ if (ENABLE_DOCUMENTATION) add_subdirectory(docs) endif () -if (ENABLE_BENCHMARKS) +if (RAJA_ENABLE_BENCHMARKS) add_subdirectory(benchmark) endif () diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c072b7efc5..8937b7396e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ [comment]: # (#################################################################) -[comment]: # (Copyright 2016-19, Lawrence Livermore National Security, LLC) +[comment]: # (Copyright 2016-21, Lawrence Livermore National Security, LLC) [comment]: # (and RAJA project contributors. See the RAJA/COPYRIGHT file) [comment]: # (for details.) [comment]: # diff --git a/Dockerfile b/Dockerfile index f21c0478ea..c52835b3bf 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,23 +1,94 @@ ############################################################################### -# Copyright (c) 2016-20, Lawrence Livermore National Security, LLC +# Copyright (c) 2016-21, Lawrence Livermore National Security, LLC # and RAJA project contributors. See the RAJA/COPYRIGHT file for details. # # SPDX-License-Identifier: (BSD-3-Clause) ############################################################################### -# -#Builds and installs RAJA using the gcc8 compiler -# +FROM axom/compilers:gcc-5 AS gcc5 +ENV GTEST_COLOR=1 +COPY --chown=axom:axom . /home/axom/workspace +WORKDIR /home/axom/workspace +RUN ls +RUN mkdir build && cd build && cmake -DCMAKE_CXX_COMPILER=g++ -DENABLE_WARNINGS=On -DENABLE_TBB=On -DRAJA_DEPRECATED_TESTS=On .. +RUN cd build && make -j 16 +RUN cd build && ctest -T test --output-on-failure + +FROM axom/compilers:gcc-5 AS gcc5-debug +ENV GTEST_COLOR=1 +COPY --chown=axom:axom . /home/axom/workspace +WORKDIR /home/axom/workspace +RUN mkdir build && cd build && cmake -DCMAKE_CXX_COMPILER=g++ -DCMAKE_BUILD_TYPE=Debug -DENABLE_WARNINGS=On -DENABLE_WARNINGS_AS_ERRORS=On -DENABLE_COVERAGE=On -DENABLE_TBB=On .. +RUN cd build && make -j 16 +RUN cd build && ctest -T test --output-on-failure + +FROM axom/compilers:gcc-6 AS gcc6 +ENV GTEST_COLOR=1 +COPY --chown=axom:axom . /home/axom/workspace +WORKDIR /home/axom/workspace +RUN mkdir build && cd build && cmake -DCMAKE_CXX_COMPILER=g++ -DENABLE_WARNINGS=On -DENABLE_TBB=On -DRAJA_ENABLE_RUNTIME_PLUGINS=On .. +RUN cd build && make -j 16 +RUN cd build && ctest -T test --output-on-failure + +FROM axom/compilers:gcc-7 AS gcc7 +ENV GTEST_COLOR=1 +COPY --chown=axom:axom . /home/axom/workspace +WORKDIR /home/axom/workspace +RUN mkdir build && cd build && cmake -DCMAKE_CXX_COMPILER=g++ -DENABLE_WARNINGS=On -DENABLE_TBB=On .. +RUN cd build && make -j 16 +RUN cd build && ctest -T test --output-on-failure + +FROM axom/compilers:gcc-8 AS gcc8 +ENV GTEST_COLOR=1 +COPY --chown=axom:axom . /home/axom/workspace +WORKDIR /home/axom/workspace +RUN mkdir build && cd build && cmake -DCMAKE_CXX_COMPILER=g++ -DENABLE_WARNINGS=On -DENABLE_TBB=On -DRAJA_ENABLE_BOUNDS_CHECK=ON .. +RUN cd build && make -j 16 +RUN cd build && ctest -T test --output-on-failure + +FROM axom/compilers:clang-9 AS clang9 +ENV GTEST_COLOR=1 +COPY --chown=axom:axom . /home/axom/workspace +WORKDIR /home/axom/workspace +RUN mkdir build && cd build && cmake -DCMAKE_CXX_COMPILER=clang++ -DCMAKE_CXX_FLAGS=-fmodules -DENABLE_TBB=On .. +RUN cd build && make -j 16 +RUN cd build && ctest -T test --output-on-failure -FROM rajaorg/compiler:gcc8 -MAINTAINER RAJA Development Team +FROM axom/compilers:clang-9 AS clang9-debug +ENV GTEST_COLOR=1 +COPY --chown=axom:axom . /home/axom/workspace +WORKDIR /home/axom/workspace +RUN mkdir build && cd build && cmake -DCMAKE_CXX_COMPILER=clang++ -DCMAKE_BUILD_TYPE=Debug -DENABLE_TBB=On -DCMAKE_CXX_FLAGS=-fsanitize=address .. +RUN cd build && make -j 16 +RUN cd build && ctest -T test --output-on-failure -COPY --chown=raja:raja . /home/raja/workspace +FROM axom/compilers:nvcc-10.2 AS nvcc10 +ENV GTEST_COLOR=1 +COPY --chown=axom:axom . /home/axom/workspace +WORKDIR /home/axom/workspace +RUN mkdir build && cd build && cmake -DCMAKE_CXX_COMPILER=g++ -DENABLE_CUDA=On -DCMAKE_CUDA_STANDARD=14 .. +RUN cd build && make -j 2 -WORKDIR /home/raja/workspace +FROM axom/compilers:nvcc-10.2 AS nvcc10-debug +ENV GTEST_COLOR=1 +COPY --chown=axom:axom . /home/axom/workspace +WORKDIR /home/axom/workspace +RUN mkdir build && cd build && cmake -DCMAKE_CXX_COMPILER=g++ -DCMAKE_BUILD_TYPE=Debug -DENABLE_CUDA=On -DCMAKE_CUDA_STANDARD=14 .. +RUN cd build && make -j 2 -RUN mkdir build && cd build && cmake -DENABLE_CUDA=OFF .. +FROM axom/compilers:rocm AS hip +ENV GTEST_COLOR=1 +COPY --chown=axom:axom . /home/axom/workspace +WORKDIR /home/axom/workspace +ENV HCC_AMDGPU_TARGET=gfx900 +RUN mkdir build && cd build && cmake -DROCM_ROOT_DIR=/opt/rocm/include -DHIP_RUNTIME_INCLUDE_DIRS="/opt/rocm/include;/opt/rocm/hip/include" -DENABLE_HIP=On -DENABLE_OPENMP=Off -DENABLE_CUDA=Off -DENABLE_WARNINGS_AS_ERRORS=Off -DHIP_HIPCC_FLAGS=-fPIC .. +RUN cd build && make -j 16 -RUN cd build && sudo make -j 3 && sudo make install +FROM axom/compilers:oneapi-2021.2.0 AS sycl +ENV GTEST_COLOR=1 +COPY --chown=axom:axom . /home/axom/workspace +WORKDIR /home/axom/workspace +RUN /bin/bash -c 'source /opt/intel/oneapi/setvars.sh && mkdir build && cd build && cmake -DCMAKE_CXX_COMPILER=dpcpp -DENABLE_SYCL=On -DENABLE_OPENMP=OFF -DENABLE_ALL_WARNINGS=Off -DBLT_CXX_STD=c++17 ..' +RUN /bin/bash -c "source /opt/intel/oneapi/setvars.sh && cd build && make -j 16" +RUN /bin/bash -c "source /opt/intel/oneapi/setvars.sh && cd build && ctest -T test --output-on-failure" -CMD ["bash"] diff --git a/LICENSE b/LICENSE index b40399aa2e..22c365b5f5 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright (c) 2016-2020, Lawrence Livermore National Security, LLC. +Copyright (c) 2016-2021, Lawrence Livermore National Security, LLC. All rights reserved. Redistribution and use in source and binary forms, with or without diff --git a/README.md b/README.md index 397bebec90..dd10e14a51 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ [comment]: # (#################################################################) -[comment]: # (Copyright 2016-19, Lawrence Livermore National Security, LLC) +[comment]: # (Copyright 2016-21, Lawrence Livermore National Security, LLC) [comment]: # (and RAJA project contributors. See the RAJA/COPYRIGHT file) [comment]: # (for details.) [comment]: # @@ -13,36 +13,38 @@ [![Join the chat at https://gitter.im/llnl/raja](https://badges.gitter.im/llnl/raja.svg)](https://gitter.im/llnl/raja?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Coverage](https://img.shields.io/codecov/c/github/LLNL/RAJA/develop.svg)](https://codecov.io/gh/LLNL/RAJA) -RAJA is a collection of C++ software abstractions, being developed at -Lawrence Livermore National Laboratory (LLNL), that enable architecture -portability for HPC applications. The overarching goals of RAJA are to: +RAJA is a library of C++ software abstractions, primarily developed at +Lawrence Livermore National Laboratory (LLNL), that enables architecture +and programming model portability for HPC applications. RAJA has two main goals: - * Make existing (production) applications *portable with minimal disruption* - * Provide a model for new applications so that they are portable from - inception. + * To enable application portability with manageable disruption to existing + algorithms and programming styles + * To achieve performance comparable to using common programming models, + such as OpenMP, CUDA, etc. directly. -RAJA uses standard C++11 -- C++ is the predominant programming language in -which many LLNL codes are written. RAJA is rooted in a perspective based on -substantial experience working on production mesh-based multiphysics -applications at LLNL. Another goal of RAJA is to enable application developers -to adapt RAJA concepts and specialize them for different code implementation -patterns and C++ usage, since data structures and algorithms vary widely -across applications. +RAJA offers portable, parallel loop execution by providing building blocks +that extend the generally-accepted parallel for idiom. RAJA relies on standard +C++11 features, such as lambda expressions. + +RAJA's design is rooted in decades of experience working on +production mesh-based multiphysics applications. Based on the diversity of +algorithms and software engineering styles used in such applications, RAJA +is designed to enable application developers to adapt RAJA concepts and +specialize them for different code implementation patterns and C++ usage. RAJA shares goals and concepts found in other C++ portability abstraction approaches, such as [Kokkos](https://github.com/kokkos/kokkos) and [Thrust](https://developer.nvidia.com/thrust). -However, it includes concepts that are absent in other models and which are -fundamental to LLNL codes. +However, it includes concepts and capabilities that are absent in other models +that are fundamental to applications we work with. -It is important to note that RAJA is very much a work-in-progress. -The community of researchers and application developers at LLNL that are -actively contributing to it and developing new capabilities is growing. -The publicly-released version contains only core pieces of RAJA as they -exist today. While the basic interfaces are fairly stable, the implementation -of the underlying concepts is being refined. Additional features will appear -in future releases. +It is important to note that, although RAJA is used in a diversity of +production applications, it is very much a work-in-progress. The community +of researchers and application developers at LLNL that actively contribute to +it is growing. Versions available as [GitHub releases](https://github.com/LLNL/RAJA/releases) contain mostly well-used and well-tested features. Our core +interfaces are fairly stable while underlying implementations are being +refined. Additional features will appear in future releases. Quick Start ----------- @@ -62,8 +64,8 @@ commands in the top-level RAJA directory (in-source builds are not allowed!): cmake ../ make -More details about RAJA configuration options are located in the User -Documentation. +More details about RAJA configuration options are located in the RAJA User Guide +(linked below). We also maintain a [**RAJA Template Project**](https://github.com/LLNL/RAJA-project-template) that shows how to use RAJA in a CMake project, either as a Git submodule or as an installed library. @@ -71,8 +73,12 @@ submodule or as an installed library. User Documentation ------------------- -The [**RAJA User Guide and Tutorial**](http://raja.readthedocs.io/en/main/) -is the best place to start learning about RAJA and how to use it. +The RAJA User Guide is the best place to start learning about RAJA and how to +use it. + +The most recent version of the User Guide (RAJA develop branch): https://raja.readthedocs.io + +To access docs for other RAJA released versions: https://readthedocs.org/projects/raja/ To cite RAJA, please use the following references: @@ -86,7 +92,8 @@ Related Software The [**RAJA Performance Suite**](https://github.com/LLNL/RAJAPerf) contains a collection of loop kernels implemented in multiple RAJA and non-RAJA variants. We use it to monitor and assess RAJA performance on different -platforms using a variety of compilers. +platforms using a variety of compilers. Many major compiler vendors use the +Suite to improve their support of abstractions like RAJA. The [**RAJA Proxies**](https://github.com/LLNL/RAJAProxies) repository contains RAJA versions of several important HPC proxy applications. @@ -95,12 +102,13 @@ contains RAJA versions of several important HPC proxy applications. that works with RAJA to automatically copy data used in RAJA kernels to the appropriate space for execution. It was developed as a complement to RAJA. -Mailing List ------------------ +Communicate with Us +------------------- + +The most effective way to communicate with the core RAJA development team +is via our mailing list: **raja-dev@llnl.gov** -Interested in keeping up with RAJA or communicating with its developers and -users? Please join our mailing list at Google Groups: -- [RAJA Google Group](https://groups.google.com/forum/#!forum/raja-users) +You are also welcome to join our [RAJA Google Group](https://groups.google.com/forum/#!forum/raja-users). If you have questions, find a bug, or have ideas about expanding the functionality or applicability of RAJA and are interested in contributing @@ -112,26 +120,20 @@ Contributions The RAJA team follows the [GitFlow](http://nvie.com/posts/a-successful-git-branching-model/) development model. Folks wishing to contribute to RAJA, should include their work in a feature branch created from the RAJA `develop` branch. -Then, create a pull request with the `develop` branch as the destination. That -branch contains the latest work in RAJA. Periodically, we will merge the +That branch contains the latest work in RAJA. Then, create a pull request +with the `develop` branch as the destination. Periodically, we merge the develop branch into the `main` branch and tag a new release. Authors ----------- -The original developers of RAJA are: - - * Rich Hornung (hornung1@llnl.gov) - * Jeff Keasler (keasler1@llnl.gov) - Please see the [RAJA Contributors Page](https://github.com/LLNL/RAJA/graphs/contributors), to see the full list of contributors to the project. License ----------- -RAJA is licensed under the BSD 3-Clause license, -(BSD-3-Clause or https://opensource.org/licenses/BSD-3-Clause). +RAJA is licensed under the [BSD 3-Clause license](https://opensource.org/licenses/BSD-3-Clause). Copyrights and patents in the RAJA project are retained by contributors. No copyright assignment is required to contribute to RAJA. @@ -175,3 +177,7 @@ PackageLicenseDeclared: BSD-3-Clause PackageName: CUB PackageHomePage: https://github.com/NVlabs/cub PackageLicenseDeclared: BSD-3-Clause + +PackageName: rocPRIM +PackageHomePage: https://github.com/ROCmSoftwarePlatform/rocPRIM.git +PackageLicenseDeclared: MIT License diff --git a/RELEASE b/RELEASE index 7bfcd98fbf..4cb8687054 100644 --- a/RELEASE +++ b/RELEASE @@ -1,8 +1,8 @@ ******************************************************************************* -RAJA: ................................, version 0.10.0 +RAJA: ................................, version 0.14.0 -Copyright (c) 2016-19, Lawrence Livermore National Security, LLC. +Copyright (c) 2016-21, Lawrence Livermore National Security, LLC. Produced at the Lawrence Livermore National Laboratory. All rights reserved. See details in the RAJA/LICENSE file. @@ -10,20 +10,3 @@ Unlimited Open Source - BSD Distribution LLNL-CODE-689114 OCEC-16-063 -The RAJA development team and contributors are: - -Rich Hornung (hornung1@llnl.gov) -David Beckingsale (beckingsale1@llnl.gov) -Jason Burmark (burmark1@llnl.gov) -Robert Chen (chen59@llnl.gov) -Matt Cordery (mcorder@us.ibm.com) -Mike Davis (davis291@llnl.gov) -Jeff Hammond (jeff.science@gmail.com) -Holger Jones (jones19@llnl.gov) -Jeff Keasler (keasler1@llnl.gov) -Will Killian (killian4@llnl.gov) -Adam Kunen (kunen1@llnl.gov) -Olga Pearce (pearce8@llnl.gov) -David Poliakoff (poliakoff1@llnl.gov) -Tom Scogland (scogland1@llnl.gov) -Arturo Vargas (vargas45@llnl.gov) diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index 1e486959c4..12e33720ee 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -1,6 +1,5 @@ - [comment]: # (#################################################################) -[comment]: # (Copyright 2016-20, Lawrence Livermore National Security, LLC) +[comment]: # (Copyright 2016-21, Lawrence Livermore National Security, LLC) [comment]: # (and RAJA project contributors. See the RAJA/COPYRIGHT file) [comment]: # (for details.) [comment]: # @@ -10,6 +9,133 @@ Version vxx.yy.zz -- Release date 20yy-mm-dd ============================================ +Version v0.14.0 -- Release date 2021-08-20 +============================================ + +This release contains new features, bug fixes, and build improvements. Please +see the RAJA user guide for more information about items in this release. + +Notable changes include: + + * New features / API changes: + * Initial release of some SYCL execution back-end features for supporting + Intel GPUs. Users should be able to exercise RAJA::forall, basic + RAJA::kernel, and reductions. Future releases will contain additional + RAJA feature support for SYCL. + * Various enhancements to the experimental RAJA "teams" capability, + including documentation and complete code examples illustrating usage. + * The RAJA "teams" interface was expanded to initial support for RAJA + resources. + * The RAJA "teams" interface was expanded to allow users to label + kernels with name strings to easily attribute execution timings and + other details to specific kernels with NVIDIA profiling tools, + for example. Usage information is available in the RAJA User Guide. + Kernel naming will be available for all other RAJA kernel execution + methods in a future release. + * Deprecated sort and scan methods taking iterators have been removed, + Now, these methods take RAJA span arguments. For example, + (begin, end) args are replaced with RAJA::make_span(begin, N), where + N = end - begin. Please see the RAJA User Guide documentation for + scan and sort operations for details and usage examples. + * Sort and scan methods now accept an optional resource argument. + * Methods were added to the RAJA::kernel API to accept a resource + argument; specifically 'kernel_resource' and 'kernel_param_resource'. + These kernel methods return an Event object similar to the RAJA::forall + interface. + * Kernel launch methods for the RAJA "teams" interface now use the + CAMP default resource based on the specified execution back-end. + Future work will expand the interface to allow users to pass a + resource object. + * RAJA resource support added to RAJA workgroup and worksite constructs. + * OpenMP CPU multithreading policies have been reworked so that usage + involving OpenMP scheduling are consistent. Specification of a chunk + size for scheduling policies is optional, which is consistent with + native OpenMP usage. In addition, no-wait policies are more constrained + to prevent potentially non-conforming (to the OpenMP spec) usage. + Finally, additional policy type aliases have been added to make common + use cases less verbose. Please see the RAJA policy documentation in + the User Guide for policy descriptions. + * Host implementation of Hip atomics added. + * Add ability to specify atomic to use on the host in CUDA and Hip + atomic policies (i.e., added host atomic template parameter), This + is useful for host-device decorated lambda expressions that may be + used for either host or device execution. It also fixes compilation + issues with Hip atomic compilation in host-device contexts. + * The RAJA Registry API has been changed to return raw pointers to + registry objects rather than shared_ptr type. This is better for + performance. + * New content has been added to the RAJA Developer Guide available in the + Read The Docs Sphinx documentation. This should help folks align their + work with RAJA processes when making contributions to RAJA. + * Basic doxygen source code documentation is now available via a link + in our Read The Docs Sphinx documentation. + * Unified memory implementation for storing indices in TypedListSegment, + which was marked deprecated in v0.12.0 release has been removed. Now, + TypedListSegment constructor requires a camp resource object to be + passed which indicates the memory space where the indices will live. + Specifically, the array of indices passed to the constructor by a user + (assumed to live in host memory for the "owned" case) will be copied + to an internally owned allocation in the memory space defined by the + resource object. + * The ListSegment constructor takes a resource by value now, previously + taken by reference, which allows more resource argument types to be + passed more seamlessly to the List Segment constructor. + * 'CudaKernelFixedSM' and 'CudaKernelFixedSMAsync' methods were added + which allow users to specify the minimum number of thread blocks to + launch per SM. This resulted in a performance improvement for an + application use case. Future work will expand this concept to other GPU + kernel execution methods in RAJA. + + * Build changes/improvements: + * Update BLT submodule to latest release, v0.4.1. + * Update camp submodule to latest tagged release, v0.2.2 + * The RAJA_CXX_STANDARD_FLAG CMake variable was removed. The BLT_CXX_STD + variable is now used instead. + * Support for building RAJA as a shared library on Windows has been added. + * A build system adjustment was made to address an issue when RAJA is + built with an external version of camp (e.g., through Spack). + * The build default has been changed to use the version of CUB that + is installed in the specified version of the CUDA toolkit, if available, + when CUDA is enabled. Similarly, for the analogous functionality in + Hip. Specific versions of these libraries can still be specified for + a RAJA build. Please see the RAJA User Guide for details. + * The build system now uses the BLT cmake_dependent_options support for + options defined by BLT. This avoids shadowing of BLT options by options + defined in RAJA and in the cases where RAJA is used as a sub-module in + another BLT project. For example, it provides the ability to disable + RAJA tests and examples at a more fine granularity. + * Checks were added to the RAJA CMake build system to check for minimum + required versions of CUDA (9.2) and Hip (3.5). + * A build system bug was fixed so that targets for third-party + dependencies provided by BLT (e.g., CUDA and Hip) are exported properly. + This allows non-BLT projects to use the imported RAJA target. + * An issue was fixed to appease the MSVC 2019 compiler. + * Improvements to build system to address Hip linking issues. + + * Bug fixes/improvements: + * Hip and CUDA block reductions were tweaked to fix the number of steps + in the final wavefront/warp reduction. This saves a couple rounds of + warp shfls. + * A runtime bug resulting from defaulted View constructors not being + implemented correctly in CUDA 10.1 is fixed. This fixes an issue + with CHAI managed arrays not having their copy constructor being + triggered properly. + * Fix bug that caused a CUDA or Hip synchronization error when a zero + length loop was enqueued in a workgroup. + * Added missing Hip workgroup unordered execution policy, so Hip + version is consistent with CUDA version. + * Fixed issue where the RAJA non-resource API returns an EventProxy object + with a dangling resource pointer, by getting a reference to the + default resource for the execution context. + * IndexSet utility methods for collecting indices into a separate + container now work with any index type. + * The volatile qualifier was removed from a type conversion function used + in RAJA atomics. This fixes a performance issue with Hip where the + value was written to stack memory during type conversion. + * Numerous improvements, updates, and fixes (formatting, typos, etc.) + in RAJA User Guide. + + Version v0.13.0 -- Release date 2020-10-30 ============================================ @@ -19,7 +145,7 @@ see the RAJA user guide for more information about items in this release. Notable changes include: * New features: - * Execution policies for the RAJA HIP back-end and examples have been + * Execution policies for the RAJA Hip back-end and examples have been added to the RAJA User Guide and Tutorial. * Strongly-typed indices now work with Multiview. @@ -65,7 +191,7 @@ Notable changes include: things like Kokkos Performance Profiline Tools to be used with RAJA (https://github.com/kokkos/kokkos-tools) * Added ability to pass a resource object to RAJA::forall methods to - enable asynchronous execution for CUDA and HIP back-ends. + enable asynchronous execution for CUDA and Hip back-ends. * Added "Multi-view" that works like a regular view, except that it can wrap multiple arrays so their accesses can share index arithmetic. * Multiple sort algorithms added. This provides portable parallel sort @@ -102,7 +228,7 @@ Notable changes include: Resource object. This enables run time specification of the memory space where the data for list segment indices will live. In earlier RAJA versions, the space in which list segment index data lived was a - compile-time choice based on whether CUDA or HIP was enabled and the + compile-time choice based on whether CUDA or Hip was enabled and the data resided in unified memory for either case. This is still supported in this release, but is marked as a DEPRECATED FEATURE. In the next RAJA release, ListSegment construction will require a camp Resource object. @@ -115,7 +241,7 @@ Notable changes include: * Build changes/improvements: * The BLT, camp, CUB, and rocPRIM submodules have all been updated to more recent versions. Please note that RAJA now requires rocm version - 3.5 or newer to use the HIP back-end. + 3.5 or newer to use the Hip back-end. * Build for clang9 on macosx has been fixed. * Build for Intel19 on Windows has been fixed. * Host/device annotations have been added to reduction operations to @@ -136,7 +262,7 @@ Notable changes include: * Bug fixes: * An issue with SIMD privatization with the Intel compiler, required to generate correct code, has been fixed. - * An issue with the atomicExchange() operation for the RAJA HIP back-end + * An issue with the atomicExchange() operation for the RAJA Hip back-end has been fixed. * A type issue in the RAJA::kernel implementation involving RAJA span usage has been fixed. @@ -158,7 +284,7 @@ This release contains new features, several notable changes, and some bug fixes. Notable changes include: * New features: - * HIP compiler back-end added to support AMD GPUs. Usage is essentially + * Hip compiler back-end added to support AMD GPUs. Usage is essentially the same as for CUDA. Note that this feature is considered a work-in-progress and not yet production ready. It is undocumented, but noted here, for friendly users who would like to try it out. diff --git a/appveyor.yml b/appveyor.yml index 947fb05695..a3828d2421 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -1,6 +1,8 @@ version: 1.0.{build} skip_branch_with_pr: true -image: Visual Studio 2017 +image: + - Visual Studio 2017 + - Visual Studio 2019 build_script: - cmd: >- git submodule init diff --git a/azure-pipelines.yml b/azure-pipelines.yml new file mode 100644 index 0000000000..ee7c1dbe40 --- /dev/null +++ b/azure-pipelines.yml @@ -0,0 +1,121 @@ +variables: + DO_BUILD: 'yes' + DO_TEST: 'yes' + DO_INSTALL: 'yes' + COMPILER: 'g++' + +jobs: +- job: Windows #temporarily commenting out until cmake/azure version issue resolved + strategy: + matrix: + shared: + SHARED_ARGS: '-DBUILD_SHARED_LIBS=On -DCMAKE_CXX_FLAGS="/DRAJASHAREDDLL_EXPORTS" ' + static: + SHARED_ARGS: '-DBUILD_SHARED_LIBS=Off' + pool: + vmImage: 'windows-2019' + variables: + CMAKE_EXTRA_FLAGS: '-DENABLE_WARNINGS_AS_ERRORS=Off -DBLT_CXX_STD="" -DCMAKE_CXX_STANDARD=17' + steps: + - checkout: self + clean: boolean + submodules: recursive + - task: CMake@1 + inputs: + workingDir: 'build' + cmakeArgs: '$(CMAKE_EXTRA_FLAGS) $(SHARED_ARGS) ../' + - task: CMake@1 + inputs: + workingDir: 'build' + cmakeArgs: '--build . --config Release --verbose' +# - task: CmdLine@2 +# inputs: +# script: 'ctest.exe -T test -C Release' +# workingDirectory: 'build' +# condition: eq( variables['Agent.OS'], 'Windows_NT') +# - task: PublishTestResults@2 +# inputs: +# testResultsFormat: 'cTest' +# testResultsFiles: '**/Test.xml' +- job: Docker + timeoutInMinutes: 360 + strategy: + matrix: + gcc5: + docker_target: gcc5 + gcc5-debug: + docker_target: gcc5-debug + gcc6: + docker_target: gcc6 + gcc7: + docker_target: gcc7 + gcc8: + docker_target: gcc8 + clang9: + docker_target: clang9 + clang9-debug: + docker_target: clang9-debug + nvcc10: + docker_target: nvcc10 + nvcc10-debug: + docker_target: nvcc10-debug + hip: + docker_target: hip + sycl: + docker_target: sycl + pool: + vmImage: 'ubuntu-latest' + variables: + DOCKER_BUILDKIT: '1' + CMAKE_EXTRA_FLAGS: '-DENABLE_DEVELOPER_BENCHMARKS=On -DENABLE_DEVELOPER_DEFAULTS=On -DCMAKE_CXX_STANDARD=11' + steps: + - checkout: self + clean: boolean + submodules: recursive + - task: Docker@1 + inputs: + command: build + dockerFile: 'Dockerfile' + arguments: '--target $(docker_target)' + - script: | + CID=$(docker create llnl/raja:$(Build.BuildId)) + echo ${CID} + docker cp ${CID}:/home/axom/workspace/build local-build + docker rm ${CID} + displayName: 'Copy test artifacts' + condition: ne( variables['docker_target'], 'nvcc') + - script: | + bash <(curl -s https://raw.githubusercontent.com/codecov/codecov-bash/0b376529f626b50b7d4a9fb734e0e50d28b9b91e/codecov) >& /dev/null + displayName: 'Upload code coverage' + condition: eq( variables['docker_target'], 'gcc') + - task: PublishTestResults@2 + inputs: + testResultsFormat: 'cTest' + testResultsFiles: '**/Test.xml' +- job: Mac + pool: + vmImage: 'macOS-latest' + variables: + CMAKE_EXTRA_FLAGS: '-DENABLE_OPENMP=Off' + steps: + - checkout: self + clean: boolean + submodules: recursive + - task: CMake@1 + inputs: + workingDir: 'build' + cmakeArgs: '$(CMAKE_EXTRA_FLAGS) ../' + - script: | + cd build + make + displayName: 'OSX Build' + condition: eq( variables['Agent.OS'], 'Darwin') +# - script: | +# cd build +# ctest -T test --output-on-failure +# displayName: 'OSX Test' +# condition: eq( variables['Agent.OS'], 'Darwin') +# - task: PublishTestResults@2 +# inputs: +# testResultsFormat: 'cTest' +# testResultsFiles: '**/Test.xml' diff --git a/benchmark/CMakeLists.txt b/benchmark/CMakeLists.txt index f140c24c09..9da1adfaaa 100644 --- a/benchmark/CMakeLists.txt +++ b/benchmark/CMakeLists.txt @@ -1,5 +1,5 @@ ############################################################################### -# Copyright (c) 2016-20, Lawrence Livermore National Security, LLC +# Copyright (c) 2016-21, Lawrence Livermore National Security, LLC # and RAJA project contributors. See the RAJA/COPYRIGHT file for details. # # SPDX-License-Identifier: (BSD-3-Clause) diff --git a/benchmark/host-device-lambda-benchmark.cpp b/benchmark/host-device-lambda-benchmark.cpp index d4b623c15d..122cb187d9 100644 --- a/benchmark/host-device-lambda-benchmark.cpp +++ b/benchmark/host-device-lambda-benchmark.cpp @@ -1,5 +1,5 @@ //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~// -// Copyright (c) 2016-20, Lawrence Livermore National Security, LLC +// Copyright (c) 2016-21, Lawrence Livermore National Security, LLC // and RAJA project contributors. See the RAJA/COPYRIGHT file for details. // //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~// diff --git a/blt b/blt index cbe99c93d0..ddd5a0ca7c 160000 --- a/blt +++ b/blt @@ -1 +1 @@ -Subproject commit cbe99c93d0d83ca04f13018cdfed9a3663ea248c +Subproject commit ddd5a0ca7c566d0ae14270b66625c8a363630ddb diff --git a/cmake/RAJAMacros.cmake b/cmake/RAJAMacros.cmake index 0d26065854..bba91b9feb 100644 --- a/cmake/RAJAMacros.cmake +++ b/cmake/RAJAMacros.cmake @@ -1,5 +1,5 @@ ############################################################################### -# Copyright (c) 2016-20, Lawrence Livermore National Security, LLC +# Copyright (c) 2016-21, Lawrence Livermore National Security, LLC # and other RAJA project contributors. See the RAJA/COPYRIGHT file for details. # # SPDX-License-Identifier: (BSD-3-Clause) @@ -27,6 +27,10 @@ macro(raja_add_executable) list (APPEND arg_DEPENDS_ON hip) endif () + if (ENABLE_SYCL) + list (APPEND arg_DEPENDS_ON sycl) + endif () + if (ENABLE_TBB) list (APPEND arg_DEPENDS_ON tbb) endif () @@ -71,6 +75,10 @@ macro(raja_add_plugin_library) list (APPEND arg_DEPENDS_ON hip) endif () + if (ENABLE_SYCL) + list (APPEND arg_DEPENDS_ON sycl) + endif () + if (ENABLE_TBB) list (APPEND arg_DEPENDS_ON tbb) endif () @@ -93,6 +101,48 @@ macro(raja_add_plugin_library) endmacro(raja_add_plugin_library) +# Allows strings embedded in test files to used to process ctest results. +# Only works for new testing framework/structure (no effect on old tests). +# Borrowed heavily from CAMP. +function(raja_set_failtest TESTNAME) + set(test_name ${TESTNAME}) + + # Chopping off backend from test name + string(REGEX REPLACE "\-Sequential|\-OpenMP|\-OpenMPTarget|\-TBB|\-CUDA|\-HIP" "" test_nobackend ${test_name}) + + # Finding test source code + if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/tests/${test_nobackend}.hpp") + list(APPEND TEST_LIST "${CMAKE_CURRENT_SOURCE_DIR}/tests/${test_nobackend}.hpp") + list(REMOVE_DUPLICATES TEST_LIST) + endif() + + list(GET TEST_LIST 0 source_file) + + if(EXISTS ${source_file}) + set(test_regex ".*(WILL_FAIL|PASS_REGEX|FAIL_REGEX):?[ ]*(.*)[ ]*") + + file(STRINGS ${source_file} test_lines REGEX "${test_regex}") + + # Search test source code for fail string + foreach(line ${test_lines}) + if(NOT line MATCHES "${test_regex}") + continue() + endif() + + if(CMAKE_MATCH_1 STREQUAL "WILL_FAIL") + set_property( TARGET ${test_name}.exe # TARGET more conformant to BLT + APPEND PROPERTY WILL_FAIL ) + elseif(CMAKE_MATCH_1 STREQUAL "PASS_REGEX") + set_property( TARGET ${test_name}.exe + APPEND PROPERTY PASS_REGULAR_EXPRESSION "${CMAKE_MATCH_2}") + elseif(CMAKE_MATCH_1 STREQUAL "FAIL_REGEX") + set_property( TARGET ${test_name}.exe + APPEND PROPERTY FAIL_REGULAR_EXPRESSION "${CMAKE_MATCH_2}") + endif() + endforeach() + endif() +endfunction() + macro(raja_add_test) set(options ) set(singleValueArgs NAME) @@ -103,6 +153,8 @@ macro(raja_add_test) list (APPEND arg_DEPENDS_ON gtest ${CMAKE_THREAD_LIBS_INIT}) + set(original_test_name ${arg_NAME}) + raja_add_executable( NAME ${arg_NAME}.exe SOURCES ${arg_SOURCES} @@ -113,6 +165,8 @@ macro(raja_add_test) NAME ${arg_NAME} #COMMAND ${TEST_DRIVER} $) COMMAND ${TEST_DRIVER} ${arg_NAME}) + + raja_set_failtest(${original_test_name}) endmacro(raja_add_test) macro(raja_add_reproducer) diff --git a/cmake/SetupBasics.cmake b/cmake/SetupBasics.cmake index 9465cdd678..d3513d876b 100644 --- a/cmake/SetupBasics.cmake +++ b/cmake/SetupBasics.cmake @@ -1,5 +1,5 @@ ############################################################################### -# Copyright (c) 2016-20, Lawrence Livermore National Security, LLC +# Copyright (c) 2016-21, Lawrence Livermore National Security, LLC # and other RAJA project contributors. See the RAJA/COPYRIGHT file for details. # # SPDX-License-Identifier: (BSD-3-Clause) diff --git a/cmake/SetupCompilers.cmake b/cmake/SetupCompilers.cmake index eb9ec9d2f2..a76fd3d362 100644 --- a/cmake/SetupCompilers.cmake +++ b/cmake/SetupCompilers.cmake @@ -1,5 +1,5 @@ ############################################################################### -# Copyright (c) 2016-20, Lawrence Livermore National Security, LLC +# Copyright (c) 2016-21, Lawrence Livermore National Security, LLC # and other RAJA project contributors. See the RAJA/COPYRIGHT file for details. # # SPDX-License-Identifier: (BSD-3-Clause) diff --git a/cmake/SetupPackages.cmake b/cmake/SetupPackages.cmake index e466a379bf..8bf56b75f1 100644 --- a/cmake/SetupPackages.cmake +++ b/cmake/SetupPackages.cmake @@ -1,5 +1,5 @@ ############################################################################### -# Copyright (c) 2016-20, Lawrence Livermore National Security, LLC +# Copyright (c) 2016-21, Lawrence Livermore National Security, LLC # and other RAJA project contributors. See the RAJA/COPYRIGHT file for details. # # SPDX-License-Identifier: (BSD-3-Clause) @@ -27,4 +27,71 @@ if (ENABLE_TBB) message(WARNING "TBB NOT FOUND") set(ENABLE_TBB Off) endif() -endif () \ No newline at end of file +endif () + +if (ENABLE_CUDA OR ENABLE_EXTERNAL_CUB) + find_package(CUB) + if (CUB_FOUND) + set(ENABLE_EXTERNAL_CUB On) + blt_import_library( + NAME cub + INCLUDES ${CUB_INCLUDE_DIRS} + TREAT_INCLUDES_AS_SYSTEM ON + EXPORTABLE ON) + elseif(ENABLE_EXTERNAL_CUB) + message(FATAL_ERROR "External CUB not found, CUB_DIR=${CUB_DIR}.") + else() + message(STATUS "Using RAJA CUB submodule.") + endif() +endif () + +if (ENABLE_CUDA AND ENABLE_NV_TOOLS_EXT) + find_package(NvToolsExt) + if (NVTOOLSEXT_FOUND) + blt_import_library( NAME nvtoolsext + TREAT_INCLUDES_AS_SYSTEM ON + INCLUDES ${NVTOOLSEXT_INCLUDE_DIRS} + LIBRARIES ${NVTOOLSEXT_LIBRARY} + EXPORTABLE ON + ) + else() + message(FATAL_ERROR "NvToolsExt not found, NVTOOLSEXT_DIR=${NVTOOLSEXT_DIR}.") + endif() +endif () + +if (ENABLE_HIP OR ENABLE_EXTERNAL_ROCPRIM) + find_package(RocPRIM) + if (ROCPRIM_FOUND) + set(ENABLE_EXTERNAL_ROCPRIM On) + blt_import_library( + NAME rocPRIM + INCLUDES ${ROCPRIM_INCLUDE_DIRS} + TREAT_INCLUDES_AS_SYSTEM ON + EXPORTABLE ON) + elseif (ENABLE_EXTERNAL_ROCPRIM) + message(FATAL_ERROR "External rocPRIM not found, ROCPRIM_DIR=${ROCPRIM_DIR}.") + else() + message(STATUS "Using RAJA rocPRIM submodule.") + endif() +endif () + +set(TPL_DEPS) +blt_list_append(TO TPL_DEPS ELEMENTS cuda cuda_runtime IF ENABLE_CUDA) +blt_list_append(TO TPL_DEPS ELEMENTS nvtoolsext IF ENABLE_NV_TOOLS_EXT) +blt_list_append(TO TPL_DEPS ELEMENTS cub IF ENABLE_EXTERNAL_CUB) +blt_list_append(TO TPL_DEPS ELEMENTS hip hip_runtime IF ENABLE_HIP) +blt_list_append(TO TPL_DEPS ELEMENTS rocPRIM IF ENABLE_EXTERNAL_ROCPRIM) +blt_list_append(TO TPL_DEPS ELEMENTS openmp IF ENABLE_OPENMP) +blt_list_append(TO TPL_DEPS ELEMENTS mpi IF ENABLE_MPI) + +foreach(dep ${TPL_DEPS}) + # If the target is EXPORTABLE, add it to the export set + get_target_property(_is_imported ${dep} IMPORTED) + if(NOT ${_is_imported}) + install(TARGETS ${dep} + EXPORT RAJA + DESTINATION lib) + # Namespace target to avoid conflicts + set_target_properties(${dep} PROPERTIES EXPORT_NAME RAJA::${dep}) + endif() +endforeach() diff --git a/cmake/SetupRajaConfig.cmake b/cmake/SetupRajaConfig.cmake index 589ba2f84a..a3b3a21415 100644 --- a/cmake/SetupRajaConfig.cmake +++ b/cmake/SetupRajaConfig.cmake @@ -1,5 +1,5 @@ ############################################################################### -# Copyright (c) 2016-20, Lawrence Livermore National Security, LLC +# Copyright (c) 2016-21, Lawrence Livermore National Security, LLC # and other RAJA project contributors. See the RAJA/COPYRIGHT file for details. # # SPDX-License-Identifier: (BSD-3-Clause) @@ -59,8 +59,10 @@ set(RAJA_ENABLE_OPENMP ${ENABLE_OPENMP}) set(RAJA_ENABLE_TARGET_OPENMP ${ENABLE_TARGET_OPENMP}) set(RAJA_ENABLE_TBB ${ENABLE_TBB}) set(RAJA_ENABLE_CUDA ${ENABLE_CUDA}) +set(RAJA_ENABLE_NV_TOOLS_EXT ${ENABLE_NV_TOOLS_EXT}) set(RAJA_ENABLE_CLANG_CUDA ${ENABLE_CLANG_CUDA}) set(RAJA_ENABLE_HIP ${ENABLE_HIP}) +set(RAJA_ENABLE_SYCL ${ENABLE_SYCL}) set(RAJA_ENABLE_CUB ${ENABLE_CUB}) option(RAJA_ENABLE_HIP_INDIRECT_FUNCTION_CALL "Enable use of device function pointers in hip backend" OFF) @@ -71,7 +73,7 @@ configure_file(${PROJECT_SOURCE_DIR}/include/RAJA/config.hpp.in # Configure CMake config configure_file(${PROJECT_SOURCE_DIR}/share/raja/cmake/RAJA-config.cmake.in - ${PROJECT_BINARY_DIR}/share/raja/cmake/raja-config.cmake) + ${PROJECT_BINARY_DIR}/share/raja/cmake/raja-config.cmake @ONLY) install(FILES ${PROJECT_BINARY_DIR}/share/raja/cmake/raja-config.cmake DESTINATION share/raja/cmake/) @@ -86,6 +88,16 @@ if(PKG_CONFIG_FOUND) foreach(INCDIR ${INCLUDE_DIRECTORIES} ${CUDA_INCLUDE_DIRS}) set(PC_C_FLAGS "${PC_C_FLAGS} -I${INCDIR}") endforeach() + if(ENABLE_EXTERNAL_ROCPRIM) + foreach(INCDIR ${ROCPRIM_INCLUDE_DIRS}) + set(PC_C_FLAGS "${PC_C_FLAGS} -I${INCDIR}") + endforeach() + endif() + if(ENABLE_EXTERNAL_CUB) + foreach(INCDIR ${CUB_INCLUDE_DIRS}) + set(PC_C_FLAGS "${PC_C_FLAGS} -I${INCDIR}") + endforeach() + endif() if(ENABLE_CUDA) foreach(FLAG ${RAJA_NVCC_FLAGS}) set(PC_C_FLAGS "${PC_C_FLAGS} ${FLAG}") diff --git a/cmake/thirdparty/FindCUB.cmake b/cmake/thirdparty/FindCUB.cmake index 640b7c5fcb..106173ae10 100644 --- a/cmake/thirdparty/FindCUB.cmake +++ b/cmake/thirdparty/FindCUB.cmake @@ -1,5 +1,5 @@ ############################################################################### -# Copyright (c) 2016-20, Lawrence Livermore National Security, LLC +# Copyright (c) 2016-21, Lawrence Livermore National Security, LLC # and other RAJA project contributors. See the RAJA/COPYRIGHT file for details. # # SPDX-License-Identifier: (BSD-3-Clause) @@ -11,7 +11,8 @@ find_path(CUB_INCLUDE_DIRS NAMES cub/cub.cuh HINTS ${CUB_DIR}/ - ${CUB_DIR}/include) + ${CUB_DIR}/include + ${CUDA_TOOLKIT_ROOT_DIR}/include) find_package_handle_standard_args( CUB diff --git a/cmake/thirdparty/FindNvToolsExt.cmake b/cmake/thirdparty/FindNvToolsExt.cmake new file mode 100644 index 0000000000..1706859adb --- /dev/null +++ b/cmake/thirdparty/FindNvToolsExt.cmake @@ -0,0 +1,34 @@ +############################################################################### +# Copyright (c) 2016-21, Lawrence Livermore National Security, LLC +# and other RAJA project contributors. See the RAJA/COPYRIGHT file for details. +# +# SPDX-License-Identifier: (BSD-3-Clause) +############################################################################### + +############################################################################### +# +# Setup nvToolsExt +# This file defines: +# NVTOOLSEXT_FOUND - If nvToolsExt was found +# NVTOOLSEXT_INCLUDE_DIRS - The nvToolsExt include directories +# NVTOOLSEXT_LIBRARY - The nvToolsExt library + +# first Check for CUDA_TOOLKIT_ROOT_DIR +if(NOT CUDA_TOOLKIT_ROOT_DIR) + MESSAGE(FATAL_ERROR "Could not find NvToolsExt. NvToolsExt support needs explicit CUDA_TOOLKIT_ROOT_DIR") +endif() + +#find includes +find_path( NVTOOLSEXT_INCLUDE_DIRS nvToolsExt.h + HINTS ${CUDA_TOOLKIT_ROOT_DIR}/include ) + +find_library( NVTOOLSEXT_LIBRARY NAMES nvToolsExt libnvToolsExt + HINTS ${CUDA_TOOLKIT_ROOT_DIR}/lib ) + + +include(FindPackageHandleStandardArgs) +# handle the QUIETLY and REQUIRED arguments and set NVTOOLSEXT_FOUND to TRUE +# if all listed variables are TRUE +find_package_handle_standard_args(NVTOOLSEXT DEFAULT_MSG + NVTOOLSEXT_INCLUDE_DIRS + NVTOOLSEXT_LIBRARY ) \ No newline at end of file diff --git a/cmake/thirdparty/FindRocPRIM.cmake b/cmake/thirdparty/FindRocPRIM.cmake index 0723d98854..018dd0c531 100644 --- a/cmake/thirdparty/FindRocPRIM.cmake +++ b/cmake/thirdparty/FindRocPRIM.cmake @@ -1,5 +1,5 @@ ############################################################################### -# Copyright (c) 2016-20, Lawrence Livermore National Security, LLC +# Copyright (c) 2016-21, Lawrence Livermore National Security, LLC # and other RAJA project contributors. See the RAJA/COPYRIGHT file for details. # # SPDX-License-Identifier: (BSD-3-Clause) @@ -8,10 +8,14 @@ include (FindPackageHandleStandardArgs) find_path(ROCPRIM_INCLUDE_DIRS - NAMES rocPRIM/rocprim/include/rocprim + NAMES rocprim/rocprim.hpp HINTS ${ROCPRIM_DIR}/ - ${ROCPRIM_DIR}/include) + ${ROCPRIM_DIR}/include + ${ROCPRIM_DIR}/rocprim/include + ${HIP_ROOT_DIR}/../rocprim + ${HIP_ROOT_DIR}/../rocprim/include + ${HIP_ROOT_DIR}/../include) find_package_handle_standard_args( ROCPRIM diff --git a/cmake/thirdparty/FindSphinx.cmake b/cmake/thirdparty/FindSphinx.cmake index efdc42a4c6..a7555b43d6 100644 --- a/cmake/thirdparty/FindSphinx.cmake +++ b/cmake/thirdparty/FindSphinx.cmake @@ -1,5 +1,5 @@ ############################################################################### -# Copyright (c) 2016-20, Lawrence Livermore National Security, LLC +# Copyright (c) 2016-21, Lawrence Livermore National Security, LLC # and other RAJA project contributors. See the RAJA/COPYRIGHT file for details. # # SPDX-License-Identifier: (BSD-3-Clause) diff --git a/docker/Dockerfile b/docker/Dockerfile new file mode 100644 index 0000000000..f2c058bab5 --- /dev/null +++ b/docker/Dockerfile @@ -0,0 +1,23 @@ +############################################################################### +# Copyright (c) 2016-21, Lawrence Livermore National Security, LLC +# and RAJA project contributors. See the RAJA/COPYRIGHT file for details. +# +# SPDX-License-Identifier: (BSD-3-Clause) +############################################################################### + +# +#Builds and installs RAJA using the gcc8 compiler +# + +FROM rajaorg/compiler:gcc8 +MAINTAINER RAJA Development Team + +COPY --chown=raja:raja . /home/raja/workspace + +WORKDIR /home/raja/workspace + +RUN mkdir build && cd build && cmake -DENABLE_CUDA=OFF .. + +RUN cd build && sudo make -j 3 && sudo make install + +CMD ["bash"] diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt index 642e8db256..16d6f65ae6 100644 --- a/docs/CMakeLists.txt +++ b/docs/CMakeLists.txt @@ -1,21 +1,21 @@ ############################################################################### -# Copyright (c) 2016-20, Lawrence Livermore National Security, LLC +# Copyright (c) 2016-21, Lawrence Livermore National Security, LLC # and RAJA project contributors. See the RAJA/COPYRIGHT file for details. # # SPDX-License-Identifier: (BSD-3-Clause) ############################################################################### -add_custom_target(raja-docs) +if (ENABLE_DOCUMENTATION) + if (SPHINX_FOUND) + blt_add_sphinx_target( raja_docs ) + endif() -if (SPHINX_FOUND) - add_subdirectory(sphinx/user_guide) -endif() + if (DOXYGEN_FOUND) + add_subdirectory(doxygen) + endif() -if (DOXYGEN_FOUND) - add_subdirectory(doxygen) + if ( NOT SPHINX_FOUND AND NOT DOXGEN_FOUND) + message(WARNING "ENABLE_DOCUMENTATION=On, but Sphinx or Doxygen not found. \ + Documentation won't be built.") + endif () endif() - -if ( NOT SPHINX_FOUND AND NOT DOXGEN_FOUND) - message(WARNING "ENABLE_DOCUMENTATION=On, but Sphinx or Doxygen not found. \ - Documentation won't be built.") -endif () diff --git a/docs/sphinx/user_guide/conf.py b/docs/conf.py similarity index 87% rename from docs/sphinx/user_guide/conf.py rename to docs/conf.py index c68157ce6c..fd211f2b8a 100644 --- a/docs/sphinx/user_guide/conf.py +++ b/docs/conf.py @@ -19,12 +19,31 @@ # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. -sys.path.insert(0, os.path.abspath('_exts')) +#sys.path.insert(0, os.path.abspath('_exts')) -# Generate Doxygen on RTD +# Call doxygen in ReadtheDocs read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True' if read_the_docs_build: - subprocess.call('cd ../doxygen; cp Doxyfile.in Doxyfile; doxygen', shell=True) + # Makes sure directory exists for doxygen output + cwd=os.getcwd() + buildpath=os.path.join(cwd,"_build") + if (os.path.isdir(buildpath) == 0): + os.mkdir(buildpath) + htmlpath=os.path.join(buildpath,"html") + if (os.path.isdir(htmlpath) == 0): + os.mkdir(htmlpath) + + # Call doxygen + from subprocess import call + call(['doxygen', "./doxygen/Doxyfile"]) + +# Get current directory +conf_directory = os.path.dirname(os.path.realpath(__file__)) + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) # -- General configuration ------------------------------------------------ @@ -43,7 +62,7 @@ ] # Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +templates_path = [os.path.join(conf_directory, 'sphinx/_templates')] # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: @@ -58,17 +77,16 @@ # General information about the project. project = u'RAJA' -copyright = u'2016-2020' -author = u'LLNS' +copyright = u'2016-2021, Lawrence Livermore National Security, LLNS' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. -version = u'0.13' +version = u'0.14' # The full version, including alpha/beta/rc tags. -release = u'0.13.0' +release = u'0.14.0' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -117,6 +135,8 @@ # -- Options for HTML output ---------------------------------------------- +# The theme to use for HTML and HTML help pages. See the documentation for +# list of built-in themes. try: import sphinx_rtd_theme except: @@ -162,12 +182,12 @@ # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +html_static_path = [os.path.join(conf_directory, 'sphinx/_static')] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied # directly to the root of the documentation. -html_extra_path = ['../doxygen/build/html'] +#html_extra_path = # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. @@ -248,7 +268,7 @@ # author, documentclass [howto, manual, or own class]). latex_documents = [ (master_doc, 'RAJA.tex', u'RAJA Documentation', - author, 'manual'), + u'LLNL', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of @@ -278,7 +298,7 @@ # (source start file, name, description, authors, manual section). man_pages = [ (master_doc, 'raja', u'RAJA Documentation', - [author], 1) + [u'RAJA Team'], 1) ] # If true, show URL addresses after external links. @@ -292,7 +312,7 @@ # dir menu entry, description, category) texinfo_documents = [ (master_doc, 'RAJA', u'RAJA Documentation', - author, 'RAJA', 'Performance Portability for HPC Simulations', + 'RAJA Team', 'RAJA', 'Performance Portability for HPC Simulations', 'Miscellaneous'), ] @@ -307,5 +327,3 @@ # If true, do not generate a @detailmenu in the "Top" node's menu. #texinfo_no_detailmenu = False - -# diff --git a/docs/doxygen/CMakeLists.txt b/docs/doxygen/CMakeLists.txt index 2c83933591..fd6e4d4519 100644 --- a/docs/doxygen/CMakeLists.txt +++ b/docs/doxygen/CMakeLists.txt @@ -1,25 +1,23 @@ ############################################################################### -# Copyright (c) 2016-20, Lawrence Livermore National Security, LLC +# Copyright (c) 2016-21, Lawrence Livermore National Security, LLC # and other RAJA project contributors. See the RAJA/COPYRIGHT file for details. # # SPDX-License-Identifier: (BSD-3-Clause) ############################################################################### -set(DOXYGEN_BUILD_DIR "${CMAKE_CURRENT_BINARY_DIR}/_build") -set(DOXYGEN_HTML_DIR "${CMAKE_CURRENT_BINARY_DIR}/html") +#------------------------------------------------------------------------------ +# Doxygen documentation targets +#------------------------------------------------------------------------------ -configure_file( - ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in - ${DOXYGEN_BUILD_DIR}/Doxyfile - @ONLY) +blt_add_doxygen_target( raja_doxygen ) -add_custom_target(raja-doxygen - ${DOXYGEN_EXECUTABLE} - ${DOXYGEN_BUILD_DIR}/Doxyfile - COMMENT "Building API documentation with Doxygen") +# Required directory for doxygen to generate output to +add_custom_target( build_doxygen_output_dir + ALL + COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_BINARY_DIR}/html + ) -install(DIRECTORY ${DOXYGEN_HTML_DIR} - DESTINATION "docs/doxygen/" OPTIONAL) +add_dependencies( raja_doxygen build_doxygen_output_dir ) -add_dependencies(raja-docs - raja-doxygen) +add_dependencies(raja_docs + raja_doxygen) diff --git a/docs/doxygen/Doxyfile b/docs/doxygen/Doxyfile new file mode 100644 index 0000000000..74811a99bf --- /dev/null +++ b/docs/doxygen/Doxyfile @@ -0,0 +1,2389 @@ +############################################################################### +# Copyright (c) 2016-21, Lawrence Livermore National Security, LLC +# and other RAJA project contributors. See the RAJA/COPYRIGHT file for details. +# +# SPDX-License-Identifier: (BSD-3-Clause) +############################################################################### + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +PROJECT_NAME = RAJA +PROJECT_NUMBER = +PROJECT_BRIEF = "RAJA provides a collection of platform portability abstractions for C++ HPC applications." +PROJECT_LOGO = +OUTPUT_DIRECTORY = ./_build/html/doxygen +CREATE_SUBDIRS = NO +ALLOW_UNICODE_NAMES = NO + +OUTPUT_LANGUAGE = English + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), VHDL. For +# instance to make doxygen treat .inc files as Fortran files (default is PHP), +# and .f files as C (default is Fortran), use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 0. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 0 + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO, these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES, upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = NO + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = dox.warnings + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = ../src \ + ../include + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, +# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, +# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.C \ + *.cpp \ + *.c++ \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.idl \ + *.ddl \ + *.odl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.cs \ + *.d \ + *.php \ + *.php4 \ + *.php5 \ + *.phtml \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.pyw \ + *.f90 \ + *.f95 \ + *.f03 \ + *.f08 \ + *.f \ + *.for \ + *.tcl \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the master .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /