diff --git a/cmake/std/atdm/contributed/weaver/environment.sh b/cmake/std/atdm/contributed/weaver/environment.sh index 897711ef1e62..388abfb4c58f 100755 --- a/cmake/std/atdm/contributed/weaver/environment.sh +++ b/cmake/std/atdm/contributed/weaver/environment.sh @@ -177,7 +177,7 @@ elif [[ "$ATDM_CONFIG_COMPILER" == "CUDA"* ]] ; then fi # Ninja -module load ninja/1.7.2 +#module load ninja/1.7.2 # CMake #module swap cmake/3.6.2 cmake/3.12.3 diff --git a/packages/amesos2/src/Amesos2_MatrixAdapter_def.hpp b/packages/amesos2/src/Amesos2_MatrixAdapter_def.hpp index 84fe54e163bb..4cb885a92c98 100644 --- a/packages/amesos2/src/Amesos2_MatrixAdapter_def.hpp +++ b/packages/amesos2/src/Amesos2_MatrixAdapter_def.hpp @@ -52,6 +52,7 @@ #define TESTING_AMESOS2_WITH_TPETRA_REMOVE_UVM #if defined(TESTING_AMESOS2_WITH_TPETRA_REMOVE_UVM) #include "KokkosKernels_SparseUtils.hpp" +#include "KokkosKernels_Sorting.hpp" #endif namespace Amesos2 { @@ -608,7 +609,7 @@ namespace Amesos2 { // sort if( ordering == SORTED_INDICES ) { using execution_space = typename KV_GS::execution_space; - KokkosKernels::Impl::sort_crs_matrix + KokkosKernels::sort_crs_matrix (rowptr, colind, nzval); } #endif diff --git a/packages/amesos2/src/Amesos2_Superlu_def.hpp b/packages/amesos2/src/Amesos2_Superlu_def.hpp index 5af71193dffa..14b58f1e71a5 100644 --- a/packages/amesos2/src/Amesos2_Superlu_def.hpp +++ b/packages/amesos2/src/Amesos2_Superlu_def.hpp @@ -1060,7 +1060,6 @@ Superlu::triangular_solve_factor() if (data_.options.ConditionNumber == SLU::YES) { using STM = Teuchos::ScalarTraits; const magnitude_type eps = STM::eps (); - int n = data_.perm_r.extent(0); SCformat *Lstore = (SCformat*)(data_.L.Store); int nsuper = 1 + Lstore->nsuper; @@ -1077,6 +1076,7 @@ Superlu::triangular_solve_factor() condition_flag = (((double)max_cols * nsuper) * eps * multiply_fact >= data_.rcond); #ifdef HAVE_AMESOS2_VERBOSE_DEBUG + int n = data_.perm_r.extent(0); std::cout << this->getComm()->getRank() << " : anorm = " << data_.anorm << ", rcond = " << data_.rcond << ", n = " << n << ", num super cols = " << nsuper << ", max super cols = " << max_cols diff --git a/packages/ifpack2/src/Ifpack2_BlockTriDiContainer_impl.hpp b/packages/ifpack2/src/Ifpack2_BlockTriDiContainer_impl.hpp index 73790de2bf78..dd5db17ab029 100644 --- a/packages/ifpack2/src/Ifpack2_BlockTriDiContainer_impl.hpp +++ b/packages/ifpack2/src/Ifpack2_BlockTriDiContainer_impl.hpp @@ -315,10 +315,10 @@ namespace Ifpack2 { #if defined(KOKKOS_ENABLE_CUDA) && defined(IFPACK2_BLOCKTRIDICONTAINER_ENABLE_PROFILE) #define IFPACK2_BLOCKTRIDICONTAINER_PROFILER_REGION_BEGIN \ - CUDA_SAFE_CALL(cudaProfilerStart()); + KOKKOS_IMPL_CUDA_SAFE_CALL(cudaProfilerStart()); #define IFPACK2_BLOCKTRIDICONTAINER_PROFILER_REGION_END \ - { CUDA_SAFE_CALL( cudaProfilerStop() ); } + { KOKKOS_IMPL_CUDA_SAFE_CALL( cudaProfilerStop() ); } #else /// later put vtune profiler region #define IFPACK2_BLOCKTRIDICONTAINER_PROFILER_REGION_BEGIN @@ -676,7 +676,7 @@ namespace Ifpack2 { exec_instances.clear(); exec_instances.resize(num_streams); for (local_ordinal_type i=0;i::createInstance(stream[i], exec_instances[i]); } } @@ -688,7 +688,7 @@ namespace Ifpack2 { { const local_ordinal_type num_streams = stream.size(); for (local_ordinal_type i=0;i -#include +#include #include #include "Teuchos_TimeMonitor.hpp" @@ -164,7 +164,7 @@ initialize() { throw std::runtime_error(std::string("Called ") + getName() + "::initialize() but matrix was null (call setMatrix() with a non-null matrix first)"); } - Kokkos::Impl::Timer copyTimer; + Kokkos::Timer copyTimer; CrsArrayReader::getStructure(mat_.get(), localRowPtrsHost_, localRowPtrs_, localColInds_); crsCopyTime_ = copyTimer.seconds(); initLocalPrec(); //note: initLocalPrec updates initTime @@ -196,7 +196,7 @@ compute() //get copy of values array from matrix - Kokkos::Impl::Timer copyTimer; + Kokkos::Timer copyTimer; CrsArrayReader::getValues(mat_.get(), localValues_, localRowPtrsHost_); crsCopyTime_ += copyTimer.seconds(); //add to the time spent getting rowptrs/colinds computeLocalPrec(); //this updates computeTime_ diff --git a/packages/ifpack2/src/Ifpack2_Details_Fic_def.hpp b/packages/ifpack2/src/Ifpack2_Details_Fic_def.hpp index 578f188b8b52..ea43f0438462 100644 --- a/packages/ifpack2/src/Ifpack2_Details_Fic_def.hpp +++ b/packages/ifpack2/src/Ifpack2_Details_Fic_def.hpp @@ -47,7 +47,7 @@ #include "Ifpack2_Details_Fic_decl.hpp" #include "Ifpack2_Details_CrsArrays.hpp" -#include +#include #include namespace Ifpack2 diff --git a/packages/ifpack2/src/Ifpack2_Details_Fildl_def.hpp b/packages/ifpack2/src/Ifpack2_Details_Fildl_def.hpp index 89428adf81d2..f34c588a3417 100644 --- a/packages/ifpack2/src/Ifpack2_Details_Fildl_def.hpp +++ b/packages/ifpack2/src/Ifpack2_Details_Fildl_def.hpp @@ -47,7 +47,7 @@ #include "Ifpack2_Details_Fildl_decl.hpp" #include "Ifpack2_Details_CrsArrays.hpp" -#include +#include #include namespace Ifpack2 diff --git a/packages/ifpack2/src/Ifpack2_Details_Filu_def.hpp b/packages/ifpack2/src/Ifpack2_Details_Filu_def.hpp index 2576b32a91bd..1c6cb3b4fb2b 100644 --- a/packages/ifpack2/src/Ifpack2_Details_Filu_def.hpp +++ b/packages/ifpack2/src/Ifpack2_Details_Filu_def.hpp @@ -47,7 +47,7 @@ #include "Ifpack2_Details_Filu_decl.hpp" #include "Ifpack2_Details_CrsArrays.hpp" -#include +#include #include namespace Ifpack2 diff --git a/packages/intrepid2/perf-test/ComputeBasis/Cuda/test_hgrad.cpp b/packages/intrepid2/perf-test/ComputeBasis/Cuda/test_hgrad.cpp index d546ecd70650..b95bee32b7ba 100644 --- a/packages/intrepid2/perf-test/ComputeBasis/Cuda/test_hgrad.cpp +++ b/packages/intrepid2/perf-test/ComputeBasis/Cuda/test_hgrad.cpp @@ -48,7 +48,7 @@ #include #include "Kokkos_Core.hpp" -#include +#include #include "Teuchos_CommandLineProcessor.hpp" diff --git a/packages/intrepid2/perf-test/ComputeBasis/OpenMP/test_hgrad.cpp b/packages/intrepid2/perf-test/ComputeBasis/OpenMP/test_hgrad.cpp index a20f5cbe6290..5c519082b500 100644 --- a/packages/intrepid2/perf-test/ComputeBasis/OpenMP/test_hgrad.cpp +++ b/packages/intrepid2/perf-test/ComputeBasis/OpenMP/test_hgrad.cpp @@ -48,7 +48,7 @@ #include #include "Kokkos_Core.hpp" -#include +#include #include "Teuchos_CommandLineProcessor.hpp" diff --git a/packages/intrepid2/perf-test/ComputeBasis/Serial/test_hgrad.cpp b/packages/intrepid2/perf-test/ComputeBasis/Serial/test_hgrad.cpp index f8c74d46b5e7..267698c9acd5 100644 --- a/packages/intrepid2/perf-test/ComputeBasis/Serial/test_hgrad.cpp +++ b/packages/intrepid2/perf-test/ComputeBasis/Serial/test_hgrad.cpp @@ -48,7 +48,7 @@ #include #include "Kokkos_Core.hpp" -#include +#include #include "Teuchos_CommandLineProcessor.hpp" diff --git a/packages/intrepid2/perf-test/ComputeBasis/test_hgrad.hpp b/packages/intrepid2/perf-test/ComputeBasis/test_hgrad.hpp index a124196a9234..16186f06bbb0 100644 --- a/packages/intrepid2/perf-test/ComputeBasis/test_hgrad.hpp +++ b/packages/intrepid2/perf-test/ComputeBasis/test_hgrad.hpp @@ -100,7 +100,7 @@ namespace Intrepid2 { constexpr size_t LLC_CAPACITY = 32*1024*1024; Intrepid2::Test::Flush flush; - Kokkos::Impl::Timer timer; + Kokkos::Timer timer; double t_horizontal = 0, t_vertical = 0; int errorFlag = 0; @@ -210,8 +210,8 @@ namespace Intrepid2 { typedef F_hgrad_eval FunctorType; - using range_policy_type = Kokkos::Experimental::MDRangePolicy - < DeviceSpaceType, Kokkos::Experimental::Rank<2>, Kokkos::IndexType >; + using range_policy_type = Kokkos::MDRangePolicy + < DeviceSpaceType, Kokkos::Rank<2>, Kokkos::IndexType >; range_policy_type policy( { 0, 0 }, { numCells, numPoints } ); diff --git a/packages/intrepid2/perf-test/ComputeBasis/test_hgrad_vector.hpp b/packages/intrepid2/perf-test/ComputeBasis/test_hgrad_vector.hpp index 7a657389a828..f24dc63375ab 100644 --- a/packages/intrepid2/perf-test/ComputeBasis/test_hgrad_vector.hpp +++ b/packages/intrepid2/perf-test/ComputeBasis/test_hgrad_vector.hpp @@ -105,7 +105,7 @@ namespace Intrepid2 { constexpr size_t LLC_CAPACITY = 32*1024*1024; Intrepid2::Test::Flush flush; - Kokkos::Impl::Timer timer; + Kokkos::Timer timer; double t_vectorize = 0; int errorFlag = 0; @@ -173,8 +173,8 @@ namespace Intrepid2 { typedef F_hgrad_eval FunctorType; - using range_policy_type = Kokkos::Experimental::MDRangePolicy - < DeviceSpaceType, Kokkos::Experimental::Rank<2>, Kokkos::IndexType >; + using range_policy_type = Kokkos::MDRangePolicy + < DeviceSpaceType, Kokkos::Rank<2>, Kokkos::IndexType >; range_policy_type policy( { 0, 0 }, { numCellsAdjusted, numPoints } ); diff --git a/packages/intrepid2/perf-test/DynRankView/Cuda/test_01.cpp b/packages/intrepid2/perf-test/DynRankView/Cuda/test_01.cpp index 3153701d4989..34906730acc4 100644 --- a/packages/intrepid2/perf-test/DynRankView/Cuda/test_01.cpp +++ b/packages/intrepid2/perf-test/DynRankView/Cuda/test_01.cpp @@ -46,7 +46,7 @@ */ #include "Kokkos_Core.hpp" -#include +#include #include "Teuchos_CommandLineProcessor.hpp" diff --git a/packages/intrepid2/perf-test/DynRankView/OpenMP/test_01.cpp b/packages/intrepid2/perf-test/DynRankView/OpenMP/test_01.cpp index 6d495563ca66..815eb62d1277 100644 --- a/packages/intrepid2/perf-test/DynRankView/OpenMP/test_01.cpp +++ b/packages/intrepid2/perf-test/DynRankView/OpenMP/test_01.cpp @@ -46,7 +46,7 @@ */ #include "Kokkos_Core.hpp" -#include +#include #include "Teuchos_CommandLineProcessor.hpp" diff --git a/packages/intrepid2/perf-test/DynRankView/Serial/test_01.cpp b/packages/intrepid2/perf-test/DynRankView/Serial/test_01.cpp index 94d154596a4a..c35c074d04fc 100644 --- a/packages/intrepid2/perf-test/DynRankView/Serial/test_01.cpp +++ b/packages/intrepid2/perf-test/DynRankView/Serial/test_01.cpp @@ -46,7 +46,7 @@ */ #include "Kokkos_Core.hpp" -#include +#include #include "Teuchos_CommandLineProcessor.hpp" diff --git a/packages/intrepid2/perf-test/DynRankView/Serial/test_02.cpp b/packages/intrepid2/perf-test/DynRankView/Serial/test_02.cpp index 12b887f10810..0e41ada32299 100644 --- a/packages/intrepid2/perf-test/DynRankView/Serial/test_02.cpp +++ b/packages/intrepid2/perf-test/DynRankView/Serial/test_02.cpp @@ -46,7 +46,7 @@ */ #include "Kokkos_Core.hpp" -#include +#include #include "Teuchos_CommandLineProcessor.hpp" diff --git a/packages/intrepid2/perf-test/DynRankView/test_01.hpp b/packages/intrepid2/perf-test/DynRankView/test_01.hpp index b73baf402f99..08f0676c4510 100644 --- a/packages/intrepid2/perf-test/DynRankView/test_01.hpp +++ b/packages/intrepid2/perf-test/DynRankView/test_01.hpp @@ -162,7 +162,7 @@ namespace Intrepid2 { << " Test Array Structure (C,P,D) = " << C << ", " << P << ", " << D << "\n" << "===============================================================================\n"; - Kokkos::Impl::Timer timer; + Kokkos::Timer timer; double t_dynrankview[20] = {}, t_view[20] = {}; int errorFlag = 0, itest = 0; diff --git a/packages/intrepid2/perf-test/DynRankView/test_02.hpp b/packages/intrepid2/perf-test/DynRankView/test_02.hpp index ea573bfc109b..d71b6965fbdb 100644 --- a/packages/intrepid2/perf-test/DynRankView/test_02.hpp +++ b/packages/intrepid2/perf-test/DynRankView/test_02.hpp @@ -159,7 +159,7 @@ namespace Intrepid2 { << " Test Array Structure (C,P,D) = " << C << ", " << P << ", " << D << "\n" << "===============================================================================\n"; - Kokkos::Impl::Timer timer; + Kokkos::Timer timer; double t_without_subview[20] = {}, t_with_subview[20] = {}; int errorFlag = 0, itest = 0; diff --git a/packages/intrepid2/perf-test/test_util.hpp b/packages/intrepid2/perf-test/test_util.hpp index cbe840de3b58..46b5fa4d1597 100644 --- a/packages/intrepid2/perf-test/test_util.hpp +++ b/packages/intrepid2/perf-test/test_util.hpp @@ -45,7 +45,7 @@ \author Created by Kyungjoo Kim. */ #include "Kokkos_Core.hpp" -#include +#include namespace Intrepid2 { diff --git a/packages/intrepid2/src/Cell/Intrepid2_CellToolsDefJacobian.hpp b/packages/intrepid2/src/Cell/Intrepid2_CellToolsDefJacobian.hpp index b5371ac9ce59..9f0c32423b5b 100644 --- a/packages/intrepid2/src/Cell/Intrepid2_CellToolsDefJacobian.hpp +++ b/packages/intrepid2/src/Cell/Intrepid2_CellToolsDefJacobian.hpp @@ -805,8 +805,8 @@ namespace Intrepid2 { // resolve the -1 default argument for endCell into the true end cell index int endCellResolved = (endCell == -1) ? worksetCell.extent_int(0) : endCell; - using range_policy_type = Kokkos::Experimental::MDRangePolicy - < ExecSpaceType, Kokkos::Experimental::Rank<2>, Kokkos::IndexType >; + using range_policy_type = Kokkos::MDRangePolicy + < ExecSpaceType, Kokkos::Rank<2>, Kokkos::IndexType >; range_policy_type policy( { 0, 0 }, { jacobian.extent(0), jacobian.extent(1) } ); Kokkos::parallel_for( policy, FunctorType(jacobian, worksetCell, gradients, startCell, endCellResolved) ); diff --git a/packages/intrepid2/src/Discretization/FunctionSpaceTools/Intrepid2_FunctionSpaceToolsDef.hpp b/packages/intrepid2/src/Discretization/FunctionSpaceTools/Intrepid2_FunctionSpaceToolsDef.hpp index 56ec1249785d..465225c464cd 100644 --- a/packages/intrepid2/src/Discretization/FunctionSpaceTools/Intrepid2_FunctionSpaceToolsDef.hpp +++ b/packages/intrepid2/src/Discretization/FunctionSpaceTools/Intrepid2_FunctionSpaceToolsDef.hpp @@ -142,8 +142,8 @@ namespace Intrepid2 { // F = outputVals.extent(1), // P = outputVals.extent(2); - // using range_policy_type = Kokkos::Experimental::MDRangePolicy - // < DeviceType, Kokkos::Experimental::Rank<3>, Kokkos::IndexType >; + // using range_policy_type = Kokkos::MDRangePolicy + // < DeviceType, Kokkos::Rank<3>, Kokkos::IndexType >; // range_policy_type policy( { 0, 0, 0 }, // { C, F, P } ); diff --git a/packages/intrepid2/src/Shared/Intrepid2_ArrayToolsDefTensor.hpp b/packages/intrepid2/src/Shared/Intrepid2_ArrayToolsDefTensor.hpp index 571b752fbecb..922aa506aba7 100644 --- a/packages/intrepid2/src/Shared/Intrepid2_ArrayToolsDefTensor.hpp +++ b/packages/intrepid2/src/Shared/Intrepid2_ArrayToolsDefTensor.hpp @@ -793,14 +793,14 @@ namespace Intrepid2 { typedef FunctorArrayTools::F_matvecProduct FunctorType; if (hasField) { - using range_policy_type = Kokkos::Experimental::MDRangePolicy - < ExecSpaceType, Kokkos::Experimental::Rank<3>, Kokkos::IndexType >; + using range_policy_type = Kokkos::MDRangePolicy + < ExecSpaceType, Kokkos::Rank<3>, Kokkos::IndexType >; range_policy_type policy( { 0, 0, 0 }, { output.extent(0), output.extent(1), output.extent(2) } ); Kokkos::parallel_for( policy, FunctorType(output, leftInput, rightInput, isTranspose) ); } else { - using range_policy_type = Kokkos::Experimental::MDRangePolicy - < ExecSpaceType, Kokkos::Experimental::Rank<2>, Kokkos::IndexType >; + using range_policy_type = Kokkos::MDRangePolicy + < ExecSpaceType, Kokkos::Rank<2>, Kokkos::IndexType >; range_policy_type policy( { 0, 0 }, { output.extent(0), output.extent(1) } ); Kokkos::parallel_for( policy, FunctorType(output, leftInput, rightInput, isTranspose) ); diff --git a/packages/intrepid2/src/Shared/Intrepid2_Data.hpp b/packages/intrepid2/src/Shared/Intrepid2_Data.hpp index a33cf77e6f0a..4c626f897b1c 100644 --- a/packages/intrepid2/src/Shared/Intrepid2_Data.hpp +++ b/packages/intrepid2/src/Shared/Intrepid2_Data.hpp @@ -1655,6 +1655,21 @@ class ZeroView { //! Copies 0.0 to the underlying View. void clear() const { +#ifdef KOKKOS_COMPILER_INTEL +// Workaround intel internal compiler errors + DataScalar zero = DataScalar(0); + switch (dataRank_) + { + case 1: {Kokkos::parallel_for(Kokkos::RangePolicy(0, data1_.extent_int(0)), KOKKOS_LAMBDA(int i) {data1_(i) = zero;}); break; } + case 2: {Kokkos::parallel_for(Kokkos::MDRangePolicy, execution_space>({0,0},{data2_.extent_int(0),data2_.extent_int(1)}), KOKKOS_LAMBDA(int i0, int i1) {data2_(i0, i1) = zero;}); break; } + case 3: {Kokkos::parallel_for(Kokkos::MDRangePolicy, execution_space>({0,0,0},{data3_.extent_int(0),data3_.extent_int(1),data3_.extent_int(2)}), KOKKOS_LAMBDA(int i0, int i1, int i2) {data3_(i0, i1, i2) = zero;}); break; } + case 4: {Kokkos::parallel_for(Kokkos::MDRangePolicy, execution_space>({0,0,0,0},{data4_.extent_int(0),data4_.extent_int(1),data4_.extent_int(2),data4_.extent_int(3)}), KOKKOS_LAMBDA(int i0, int i1, int i2, int i3) {data4_(i0, i1, i2, i3) = zero;}); break; } + case 5: {Kokkos::parallel_for(Kokkos::MDRangePolicy, execution_space>({0,0,0,0,0},{data5_.extent_int(0),data5_.extent_int(1),data5_.extent_int(2),data5_.extent_int(3),data5_.extent_int(4)}), KOKKOS_LAMBDA(int i0, int i1, int i2, int i3, int i4) {data5_(i0, i1, i2, i3, i4) = zero;}); break; } + case 6: {Kokkos::parallel_for(Kokkos::MDRangePolicy, execution_space>({0,0,0,0,0,0},{data6_.extent_int(0),data6_.extent_int(1),data6_.extent_int(2),data6_.extent_int(3),data6_.extent_int(4),data6_.extent_int(5)}), KOKKOS_LAMBDA(int i0, int i1, int i2, int i3, int i4, int i5) {data6_(i0, i1, i2, i3, i4, i5) = zero;}); break; } + case 7: {Kokkos::parallel_for(Kokkos::MDRangePolicy, execution_space>({0,0,0,0,0,0},{data7_.extent_int(0),data7_.extent_int(1),data7_.extent_int(2),data7_.extent_int(3),data7_.extent_int(4),data7_.extent_int(5)}), KOKKOS_LAMBDA(int i0, int i1, int i2, int i3, int i4, int i5 ) {for (int i6 = 0; i6 < data7_.extent_int(6); ++i6) data7_(i0, i1, i2, i3, i4, i5, i6) = zero;}); break; } + default: INTREPID2_TEST_FOR_EXCEPTION(true, std::invalid_argument, "Invalid data rank"); + } +#else switch (dataRank_) { case 1: Kokkos::deep_copy(data1_, 0.0); break; @@ -1666,6 +1681,7 @@ class ZeroView { case 7: Kokkos::deep_copy(data7_, 0.0); break; default: INTREPID2_TEST_FOR_EXCEPTION(true, std::invalid_argument, "Invalid data rank"); } +#endif } //! Copies from the provided DynRankView into the underlying Kokkos::View container storing the unique data. diff --git a/packages/intrepid2/src/Shared/Intrepid2_PointToolsDef.hpp b/packages/intrepid2/src/Shared/Intrepid2_PointToolsDef.hpp index 86ff6541142e..708f60c02ddc 100644 --- a/packages/intrepid2/src/Shared/Intrepid2_PointToolsDef.hpp +++ b/packages/intrepid2/src/Shared/Intrepid2_PointToolsDef.hpp @@ -321,7 +321,9 @@ getWarpBlendLatticeLine( Kokkos::DynRankView(zHost.data() + offset, np-offset); - Kokkos::deep_copy(pts, z); + const auto common_range = range_type(0, std::min(pts.extent(0), z.extent(0))); + Kokkos::deep_copy(Kokkos::subview(pts, common_range), + Kokkos::subview(z, common_range)); } } diff --git a/packages/kokkos-kernels/.jenkins/nightly.groovy b/packages/kokkos-kernels/.jenkins/nightly.groovy index 41e4daf71e79..e98b34001c86 100644 --- a/packages/kokkos-kernels/.jenkins/nightly.groovy +++ b/packages/kokkos-kernels/.jenkins/nightly.groovy @@ -2,12 +2,12 @@ pipeline { agent none stages { - stage('HIP-ROCm-3.10-C++14') { + stage('HIP-ROCm-4.2-C++14') { agent { dockerfile { filename 'Dockerfile.hip' dir 'scripts/docker' - additionalBuildArgs '--build-arg BASE=rocm/dev-ubuntu-20.04:3.10' + additionalBuildArgs '--build-arg BASE=rocm/dev-ubuntu-20.04:4.2' label 'rocm-docker && vega' args '-v /tmp/ccache.kokkos:/tmp/ccache --device=/dev/kfd --device=/dev/dri --security-opt seccomp=unconfined --group-add video --env HIP_VISIBLE_DEVICES=$HIP_VISIBLE_DEVICES' } @@ -18,8 +18,8 @@ pipeline { mkdir build && cd build && \ cmake \ -DCMAKE_CXX_COMPILER=hipcc \ + -DCMAKE_CXX_EXTENSIONS=OFF \ -DKokkos_ENABLE_HIP=ON \ - -DKokkos_ARCH_VEGA906=ON \ .. && \ make -j8 && make install && \ cd ../.. && rm -rf kokkos''' @@ -27,9 +27,9 @@ pipeline { cmake \ -DCMAKE_BUILD_TYPE=RelWithDebInfo \ -DCMAKE_CXX_COMPILER=hipcc \ + -DCMAKE_CXX_EXTENSIONS=OFF \ -DKokkosKernels_ENABLE_TESTS=ON \ -DKokkosKernels_ENABLE_EXAMPLES=ON \ - -DKokkos_ENABLE_HIP=ON \ -DKokkosKernels_INST_DOUBLE=ON \ -DKokkosKernels_INST_ORDINAL_INT=ON \ -DKokkosKernels_INST_OFFSET_INT=ON \ diff --git a/packages/kokkos-kernels/BUILD.md b/packages/kokkos-kernels/BUILD.md index 023cf96f4e77..e86228529b6c 100644 --- a/packages/kokkos-kernels/BUILD.md +++ b/packages/kokkos-kernels/BUILD.md @@ -149,6 +149,9 @@ endif() * KokkosKernels_ENABLE_TESTS: BOOL * Whether to build tests. * Default: OFF +* KokkosKernels_ENABLE_DOCS: BOOL + * Whether to build docs. + * Default: OFF * KokkosKernels_ENABLE_TPL_BLAS: BOOL * Whether to enable BLAS * Default: OFF diff --git a/packages/kokkos-kernels/CHANGELOG.md b/packages/kokkos-kernels/CHANGELOG.md index 4326f3ee5f19..76de9db0d07a 100644 --- a/packages/kokkos-kernels/CHANGELOG.md +++ b/packages/kokkos-kernels/CHANGELOG.md @@ -1,5 +1,95 @@ # Change Log +## [3.5.00](https://github.com/kokkos/kokkos-kernels/tree/3.5.00) (2021-10-19) +[Full Changelog](https://github.com/kokkos/kokkos-kernels/compare/3.4.01...3.5.00) + +**Features:** +- Batched serial SVD [\#1107](https://github.com/kokkos/kokkos-kernels/pull/1107) +- Batched: Add BatchedDblBufGemm [\#1095](https://github.com/kokkos/kokkos-kernels/pull/1095) +- feature/gemv rps test -- RAJAPerf Suite Version of the BLAS2 GEMV Test [\#1085](https://github.com/kokkos/kokkos-kernels/pull/1085) +- Add new bsrmatrix [\#1077](https://github.com/kokkos/kokkos-kernels/pull/1077) +- Adding Kokkos GMRES example [\#1028](https://github.com/kokkos/kokkos-kernels/pull/1028) +- Add fast two-level mode N GEMV (#926) [\#939](https://github.com/kokkos/kokkos-kernels/pull/939) +- Batched: Add BatchedGemm interface [\#935](https://github.com/kokkos/kokkos-kernels/pull/935) +- OpenMPTarget: adding ETI and CMake logic for OpenMPTarget backend [\#886](https://github.com/kokkos/kokkos-kernels/pull/886) + +**Implemented enhancements Algorithms and Archs:** +- Use float as accumulator for GEMV on half_t (Fix #1081) [\#1082](https://github.com/kokkos/kokkos-kernels/pull/1082) +- Supernodal SpTRSV: add option to use MAGMA TPL for TRTRI [\#1069](https://github.com/kokkos/kokkos-kernels/pull/1069) +- Updates for running GMRES example with half precision [\#1067](https://github.com/kokkos/kokkos-kernels/pull/1067) +- src/blas/impl: Explicitly cast to LHS type for ax [\#1073](https://github.com/kokkos/kokkos-kernels/pull/1073) +- Update BatchedGemm interface to match design proposal [\#1054](https://github.com/kokkos/kokkos-kernels/pull/1054) +- Move dot-based GEMM out of TPL CUBLAS [\#1050](https://github.com/kokkos/kokkos-kernels/pull/1050) +- Adding ArmPL option to spmv perf_test [\#1038](https://github.com/kokkos/kokkos-kernels/pull/1038) +- Add (right) preconditioning to GMRES [\#1078](https://github.com/kokkos/kokkos-kernels/pull/1078) +- Supernodal SpTRSV: perform TRMM only if TPL CuBLAS is enabled [\#1027](https://github.com/kokkos/kokkos-kernels/pull/1027) +- Supernodal SpTRSV: support SuperLU version < 5 [\#1012](https://github.com/kokkos/kokkos-kernels/pull/1012) +- perf_test/blas/blas3: Add dgemm armpl experiment [\#1005](https://github.com/kokkos/kokkos-kernels/pull/1005) +- Supernodal SpTRSV: run TRMM on device for setup [\#983](https://github.com/kokkos/kokkos-kernels/pull/983) +- Merge pull request #951 from vqd8a/move_sort_ifpack2riluk [\#972](https://github.com/kokkos/kokkos-kernels/pull/972) +- Point multicolor GS: faster handling of long/bulk rows [\#993](https://github.com/kokkos/kokkos-kernels/pull/993) +- Make CRS sorting utils work with unmanaged [\#963](https://github.com/kokkos/kokkos-kernels/pull/963) +- Add sort and make sure using host mirror on host memory in kspiluk_symbolic [\#951](https://github.com/kokkos/kokkos-kernels/pull/951) +- GEMM: call GEMV instead in certain cases [\#948](https://github.com/kokkos/kokkos-kernels/pull/948) +- SpAdd performance improvements, better perf test, fix mtx reader columns [\#930](https://github.com/kokkos/kokkos-kernels/pull/930) + +**Implemented enhancements BuildSystem:** +- Automate documentation generation [\#1116](https://github.com/kokkos/kokkos-kernels/pull/1116) +- Move the batched dense files to specific directories [\#1098](https://github.com/kokkos/kokkos-kernels/pull/1098) +- cmake: Update SUPERLU tpl option for Tribits [\#1066](https://github.com/kokkos/kokkos-kernels/pull/1066) +- cmake/Modules: Allow user to use MAGMA_DIR from env [\#1007](https://github.com/kokkos/kokkos-kernels/pull/1007) +- Supernodal SpTRSV: update TPLs requirements [\#997](https://github.com/kokkos/kokkos-kernels/pull/997) +- cmake: Add MAGMA TPL support [\#982](https://github.com/kokkos/kokkos-kernels/pull/982) +- Host only macro: adding macro to check for any device backend [\#940](https://github.com/kokkos/kokkos-kernels/pull/940) +- Prevent redundant spmv kernel instantiations (reduce library size) [\#937](https://github.com/kokkos/kokkos-kernels/pull/937) +- unit-test: refactor infrastructure to remove most *.cpp [\#906](https://github.com/kokkos/kokkos-kernels/pull/906) + +**Implemented enhancements Other:** +- Allow reading integer mtx files into floating-point matrices [\#1100](https://github.com/kokkos/kokkos-kernels/pull/1100) +- Warnings: remove -Wunused-parameter warnings in Kokkos Kernels [\#962](https://github.com/kokkos/kokkos-kernels/pull/962) +- Clean up CrsMatrix raw pointer constructor [\#949](https://github.com/kokkos/kokkos-kernels/pull/949) +- unit_test/batched: Remove *_half fns from gemm unit tests [\#943](https://github.com/kokkos/kokkos-kernels/pull/943) +- Move sorting functionality out of Impl:: [\#932](https://github.com/kokkos/kokkos-kernels/pull/932) + +**Incompatibilities:** +- Deprecation warning: SpaceAccessibility move out of impl [\#1141](https://github.com/kokkos/kokkos-kernels/pull/1141) +- Rename CUDA_SAFE_CALL to KOKKOS_IMPL_CUDA_SAFE_CALL [\#1130](https://github.com/kokkos/kokkos-kernels/pull/1130) +- Workaround error with intel [\#1128](https://github.com/kokkos/kokkos-kernels/pull/1128) +- gmres: disable examples for builds with ibm/xl [\#1123](https://github.com/kokkos/kokkos-kernels/pull/1123) +- CrsMatrix: deprecate constructor without ncols input [\#1115](https://github.com/kokkos/kokkos-kernels/pull/1115) +- perf_test/blas/blas3: Disable simd verify for cuda/10.2.2 [\#1093](https://github.com/kokkos/kokkos-kernels/pull/1093) +- Replace impl/Kokkos_Timer.hpp includes with Kokkos_Timer.hpp [\#1074](https://github.com/kokkos/kokkos-kernels/pull/1074) +- Remove deprecated ViewAllocateWithoutInitializing [\#1058](https://github.com/kokkos/kokkos-kernels/pull/1058) +- src/sparse: spadd resolve deprecation warnings [\#1053](https://github.com/kokkos/kokkos-kernels/pull/1053) +- Give full namespace path for D2 coloring [\#999](https://github.com/kokkos/kokkos-kernels/pull/999) +- Fix -Werror=deprecated errors with c++20 standard [\#964](https://github.com/kokkos/kokkos-kernels/pull/964) +- Deprecation: a deprecated function is called in the SpADD perf_test [\#954](https://github.com/kokkos/kokkos-kernels/pull/954) + +**Enabled tests:** +- HIP: enabling all unit tests [\#968](https://github.com/kokkos/kokkos-kernels/pull/968) +- Fix build and add CI coverage for LayoutLeft=OFF [\#965](https://github.com/kokkos/kokkos-kernels/pull/965) +- Enable SYCL tests [\#927](https://github.com/kokkos/kokkos-kernels/pull/927) +- Fixup HIP nightly builds [\#907](https://github.com/kokkos/kokkos-kernels/pull/907) + +**Fixed Bugs:** +- Fix SpGEMM for Nvidia Turing/Ampere [\#1118](https://github.com/kokkos/kokkos-kernels/pull/1118) +- Fix #1111: spmv tpl instantiations [\#1112](https://github.com/kokkos/kokkos-kernels/pull/1112) +- Fix C's numCols in spadd simplified interface [\#1102](https://github.com/kokkos/kokkos-kernels/pull/1102) +- Fix #1089 (failing batched UTV tests) [\#1096](https://github.com/kokkos/kokkos-kernels/pull/1096) +- Blas GEMM: fix early exit logic, see issue #1088 [\#1091](https://github.com/kokkos/kokkos-kernels/pull/1091) +- Fix #1048: handle mode C spmv correctly in serial/openmp [\#1084](https://github.com/kokkos/kokkos-kernels/pull/1084) +- src/batched: Fix multiple definitions of singleton [\#1072](https://github.com/kokkos/kokkos-kernels/pull/1072) +- Fix host accessing View in non-host space [\#1057](https://github.com/kokkos/kokkos-kernels/pull/1057) +- Fix559: Intel 18 has trouble with pointer in ternary expr [\#1042](https://github.com/kokkos/kokkos-kernels/pull/1042) +- Work around team size AUTO issue on kepler [\#1020](https://github.com/kokkos/kokkos-kernels/pull/1020) +- Supernodal SpTrsv: fix out-of-bound error [\#1019](https://github.com/kokkos/kokkos-kernels/pull/1019) +- Some fixes for MAGMA TPL and gesv [\#1008](https://github.com/kokkos/kokkos-kernels/pull/1008) +- Merge pull request #981 from Tech-XCorp/4005-winllvmbuild [\#984](https://github.com/kokkos/kokkos-kernels/pull/984) +- This is a PR for 4005 vs2019build, which fixes a few things on Windows [\#981](https://github.com/kokkos/kokkos-kernels/pull/981) +- Fix build for no-ETI build [\#977](https://github.com/kokkos/kokkos-kernels/pull/977) +- Fix invalid mem accesses in new GEMV kernel [\#961](https://github.com/kokkos/kokkos-kernels/pull/961) +- Kokkos_ArithTraits.hpp: Fix isInf and isNan with complex types [\#936](https://github.com/kokkos/kokkos-kernels/pull/936) + ## [3.4.01](https://github.com/kokkos/kokkos-kernels/tree/3.4.01) (2021-05-19) [Full Changelog](https://github.com/kokkos/kokkos-kernels/compare/3.4.00...3.4.01) diff --git a/packages/kokkos-kernels/CMakeLists.txt b/packages/kokkos-kernels/CMakeLists.txt index 88292bdd0c06..95f4cd0ee981 100644 --- a/packages/kokkos-kernels/CMakeLists.txt +++ b/packages/kokkos-kernels/CMakeLists.txt @@ -24,8 +24,8 @@ IF(NOT KOKKOSKERNELS_HAS_TRILINOS) PROJECT(KokkosKernels CXX) ENDIF() SET(KokkosKernels_VERSION_MAJOR 3) - SET(KokkosKernels_VERSION_MINOR 4) - SET(KokkosKernels_VERSION_PATCH 01) + SET(KokkosKernels_VERSION_MINOR 5) + SET(KokkosKernels_VERSION_PATCH 00) ENDIF() IF(${CMAKE_VERSION} VERSION_GREATER_EQUAL "3.12.0") @@ -54,19 +54,39 @@ IF (NOT KOKKOSKERNELS_HAS_TRILINOS) KOKKOSKERNELS_ADD_OPTION( "ENABLE_EXAMPLES" OFF - BOOL - "Whether to build examples. Default: OFF" + BOOL + "Whether to build examples. Default: OFF" ) KOKKOSKERNELS_ADD_OPTION( - "ENABLE_TESTS" - OFF - BOOL - "Whether to build tests. Default: OFF" + "ENABLE_TESTS" + OFF + BOOL + "Whether to build tests. Default: OFF" ) -ENDIF() + KOKKOSKERNELS_ADD_OPTION( + "ENABLE_TESTS_AND_PERFSUITE" + OFF + BOOL + "Whether to build tests including Perfsuite. Default: OFF" + ) + IF(KokkosKernels_ENABLE_TESTS_AND_PERFSUITE) + set(BLT_CODE_CHECK_TARGET_NAME "fix-for-blt" CACHE STRING "Docstring") + set(INFRASTRUCTURE_ONLY ON CACHE BOOL "Only build the RAJAPerf infrastructure, no builtin kernels") + add_definitions("-DRAJAPERF_INFRASTRUCTURE_ONLY") + add_subdirectory(tpls/rajaperf) + include_directories(tpls/rajaperf/src) + ENDIF() +ENDIF () + +KOKKOSKERNELS_ADD_OPTION( + "ENABLE_DOCS" + OFF + BOOL + "Whether to build docs. Default: OFF" +) SET(KokkosKernels_INSTALL_TESTING OFF CACHE INTERNAL - "Whether to build tests and examples against installation") + "Whether to build tests and examples against installation") IF (KokkosKernels_INSTALL_TESTING) # Force testing on if we are doing intall testing SET(KOKKOSKERNELS_ENABLE_TESTS ON) @@ -76,7 +96,6 @@ IF (KokkosKernels_INSTALL_TESTING) # Still need to figure out which backends INCLUDE(cmake/kokkos_backends.cmake) # Only build the tests - KOKKOSKERNELS_ADD_TEST_DIRECTORIES(test_common) KOKKOSKERNELS_ADD_TEST_DIRECTORIES(perf_test) KOKKOSKERNELS_ADD_TEST_DIRECTORIES(unit_test) KOKKOSKERNELS_ADD_EXAMPLE_DIRECTORIES(example) @@ -196,14 +215,16 @@ ELSE() MESSAGE("") # Skip building Kokkos Kernels if we are doing an installation test ADD_SUBDIRECTORY(src) - IF(KokkosKernels_ENABLE_INSTALL_TEST) + IF (KokkosKernels_ENABLE_INSTALL_TEST) ADD_SUBDIRECTORY(install_test) MESSAGE("The install test has been enabled, you will need to peform: make install before running the tests otherwise install_test will fail") - ENDIF() - KOKKOSKERNELS_ADD_TEST_DIRECTORIES(test_common) + ENDIF () KOKKOSKERNELS_ADD_TEST_DIRECTORIES(perf_test) KOKKOSKERNELS_ADD_TEST_DIRECTORIES(unit_test) KOKKOSKERNELS_ADD_EXAMPLE_DIRECTORIES(example) KOKKOSKERNELS_PACKAGE_POSTPROCESS() + IF (KokkosKernels_ENABLE_DOCS) + ADD_SUBDIRECTORY(docs) + ENDIF () ENDIF() diff --git a/packages/kokkos-kernels/cm_generate_makefile.bash b/packages/kokkos-kernels/cm_generate_makefile.bash index bb9913b05b0e..d633a139c862 100755 --- a/packages/kokkos-kernels/cm_generate_makefile.bash +++ b/packages/kokkos-kernels/cm_generate_makefile.bash @@ -214,6 +214,8 @@ get_kernels_extra_linker_flags() { KOKKOSKERNELS_EXTRA_LINKER_FLAGS_CMD="-DCMAKE_EXE_LINKER_FLAGS=${PARSE_EXTRA_LINKER_FLAGS_LIST} ${KOKKOSKERNELS_EXTRA_LINKER_FLAGS_CMD}" } + + display_help_text() { echo "KokkosKernels and Kokkos configure options:" @@ -331,6 +333,10 @@ display_help_text() { echo "--gcc-toolchain=/Path/To/GccRoot: Set the gcc toolchain to use with clang (e.g. /usr)" echo "--kokkos-make-j=[NUM]: Set -j parallel level for kokkos install" echo " Default: j == 4" + echo "--enable-tests: build Kokkos Kernels unit and performance tests" + echo "--enable-perfsuite: build Kokkos Kernels performance tests with +RAJAPerf Suite" + } @@ -339,6 +345,7 @@ KOKKOS_INSTALL_PATH="" KOKKOS_DO_TESTS=OFF KOKKOS_DO_EXAMPLES=OFF KOKKOSKERNELS_DO_TESTS=ON +KOKKOSKERNELS_DO_PERFSUITE=OFF KOKKOSKERNELS_DO_EXAMPLES=ON KOKKOS_MAKEINSTALL_J=4 @@ -491,6 +498,13 @@ do # This is the default KOKKOSKERNELS_DO_TESTS=ON ;; + --enable-perfsuite) + KOKKOSKERNELS_DO_PERFSUITE=ON + ;; + --disable-perfsuite) + # This is the default + KOKKOSKERNELS_DO_PERFSUITE=OFF + ;; --disable-tests) KOKKOSKERNELS_DO_TESTS=OFF ;; @@ -717,9 +731,9 @@ cd ${KOKKOS_INSTALL_PATH} # Configure kokkos echo "" -echo cmake $COMPILER_CMD -DCMAKE_CXX_FLAGS="${KOKKOS_CXXFLAGS}" -DCMAKE_EXE_LINKER_FLAGS="${KOKKOS_LDFLAGS}" -DCMAKE_INSTALL_PREFIX=${KOKKOS_INSTALL_PATH} ${KOKKOS_DEVICE_CMD} ${KOKKOS_ARCH_CMD} -DKokkos_ENABLE_TESTS=${KOKKOS_DO_TESTS} -DKokkos_ENABLE_EXAMPLES=${KOKKOS_DO_EXAMPLES} ${KOKKOS_OPTION_CMD} ${KOKKOS_CUDA_OPTION_CMD} ${KOKKOS_HIP_OPTION_CMD} -DCMAKE_VERBOSE_MAKEFILE=ON -DCMAKE_CXX_EXTENSIONS=OFF ${STANDARD_CMD} ${KOKKOS_BUILDTYPE_CMD} ${KOKKOS_BC_CMD} ${KOKKOS_HWLOC_CMD} ${KOKKOS_HWLOC_PATH_CMD} ${KOKKOS_MEMKIND_CMD} ${KOKKOS_MEMKIND_PATH_CMD} ${KOKKOS_PATH} +echo cmake $COMPILER_CMD -DCMAKE_CXX_FLAGS="${KOKKOS_CXXFLAGS}" -DCMAKE_EXE_LINKER_FLAGS="${KOKKOS_LDFLAGS}" -DCMAKE_INSTALL_PREFIX=${KOKKOS_INSTALL_PATH} ${KOKKOS_DEVICE_CMD} ${KOKKOS_ARCH_CMD} -DKokkos_ENABLE_TESTS=${KOKKOS_DO_TESTS} -DKokkos_ENABLE_EXAMPLES=${KOKKOS_DO_EXAMPLES} ${KOKKOS_OPTION_CMD} ${KOKKOS_CUDA_OPTION_CMD} ${KOKKOS_HIP_OPTION_CMD} -DCMAKE_VERBOSE_MAKEFILE=ON -DCMAKE_CXX_EXTENSIONS=OFF ${STANDARD_CMD} ${KOKKOS_BUILDTYPE_CMD} ${KOKKOS_BC_CMD} ${KOKKOS_HWLOC_CMD} ${KOKKOS_HWLOC_PATH_CMD} ${KOKKOS_MEMKIND_CMD} ${KOKKOS_MEMKIND_PATH_CMD} -DKokkos_ENABLE_DEPRECATION_WARNINGS=OFF ${KOKKOS_PATH} echo "" -cmake $COMPILER_CMD -DCMAKE_CXX_FLAGS="${KOKKOS_CXXFLAGS//\"}" -DCMAKE_EXE_LINKER_FLAGS="${KOKKOS_LDFLAGS//\"}" -DCMAKE_INSTALL_PREFIX=${KOKKOS_INSTALL_PATH} ${KOKKOS_DEVICE_CMD} ${KOKKOS_ARCH_CMD} -DKokkos_ENABLE_TESTS=${KOKKOS_DO_TESTS} -DKokkos_ENABLE_EXAMPLES=${KOKKOS_DO_EXAMPLES} ${KOKKOS_OPTION_CMD} ${KOKKOS_CUDA_OPTION_CMD} ${KOKKOS_HIP_OPTION_CMD} -DCMAKE_VERBOSE_MAKEFILE=ON -DCMAKE_CXX_EXTENSIONS=OFF ${STANDARD_CMD} ${KOKKOS_BUILDTYPE_CMD} ${KOKKOS_BC_CMD} ${KOKKOS_HWLOC_CMD} ${KOKKOS_HWLOC_PATH_CMD} ${KOKKOS_MEMKIND_CMD} ${KOKKOS_MEMKIND_PATH_CMD} ${KOKKOS_PATH} +cmake $COMPILER_CMD -DCMAKE_CXX_FLAGS="${KOKKOS_CXXFLAGS//\"}" -DCMAKE_EXE_LINKER_FLAGS="${KOKKOS_LDFLAGS//\"}" -DCMAKE_INSTALL_PREFIX=${KOKKOS_INSTALL_PATH} ${KOKKOS_DEVICE_CMD} ${KOKKOS_ARCH_CMD} -DKokkos_ENABLE_TESTS=${KOKKOS_DO_TESTS} -DKokkos_ENABLE_EXAMPLES=${KOKKOS_DO_EXAMPLES} ${KOKKOS_OPTION_CMD} ${KOKKOS_CUDA_OPTION_CMD} ${KOKKOS_HIP_OPTION_CMD} -DCMAKE_VERBOSE_MAKEFILE=ON -DCMAKE_CXX_EXTENSIONS=OFF ${STANDARD_CMD} ${KOKKOS_BUILDTYPE_CMD} ${KOKKOS_BC_CMD} ${KOKKOS_HWLOC_CMD} ${KOKKOS_HWLOC_PATH_CMD} ${KOKKOS_MEMKIND_CMD} ${KOKKOS_MEMKIND_PATH_CMD} -DKokkos_ENABLE_DEPRECATION_WARNINGS=OFF ${KOKKOS_PATH} # Install kokkos library make install -j $KOKKOS_MAKEINSTALL_J @@ -744,7 +758,7 @@ cd $STORE_KOKKOSKERNELS_BUILD_PATH # Configure kokkos-kernels echo "" -echo cmake $COMPILER_CMD -DKokkos_DIR="${KOKKOS_FIND_PATH}" -DCMAKE_CXX_FLAGS="${KOKKOS_CXXFLAGS}" -DCMAKE_INSTALL_PREFIX="${PREFIX}" -DKokkosKernels_ENABLE_TESTS=${KOKKOSKERNELS_DO_TESTS} -DKokkosKernels_ENABLE_EXAMPLES:BOOL=${KOKKOSKERNELS_DO_EXAMPLES} ${KOKKOSKERNELS_SCALARS_CMD} ${KOKKOSKERNELS_ORDINALS_CMD} ${KOKKOSKERNELS_OFFSETS_CMD} ${KOKKOSKERNELS_LAYOUTS_CMD} ${KOKKOSKERNELS_TPLS_CMD} ${KOKKOSKERNELS_USER_TPL_PATH_CMD} ${KOKKOSKERNELS_USER_TPL_LIBNAME_CMD} ${KOKKOSKERNELS_EXTRA_LINKER_FLAGS_CMD} ${KOKKOSKERNELS_BUILDTYPE_CMD} ${KOKKOSKERNELS_SPACES_CMD} ${KERNELS_DEFAULT_ETI_OPTION} ${KOKKOSKERNELS_PATH} +echo cmake $COMPILER_CMD -DKokkos_DIR="${KOKKOS_FIND_PATH}" -DCMAKE_CXX_FLAGS="${KOKKOS_CXXFLAGS}" -DCMAKE_INSTALL_PREFIX="${PREFIX}" -DKokkosKernels_ENABLE_TESTS_AND_PERFSUITE=${KOKKOSKERNELS_DO_PERFSUITE} -DKokkosKernels_ENABLE_TESTS=${KOKKOSKERNELS_DO_TESTS} -DKokkosKernels_ENABLE_EXAMPLES:BOOL=${KOKKOSKERNELS_DO_EXAMPLES} ${KOKKOSKERNELS_SCALARS_CMD} ${KOKKOSKERNELS_ORDINALS_CMD} ${KOKKOSKERNELS_OFFSETS_CMD} ${KOKKOSKERNELS_LAYOUTS_CMD} ${KOKKOSKERNELS_TPLS_CMD} ${KOKKOSKERNELS_USER_TPL_PATH_CMD} ${KOKKOSKERNELS_USER_TPL_LIBNAME_CMD} ${KOKKOSKERNELS_EXTRA_LINKER_FLAGS_CMD} ${KOKKOSKERNELS_BUILDTYPE_CMD} ${KOKKOSKERNELS_SPACES_CMD} ${KERNELS_DEFAULT_ETI_OPTION} ${KOKKOSKERNELS_PATH} echo "" -cmake $COMPILER_CMD -DKokkos_DIR="${KOKKOS_FIND_PATH}" -DCMAKE_CXX_FLAGS="${KOKKOS_CXXFLAGS//\"}" -DCMAKE_INSTALL_PREFIX="${PREFIX}" -DKokkosKernels_ENABLE_TESTS=${KOKKOSKERNELS_DO_TESTS} -DKokkosKernels_ENABLE_EXAMPLES:BOOL=${KOKKOSKERNELS_DO_EXAMPLES} ${KOKKOSKERNELS_SCALARS_CMD} ${KOKKOSKERNELS_ORDINALS_CMD} ${KOKKOSKERNELS_OFFSETS_CMD} ${KOKKOSKERNELS_LAYOUTS_CMD} ${KOKKOSKERNELS_TPLS_CMD} ${KOKKOSKERNELS_USER_TPL_PATH_CMD} ${KOKKOSKERNELS_USER_TPL_LIBNAME_CMD} ${KOKKOSKERNELS_EXTRA_LINKER_FLAGS_CMD} ${KOKKOSKERNELS_BUILDTYPE_CMD} ${KOKKOSKERNELS_SPACES_CMD} ${KERNELS_DEFAULT_ETI_OPTION} ${KOKKOSKERNELS_PATH} +cmake $COMPILER_CMD -DKokkos_DIR="${KOKKOS_FIND_PATH}" -DCMAKE_CXX_FLAGS="${KOKKOS_CXXFLAGS//\"}" -DCMAKE_INSTALL_PREFIX="${PREFIX}" -DKokkosKernels_ENABLE_TESTS_AND_PERFSUITE=${KOKKOSKERNELS_DO_PERFSUITE} -DKokkosKernels_ENABLE_TESTS=${KOKKOSKERNELS_DO_TESTS} -DKokkosKernels_ENABLE_EXAMPLES:BOOL=${KOKKOSKERNELS_DO_EXAMPLES} ${KOKKOSKERNELS_SCALARS_CMD} ${KOKKOSKERNELS_ORDINALS_CMD} ${KOKKOSKERNELS_OFFSETS_CMD} ${KOKKOSKERNELS_LAYOUTS_CMD} ${KOKKOSKERNELS_TPLS_CMD} ${KOKKOSKERNELS_USER_TPL_PATH_CMD} ${KOKKOSKERNELS_USER_TPL_LIBNAME_CMD} ${KOKKOSKERNELS_EXTRA_LINKER_FLAGS_CMD} ${KOKKOSKERNELS_BUILDTYPE_CMD} ${KOKKOSKERNELS_SPACES_CMD} ${KERNELS_DEFAULT_ETI_OPTION} ${KOKKOSKERNELS_PATH} diff --git a/packages/kokkos-kernels/cmake/Dependencies.cmake b/packages/kokkos-kernels/cmake/Dependencies.cmake index 0aa97b1d6ce1..a36e745c7129 100644 --- a/packages/kokkos-kernels/cmake/Dependencies.cmake +++ b/packages/kokkos-kernels/cmake/Dependencies.cmake @@ -1,5 +1,7 @@ TRIBITS_PACKAGE_DEFINE_DEPENDENCIES( - LIB_REQUIRED_PACKAGES KokkosCore KokkosContainers KokkosAlgorithms - LIB_OPTIONAL_TPLS quadmath MKL BLAS LAPACK CUSPARSE MAGMA SUPERLU CHOLMOD LAPACKE CBLAS ARMPL - TEST_OPTIONAL_TPLS yaml-cpp + LIB_REQUIRED_PACKAGES KokkosCore KokkosContainers KokkosAlgorithms + LIB_OPTIONAL_TPLS quadmath MKL BLAS LAPACK CUSPARSE MAGMA METIS SuperLU Cholmod LAPACKE CBLAS ARMPL + TEST_OPTIONAL_TPLS yaml-cpp ) +# NOTE: If you update names in LIB_OPTIONAL_TPLS above, make sure to map those names in +# the macro 'KOKKOSKERNELS_ADD_TPL_OPTION' that resides in cmake/kokkoskernels_tpls.cmake. \ No newline at end of file diff --git a/packages/kokkos-kernels/cmake/KokkosKernelsConfig.cmake.in b/packages/kokkos-kernels/cmake/KokkosKernelsConfig.cmake.in index 6b95ff91aec9..f930dd51a022 100644 --- a/packages/kokkos-kernels/cmake/KokkosKernelsConfig.cmake.in +++ b/packages/kokkos-kernels/cmake/KokkosKernelsConfig.cmake.in @@ -9,12 +9,13 @@ include(CMakeFindDependencyMacro) find_dependency(Kokkos HINTS @Kokkos_DIR@) -SET(Kokkos_ENABLE_OPENMP @Kokkos_ENABLE_OPENMP@) -SET(Kokkos_ENABLE_CUDA @Kokkos_ENABLE_CUDA@) -SET(Kokkos_ENABLE_HIP @Kokkos_ENABLE_HIP@) -SET(Kokkos_ENABLE_SYCL @Kokkos_ENABLE_SYCL@) -SET(Kokkos_ENABLE_PTHREAD @Kokkos_ENABLE_PTHREAD@) -SET(Kokkos_ENABLE_SERIAL @Kokkos_ENABLE_SERIAL@) +SET(Kokkos_ENABLE_OPENMP @Kokkos_ENABLE_OPENMP@) +SET(Kokkos_ENABLE_OPENMPTARGET @Kokkos_ENABLE_OPENMPTARGET@) +SET(Kokkos_ENABLE_CUDA @Kokkos_ENABLE_CUDA@) +SET(Kokkos_ENABLE_HIP @Kokkos_ENABLE_HIP@) +SET(Kokkos_ENABLE_SYCL @Kokkos_ENABLE_SYCL@) +SET(Kokkos_ENABLE_PTHREAD @Kokkos_ENABLE_PTHREAD@) +SET(Kokkos_ENABLE_SERIAL @Kokkos_ENABLE_SERIAL@) INCLUDE("${KokkosKernels_CMAKE_DIR}/KokkosKernelsTargets.cmake") diff --git a/packages/kokkos-kernels/cmake/KokkosKernels_config.h.in b/packages/kokkos-kernels/cmake/KokkosKernels_config.h.in index 9326edc47ac9..adfd3cd11850 100644 --- a/packages/kokkos-kernels/cmake/KokkosKernels_config.h.in +++ b/packages/kokkos-kernels/cmake/KokkosKernels_config.h.in @@ -22,10 +22,17 @@ than just BLAS and LAPACK functions. */ #cmakedefine HAVE_KOKKOSKERNELS_MKL + +#cmakedefine KOKKOSKERNELS_ENABLE_TESTS_AND_PERFSUITE + /* Define this macro if experimental features of Kokkoskernels are enabled */ #cmakedefine HAVE_KOKKOSKERNELS_EXPERIMENTAL -/* Define this macro to disallow instantiations of kernels which are not covered by ETI */ +/* Define this macro if we have SuperLU API version 5 */ +#cmakedefine HAVE_KOKKOSKERNELS_SUPERLU5_API + +/* Define this macro to disallow instantiations of kernels which are not covered + * by ETI */ #cmakedefine KOKKOSKERNELS_ETI_ONLY /* Define this macro to only test ETI types */ #cmakedefine KOKKOSKERNELS_TEST_ETI_ONLY @@ -41,6 +48,9 @@ #cmakedefine KOKKOSKERNELS_INST_EXECSPACE_SYCL #cmakedefine KOKKOSKERNELS_INST_MEMSPACE_SYCLSPACE #cmakedefine KOKKOSKERNELS_INST_MEMSPACE_SYCLSHAREDSPACE +/* Whether to build kernels for execution space Kokkos::Experimental::HIP */ +#cmakedefine KOKKOSKERNELS_INST_EXECSPACE_OPENMPTARGET +#cmakedefine KOKKOSKERNELS_INST_MEMSPACE_OPENMPTARGETSPACE /* Whether to build kernels for execution space Kokkos::OpenMP */ #cmakedefine KOKKOSKERNELS_INST_EXECSPACE_OPENMP /* Whether to build kernels for execution space Kokkos::Threads */ @@ -98,6 +108,7 @@ #cmakedefine KOKKOSKERNELS_ENABLE_TPL_MAGMA /* SuperLU */ #cmakedefine KOKKOSKERNELS_ENABLE_TPL_SUPERLU +#cmakedefine KOKKOSKERNELS_ENABLE_TPL_SuperLU // For Trilinos /* CHOLMOD */ #cmakedefine KOKKOSKERNELS_ENABLE_TPL_CHOLMOD /* CBLAS */ @@ -119,6 +130,13 @@ #endif #endif +#if !defined(KOKKOS_ENABLE_CUDA) \ + && !defined(KOKKOS_ENABLE_HIP) \ + && !defined(KOKKOS_ENABLE_SYCL) \ + && !defined(KOKKOS_ENABLE_OPENMPTARGET) +#define KOKKOSKERNELS_ENABLE_HOST_ONLY +#endif + /* * "Optimization level" for computational kernels in this subpackage. diff --git a/packages/kokkos-kernels/cmake/Modules/FindSphinx.cmake b/packages/kokkos-kernels/cmake/Modules/FindSphinx.cmake new file mode 100644 index 000000000000..24bf486aa8e4 --- /dev/null +++ b/packages/kokkos-kernels/cmake/Modules/FindSphinx.cmake @@ -0,0 +1,11 @@ +#Look for an executable called sphinx-build +find_program(SPHINX_EXECUTABLE + NAMES sphinx-build + DOC "Path to sphinx-build executable") + +include(FindPackageHandleStandardArgs) + +#Handle standard arguments to find_package like REQUIRED and QUIET +find_package_handle_standard_args(Sphinx + "Failed to find sphinx-build executable" + SPHINX_EXECUTABLE) \ No newline at end of file diff --git a/packages/kokkos-kernels/cmake/Modules/FindTPLMAGMA.cmake b/packages/kokkos-kernels/cmake/Modules/FindTPLMAGMA.cmake new file mode 100644 index 000000000000..bdf2f7577383 --- /dev/null +++ b/packages/kokkos-kernels/cmake/Modules/FindTPLMAGMA.cmake @@ -0,0 +1,42 @@ +IF (MAGMA_LIBRARY_DIRS AND MAGMA_LIBRARIES) + KOKKOSKERNELS_FIND_IMPORTED(MAGMA INTERFACE LIBRARIES ${MAGMA_LIBRARIES} LIBRARY_PATHS ${MAGMA_LIBRARY_DIRS}) +ELSEIF (MAGMA_LIBRARIES) + KOKKOSKERNELS_FIND_IMPORTED(MAGMA INTERFACE LIBRARIES ${MAGMA_LIBRARIES}) +ELSEIF (MAGMA_LIBRARY_DIRS) + KOKKOSKERNELS_FIND_IMPORTED(MAGMA INTERFACE LIBRARIES amath ${MAGMA_LIB} LIBRARY_PATHS ${MAGMA_LIBRARY_DIRS}) +ELSEIF (KokkosKernels_MAGMA_ROOT OR DEFINED ENV{MAGMA_DIR}) + IF (KokkosKernels_MAGMA_ROOT AND DEFINED ENV{MAGMA_DIR}) + MESSAGE(FATAL_ERROR "Both KokkosKernels_MAGMA_ROOT and ENV{MAGMA_DIR} are defined!") + ENDIF() + + IF (KokkosKernels_MAGMA_ROOT) + SET(MAGMA_ROOT ${KokkosKernels_MAGMA_ROOT}) + ELSE() + SET(MAGMA_ROOT $ENV{MAGMA_DIR}) + ENDIF() + + KOKKOSKERNELS_FIND_IMPORTED(MAGMA INTERFACE + LIBRARIES + magma + magma_sparse + LIBRARY_PATHS + ${MAGMA_ROOT}/lib + HEADERS + magmablas.h + HEADER_PATHS + ${MAGMA_ROOT}/include + ) +ELSE() + FIND_PACKAGE(MAGMA REQUIRED) + KOKKOSKERNELS_CREATE_IMPORTED_TPL(MAGMA INTERFACE LINK_LIBRARIES ${MAGMA_LIBRARIES}) +ENDIF() + +TRY_COMPILE(KOKKOSKERNELS_TRY_COMPILE_MAGMA + ${KOKKOSKERNELS_TOP_BUILD_DIR}/tpl_tests + ${KOKKOSKERNELS_TOP_SOURCE_DIR}/cmake/compile_tests/magma.cpp + CMAKE_FLAGS -DINCLUDE_DIRECTORIES=${MAGMA_ROOT}/include + LINK_LIBRARIES -L${MAGMA_ROOT}/lib -lmagma -lmagma_sparse + OUTPUT_VARIABLE KOKKOSKERNELS_TRY_COMPILE_MAGMA_OUT) +IF(NOT KOKKOSKERNELS_TRY_COMPILE_MAGMA) + MESSAGE(FATAL_ERROR "KOKKOSKERNELS_TRY_COMPILE_MAGMA_OUT=${KOKKOSKERNELS_TRY_COMPILE_MAGMA_OUT}") +ENDIF() diff --git a/packages/kokkos-kernels/cmake/Modules/FindTPLSUPERLU.cmake b/packages/kokkos-kernels/cmake/Modules/FindTPLSUPERLU.cmake index c8abdef24e74..4dc619ce6b31 100644 --- a/packages/kokkos-kernels/cmake/Modules/FindTPLSUPERLU.cmake +++ b/packages/kokkos-kernels/cmake/Modules/FindTPLSUPERLU.cmake @@ -7,12 +7,46 @@ IF (SUPERLU_LIBRARIES) LIBRARIES ${SUPERLU_LIBRARIES} LIBRARY_PATHS ${SUPERLU_LIBRARY_DIRS} HEADERS slu_ddefs.h - HEADER_PATHS ${SUPERLU_INCLUDE_DIRS}) -ELSE() + HEADER_PATHS ${SUPERLU_INCLUDE_DIRS}) +ELSE () #we need to find one of the valid versions from the list below KOKKOSKERNELS_FIND_IMPORTED(SUPERLU - LIBRARY superlu - LIBRARY_PATHS ${SUPERLU_LIBRARY_DIRS} - HEADERS slu_ddefs.h - HEADER_PATHS ${SUPERLU_INCLUDE_DIRS}) -ENDIF() + LIBRARY superlu + LIBRARY_PATHS ${SUPERLU_LIBRARY_DIRS} + HEADERS slu_ddefs.h + HEADER_PATHS ${SUPERLU_INCLUDE_DIRS}) +ENDIF () + +# From Trilinos/cmake/TPLs/FindTPLSuperLU.cmake +FUNCTION(CHECK_SUPERLU_GLOBALLU_T_ARG VARNAME) + SET(SOURCE + " +#include + +int main() +{ + GlobalLU_t lu; + superlu_options_t opt; + SuperMatrix M; + int *i; + double *d; + void *v; + char *c; + SuperLUStat_t stat; + mem_usage_t mem; + + dgsisx(&opt,&M,i,i,i,c,d,d,&M,&M,v,*i,&M,&M,d,d,&lu,&mem,&stat,i); + return 0; +} +" + ) + + SET(CMAKE_REQUIRED_INCLUDES ${TPL_SuperLU_INCLUDE_DIRS}) + SET(CMAKE_REQUIRED_LIBRARIES ${TPL_SuperLU_LIBRARIES} ${TPL_METIS_LIBRARIES} ${TPL_BLAS_LIBRARIES}) + SET(CMAKE_REQUIRED_FLAGS ${CMAKE_EXE_LINKER_FLAGS}) + CHECK_C_SOURCE_COMPILES("${SOURCE}" ${VARNAME}) +ENDFUNCTION() + +IF (KokkosKernels_ENABLE_TPL_SUPERLU) + CHECK_SUPERLU_GLOBALLU_T_ARG(${PROJECT_NAME}_ENABLE_SuperLU5_API) +ENDIF (KokkosKernels_ENABLE_TPL_SUPERLU) diff --git a/packages/kokkos-kernels/cmake/compile_tests/magma.cpp b/packages/kokkos-kernels/cmake/compile_tests/magma.cpp new file mode 100644 index 000000000000..588c4608c435 --- /dev/null +++ b/packages/kokkos-kernels/cmake/compile_tests/magma.cpp @@ -0,0 +1,8 @@ +#include +#include +#include +#include + +int main(void) { + return 0; +} diff --git a/packages/kokkos-kernels/cmake/fake_tribits.cmake b/packages/kokkos-kernels/cmake/fake_tribits.cmake index 26737b891956..4a44ffea8662 100644 --- a/packages/kokkos-kernels/cmake/fake_tribits.cmake +++ b/packages/kokkos-kernels/cmake/fake_tribits.cmake @@ -314,11 +314,11 @@ GET_CMAKE_PROPERTY(_variableNames VARIABLES) LIST (SORT _variableNames) FOREACH (_variableName ${_variableNames}) MESSAGE(STATUS "${_variableName}=${${_variableName}}") -ENDFOREACH() +ENDFOREACH () ENDMACRO(PRINTALL) MACRO(KOKKOSKERNELS_ADD_DEBUG_OPTION) - IF(KOKKOSKERNELS_HAS_TRILINOS) + IF (KOKKOSKERNELS_HAS_TRILINOS) TRIBITS_ADD_DEBUG_OPTION() - ENDIF() + ENDIF () ENDMACRO() diff --git a/packages/kokkos-kernels/cmake/kokkos_backends.cmake b/packages/kokkos-kernels/cmake/kokkos_backends.cmake index eb7d8602b7d3..11c51eed5323 100644 --- a/packages/kokkos-kernels/cmake/kokkos_backends.cmake +++ b/packages/kokkos-kernels/cmake/kokkos_backends.cmake @@ -9,9 +9,10 @@ MACRO(CHECK_KOKKOS_BACKEND BE) SET(KOKKOSKERNELS_INST_EXECSPACE_${BE}_DEFAULT ${KOKKOS_ENABLE_${BE}}) ENDMACRO(CHECK_KOKKOS_BACKEND) +CHECK_KOKKOS_BACKEND(SERIAL) +CHECK_KOKKOS_BACKEND(PTHREAD) +CHECK_KOKKOS_BACKEND(OPENMP) +CHECK_KOKKOS_BACKEND(OPENMPTARGET) CHECK_KOKKOS_BACKEND(CUDA) CHECK_KOKKOS_BACKEND(HIP) CHECK_KOKKOS_BACKEND(SYCL) -CHECK_KOKKOS_BACKEND(OPENMP) -CHECK_KOKKOS_BACKEND(PTHREAD) -CHECK_KOKKOS_BACKEND(SERIAL) diff --git a/packages/kokkos-kernels/cmake/kokkoskernels_eti_devices.cmake b/packages/kokkos-kernels/cmake/kokkoskernels_eti_devices.cmake index ad7ef15e55a7..81ab89508e1a 100644 --- a/packages/kokkos-kernels/cmake/kokkoskernels_eti_devices.cmake +++ b/packages/kokkos-kernels/cmake/kokkoskernels_eti_devices.cmake @@ -6,16 +6,18 @@ SET(EXEC_SPACES EXECSPACE_CUDA EXECSPACE_HIP EXECSPACE_SYCL + EXECSPACE_OPENMPTARGET EXECSPACE_OPENMP EXECSPACE_PTHREAD EXECSPACE_SERIAL ) -SET(EXECSPACE_CUDA_CPP_TYPE Kokkos::Cuda) -SET(EXECSPACE_HIP_CPP_TYPE Kokkos::Experimental::HIP) -SET(EXECSPACE_SYCL_CPP_TYPE Kokkos::Experimental::SYCL) -SET(EXECSPACE_OPENMP_CPP_TYPE Kokkos::OpenMP) -SET(EXECSPACE_PTHREAD_CPP_TYPE Kokkos::Threads) -SET(EXECSPACE_SERIAL_CPP_TYPE Kokkos::Serial) +SET(EXECSPACE_CUDA_CPP_TYPE Kokkos::Cuda) +SET(EXECSPACE_HIP_CPP_TYPE Kokkos::Experimental::HIP) +SET(EXECSPACE_SYCL_CPP_TYPE Kokkos::Experimental::SYCL) +SET(EXECSPACE_OPENMPTARGET_CPP_TYPE Kokkos::Experimental::OpenMPTarget) +SET(EXECSPACE_OPENMP_CPP_TYPE Kokkos::OpenMP) +SET(EXECSPACE_PTHREAD_CPP_TYPE Kokkos::Threads) +SET(EXECSPACE_SERIAL_CPP_TYPE Kokkos::Serial) SET(MEM_SPACES MEMSPACE_CUDASPACE @@ -23,16 +25,18 @@ SET(MEM_SPACES MEMSPACE_HIPSPACE MEMSPACE_SYCLSPACE MEMSPACE_SYCLSHAREDSPACE + MEMSPACE_OPENMPTARGET MEMSPACE_HOSTSPACE MEMSPACE_HBWSPACE ) -SET(MEMSPACE_CUDASPACE_CPP_TYPE Kokkos::CudaSpace) -SET(MEMSPACE_CUDAUVMSPACE_CPP_TYPE Kokkos::CudaUVMSpace) -SET(MEMSPACE_HIPSPACE_CPP_TYPE Kokkos::Experimental::HIPSpace) -SET(MEMSPACE_SYCLSPACE_CPP_TYPE Kokkos::Experimental::SYCLDeviceUSMSpace) -SET(MEMSPACE_SYCLSHAREDSPACE_CPP_TYPE Kokkos::Experimental::SYCLSharedUSMSpace) -SET(MEMSPACE_HOSTSPACE_CPP_TYPE Kokkos::HostSpace) -SET(MEMSPACE_HBWSPACE_CPP_TYPE Kokkos::HBWSpace) +SET(MEMSPACE_CUDASPACE_CPP_TYPE Kokkos::CudaSpace) +SET(MEMSPACE_CUDAUVMSPACE_CPP_TYPE Kokkos::CudaUVMSpace) +SET(MEMSPACE_HIPSPACE_CPP_TYPE Kokkos::Experimental::HIPSpace) +SET(MEMSPACE_SYCLSPACE_CPP_TYPE Kokkos::Experimental::SYCLDeviceUSMSpace) +SET(MEMSPACE_SYCLSHAREDSPACE_CPP_TYPE Kokkos::Experimental::SYCLSharedUSMSpace) +SET(MEMSPACE_OPENMPTARGETSPACE_CPP_TYPE Kokkos::Experimental::OpenMPTargetSpace) +SET(MEMSPACE_HOSTSPACE_CPP_TYPE Kokkos::HostSpace) +SET(MEMSPACE_HBWSPACE_CPP_TYPE Kokkos::HBWSpace) IF(KOKKOS_ENABLE_CUDA) KOKKOSKERNELS_ADD_OPTION( @@ -113,9 +117,31 @@ IF(KOKKOS_ENABLE_SYCL) ENDIF() IF( Trilinos_ENABLE_COMPLEX_DOUBLE AND ((NOT DEFINED CMAKE_CXX_USE_RESPONSE_FILE_FOR_OBJECTS) OR (NOT CMAKE_CXX_USE_RESPONSE_FILE_FOR_OBJECTS)) ) - MESSAGE( WARNING "The CMake option CMAKE_CXX_USE_RESPONSE_FILE_FOR_OBJECTS is either undefined or OFF. Please set CMAKE_CXX_USE_RESPONSE_FILE_FOR_OBJECTS:BOOL=ON when building with SYCL and complex double enabled.") + MESSAGE( WARNING "The CMake option CMAKE_CXX_USE_RESPONSE_FILE_FOR_OBJECTS is either undefined or OFF. Please set CMAKE_CXX_USE_RESPONSE_FILE_FOR_OBJECTS:BOOL=ON when building with SYCL and complex double enabled.") + ENDIF() +ENDIF() + +IF(KOKKOS_ENABLE_OPENMPTARGET) + KOKKOSKERNELS_ADD_OPTION( + INST_EXECSPACE_OPENMPTARGET + ${KOKKOSKERNELS_INST_EXECSPACE_OPENMPTARGET_DEFAULT} + BOOL + "Whether to pre instantiate kernels for the execution space Kokkos::Experimental::OpenMPTarget. Disabling this when Kokkos_ENABLE_OpenMPTarget is enabled may increase build times. Default: ON if Kokkos is OpenMPTarget-enabled, OFF otherwise." + ) + KOKKOSKERNELS_ADD_OPTION( + INST_MEMSPACE_OPENMPTARGETSPACE + ${KOKKOSKERNELS_INST_EXECSPACE_OPENMPTARGET_DEFAULT} + BOOL + "Whether to pre instantiate kernels for the memory space Kokkos::Experimental::OpenMPTargetSpace. Disabling this when Kokkos_ENABLE_OPENMPTARGET is enabled may increase build times. Default: ON if Kokkos is OpenMPTarget-enabled, OFF otherwise." + ) + + IF(KOKKOSKERNELS_INST_EXECSPACE_OPENMPTARGET AND KOKKOSKERNELS_INST_MEMSPACE_OPENMPTARGETSPACE) + LIST(APPEND DEVICE_LIST "") ENDIF() + IF( Trilinos_ENABLE_COMPLEX_DOUBLE AND ((NOT DEFINED CMAKE_CXX_USE_RESPONSE_FILE_FOR_OBJECTS) OR (NOT CMAKE_CXX_USE_RESPONSE_FILE_FOR_OBJECTS)) ) + MESSAGE( WARNING "The CMake option CMAKE_CXX_USE_RESPONSE_FILE_FOR_OBJECTS is either undefined or OFF. Please set CMAKE_CXX_USE_RESPONSE_FILE_FOR_OBJECTS:BOOL=ON when building with OpenMPTarget and complex double enabled.") + ENDIF() ENDIF() KOKKOSKERNELS_ADD_OPTION( @@ -169,12 +195,13 @@ KOKKOSKERNELS_ADD_OPTION( "Whether to build kernels for the execution space Kokkos::Serial. If explicit template instantiation (ETI) is enabled in Trilinos, disabling this when Kokkos_ENABLE_SERIAL is enabled may increase build times. Default: ON when Kokkos is Serial-enabled, OFF otherwise." ) -SET(EXECSPACE_CUDA_VALID_MEM_SPACES CUDASPACE CUDAUVMSPACE) -SET(EXECSPACE_HIP_VALID_MEM_SPACES HIPSPACE) -SET(EXECSPACE_SYCL_VALID_MEM_SPACES SYCLSPACE SYCLSHAREDSPACE) -SET(EXECSPACE_SERIAL_VALID_MEM_SPACES HBWSPACE HOSTSPACE) -SET(EXECSPACE_OPENMP_VALID_MEM_SPACES HBWSPACE HOSTSPACE) -SET(EXECSPACE_PTHREAD_VALID_MEM_SPACES HBWSPACE HOSTSPACE) +SET(EXECSPACE_CUDA_VALID_MEM_SPACES CUDASPACE CUDAUVMSPACE) +SET(EXECSPACE_HIP_VALID_MEM_SPACES HIPSPACE) +SET(EXECSPACE_SYCL_VALID_MEM_SPACES SYCLSPACE SYCLSHAREDSPACE) +SET(EXECSPACE_OPENMPTARGET_VALID_MEM_SPACES OPENMPTARGETSPACE) +SET(EXECSPACE_SERIAL_VALID_MEM_SPACES HBWSPACE HOSTSPACE) +SET(EXECSPACE_OPENMP_VALID_MEM_SPACES HBWSPACE HOSTSPACE) +SET(EXECSPACE_PTHREAD_VALID_MEM_SPACES HBWSPACE HOSTSPACE) SET(DEVICES) FOREACH(EXEC ${EXEC_SPACES}) IF (KOKKOSKERNELS_INST_${EXEC}) diff --git a/packages/kokkos-kernels/cmake/kokkoskernels_features.cmake b/packages/kokkos-kernels/cmake/kokkoskernels_features.cmake index 6f4561f664fc..aacc1c845109 100644 --- a/packages/kokkos-kernels/cmake/kokkoskernels_features.cmake +++ b/packages/kokkos-kernels/cmake/kokkoskernels_features.cmake @@ -10,15 +10,14 @@ endfunction() KOKKOSKERNELS_ADD_OPTION( ENABLE_SUPERNODAL_SPTRSV - OFF + ON BOOL "Whether to build supernodal SPTRSV support") -KOKKOSKERNELS_FEATURE_DEPENDS_ON_TPLS( - SUPERNODAL_SPTRSV - CHOLMOD - SUPERLU - BLAS -) + +IF (KOKKOSKERNELS_ENABLE_SUPERNODAL_SPTRSV AND NOT KOKKOSKERNELS_INST_LAYOUTLEFT) + MESSAGE(WARNING "Disabling SUPERNODAL_SPTRSV - this capability is only supported with LayoutLeft") + SET(KOKKOSKERNELS_ENABLE_SUPERNODAL_SPTRSV OFF CACHE BOOL "Disabling SUPERNODAL_SPTRSV - this capability is only supported with LayoutLeft" FORCE) +ENDIF() # ================================================================== # Fortran Complex BLAS diff --git a/packages/kokkos-kernels/cmake/kokkoskernels_tpls.cmake b/packages/kokkos-kernels/cmake/kokkoskernels_tpls.cmake index 2bdcda1e81fb..15ff4e8bd66f 100644 --- a/packages/kokkos-kernels/cmake/kokkoskernels_tpls.cmake +++ b/packages/kokkos-kernels/cmake/kokkoskernels_tpls.cmake @@ -4,29 +4,46 @@ ENDFUNCTION() MACRO(KOKKOSKERNELS_ADD_TPL_OPTION NAME DEFAULT_VALUE DOCSTRING) CMAKE_PARSE_ARGUMENTS(TPL - "" - "DEFAULT_DOCSTRING" - "" - ${ARGN} - ) + "" + "DEFAULT_DOCSTRING" + "" + ${ARGN} + ) IF (NOT TPL_DEFAULT_DOCSTRING) SET(TPL_DEFAULT_DOCSTRING "${DEFAULT_VALUE}") - ENDIF() - KOKKOSKERNELS_ADD_OPTION(ENABLE_TPL_${NAME} ${DEFAULT_VALUE} BOOL "${DOCSTRING} Default: ${TPL_DEFAULT_DOCSTRING}") - SET(ROOT_DEFAULT $ENV{${NAME}_ROOT}) - KOKKOSKERNELS_ADD_OPTION(${NAME}_ROOT "${ROOT_DEFAULT}" PATH "Location of ${NAME} install root. Default: None or the value of the environment variable ${NAME}_ROOT if set") - IF (DEFINED TPL_ENABLE_${NAME}) - IF (TPL_ENABLE_${NAME} AND NOT KOKKOSKERNELS_ENABLE_TPL_${NAME}) - MESSAGE("Overriding KOKKOSKERNELS_ENABLE_TPL_${NAME}=OFF with TPL_ENABLE_${NAME}=ON") - SET(KOKKOSKERNELS_ENABLE_TPL_${NAME} ON) - ELSEIF(NOT TPL_ENABLE_${NAME} AND KOKKOSKERNELS_ENABLE_TPL_${NAME}) - MESSAGE("Overriding KOKKOSKERNELS_ENABLE_TPL_${NAME}=ON with TPL_ENABLE_${NAME}=OFF") - SET(KOKKOSKERNELS_ENABLE_TPL_${NAME} OFF) - ENDIF() - ENDIF() - IF (KOKKOSKERNELS_ENABLE_TPL_${NAME}) - LIST(APPEND KOKKOSKERNELS_TPL_LIST ${NAME}) - ENDIF() + ENDIF () + + SET(_NAME_ORIG ${NAME}) + SET(_NAME ${NAME}) + + # KokkosKernels uses all uppercase for TPLs while TriBits does not... + # See https://github.com/kokkos/kokkos-kernels/issues/1059 + IF (KOKKOSKERNELS_HAS_TRILINOS) + # Map KK TPL names to Trilinos TPL names + IF (${_NAME} STREQUAL SUPERLU) + SET(_NAME SuperLU) + ELSEIF (${_NAME} STREQUAL CHOLMOD) + SET(_NAME Cholmod) + ENDIF () + ENDIF () + + KOKKOSKERNELS_ADD_OPTION(ENABLE_TPL_${_NAME} ${DEFAULT_VALUE} BOOL "${DOCSTRING} Default: ${TPL_DEFAULT_DOCSTRING}") + SET(ROOT_DEFAULT $ENV{${_NAME_ORIG}_ROOT}) + KOKKOSKERNELS_ADD_OPTION(${_NAME_ORIG}_ROOT "${ROOT_DEFAULT}" PATH "Location of ${_NAME} install root. Default: None or the value of the environment variable ${_NAME}_ROOT if set") + IF (DEFINED TPL_ENABLE_${_NAME}) + IF (TPL_ENABLE_${_NAME} AND NOT KOKKOSKERNELS_ENABLE_TPL_${_NAME}) + MESSAGE("Overriding KOKKOSKERNELS_ENABLE_TPL_${_NAME_ORIG}=OFF with TPL_ENABLE_${_NAME}=ON") + SET(KOKKOSKERNELS_ENABLE_TPL_${_NAME_ORIG} ON) + SET(KOKKOSKERNELS_ENABLE_TPL_${_NAME} ON) + ELSEIF (NOT TPL_ENABLE_${_NAME} AND KOKKOSKERNELS_ENABLE_TPL_${_NAME}) + MESSAGE("Overriding KOKKOSKERNELS_ENABLE_TPL_${_NAME_ORIG}=ON with TPL_ENABLE_${_NAME}=OFF") + SET(KOKKOSKERNELS_ENABLE_TPL_${_NAME_ORIG} OFF) + SET(KOKKOSKERNELS_ENABLE_TPL_${_NAME} OFF) + ENDIF () + ENDIF () + IF (KOKKOSKERNELS_ENABLE_TPL_${_NAME}) + LIST(APPEND KOKKOSKERNELS_TPL_LIST ${_NAME}) + ENDIF () ENDMACRO() @@ -450,7 +467,6 @@ KOKKOSKERNELS_ADD_TPL_OPTION(CUSPARSE ${CUSPARSE_DEFAULT} "Whether to enable C DEFAULT_DOCSTRING "ON if CUDA-enabled Kokkos, otherwise OFF") IF (KOKKOSKERNELS_ENABLE_TPL_MAGMA) - IF (KOKKOSKERNELS_HAS_TRILINOS) IF (F77_BLAS_MANGLE STREQUAL "(name,NAME) name ## _") SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -DADD_ -fopenmp -lgfortran") ELSEIF (F77_BLAS_MANGLE STREQUAL "(name,NAME) NAME") @@ -460,18 +476,19 @@ IF (KOKKOSKERNELS_ENABLE_TPL_MAGMA) ELSE () MESSAGE(FATAL_ERROR "F77_BLAS_MANGLE ${F77_BLAS_MANGLE} detected while MAGMA only accepts Fortran mangling that is one of single underscore (-DADD_), uppercase (-DUPCASE), and no change (-DNOCHANGE)") ENDIF() - ELSE() - MESSAGE(FATAL_ERROR "KokkosKernels does not currently support MAGMA in standalone mode") - ENDIF() LIST(APPEND TPL_LIST "MAGMA") ENDIF() -KOKKOSKERNELS_ADD_TPL_OPTION(CHOLMOD OFF "Whether to enable CHOLMOD") -KOKKOSKERNELS_ADD_TPL_OPTION(SUPERLU OFF "Whether to enable SUPERLU") +KOKKOSKERNELS_ADD_TPL_OPTION(SUPERLU OFF "Whether to enable SUPERLU") +KOKKOSKERNELS_ADD_TPL_OPTION(CHOLMOD OFF "Whether to enable CHOLMOD") KOKKOSKERNELS_ADD_TPL_OPTION(METIS OFF "Whether to enable METIS") # We need to do all the import work IF (NOT KOKKOSKERNELS_HAS_TRILINOS) + IF (KokkosKernels_ENABLE_SuperLU5_API) + SET(HAVE_KOKKOSKERNELS_SUPERLU5_API TRUE) + ENDIF () + KOKKOSKERNELS_IMPORT_TPL(BLAS) KOKKOSKERNELS_IMPORT_TPL(LAPACK) KOKKOSKERNELS_IMPORT_TPL(MKL) @@ -483,11 +500,15 @@ IF (NOT KOKKOSKERNELS_HAS_TRILINOS) KOKKOSKERNELS_IMPORT_TPL(SUPERLU) KOKKOSKERNELS_IMPORT_TPL(METIS) KOKKOSKERNELS_IMPORT_TPL(ARMPL) -ENDIF() + KOKKOSKERNELS_IMPORT_TPL(MAGMA) +ELSE () + IF (Trilinos_ENABLE_SuperLU5_API) + SET(HAVE_KOKKOSKERNELS_SUPERLU5_API TRUE) + ENDIF () +ENDIF () #Convert list to newlines (which CMake doesn't always like in cache variables) STRING(REPLACE ";" "\n" KOKKOSKERNELS_TPL_EXPORT_TEMP "${KOKKOSKERNELS_TPL_EXPORTS}") #Convert to a regular variable UNSET(KOKKOSKERNELS_TPL_EXPORTS CACHE) SET(KOKKOSKERNELS_TPL_EXPORTS ${KOKKOSKERNELS_TPL_EXPORT_TEMP}) - diff --git a/packages/kokkos-kernels/cmake/kokkoskernels_tribits.cmake b/packages/kokkos-kernels/cmake/kokkoskernels_tribits.cmake index b023d7c4d2eb..981ace6bbe0e 100644 --- a/packages/kokkos-kernels/cmake/kokkoskernels_tribits.cmake +++ b/packages/kokkos-kernels/cmake/kokkoskernels_tribits.cmake @@ -152,6 +152,11 @@ IF (IS_ENABLED) TESTONLYLIBS ${PARSE_TESTONLYLIBS}) ELSE() ADD_EXECUTABLE(${EXE_NAME} ${PARSE_SOURCES}) + #AJP, BMK altered: + IF(KOKKOSKERNELS_ENABLE_TESTS_AND_PERFSUITE) + TARGET_LINK_LIBRARIES(${EXE_NAME} PRIVATE common ${PARSE_TESTONLYLIBS}) + ENDIF() + IF (PARSE_TESTONLYLIBS) TARGET_LINK_LIBRARIES(${EXE_NAME} PRIVATE Kokkos::kokkoskernels ${PARSE_TESTONLYLIBS}) ELSE () diff --git a/packages/kokkos-kernels/docs/CMakeLists.txt b/packages/kokkos-kernels/docs/CMakeLists.txt new file mode 100644 index 000000000000..63a4fa1e436f --- /dev/null +++ b/packages/kokkos-kernels/docs/CMakeLists.txt @@ -0,0 +1,45 @@ +# Source: https://devblogs.microsoft.com/cppblog/clear-functional-c-documentation-with-sphinx-breathe-doxygen-cmake/ +# Author: Evan Harvey +find_package(Doxygen REQUIRED) +find_package(Sphinx REQUIRED) + +set(SPHINX_SOURCE ${CMAKE_CURRENT_SOURCE_DIR}) +set(SPHINX_BUILD ${CMAKE_CURRENT_BINARY_DIR}/docs/sphinx) +set(KOKKOS_INCLUDE_DIR ${Kokkos_DIR}/../../../include) + +file(COPY ${CMAKE_CURRENT_SOURCE_DIR}/conf.py DESTINATION ${CMAKE_CURRENT_BINARY_DIR}) +file(COPY ${CMAKE_CURRENT_SOURCE_DIR}/index.rst DESTINATION ${CMAKE_CURRENT_BINARY_DIR}) + +# Find all public headers in KokkosKernels and Kokkos::kokkos +file(GLOB_RECURSE ${PROJECT_NAME}_PUBLIC_HEADERS ${PROJECT_SOURCE_DIR}/src/*.hpp ${KOKKOS_INCLUDE_DIR}/*.hpp) + +set(DOXYGEN_KOKKOSKERNELS_INPUT_DIR ${PROJECT_SOURCE_DIR}/src) +set(DOXYGEN_KOKKOS_INPUT_DIR ${KOKKOS_INCLUDE_DIR}) +set(DOXYGEN_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/doxygen/) +set(DOXYGEN_INDEX_FILE ${DOXYGEN_OUTPUT_DIR}/xml/index.xml) +set(DOXYFILE_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in) +set(DOXYFILE_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile) + +#Replace variables inside @@ with the current values +configure_file(${DOXYFILE_IN} ${DOXYFILE_OUT}) + +file(MAKE_DIRECTORY ${DOXYGEN_OUTPUT_DIR}) #Doxygen won't create this for us + +add_custom_command(OUTPUT ${DOXYGEN_INDEX_FILE} + DEPENDS ${${PROJECT_NAME}_PUBLIC_HEADERS} + COMMAND ${DOXYGEN_EXECUTABLE} Doxyfile + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} + DEPENDS Doxyfile + COMMENT "Generating docs") + +add_custom_target(Doxygen ALL DEPENDS ${DOXYGEN_INDEX_FILE}) + + +add_custom_target(Sphinx ALL + COMMAND ${SPHINX_EXECUTABLE} -b html + # Tell Breathe where to find the Doxygen output + -Dbreathe_projects.${PROJECT_NAME}=${DOXYGEN_OUTPUT_DIR}/xml + ${SPHINX_SOURCE} ${SPHINX_BUILD} + WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} + DEPENDS Doxygen + COMMENT "Generating documentation with Sphinx") \ No newline at end of file diff --git a/packages/kokkos-kernels/docs/Doxyfile.in b/packages/kokkos-kernels/docs/Doxyfile.in new file mode 100644 index 000000000000..8e208bb937f9 --- /dev/null +++ b/packages/kokkos-kernels/docs/Doxyfile.in @@ -0,0 +1,2638 @@ +# Doxyfile 1.9.2 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the configuration +# 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 +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "Kokkos" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = "@DOXYGEN_OUTPUT_DIR@" + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# 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 JAVADOC_BANNER tag is set to YES then doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by doxygen. +# The default value is: NO. + +JAVADOC_BANNER = 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 + +# By default Python docstrings are displayed as preformatted text and doxygen's +# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the +# doxygen's special commands can be used and the contents of the docstring +# documentation blocks is shown as doxygen documentation. +# The default value is: YES. + +PYTHON_DOCSTRING = YES + +# 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:^^" +# 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:". Note that you cannot put \n's in the value part of an alias +# to insert newlines (in the resulting output). You can put ^^ in the value part +# of an alias to insert a newline as if a physical newline was in the original +# file. When you need a literal { or } or , in the value part of an alias you +# have to escape them by means of a backslash (\), this can lead to conflicts +# with the commands \{ and \} for these it is advised to use the version @{ and +# @} or use a double escape (\\{ and \\}) + +ALIASES = + +# 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 + +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = 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, +# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, +# VHDL, 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). 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. When specifying no_extension you should add +# * to the FILE_PATTERNS. +# +# Note see also the list of default file extension mappings. + +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 https://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: 5. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 5 + +# 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: +# https://www.riverbankcomputing.com/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 + +# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use +# during processing. When set to 0 doxygen will based this on the number of +# cores available in the system. You can set it explicitly to a value larger +# than 0 to get more control over the balance between CPU load and processing +# speed. At this moment only the input processing can be done using multiple +# threads. Since this is still an experimental feature the default is set to 1, +# which effectively disables parallel processing. Please report any issues you +# encounter. Generating dot graphs in parallel is controlled by the +# DOT_NUM_THREADS setting. +# Minimum value: 0, maximum value: 32, default value: 1. + +NUM_PROC_THREADS = 1 + +#--------------------------------------------------------------------------- +# 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 = NO + +# 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_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = 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 this flag is set to YES, the name of an unnamed parameter in a declaration +# will be determined by the corresponding definition. By default unnamed +# parameters remain unnamed in the output. +# The default value is: YES. + +RESOLVE_UNNAMED_PARAMS = YES + +# 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 +# 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 + +# With the correct setting of option CASE_SENSE_NAMES doxygen will better be +# able to match the capabilities of the underlying filesystem. In case the +# filesystem is case sensitive (i.e. it supports files in the same directory +# whose names only differ in casing), the option must be set to YES to properly +# deal with such files in case they appear in the input. For filesystems that +# are not case sensitive the option should be be set to NO to properly deal with +# output files written for symbols that only differ in casing, such as for two +# classes, one named CLASS and the other named Class, and to also support +# references to files without having to specify the exact matching casing. On +# Windows (including Cygwin) and MacOS, users should typically set this option +# to NO, whereas on Linux or other Unix flavors it should typically be set to +# YES. +# The default value is: system dependent. + +CASE_SENSE_NAMES = NO + +# 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_HEADERFILE tag is set to YES then the documentation for a class +# will show which file needs to be included to use the class. +# The default value is: YES. + +SHOW_HEADERFILE = YES + +# 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 = YES + +# 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. See also section "Changing the +# layout of pages" for information. +# +# 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 https://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 documenting some parameters in +# a documented function twice, or documenting parameters that don't exist or +# using markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete +# function parameter documentation. If set to NO, doxygen will accept that some +# parameters have no documentation without warning. +# The default value is: YES. + +WARN_IF_INCOMPLETE_DOC = 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 parameter +# documentation, but not about the absence of documentation. If EXTRACT_ALL is +# set to YES then this flag will automatically be disabled. See also +# WARN_IF_INCOMPLETE_DOC +# 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. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS +# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but +# at the end of the doxygen process doxygen will return with a non-zero status. +# Possible values are: NO, YES and FAIL_ON_WARNINGS. +# 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 = + +#--------------------------------------------------------------------------- +# 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 = "@DOXYGEN_KOKKOSKERNELS_INPUT_DIR@" "@DOXYGEN_KOKKOS_INPUT_DIR@" + +# 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: +# https://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. +# +# Note the list of default checked file patterns might differ from the list of +# default file extension mappings. +# +# 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++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, +# *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C +# comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, +# *.vhdl, *.ucf, *.qsf and *.ice. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.idl \ + *.ddl \ + *.odl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.l \ + *.cs \ + *.d \ + *.php \ + *.php4 \ + *.php5 \ + *.phtml \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.pyw \ + *.f90 \ + *.f95 \ + *.f03 \ + *.f08 \ + *.f18 \ + *.f \ + *.for \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf \ + *.ice + +# 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 +# entity 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 https://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 configuration 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 + +# 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 = NO + +# 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 color-wheel, see +# https://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 gray-scales 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_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via JavaScript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have JavaScript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + +# 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: +# https://developer.apple.com/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 https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.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 +# on Windows. In the beginning of 2021 Microsoft took the original page, with +# a.o. the download links, offline the HTML help workshop was already many years +# in maintenance mode). You can download the HTML help workshop from the web +# archives at Installation executable (see: +# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo +# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). +# +# 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 main .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: +# https://doc.qt.io/archives/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: +# https://doc.qt.io/archives/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: +# https://doc.qt.io/archives/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: +# https://doc.qt.io/archives/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: +# https://doc.qt.io/archives/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 (absolute path +# including file name) 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 (see "Fine-tuning the output"). 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 + +# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the +# FULL_SIDEBAR option determines if the side bar is limited to only the treeview +# area (value NO) or if it should extend to the full height of the window (value +# YES). Setting this to YES gives a layout similar to +# https://docs.readthedocs.io with more room for contents, but less room for the +# project logo, title, and description. If either GENERATOR_TREEVIEW or +# DISABLE_INDEX is set to NO, this option has no effect. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FULL_SIDEBAR = 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 + +# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg +# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see +# https://inkscape.org) to generate formulas as SVG images instead of PNGs for +# the HTML output. These images will generally look nicer at scaled resolutions. +# Possible values are: png (the default) and svg (looks nicer but requires the +# pdf2svg or inkscape tool). +# The default value is: png. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FORMULA_FORMAT = png + +# 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_TRANSPARENT 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 + +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. + +FORMULA_MACROFILE = + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://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 + +# With MATHJAX_VERSION it is possible to specify the MathJax version to be used. +# Note that the different versions of MathJax have different requirements with +# regards to the different settings, so it is possible that also other MathJax +# settings have to be changed when switching between the different MathJax +# versions. +# Possible values are: MathJax_2 and MathJax_3. +# The default value is: MathJax_2. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_VERSION = MathJax_2 + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. For more details about the output format see MathJax +# version 2 (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3 +# (see: +# http://docs.mathjax.org/en/latest/web/components/output.html). +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility. This is the name for Mathjax version 2, for MathJax version 3 +# this will be translated into chtml), NativeMML (i.e. MathML. Only supported +# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This +# is the name for Mathjax version 3, for MathJax version 2 this will be +# translated into HTML-CSS) 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 https://www.mathjax.org before deployment. The default value is: +# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 +# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# for MathJax version 2 (see https://docs.mathjax.org/en/v2.7-latest/tex.html +# #tex-and-latex-extensions): +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# For example for MathJax version 3 (see +# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html): +# MATHJAX_EXTENSIONS = ams +# 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/v2.7-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 +# , /