From b1d8ea854a716be1e720f6371dbf52b64dfb4b18 Mon Sep 17 00:00:00 2001 From: Jake Hemstad Date: Thu, 4 Jun 2020 15:37:41 -0500 Subject: [PATCH 01/35] Initial commit. --- cpp/.gitignore | 4 + cpp/CMakeLists.txt | 90 + cpp/LICENSE | 201 ++ cpp/README.md | 44 + .../Modules/ConfigureGoogleBenchmark.cmake | 59 + cpp/cmake/Modules/ConfigureGoogleTest.cmake | 59 + .../GoogleBenchmark.CMakeLists.txt.cmake | 19 + .../Templates/GoogleTest.CMakeLists.txt.cmake | 12 + cpp/docs/example_range.png | Bin 0 -> 17445 bytes cpp/doxygen/Doxyfile | 2427 +++++++++++++++++ cpp/nvtx3.hpp | 2045 ++++++++++++++ cpp/tests/CMakeLists.txt | 84 + cpp/tests/cupti_nvtx_injection.hpp | 17 + cpp/tests/nvtx_tests.cpp | 199 ++ 14 files changed, 5260 insertions(+) create mode 100644 cpp/.gitignore create mode 100644 cpp/CMakeLists.txt create mode 100644 cpp/LICENSE create mode 100644 cpp/README.md create mode 100644 cpp/cmake/Modules/ConfigureGoogleBenchmark.cmake create mode 100644 cpp/cmake/Modules/ConfigureGoogleTest.cmake create mode 100644 cpp/cmake/Templates/GoogleBenchmark.CMakeLists.txt.cmake create mode 100644 cpp/cmake/Templates/GoogleTest.CMakeLists.txt.cmake create mode 100644 cpp/docs/example_range.png create mode 100644 cpp/doxygen/Doxyfile create mode 100644 cpp/nvtx3.hpp create mode 100644 cpp/tests/CMakeLists.txt create mode 100644 cpp/tests/cupti_nvtx_injection.hpp create mode 100644 cpp/tests/nvtx_tests.cpp diff --git a/cpp/.gitignore b/cpp/.gitignore new file mode 100644 index 0000000..9d107cc --- /dev/null +++ b/cpp/.gitignore @@ -0,0 +1,4 @@ +build/ +docs/html/ +docs/index.html + diff --git a/cpp/CMakeLists.txt b/cpp/CMakeLists.txt new file mode 100644 index 0000000..b55bfef --- /dev/null +++ b/cpp/CMakeLists.txt @@ -0,0 +1,90 @@ +#============================================================================= +# Copyright (c) 2020, NVIDIA CORPORATION. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +#============================================================================= +cmake_minimum_required(VERSION 3.12 FATAL_ERROR) + +project(NVTX VERSION 0.1.0 LANGUAGES C CXX CUDA) + +find_package(CUDA REQUIRED) + +################################################################################################### +# - build type ------------------------------------------------------------------------------------ + +# Set a default build type if none was specified +set(DEFAULT_BUILD_TYPE "Release") + +if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES) + message(STATUS "Setting build type to '${DEFAULT_BUILD_TYPE}' since none specified.") + set(CMAKE_BUILD_TYPE "${DEFAULT_BUILD_TYPE}" CACHE + STRING "Choose the type of build." FORCE) + # Set the possible values of build type for cmake-gui + set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS + "Debug" "Release" "MinSizeRel" "RelWithDebInfo") +endif() + +################################################################################################### +# - compiler options ------------------------------------------------------------------------------ + +set(CMAKE_CXX_STANDARD 11) +set(CMAKE_CXX_STANDARD_REQUIRED ON) +set(CMAKE_C_COMPILER $ENV{CC}) +set(CMAKE_CXX_COMPILER $ENV{CXX}) + +if(CMAKE_COMPILER_IS_GNUCXX) + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Werror") + + option(CMAKE_CXX11_ABI "Enable the GLIBCXX11 ABI" ON) + if(CMAKE_CXX11_ABI) + message(STATUS "RMM: Enabling the GLIBCXX11 ABI") + else() + message(STATUS "RMM: Disabling the GLIBCXX11 ABI") + set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -D_GLIBCXX_USE_CXX11_ABI=0") + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -D_GLIBCXX_USE_CXX11_ABI=0") + set(CMAKE_CUDA_FLAGS "${CMAKE_CUDA_FLAGS} -Xcompiler -D_GLIBCXX_USE_CXX11_ABI=0") + endif(CMAKE_CXX11_ABI) +endif(CMAKE_COMPILER_IS_GNUCXX) + +################################################################################################### +# - cmake modules --------------------------------------------------------------------------------- + +set(CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake/Modules/" ${CMAKE_MODULE_PATH}) + +include(FeatureSummary) +include(CheckIncludeFiles) +include(CheckLibraryExists) + +################################################################################################### +# - add gtest ------------------------------------------------------------------------------------- + +include(CTest) +include(ConfigureGoogleTest) + +if(GTEST_FOUND) + message(STATUS "Google C++ Testing Framework (Google Test) found in ${GTEST_ROOT}") + include_directories(${GTEST_INCLUDE_DIR}) + add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/tests) +else() + message(AUTHOR_WARNING "Google C++ Testing Framework (Google Test) not found: automated tests are disabled.") +endif(GTEST_FOUND) + + +################################################################################################### +# - build doxygen --------------------------------------------------------------------------------- +add_custom_command(OUTPUT BUILD_DOXYGEN + WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} + COMMAND doxygen doxygen/Doxyfile + VERBATIM) + +add_custom_target(docs DEPENDS BUILD_DOXYGEN) diff --git a/cpp/LICENSE b/cpp/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/cpp/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/cpp/README.md b/cpp/README.md new file mode 100644 index 0000000..2d9d762 --- /dev/null +++ b/cpp/README.md @@ -0,0 +1,44 @@ +# NVTX++ + +Provides C++ convenience wrappers for NVIDIA Tool Extension (NVTX) C APIs. + +See https://jrhemstad.github.io/nvtx_wrappers/html/index.html for Doxygen documentation. + + # Quick Start + + To add NVTX ranges to your code, use the `nvtx3::thread_range` RAII object. A + range begins when the object is created, and ends when the object is + destroyed. + + ```c++ + #include "nvtx3.hpp" + void some_function(){ + // Begins a NVTX range with the messsage "some_function" + // The range ends when some_function() returns and `r` is destroyed + nvtx3::thread_range r{"some_function"}; + + for(int i = 0; i < 6; ++i){ + nvtx3::thread_range loop{"loop range"}; + std::this_thread::sleep_for(std::chrono::seconds{1}); + } + } // Range ends when `r` is destroyed + ``` + + The example code above generates the following timeline view in Nsight Systems: + + ![alt text](https://raw.githubusercontent.com/jrhemstad/nvtx_wrappers/master/docs/example_range.png "Example NVTX Ranges") + + Alternatively, use the macro `NVTX3_FUNC_RANGE()` to add + ranges to your code that automatically use the name of the enclosing function + as the range's message. + + ```c++ + #include "nvtx3.hpp" + void some_function(){ + // Creates a range with a message "some_function" that ends when the enclosing + // function returns + NVTX3_FUNC_RANGE(); + ... + } + ``` + diff --git a/cpp/cmake/Modules/ConfigureGoogleBenchmark.cmake b/cpp/cmake/Modules/ConfigureGoogleBenchmark.cmake new file mode 100644 index 0000000..55ed165 --- /dev/null +++ b/cpp/cmake/Modules/ConfigureGoogleBenchmark.cmake @@ -0,0 +1,59 @@ +set(GBENCH_ROOT "${CMAKE_BINARY_DIR}/googlebenchmark") + +set(GBENCH_CMAKE_ARGS " -DCMAKE_BUILD_TYPE=Release") + #" -Dgtest_build_samples=ON" + #" -DCMAKE_VERBOSE_MAKEFILE=ON") + +if(NOT CMAKE_CXX11_ABI) + message(STATUS "GBENCH: Disabling the GLIBCXX11 ABI") + list(APPEND GBENCH_CMAKE_ARGS " -DCMAKE_C_FLAGS=-D_GLIBCXX_USE_CXX11_ABI=0") + list(APPEND GBENCH_CMAKE_ARGS " -DCMAKE_CXX_FLAGS=-D_GLIBCXX_USE_CXX11_ABI=0") +elseif(CMAKE_CXX11_ABI) + message(STATUS "GBENCH: Enabling the GLIBCXX11 ABI") + list(APPEND GBENCH_CMAKE_ARGS " -DCMAKE_C_FLAGS=-D_GLIBCXX_USE_CXX11_ABI=1") + list(APPEND GBENCH_CMAKE_ARGS " -DCMAKE_CXX_FLAGS=-D_GLIBCXX_USE_CXX11_ABI=1") +endif(NOT CMAKE_CXX11_ABI) + +configure_file("${CMAKE_SOURCE_DIR}/cmake/Templates/GoogleBenchmark.CMakeLists.txt.cmake" + "${GBENCH_ROOT}/CMakeLists.txt") + +file(MAKE_DIRECTORY "${GBENCH_ROOT}/build") +file(MAKE_DIRECTORY "${GBENCH_ROOT}/install") + +execute_process(COMMAND ${CMAKE_COMMAND} -G ${CMAKE_GENERATOR} . + RESULT_VARIABLE GBENCH_CONFIG + WORKING_DIRECTORY ${GBENCH_ROOT}) + +if(GBENCH_CONFIG) + message(FATAL_ERROR "Configuring Google Benchmark failed: " ${GBENCH_CONFIG}) +endif(GBENCH_CONFIG) + +set(PARALLEL_BUILD -j) +if($ENV{PARALLEL_LEVEL}) + set(NUM_JOBS $ENV{PARALLEL_LEVEL}) + set(PARALLEL_BUILD "${PARALLEL_BUILD}${NUM_JOBS}") +endif($ENV{PARALLEL_LEVEL}) + +if(${NUM_JOBS}) + if(${NUM_JOBS} EQUAL 1) + message(STATUS "GBENCH BUILD: Enabling Sequential CMake build") + elseif(${NUM_JOBS} GREATER 1) + message(STATUS "GBENCH BUILD: Enabling Parallel CMake build with ${NUM_JOBS} jobs") + endif(${NUM_JOBS} EQUAL 1) +else() + message(STATUS "GBENCH BUILD: Enabling Parallel CMake build with all threads") +endif(${NUM_JOBS}) + +execute_process(COMMAND ${CMAKE_COMMAND} --build .. -- ${PARALLEL_BUILD} + RESULT_VARIABLE GBENCH_BUILD + WORKING_DIRECTORY ${GBENCH_ROOT}/build) + +if(GBENCH_BUILD) + message(FATAL_ERROR "Building Google Benchmark failed: " ${GBENCH_BUILD}) +endif(GBENCH_BUILD) + +message(STATUS "Google Benchmark installed here: " ${GBENCH_ROOT}/install) +set(GBENCH_INCLUDE_DIR "${GBENCH_ROOT}/install/include") +set(GBENCH_LIBRARY_DIR "${GBENCH_ROOT}/install/lib" "${GBENCH_ROOT}/install/lib64") +set(GBENCH_FOUND TRUE) + diff --git a/cpp/cmake/Modules/ConfigureGoogleTest.cmake b/cpp/cmake/Modules/ConfigureGoogleTest.cmake new file mode 100644 index 0000000..d2f2f2c --- /dev/null +++ b/cpp/cmake/Modules/ConfigureGoogleTest.cmake @@ -0,0 +1,59 @@ +set(GTEST_ROOT "${CMAKE_BINARY_DIR}/googletest") + +set(GTEST_CMAKE_ARGS "") + # " -Dgtest_build_samples=ON" + # " -DCMAKE_VERBOSE_MAKEFILE=ON") + +if(NOT CMAKE_CXX11_ABI) + message(STATUS "GTEST: Disabling the GLIBCXX11 ABI") + list(APPEND GTEST_CMAKE_ARGS " -DCMAKE_C_FLAGS=-D_GLIBCXX_USE_CXX11_ABI=0") + list(APPEND GTEST_CMAKE_ARGS " -DCMAKE_CXX_FLAGS=-D_GLIBCXX_USE_CXX11_ABI=0") +elseif(CMAKE_CXX11_ABI) + message(STATUS "GTEST: Enabling the GLIBCXX11 ABI") + list(APPEND GTEST_CMAKE_ARGS " -DCMAKE_C_FLAGS=-D_GLIBCXX_USE_CXX11_ABI=1") + list(APPEND GTEST_CMAKE_ARGS " -DCMAKE_CXX_FLAGS=-D_GLIBCXX_USE_CXX11_ABI=1") +endif(NOT CMAKE_CXX11_ABI) + +configure_file("${CMAKE_SOURCE_DIR}/cmake/Templates/GoogleTest.CMakeLists.txt.cmake" + "${GTEST_ROOT}/CMakeLists.txt") + +file(MAKE_DIRECTORY "${GTEST_ROOT}/build") +file(MAKE_DIRECTORY "${GTEST_ROOT}/install") + +execute_process(COMMAND ${CMAKE_COMMAND} -G ${CMAKE_GENERATOR} . + RESULT_VARIABLE GTEST_CONFIG + WORKING_DIRECTORY ${GTEST_ROOT}) + +if(GTEST_CONFIG) + message(FATAL_ERROR "Configuring GoogleTest failed: " ${GTEST_CONFIG}) +endif(GTEST_CONFIG) + +set(PARALLEL_BUILD -j) +if($ENV{PARALLEL_LEVEL}) + set(NUM_JOBS $ENV{PARALLEL_LEVEL}) + set(PARALLEL_BUILD "${PARALLEL_BUILD}${NUM_JOBS}") +endif($ENV{PARALLEL_LEVEL}) + +if(${NUM_JOBS}) + if(${NUM_JOBS} EQUAL 1) + message(STATUS "GTEST BUILD: Enabling Sequential CMake build") + elseif(${NUM_JOBS} GREATER 1) + message(STATUS "GTEST BUILD: Enabling Parallel CMake build with ${NUM_JOBS} jobs") + endif(${NUM_JOBS} EQUAL 1) +else() + message(STATUS "GTEST BUILD: Enabling Parallel CMake build with all threads") +endif(${NUM_JOBS}) + +execute_process(COMMAND ${CMAKE_COMMAND} --build .. -- ${PARALLEL_BUILD} + RESULT_VARIABLE GTEST_BUILD + WORKING_DIRECTORY ${GTEST_ROOT}/build) + +if(GTEST_BUILD) + message(FATAL_ERROR "Building GoogleTest failed: " ${GTEST_BUILD}) +endif(GTEST_BUILD) + +message(STATUS "GoogleTest installed here: " ${GTEST_ROOT}/install) +set(GTEST_INCLUDE_DIR "${GTEST_ROOT}/install/include") +set(GTEST_LIBRARY_DIR "${GTEST_ROOT}/install/lib") +set(GTEST_FOUND TRUE) + diff --git a/cpp/cmake/Templates/GoogleBenchmark.CMakeLists.txt.cmake b/cpp/cmake/Templates/GoogleBenchmark.CMakeLists.txt.cmake new file mode 100644 index 0000000..c0f6abb --- /dev/null +++ b/cpp/cmake/Templates/GoogleBenchmark.CMakeLists.txt.cmake @@ -0,0 +1,19 @@ +cmake_minimum_required(VERSION 3.12) + +include(ExternalProject) + +ExternalProject_Add(GoogleBenchmark + GIT_REPOSITORY https://github.com/google/benchmark.git + GIT_TAG master + SOURCE_DIR "${GBENCH_ROOT}/googlebenchmark" + BINARY_DIR "${GBENCH_ROOT}/build" + INSTALL_DIR "${GBENCH_ROOT}/install" + CMAKE_ARGS ${GBENCH_CMAKE_ARGS} -DBENCHMARK_ENABLE_TESTING=OFF -DCMAKE_INSTALL_PREFIX=${GBENCH_ROOT}/install) + # The flag BENCHMARK_ENABLE_TESTING=OFF prevents Google Benchmark from asking for Google Test. + + + + + + + diff --git a/cpp/cmake/Templates/GoogleTest.CMakeLists.txt.cmake b/cpp/cmake/Templates/GoogleTest.CMakeLists.txt.cmake new file mode 100644 index 0000000..fe0035e --- /dev/null +++ b/cpp/cmake/Templates/GoogleTest.CMakeLists.txt.cmake @@ -0,0 +1,12 @@ +cmake_minimum_required(VERSION 3.12) + +include(ExternalProject) + +ExternalProject_Add(GoogleTest + GIT_REPOSITORY https://github.com/google/googletest.git + GIT_TAG release-1.8.0 + SOURCE_DIR "${GTEST_ROOT}/googletest" + BINARY_DIR "${GTEST_ROOT}/build" + INSTALL_DIR "${GTEST_ROOT}/install" + CMAKE_ARGS ${GTEST_CMAKE_ARGS} -DCMAKE_INSTALL_PREFIX=${GTEST_ROOT}/install) + diff --git a/cpp/docs/example_range.png b/cpp/docs/example_range.png new file mode 100644 index 0000000000000000000000000000000000000000..ee501c9cd11d8fcaf3f0f7cf345fb92448ae5511 GIT binary patch literal 17445 zcmbuncRZH;|2HnBtV&8oN@tO>Gm;S{5lWJgO*SDbD^y5@$jHhlBw1x9vteW;ghXU# zugG>k&#ue$x$e*Rz8}B)@%SBoh;tstd%RxHb#zZjQFbdO6D0`=$yT|u(#j+xu%%XsvZQXm?cLMQG?Qg0!=ds@8>vfa`LUe>}Gj4CAG?djI#9yRQ%@} z&XcGJT)cR(J_94&Wtb&48w#j)DlV>#VT3Y6k!gZ%7C;6N%9?qAI zl_k{@;?l@s6%*4UH!wDC&bR5>&8-qs^)6`ugz&mZ!>3 zjEV=hz37{%muwxGoz9Aj(=#)B?lN-9CCp>9oTcj1))Dng-I$=D{odCc9B%Z7sdId$ zP}h&AwI#bFHTLyYf^Bcb#?91U3!NtFCD)cK_So$5P!CR&31BMz)u`|+eBk+x3o<89 zp3KxOZb{dY)eOt{bxH1O>gI%ouW1_Drg82q-@du_SBK%eVvic$De#jjI590w`}KtZ z21r*|SL*I}eDt^6RF|27fedoGi;FI->8iDL(ZYs?hC)nRB^fw1j|@JnRXe(}^czQb zxJb0TN;M;1^zn`32tPl+uG?5{l#pd-iF@G{(+~P~W!53}QwepW~*9;0CI%I-5lu5W4 z%zEKM{f>h&5t*W)r>8DyFuziLqnT?#wq*+yfmLpLc6RIb?cuEVYB?0|4Zd;~AWd~} z9BB!=@U+2fmsF6N4~NG-zkEWvs+Vr&T5IX5kbc?CvG#l_{?yCm^@dZ&jPf{++&K0z zjW%pm>~y0hS>NCwPS9z7vith=>%pu-W}oA)ti7|NIzqB`P(ngCT}?|%i;9q=nJ$x1 z;JN1UkiuUp-`ahy&9tSZMW^t(RnxQc*RRjv8%#evHn*~hiH=THORZB8i@mAmxzb!y zV_6kMkh=TpmxFz{7yF&BYDWh@#iVNGXY9|WG!+dzLxTxfnC`dZ*s_iJ@Y&QWbRvOg zf?7BXYaVgqs<>}VX!EB^nkHA|W9$K0f|zb4EtS+qZ9Z-Z*^x_)+BgXhd9GoR`;WY3UC>RP?m8 zv=*%yV?TcAKl^s^lux~#tLtKaO?bl7r&-zA#l^+_(TY+>?r%|(xtbag#;HC$yNG#C zZMNV~)%K}3?4I3}S8di+;*Jrxq^ztMC-MEs=`D>fl+JuI?9M-H8D=~7Ef?!0aF4KJ zlJW}9X)BZ9+4nE?xNvpctW{&fm~5q>prEEMvh9_TmX@x3u=itH)-FjepDwm^ zRT(?GX>33pZS6yfkAMF7aqZ`4f}Wn9*IT8zoX!IK%F0UFu;AbW-sIc23$K*WIv@CA zF`H}I8YO6cWn4;0;@-V`7~4n*_cyt@xw@HpSwMzr)uIDb~`pb--p1$z~aiH#PJ)8P; ztfOEC-!#puTN^3RY#|h>`t+UY z%MY6qRU7yP1k}?m8!S>-d<adzlKWOmtf_LTdna;Tzwo)8!JSX~&Lel}a0AH-o- zc=X3nTa>cDj+11}V%KXwe!Qo3_DNP%++hjzzn{2iXKQDN^>OLr_Ot7KmxS+NM%hW@ zZbGN(*LyqJeQ09D)WerPsm4vI#XYQkQSZ!XuBz%@q2(^akt)$^oT#cg%V;ypn3A^W zAO28Hwb`_&*)%b0SU^`sQaj4c($+rxJtgaRYTDlq#jWPyGx{h^b_oFkj=(DWSL$G!eRBud+i-%aAP3{=Pm5uG5f?rG5%6`0k5~gAywDu1`yizTC zi$HO4nf?peBB>?k`Ke6RRL@Z17e!qGe!;^>R>NW+uGR@FBp1&`El-D~T#8x{%FSy` z)5>r8@=Sd~*XhcY1B$W{OZh9Rlc`w}dFz+^B7<37e|hPUvQJ44la;3Hv*rHbfjq0F zZ7vJ_4-@VS^Gql4ewNHSZ?4DId}-OT>4K!=SYz&^)7%TjsV(WHE7uF+^s)~`2QnPx zzgm93@`Z1vZ_J_fORmlo$A%kHFf}~rNddUP>7tR|Ku#EEXZ#N$~l5{axVs-u?FK@lfR`-@nJ<}Jaokf9r1fLHM_jEjU$qr$^u=|Kj{rGpCH`j%V zA1_v?>J&QV=jCzmKhF5>^?UTY;au08dNJ?%`Em?+?&~QwME?}KzRP?E6Y=0+B_t|) z9^|GVB)+q1Nz*NMY`^a5xu*V1alvfdms8D~LM|~Wso%&nPQ*<&II-`;ht-uukJ;uP zdOc=ZkLkXka9wfxfiz!V(~v{wAMBOXO@2`GCf8EW!{tN39$_mhE8&$K+qz-Z%D}ki zmnw}rz8;k#C&zkSD!Wc2NX1RG1ir~_xvXKfe#8QD~LRxYG?oR6;PDh!Xf z)>U4fnbx_EU{6kj#90!y88{gUAQl(SG5}Kim5-mLP=fl*0cR=?7n@|3SwIAwYBFKbllwB z#I&?r+|M~Ud>Fc`wt>5EYgSg)w;XG3R`cFFTNO$dL{~dc1jy`UVTlV3JC@ zwWxn95psPOvS}G@xyQFAr#e35wU*15bmFedV+xM}S@;g?u$K9B2 z?qTzBo7qnO8c?m(`n%sQjlRX3maQ2D1qH3Pw#JL=`<+BVY5H`LUzfsgm%4iBG#e{{ z&U&s?i{hfgsbJk3wpA1C9$mkhDsC??7j<;(tPCudmNiXGYWwv(5&yX5|p*5VFdCnX4kdWrTU zuif$&XGdyQjEqf-7b^C|#*POtEdr^OF8yBP%<2livu$ZCKVfKSXu4)Y{qM{%m67Qr zh0Jp?%IzsFoyBhbvwK=H3t$%gf46+N-a(dZpl#v{i&E$l%oeTj*#nv*F6b5NuER>QMd}t1ch_rP$uD>QU87~nUyQ(QOc|tMig8r8@jV92s?sq<6#R(oO ziy~rT+Zp-$G+<8*}N7=0>Po7|l5x(VG<{Q^M z`ug=N&@&KXyWsYQXXm5oIMoC}RnAHRiqGuRXJ3AGDl$10|*hUwi8|3hHLBSarnd-6R^U=GRnXg(| z=@fBBuVDoxO$c&vT`jx0;nK5nuk!PM&&(8F>wedmr11UwcYw`fHl1AgZ6)q*;HzU} zV<<@BTp9;5xo%J$0UNj=xsr3*ciZ_WK}G?SbEi(d-6^tv{oLZE`yla~h| zzv#D{+oUck?BT@-x%*Ga9^4$UY@Q2Wj&m<)5+;KIv!@-sV&R6bY-sn z!@Zp>1zmYo?c4SotA#LwlRtX&D9CQ+#e@n>8mrv>d-rxo{Tgm2>M<6%sJL^yCG$NP zpZiYJizAs@AW#|_v*X{FM%%KDS%lWl@G!4cfo4q;-Lxuwe@ror6qjz1Gb9Q13~lo- z&l?~HfcrRt{wy4zj!_&$$?ooc7#b>Q@Xi~|MLZ2>>f}<2bJcxy<&2V&lCEy7Vlt<3 zDWrhu+v(})US3}KIb=-K#Ckvw*5)fEGjs|Md7nLhKIWK}=9D7jgnl0;A&U>?BM$7wF9o$~8jzss8!|WV^vkkSU-) zJ@M|7)4mUwMW#V_8X6kj-`N_%@*k90n{;6NRL0j)ADX9FR9LrfYl%s5o$2pV!$;4@hzf~{zJY?d zeV_Q`)Racy_4MV}e(m`-yq90@ClKD&)med{VPeDEe-AYc{%lB)x=XS1(76b{?r;Dh zaI=JjgyeIPw0rgdoHNtXW|=iSt>hhTw<&dB=nqGG92*|Ch?4lHs0}=omy_Ee+P*lv8|}M7&D@WH7(qABb$Fwm=P5NjMnwn&#Cv@B~^wWC|%#NW5=yqxBe};vO^ES z^d;%tvR#@RtM2rhYJoerpQtJ?yb|Ix=H)`O+kC>i>5T4 zK&Ct)vPd#626M7dpIXvtDU%IJ`_pgI(#csXD>p*sP(5{LG1K|%BtAeMb1xk`FJDcVXDYKmm+^ka|0Vc zn|cKplT;eyLMS09XYL1z%PT4t7Z(Qx1}F(P+}&F0TS|ST6NsNPOSlGSyXW#5Un0_-WNaLhN6<7SOL^`FXp6u%6 z1{6CPpt5Sd)PD;hY%eqO=55TcuXRg76Cr$nkPDI01^Vyk=v83JluOBEYoq&Fn>U0998lUGu_=nRgP)lc!nY*l+lJtKluxmTQg*src4G7vH$zGMl;Jw>wj3 zA)tWjZOBQJR8dkb$DkIAn`LT8jPjWFXRA_1rVo=}Z9b)$x`khhEz*UwcWI(DPROz) z%eV$Oh@OQ-6736e6qa@S*RSUy`OhRYJQj1xzyP6i6+m-2vhs7*H9fD#5G_j%e1fCM zPjJH|kWD<@ZKR*9zBul*3TYZa#AVch#6L~gW9-T!lcz&;tMQBJ!69~k3 zXYoj1UkhIQl;>SVU+S|3rUt#v4ibq)!`uqE5#|tMs&_d&?k<8M8Pcemd{ndSaeHc7qg*oB+i$<#I^gMhC=(c&*-xuqIyCSR! zs#n-p+C=Tz-uk~XC z0_q~O2OoK4i{t9_`TX~YEf$oxd(&i=%(;eC1cb1Nzjop+aZG(A@T`=>`?Wp$_0?p* zed1?P?K96ue=BGbSXfxFmyGqC8Q{*-(#v1b{igLXa8&A+qe^Dxw4lP{>)xcMrZ$+JJ9qAvO~aK%%gl)1hr3Iw z(lmBl4&7)jBuwfzO~@XQF}WyV)RIQdRedW*lZ4;z{?Wlr6{wu3U%+)1n(#e#GBLRV ze8I1B9Pe0I`Q24tT|Eqt;+Ba|wM%Ze^i~AKxs4Y9$JIs&ji4Oa z6wkJNiV@SwwV0i4)hmU?lYAjgEkz}ec>>t<-Jb)^jTSVWj;{ab&%@sHc%A3kij$?K zB|#c3|3a+zP)|=5)*Dvc8Clu(Z{H{h#I-ryC&$anD;Ioj@1x5f(T(4~d-o|$a$%B88br*d1Nh4*L8aXDpK1Qt6sq5{_3AM{wS}bDMmqWKYOp>>wJmtZ-xJ_U(aw^t_Y=wG8crX2`&Bav(2T zbiAIz#KIBNP23VDFJ$_O+2u*-Uetu@y1Mh^4VikS0NK3{ed;0wD$9vS5^NvxVH)M=O% z9J1g2xZ%sY$P$`!(+ge|Yn45X9A@m%dHiRtL<%Qvj- z>FIe^KOapa6`Y8PBYdza-5bI>R2!Ksb+@BKTe9?-UGMn!H`PnS-*RhG?vk(4Z7|xj zTZx90irD{ld6yAe`Na(bkISB4N>+sDXklT|E#i+7*qm}nmfXP7a_M*J+RB9Inj0kU z+hkNg+7lfG2fN;W{D4#a^lAK|Sa2LAkN5M733rxVxMK>q0Z-RXwjJJMCUCb_n7!DV{0GwVVe4Z&M8y=4T;wO(S4pYP=g`-}vwls}`G zgruaNwZ5yapJw_o25PoBwC_BZraO1#NfbJ$`LoDW(6lSjoI!DU9aw$y4N9f3U@0!*z!2dEM)YV^-h3WazkIH$M}C zOae>cXIr*uw+XDtY?C^91qHu*_l`84?ylJZ3uJnF`W$aaNQgpPuBOh^t=3faiLv~y zk~x;?$EP%o6~SmV7ddpOqN(YU?y-Oa92^$jFE_1axb(|Wmvx6oh4(As(&8$)apnQD*O2A_j3Z{EgG5h2cgtgPMq zezN?7bPS>~)^Bf<*$>o$kxsN`>fN}p49^>84Q#)|-VrC<=BRj!eoRcjyIcc15ET;> z2D%UJ1WgHj_|SG?+8DAXgwKdrn~P7Om+#uO>qA9F^>1U2a9|?E$H%84O=HbLw`F81 zR#%qvoV$IpYVT^p?X8Ov;w@b!@)J~qP89hATTvA)LA4U)b`n0|)U7*SU%Vxsp;x*J zV+};(Ydi6Xe#Xfi^MN|KKu(6hxaNL<)vIWEm@{NI@4`TMOzD@Gugt$CzM|Po81ms; zH9ZyaNOED`>%wj>?R@JPnFOe>Zl7{3W9}bc>6Z*Y8_X)#_~Y{i#}hhD${{{M-ibD? zdHw!FnMER&kKXF@F$HXlooFr6=$$gu`&3iMc)}!2KB>_n7fpEhdwd2>#p3Mn14c0( zSO-p-u{wp~?`6xCuN|oMD|l5I3p0aVZyamhz9k$#?u=6E zlNoe3AYgWOwyv&@P71mqIBXuoZvz7ZpeH9s$M1PoS~zK<(U>3`c%X2nR1pv&au?aD zsg@^CmO&sOezg&~)Lnqlg~i2^nNMPDYIZ=1FnZzm4m-TTXJ%Y}_0C~SdNS`iK{@6r zxt7$>w6Bf2`E#m3C$q4tk#GFm0MDkiT$eh2!luYGwwqcSgVaKAmuc?j_frnipprJ3 z;`{5d2eq2d>MS1>3ru0C{VqqWX#kvVZ0*EMfJ$!>^q?O-P>-*LI-1LLWC_-CN{#$M}8rWS-P9swD>F%B)G~ea z)`l5-$IKdW_V`^H1P z&IU`HY@m|W++a+|{`0;gAa>GrcISB`%Wf_RS+<{8{;~O^*`(Fwu8v$1=jT;g4Ng6@ zaYF*i!K`3({QrZ|wdTmICkeJwP#o1Wcpil*2U)0TH6(j(%t?!e@HIzWR!!{PTsrE`uksu)SdJn)ge;+)?4mGrGo!QiY+4I z()>adEgr`}#=0#ysp9hI2w;)yggllLOhFx?hor<7mK*U+L)yUlIy!Ya>l*J5b3Z>n zw~6B42#1(Pz1Jt*IFJua33=sBK|y38&EKT{ri-(SOL=8wCXzYW1k+51`1Cz&ZEZoT z|D!wTD`K+;-oMXZY=n=Y-?_7QaL{y|V_g?8*}Ze8p{5DMfw$kjed}N&J{}0fT7sT{ zs!YA-SlYW7v>vdmJj+%^4-uQrA`$xml~LIq0B44P3e#AZX9!+M-Gx|#qM!Ke8MYze z^c|cUoi)+BM=63btEJUWuj~8-V&ZnKf*T9d2;<~xa(n*-m4oCpWSpi~Dsk-CF;-S- z9^%M5ABZTsdFJzw!vGIag>l{_7mTdR38!)GF!|ZzD}4h4v67x8=o8a5=oT&LJXhQy zYC)%{*+~bH4k(ZL*wxG6takSHTQ{G6$dc_e_KglrX4fvF?1XKLQ<*j36k@8IpX&9i z^$fiN8VAmnmzCAC#SPyne(Icl*@4M5X5#P9h@wzuu~w2YBlVrZIM2@d`U|>-f=pwh zqcC}a(P-)DW-~okYMPsc(C-luK$r<2D;o)3$OQU$dIriiP|YKV^Hd;m(T!sNkOQ1u-DSq zIH`36sTcQ^MMn^~o*sVW8lWz)A38*gjyMi~VH9;RyL|bpFN??XrXhJQXOJR*)N_bz zC@Aa^b$A{ft<`Szb0ZHTCxN=(^9U2FNs_K7lpC zJAU3g+{3wd@7`vM+?4j7Z7dQu25K48)i~vd@&Ge4bD#VlnW`+L992N7du=ySk)nI) zxweWZ*_TxH3&DxY%gb04IFF*$#Sv?3YiOb1{ca=a`GQP!NMZnM4|R9H!lD7ux5lb| z@Zdog+7CDrkQgy(f|Zot>8e0J1@;Wal7=yOrgJX(*cdSE64*A6_iMZU`t%RnRs6if9}>MdKgG;Q+2n`C6}Xr}X&WMQFM=_H{o9;Izj6W=b3>zEE{V8Ml?tppqqSaods8)`1p8aIiM?1 z5fD1S0UE+2cvepCp{LNq*jP+N#9{B(Hx{yJ4)F6UlM~Ytb8d$t(RQR)*-9||%F4ks zJxDfEZ`~TE{;jR;#MSpdfBvMUy6)r@?)PhQ5?MCqBZYw35d2$_ae{qJT)x-~^k7d0 z0g!Wz`!S{nq*?JXU|Y@f21MHFMuTJDd8PKCX-8 zIpt<*1{xL?Ptb5s1jo^@uRylgjtS@-(0}7_lKhEUYJf}vk@jG_l>ko!cEkYkue|Bf z=i4>W^<~gdg70)fLj>g`u^S99QxFk^hf9z~0B1Y%aizZRn2KWE%w~%K8ADCYC}4Er zWGIt&kB)K$vO%{(ZYY>FQU;T~I+tI128WEy>P+0)V?F~ZB$QZ8Z{jS=-aoI?A)YRY z_y%O&Aju<@H}oZ?2?YcyF!l%x26keY?f2y5%iLUdBX(TvafhEo6`$q+&I=Jg1MZP8 zDIrLi)*EOS*d>KZpv-vu`gyTfmzM~=X{6vp9AsxtKAU}??hmxG?ktLoj>fhk2KZXi zIlYmJE%aDCNggI)<0z)1HI4q??rOxt8iTZWJvmjbM*|`})aFpLxs`-sV3s6Au+@VsYL%RDU2Fygc^5=Ed63# z8;-Bi9_qS7-q-57$jkg-w7YA>|Z*~i+BgDO;>L1C@rvw^ zr5|MyDicz^5t^uDOPQssi^$rl7KLEd4D|IODcuMAQ#3}A{FTE{Bf2$l#Xwa`2_U0W zEA?<+Ray^7DB-WBtcA=nG+Y?1^N0?fw?q=rcRNdo>#Rl7raKL0+NB;VP-i?BhuB>L zU_v5z*jnghL+}m@3)4*RL=}()QH4w@Eh|f;^e_PR=cJAx!*J!wm5%S<>vYyL4`o+- zdV5D86u6qNQus#-nDS`m{7ld91SSwnXBNAD_1d*-CMH;bLOwJwBWr7FpbeCwf2IWB zy8;3NhKw&?CNdCR*P$d}k#n))1zhzH?)WgELjW})56P)_mpFdJl1C#c2nO9j%YDJfroD8i-d(`T{b=2+)SY7astxfii(P$Aoj-L z0qj*DKSHQ+0XB!ygG0zk!@KxZH!nx+Uc{f1et)vO377QtS;g{g+l!>-y7yy1ix`LlA=Vv^J576(&D0;U9)pA zuq(9Wayo{abF50rtx$ARCwx8jAzryn4i^fb>;3 zno;b!UZ|#mdE#Q#ai#ofnYuc-e?VAR7@IR*5S(giYARJNJs4qi(ntRd`p-;lB19n{8qpXY*zu64(K(BJeP#Q1 z2e1=(cs?Q8+@VV1oC6J3_RJXy!vDd$stVPP#FmEiYomGH*7jpX6;!M?89mRFFp5^h32jiVV>hqXaX0 z_*grVOy}0E;o3ha{%|d71i(|mhu-TrQLI=*6}VVgKbQ$-z@|XY5)lz03guH3WMpJm znXjQ#$t0k|J@ou>*fxoahll8M0GVlFGY%PR1FnMkLyUSh(xAj6zdRbb;}*BueFbTK z7GGLP=Ycc&6lpF;rm{_SjULrTh0{v9nMmUy#v@Z+rq}V1CONpt4#>X+3Q7#Qng9|y zjFoj}f(U7|cc$M{OC5tV3g+)k6U^#3(fR%D+iu(|!ePq=Alzz^OT>b(A@jRD+H=e= z?b#Det4>My<+=hUteInms4$C*5$Yr~G_RL0`6S%v-rI80lWJA$lBB-n&di)Mec7-|pc_A%A{Xm18 zgQb;|m#2%i0amtUD^p^F8CtDLeQbKO#qY6pCs?4LKYu>3*VWZ^8$c`h!;p}f{L+>4 z>1qJ9o^Z)lS6B1$@_>nh6XDCs2MZ#cgT7br`ZaW~Cx{DRlKlPrmQW3lT=;|T4RK|} z_)qId>B7Js;PQ9dYm`%)?F5>bKvT9S&+}cnbO{m1zI-IDLSkbxnk^Kxu~X_WI)JoC zd3Z9;u1VbmugtY*mM_Uvv9``wwmz~{e(=wld1RcF!t(zzO50fC^}+YC7`9SU(n`H9 zEQB)5%RxL|oR2;>J!*}*Eo}9TRd{Y@CZyC5t`gC0D0ibGCl8_rWzE0Z7X0{eTC+uV zRu=B~0DSYI0o13L!kt;bFo}t*Zf;As)d6jbk^qP}(%;YKT~%LS3a6vNtRvqhPTK%w zqucWg$GPA{-}Ku0dSdbg=_r=G^uWM+sC=*(-QC@z1esvuE_+8ybD5M1 znuyVEN-2E`E<^!>HL?v!H$LZ~-t1+Ll}=})@5I^$EqfLK%^q2b)BwwRE+? zzCP-G;$Oc6mX>XH@Tt2+*7TZfm& zq<9j5Ymf`U#t(#zpnjq(L`q*l&s<91fP$RsmJjqaekwA;%T2ps+k8xGvnAWib=&+Y zoiT<~H?!4D5Y4^=5D*z2+&44X{hla$1AAdYJf_O&rS78n{2p#r$ZXw1y&3Bt2t?xG z!S_hSK#w@{prGT4c*9-w`H{5#V`%qHD~jocCGUAq9*n?J>}ZHVnFX0s;iU3(%*>uLfDzCE%*J4dW_&e}ck+GXDbS>81=g1b5@FJjBjb~Gy_K`y`FYMlu z4*T$y5bpymmxmhsmb%ROb{Lly|KnzKCowcWN=b={5q0N7f0p9Z+$N|g+cGznowudX%eN=`~5M$10#zQhANMG~I2m)FL);``mNRXIqtHvQ>i)iU~i`(Fm$ z>s4#3y1K(??x<}C2i-01+hr2lwtc&F(!_6n_617f4UAzcl>Y1zC#d3sN4rY($WNJU zsQGW@6&b`qO6to&STO>06o=2?%*Z^8Ne^%Mue8p`k6}dh7Z4ipI9n$tVJ8B~K7xcq z3E*xp>qCvQcmETMG$|0JNQnFH5HYV98lvRZB5vd>f9@RMJkf$}Fk{WW$@X8^^S~v$ z^Onw=H*;KMjJrkfhLE9AU}t>w&ta@i7EcN`0SqmSNxG+fSsiJ{ie+v;i!TCy3u0$P6lTt>?F1MBrFOwwMXU!xCANk zg%*?bw*kgXI{b8aBb%`v4lDDfpcdbXX6mEI1g(q-%<{qg^_TAsAU=8K5FbkVc}x7L zySU@;=gOX@)ajfglMBv4{{hdn`j#^U+6-+atd$oxxgI;#Qk46VNMYya=h>U1bu;5& zH9#~98J;}Sw37MGvQ}q3BUwfpxj^ZUxJ(x`LZYWjEPYr*kjk>IGT?TP;Na;NEt{0) z;l4g2lsEZ|U4cnebPR0&xrz_V`9Vy_ujvCSH#Rnc;@&`ihWHrO$__xR-nMPwt}K1?xdMYRyk#3hg7q_Bpu?FRhKXCWB`y#R}&KvA=|VG@I;P$3Zc=> zWMnIFd(jmIOlmQ+ZAg7U7Jz{I#%W@FV!{*h5q1Xd6w54Ge1VMww;1CAp2N|R4s{es z3tru#%ebi$8*DJv?Gu$BychKsORM57>`|zpgC~t*mXRJ zWH@^FUO}@UaXsapJg9+0Jz7!mK}g6Y^p3#5K%!a&>nc{l9Xg)FNXyufn850b%W4-p z#EEy46AvZInG5<=xW5k`rNNt^9yDS!I+fJsU{&bL@qL&~1e9$Sd>xbGiy$HEbZJP19 zHs1Eo@~li^cDe|+(Gu-{USuiE1n0)TYw5P(R#a$y$|>VrrE!lQwcwWE0GUg; zx%%eKo3zQC_r=^79q^Y$OPV?E{zg9ruc;bA0=jQx5AL_^oAciz*T4mX(!tArEve zFx^kZ53lu^uj+A8(Q1JWNt{T*e)^Qng;gB(j8jC8ZCxA-_lC=uqJW#$akUxxyVxp(d$4oTkfozTtj(4nhgm$p{rk&$S|}=Qx*bl4AjVXo12>(Gb`R}2bDL^)m&I$0YL(<<_m)jq(M|*kGo78F*+GU zQm>^>GTDc3{`>r1N)MEhCOB|}SpYfVY8G+lDOO$^$}058tgBzK{?HxLwF~&g#M(PM zOJG@)l$0dpOf)6e!yCu)d!d$!nBo!1*IGn1n<)B%lA|2C1jNLAM=JR@bW;R1;NA=k z9qH11!6o0(QdgG_HJmsK+1Ut83+M>-AVU!vnscR`65;W|LG=oq%g@jU|J8w{*(9Hc zLj4E7?1 literal 0 HcmV?d00001 diff --git a/cpp/doxygen/Doxyfile b/cpp/doxygen/Doxyfile new file mode 100644 index 0000000..238769c --- /dev/null +++ b/cpp/doxygen/Doxyfile @@ -0,0 +1,2427 @@ +# Doxyfile 1.8.11 + +# 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 config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# 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 = "NVTX++" + +# 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 = 3.0 + +# 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 = "C++ convenience wrappers for NVTX." + +# 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 = docs + +# 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 = + +# 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 = NO + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), VHDL. For +# instance to make doxygen treat .inc files as Fortran files (default is PHP), +# and .f files as C (default is Fortran), use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = cu=C++ cuh=C++ + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = 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_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO, these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES, upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = 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. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = YES + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# 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 = nvtx3.hpp + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, +# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl, +# *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js. + +FILE_PATTERNS = *.cpp *.hpp *.h *.c *.cu *.cuh + +# 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 = org::apache + +# 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 = docs + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the +# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the +# cost of reduced performance. This can be particularly helpful with template +# rich C++ code for which doxygen's built-in parser lacks the necessary type +# information. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse-libclang=ON option for CMake. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the master .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /