diff --git a/externals/coda-oss/UnitTest/pch.h b/externals/coda-oss/UnitTest/pch.h index 5a5d99b1ce..8229e0b47a 100644 --- a/externals/coda-oss/UnitTest/pch.h +++ b/externals/coda-oss/UnitTest/pch.h @@ -23,34 +23,15 @@ #include #include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include +#include "import/std.h" + #include #include #include #include #include -#include -#include // std::endian -#include -#include // std::accumulate #include -#include -#include -#include -#include -#include +#include // std::endian #include "CppUnitTest.h" diff --git a/externals/coda-oss/build/build.py b/externals/coda-oss/build/build.py index c030bafaf2..e9fd0ecdea 100644 --- a/externals/coda-oss/build/build.py +++ b/externals/coda-oss/build/build.py @@ -35,8 +35,8 @@ for ext in COMMON_EXCLUDES_EXT: TaskGen.extension(ext)(Utils.nada) -if sys.version_info < (3,7,0): - raise Errors.WafError('Build system requires at least Python 3.7') +if sys.version_info < (3,6,0): + raise Errors.WafError('Build system requires at least Python 3.6') # provide a partial function if we don't have one try: diff --git a/externals/coda-oss/modules/c++/coda-oss-lite.vcxproj b/externals/coda-oss/modules/c++/coda-oss-lite.vcxproj index 9b1eac0299..ab34ea98a9 100644 --- a/externals/coda-oss/modules/c++/coda-oss-lite.vcxproj +++ b/externals/coda-oss/modules/c++/coda-oss-lite.vcxproj @@ -28,6 +28,7 @@ + @@ -175,6 +176,9 @@ + + + diff --git a/externals/coda-oss/modules/c++/coda-oss-lite.vcxproj.filters b/externals/coda-oss/modules/c++/coda-oss-lite.vcxproj.filters index 76ec00124b..75b5514713 100644 --- a/externals/coda-oss/modules/c++/coda-oss-lite.vcxproj.filters +++ b/externals/coda-oss/modules/c++/coda-oss-lite.vcxproj.filters @@ -723,6 +723,18 @@ mem + + std + + + std + + + std + + + config + diff --git a/externals/coda-oss/modules/c++/include/TestCase.h b/externals/coda-oss/modules/c++/include/TestCase.h index 592dc105cc..a068260e0d 100644 --- a/externals/coda-oss/modules/c++/include/TestCase.h +++ b/externals/coda-oss/modules/c++/include/TestCase.h @@ -135,10 +135,12 @@ inline void specific_exception(TFunc f, diePrintf(format, testName, file, func, line); } catch (const TException&) { } + #if !CODA_OSS_except_Throwable_ISA_std_exception catch (const except::Throwable&) { diePrintf(format, testName, file, func, line); } + #endif catch (const std::exception&) { diePrintf(format, testName, file, func, line); diff --git a/externals/coda-oss/modules/c++/pch.h b/externals/coda-oss/modules/c++/pch.h index 95b9430b41..342ae85267 100644 --- a/externals/coda-oss/modules/c++/pch.h +++ b/externals/coda-oss/modules/c++/pch.h @@ -37,27 +37,7 @@ #include #include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include +#include "import/std.h" #include #include #include diff --git a/externals/coda-oss/modules/c++/std/include/import/cpp14.h b/externals/coda-oss/modules/c++/std/include/import/cpp14.h new file mode 100644 index 0000000000..f91af67f17 --- /dev/null +++ b/externals/coda-oss/modules/c++/std/include/import/cpp14.h @@ -0,0 +1,61 @@ +/* ========================================================================= + * This file is part of std-c++ + * ========================================================================= + * + * (C) Copyright 2004 - 2014, MDA Information Systems LLC + * (C) Copyright 2023, Maxar Technologies, Inc. + * + * std-c++ is free software; you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation; either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this program; If not, + * see . + * + */ + + +#ifndef CODA_OSS_import_cpp14_h_INCLUDED_ +#define CODA_OSS_import_cpp14_h_INCLUDED_ +#pragma once + +// Common C++14 headers +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include + +#include +#include +#include +#include +#include + +#include +#include +#include +#include + +#endif // CODA_OSS_import_cpp14_h_INCLUDED_ + + diff --git a/externals/coda-oss/modules/c++/std/include/import/cpp17.h b/externals/coda-oss/modules/c++/std/include/import/cpp17.h new file mode 100644 index 0000000000..a03b2c5dad --- /dev/null +++ b/externals/coda-oss/modules/c++/std/include/import/cpp17.h @@ -0,0 +1,36 @@ +/* ========================================================================= + * This file is part of std-c++ + * ========================================================================= + * + * (C) Copyright 2004 - 2014, MDA Information Systems LLC + * (C) Copyright 2023, Maxar Technologies, Inc. + * + * std-c++ is free software; you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation; either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this program; If not, + * see . + * + */ + +#ifndef CODA_OSS_import_cpp17_h_INCLUDED_ +#define CODA_OSS_import_cpp17_h_INCLUDED_ +#pragma once + +#include "cpp14.h" + +// Common C++17 headers +#include +#include + +#endif // CODA_OSS_import_cpp17_h_INCLUDED_ + + diff --git a/externals/coda-oss/modules/c++/std/include/import/std.h b/externals/coda-oss/modules/c++/std/include/import/std.h new file mode 100644 index 0000000000..426a80f0c4 --- /dev/null +++ b/externals/coda-oss/modules/c++/std/include/import/std.h @@ -0,0 +1,58 @@ +/* ========================================================================= + * This file is part of std-c++ + * ========================================================================= + * + * (C) Copyright 2004 - 2014, MDA Information Systems LLC + * (C) Copyright 2023, Maxar Technologies, Inc. + * + * std-c++ is free software; you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation; either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this program; If not, + * see . + * + */ + + +#ifndef CODA_OSS_import_std_h_INCLUDED_ +#define CODA_OSS_import_std_h_INCLUDED_ +#pragma once + +#include "coda_oss/CPlusPlus.h" +#include "config/disable_compiler_warnings.h" + +CODA_OSS_disable_warning_push +#if _MSC_VER +#pragma warning(disable: 4619) // #pragma warning: there is no warning number '...' + +#pragma warning(disable: 4710) // '...': function not inlined +#pragma warning(disable: 5027) // '...': move assignment operator was implicitly defined as deleted +#pragma warning(disable: 5026) // '...': move constructor was implicitly defined as deleted +#pragma warning(disable: 4626) // '...': assignment operator was implicitly defined as deleted +#pragma warning(disable: 4625) // '...': copy constructor was implicitly defined as deleted +#pragma warning(disable: 4355) // '...': used in base member initializer list +#pragma warning(disable: 5220) // '...': a non-static data member with a volatile qualified type no longer implies that compiler generated copy/move constructors and copy/move assignment operators are not trivial +#pragma warning(disable: 5204) // '...': class has virtual functions, but its trivial destructor is not virtual; instances of objects derived from this class may not be destructed correctly +#pragma warning(disable: 5264) // '...': '...' variable is not used +#endif // _MSC_VER + +// Common C++14 headers +#include "cpp14.h" + +#if CODA_OSS_cpp17 +#include "cpp17.h" +#endif + +CODA_OSS_disable_warning_pop + +#endif // CODA_OSS_import_std_h_INCLUDED_ + + diff --git a/externals/coda-oss/modules/drivers/CMakeLists.txt b/externals/coda-oss/modules/drivers/CMakeLists.txt index 2d580634e3..e9aeba4a1a 100644 --- a/externals/coda-oss/modules/drivers/CMakeLists.txt +++ b/externals/coda-oss/modules/drivers/CMakeLists.txt @@ -76,4 +76,5 @@ set(CODA_ENABLE_HDF5 ON CACHE BOOL "enable hdf5") set(CODA_HDF5_HOME "" CACHE PATH "path to pre-existing HDF5 installation, if not provided HDF5 will be built") if (CODA_ENABLE_HDF5 OR CODA_HDF5_HOME) add_subdirectory("hdf5") + add_subdirectory("highfive") endif() diff --git a/externals/coda-oss/modules/drivers/hdf5/source/H5MM.c b/externals/coda-oss/modules/drivers/hdf5/source/H5MM.c index 9c03ceb338..68c8633015 100644 --- a/externals/coda-oss/modules/drivers/hdf5/source/H5MM.c +++ b/externals/coda-oss/modules/drivers/hdf5/source/H5MM.c @@ -658,7 +658,9 @@ H5MM_memcpy(void *dest, const void *src, size_t n) HDassert(src); /* Check for buffer overlap */ - HDassert((char *)dest >= (const char *)src + n || (const char *)src >= (char *)dest + n); + const char* src_n = (const char*)src + n; + const char* dest_n = (const char*)dest + n; + HDassert((const char *)dest >= src_n || (const char *)src >= dest_n); /* Copy */ ret = HDmemcpy(dest, src, n); diff --git a/externals/coda-oss/modules/drivers/highfive/CMakeLists.txt b/externals/coda-oss/modules/drivers/highfive/CMakeLists.txt new file mode 100644 index 0000000000..32f2ba30d8 --- /dev/null +++ b/externals/coda-oss/modules/drivers/highfive/CMakeLists.txt @@ -0,0 +1,19 @@ +set(MODULE_NAME highfive) +set(TARGET_LANGUAGE c++) + +if(CODA_ENABLE_HDF5) + set(MODULE_DEPS config-c++ sys-c++) + list(APPEND MODULE_DEPS hdf5-c++) + + coda_add_module( + ${MODULE_NAME} + VERSION 2.6.2 + DEPS ${MODULE_DEPS}) + + coda_add_tests( + MODULE_NAME ${MODULE_NAME} + DIRECTORY "unittests" + UNITTEST) +else() + message("${MODULE_NAME} will not be built since HDF5 is not enabled") +endif() diff --git a/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2.zip b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2.zip new file mode 100644 index 0000000000..0668a026bb Binary files /dev/null and b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2.zip differ diff --git a/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/.clang-format b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/.clang-format new file mode 100644 index 0000000000..8a59ff4a31 --- /dev/null +++ b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/.clang-format @@ -0,0 +1,93 @@ +--- +AccessModifierOffset: -2 +AlignAfterOpenBracket: Align +AlignConsecutiveAssignments: false +AlignConsecutiveDeclarations: false +AlignConsecutiveMacros: true +AlignEscapedNewlinesLeft: true +AlignOperands: true +AlignTrailingComments: true +AllowAllParametersOfDeclarationOnNextLine: false +AllowShortBlocksOnASingleLine: false +AllowShortCaseLabelsOnASingleLine: false +AllowShortFunctionsOnASingleLine: Empty +AllowShortIfStatementsOnASingleLine: false +AllowShortLoopsOnASingleLine: false +AlwaysBreakBeforeMultilineStrings: true +AlwaysBreakTemplateDeclarations: true +BasedOnStyle: WebKit +BinPackArguments: false +BinPackParameters: false +BraceWrapping: + AfterClass: false + AfterControlStatement: false + AfterEnum: false + AfterExternBlock: false + AfterFunction: false + AfterNamespace: false + AfterStruct: false + AfterUnion: false + BeforeCatch: false + BeforeElse: false +BreakBeforeBraces: Custom +BreakBeforeBinaryOperators: false +BreakBeforeTernaryOperators: true +BreakConstructorInitializersBeforeComma: true +BreakStringLiterals: true +ColumnLimit: 100 +CommentPragmas: '^\\.+' +ConstructorInitializerAllOnOneLineOrOnePerLine: false +ConstructorInitializerIndentWidth: 4 +ContinuationIndentWidth: 4 +Cpp11BracedListStyle: true +DerivePointerAlignment: false +DerivePointerBinding: true +ExperimentalAutoDetectBinPacking: false +FixNamespaceComments: true +ForEachMacros: [ foreach, Q_FOREACH, BOOST_FOREACH ] +IncludeCategories: + - Regex: '^"(llvm|llvm-c|clang|clang-c)/' + Priority: 2 + - Regex: '^(<|"(gtest|isl|json)/)' + Priority: 3 + - Regex: '.*' + Priority: 1 +IncludeIsMainRegex: '$' +IndentCaseLabels: false +IndentWidth: 4 +IndentWrappedFunctionNames: false +KeepEmptyLinesAtTheStartOfBlocks: false +Language: Cpp +MaxEmptyLinesToKeep: 2 +NamespaceIndentation: None +PenaltyBreakAssignment: 40 +PenaltyBreakBeforeFirstCallParameter: 100 +PenaltyBreakComment: 60 +PenaltyBreakFirstLessLess: 120 +PenaltyBreakString: 1000 +PenaltyExcessCharacter: 1000000 +PenaltyReturnTypeOnItsOwnLine: 200 +PointerAlignment: Left +PointerBindsToType: true +ReflowComments: true +SortIncludes: false +SpaceAfterCStyleCast: true +SpaceAfterTemplateKeyword: true +SpaceBeforeAssignmentOperators: true +SpaceBeforeCpp11BracedList: false +SpaceBeforeCtorInitializerColon: false +SpaceBeforeInheritanceColon: false +SpaceBeforeParens: ControlStatements +SpaceBeforeRangeBasedForLoopColon: false +SpaceInEmptyBlock: false +SpaceInEmptyParentheses: false +SpacesBeforeTrailingComments: 2 +SpacesInAngles: false # '< ' style +SpacesInContainerLiterals: false +SpacesInCStyleCastParentheses: false +SpacesInParentheses: false # '(' style +SpacesInSquareBrackets: false +Standard: c++14 +TabWidth: 4 +UseTab: Never +... diff --git a/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/.git-blame-ignore-revs b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/.git-blame-ignore-revs new file mode 100644 index 0000000000..a7a0c41e21 --- /dev/null +++ b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/.git-blame-ignore-revs @@ -0,0 +1,2 @@ +# clang-format the whole repository +6fc243144b6a7802bf29d3fbb2c028051a71ca28 diff --git a/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/.github/ISSUE_TEMPLATE/bug_report.md b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000000..2558a56c40 --- /dev/null +++ b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,31 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Stacktrace** +If applicable, add a stacktrace and error messages to help explain your problem. + +**Desktop (please complete the following information):** + - OS: [e.g. ubuntu 20.10, macos 10.15] + - Version [e.g. master branch] + +**Additional context** +Add any other context about the problem here. diff --git a/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/.github/ISSUE_TEMPLATE/config.yml b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..1d9540b00b --- /dev/null +++ b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: true +contact_links: + - name: HighFive Community Support + url: https://github.com/BlueBrain/HighFive/discussions + about: Please ask and answer questions here. diff --git a/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/.github/ISSUE_TEMPLATE/feature_request.md b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000000..4ead48053d --- /dev/null +++ b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context about the feature request here. diff --git a/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/.github/build.sh b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/.github/build.sh new file mode 100644 index 0000000000..4cdad7e3ff --- /dev/null +++ b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/.github/build.sh @@ -0,0 +1,11 @@ +# Build env + +[ "$CC" ] && $CC --version +cmake --version +set -x +export HIGHFIVE_BUILD=$GITHUB_WORKSPACE/build +cmake -B $HIGHFIVE_BUILD -S $GITHUB_WORKSPACE \ + -DCMAKE_BUILD_TYPE=$BUILD_TYPE \ + -DCMAKE_INSTALL_PREFIX=$INSTALL_DIR \ + "${CMAKE_OPTIONS[@]}" +cmake --build $HIGHFIVE_BUILD --config $BUILD_TYPE --parallel 2 --verbose diff --git a/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/.github/pull_request_template.md b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/.github/pull_request_template.md new file mode 100644 index 0000000000..58abc6c608 --- /dev/null +++ b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/.github/pull_request_template.md @@ -0,0 +1,25 @@ +**Description** + +Please include a summary of the change and which issue is fixed or which feature is added. + +- [ ] Issue 1 fixed +- [ ] Issue 2 fixed +- [ ] Feature 1 added +- [ ] Feature 2 added + +Fixes #(issue) + +**How to test this?** + +Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce if there is no integration test added with this PR. Please also list any relevant details for your test configuration + +```bash +cmake .. +make -j8 +make test +``` + +**Test System** + - OS: [e.g. Ubuntu 20.04] + - Compiler: [e.g. clang 12.0.0] + - Dependency versions: [e.g. hdf5 1.12] diff --git a/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/.github/workflows/check_doxygen_awesome_version.yml b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/.github/workflows/check_doxygen_awesome_version.yml new file mode 100644 index 0000000000..233577ef86 --- /dev/null +++ b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/.github/workflows/check_doxygen_awesome_version.yml @@ -0,0 +1,49 @@ +name: Auto-update doxygen-awesome + +on: + workflow_dispatch: + schedule: + - cron: 0 2 * * 1 + +jobs: + check-for-updates: + runs-on: ubuntu-latest + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + + steps: + - uses: actions/checkout@v2 + - name: Open PR if doxygen-awesome outdated. + run: | + + VERSION=$(doc/doxygen-awesome-css/update_doxygen_awesome.sh "$(mktemp -d)") + BRANCH=update-doxygen-awesome-${VERSION} + COMMIT_MESSAGE="Update doxygen-awesome to ${VERSION}" + + # NOTE: In a later runs of CI we will search for PR with this exact + # title. Only if no such PR exists will the script create a + # new PR. + PR_TITLE="[docs] Update doxygen-awesome to ${VERSION}" + + if [[ -z "$(git status --porcelain)" ]] + then + echo "No differences detected: doxygen-awesome is up-to-date." + exit 0 + fi + + if [[ -z "$(gh pr list --state all --search "${PR_TITLE}")" ]] + then + + git checkout -b $BRANCH + git config user.name github-actions + git config user.email github-actions@github.com + git commit -a -m "${COMMIT_MESSAGE}" + + git push -u origin ${BRANCH} + gh pr create \ + --title "${PR_TITLE}" \ + --body "This PR was generated by a Github Actions workflow." + + else + echo "Old PR detected: didn't create a new one." + fi diff --git a/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/.github/workflows/ci.yml b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/.github/workflows/ci.yml new file mode 100644 index 0000000000..a34847188e --- /dev/null +++ b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/.github/workflows/ci.yml @@ -0,0 +1,282 @@ +name: HighFive_CI + +concurrency: + group: ${{ github.workflow }}#${{ github.ref }} + cancel-in-progress: true + +on: + push: + branches: + - ci_test + - release/** + pull_request: + branches: + - master + - release/** + paths-ignore: + - '**.md' + - '**.rst' + - 'doc/**' + +env: + HOMEBREW_NO_AUTO_UPDATE: 1 # for reproducibility, dont autoupdate + BUILD_TYPE: RelWithDebInfo + INSTALL_DIR: install + +jobs: + + # Job testing compiling on several Ubuntu systems + MPI + # ========================================================= + # + # For 18.04: bare HighFive + # For 20.04: activate Boost, OpenCV + # For latest: activate Boost, Eigen, OpenCV, with Ninja + # + # XTensor tests are run for conda/mamba and MacOS + Linux_MPI: + runs-on: ${{matrix.os}} + strategy: + matrix: + os: [ubuntu-18.04, ubuntu-20.04, ubuntu-latest] + include: + - os: ubuntu-18.04 + pkgs: '' + flags: '-DHIGHFIVE_USE_BOOST:Bool=OFF' + - os: ubuntu-20.04 + pkgs: 'libboost-all-dev libopencv-dev' + flags: '-DHIGHFIVE_USE_OPENCV:Bool=ON -GNinja' + - os: ubuntu-latest + pkgs: 'libboost-all-dev libeigen3-dev libopencv-dev' + flags: '-DHIGHFIVE_USE_EIGEN:Bool=ON -DHIGHFIVE_USE_OPENCV:Bool=ON -GNinja' + + steps: + - uses: actions/checkout@v3 + with: + submodules: true + + - name: "Setup MPI" + uses: mpi4py/setup-mpi@v1 + with: + mpi: openmpi + + - name: "Install libraries" + run: | + sudo apt-get -qq update + sudo apt-get -qq install libhdf5-openmpi-dev libsz2 ninja-build ${{ matrix.pkgs }} + + - name: Build + run: | + CMAKE_OPTIONS=(-DHIGHFIVE_PARALLEL_HDF5:BOOL=ON ${{ matrix.flags }}) + source $GITHUB_WORKSPACE/.github/build.sh + + - name: Test + working-directory: ${{github.workspace}}/build + run: ctest --output-on-failure -C $BUILD_TYPE + + + # Job testing several versions of hdf5 + # =================================================== + Linux_HDF5_Versions: + runs-on: ubuntu-latest + strategy: + matrix: + hdf5_version : [ hdf5-1_8_22, hdf5-1_10_9, hdf5-1_12_2, hdf5-1_13_2 ] + + steps: + - uses: actions/checkout@v3 + with: + submodules: true + - name: "Install libraries" + run: | + sudo apt-get -qq update + sudo apt-get -qq install ninja-build libsz2 zlib1g-dev libboost-all-dev + + - name: Build HDF5 + run: | + wget https://github.com/HDFGroup/hdf5/archive/refs/tags/${{ matrix.hdf5_version }}.tar.gz --output-document hdf5.tar.gz + tar xf hdf5.tar.gz + mkdir -p hdf5-${{ matrix.hdf5_version }}/BUILD && cd hdf5-${{ matrix.hdf5_version }}/BUILD + cmake .. -GNinja -DCMAKE_INSTALL_PREFIX=$HOME/${{ matrix.hdf5_version }} -DHDF5_ENABLE_Z_LIB_SUPPORT=ON -DUSE_LIBAEC=ON + ninja && ninja install + + - name: Build + run: | + mkdir BUILD && cd BUILD + cmake -GNinja -DHDF5_ROOT=$HOME/${{ matrix.hdf5_version }} .. + ninja + + - name: Test + run: | + cd BUILD && ctest --output-on-failure + + # Job testing several compilers on a stable Linux + # ==================================================== + Linux_Compilers: + runs-on: ubuntu-20.04 + strategy: + matrix: + env: [ + {CC: clang-10, CXX: clang++-10}, + {CC: clang-12, CXX: clang++-12}, + {CC: gcc-9, CXX: g++-9}, + {CC: gcc-10, CXX: g++-10}, + ] + + steps: + - uses: actions/checkout@v3 + with: + submodules: true + + - name: "Install libraries" + run: | + sudo apt-get -qq update + sudo apt-get -qq install libboost-all-dev libhdf5-dev libsz2 ninja-build + + - name: Build + env: ${{matrix.env}} + run: | + CMAKE_OPTIONS=(-GNinja) + source $GITHUB_WORKSPACE/.github/build.sh + + - name: Test + working-directory: ${{github.workspace}}/build + run: ctest --output-on-failure -C $BUILD_TYPE + + + # Job to check using HighFive from other CMake projects + # ===================================================== + CMake_Project: + runs-on: ubuntu-20.04 + steps: + - uses: actions/checkout@v3 + with: + submodules: true + + - name: "Install libraries" + run: | + sudo apt-get -qq update + sudo apt-get -qq install libboost-all-dev libhdf5-dev libsz2 ninja-build + + - name: "CMake Project Integration" + run: bash tests/test_project_integration.sh + + + # Job checking the benchmarks work + # ================================ + Benchmarks: + runs-on: ubuntu-20.04 + steps: + - uses: actions/checkout@v3 + with: + submodules: true + + - name: "Install libraries" + run: | + sudo apt -y update + sudo apt -y install --no-install-recommends libhdf5-dev pkg-config + + - name: "Build benchmarks" + working-directory: ${{github.workspace}}/src/benchmarks + run: make + + - run: time ${{github.workspace}}/src/benchmarks/highfive_bench + + + # Job testing in OSX + # ======================= + OSX: + runs-on: macOS-10.15 + + steps: + - uses: actions/checkout@v3 + with: + submodules: true + + - name: "Install libraries (OSX)" + run: brew install boost eigen hdf5 ninja xtensor + + - name: Build + run: | + CMAKE_OPTIONS=( + -GNinja + -DHIGHFIVE_USE_BOOST:BOOL=ON + -DHIGHFIVE_USE_EIGEN:BOOL=ON + -DHIGHFIVE_USE_XTENSOR:BOOL=ON + -DHIGHFIVE_BUILD_DOCS:BOOL=FALSE + -DHIGHFIVE_TEST_SINGLE_INCLUDES=ON + -DCMAKE_CXX_FLAGS="-coverage -O0" + ) + source $GITHUB_WORKSPACE/.github/build.sh + + - name: Test + working-directory: ${{github.workspace}}/build + run: ctest --output-on-failure -C $BUILD_TYPE + + + # Job testing in Windows + # =========================== + Windows: + runs-on: Windows-latest + steps: + - uses: actions/checkout@v3 + with: + submodules: true + + - uses: mamba-org/provision-with-micromamba@main + with: + environment-file: doc/environment.yaml + environment-name: win-test + + - name: Build + shell: bash -l {0} + run: | + CMAKE_OPTIONS=( + -DHIGHFIVE_UNIT_TESTS=ON + -DHIGHFIVE_USE_BOOST:BOOL=ON + -DHIGHFIVE_USE_EIGEN:BOOL=ON + -DHIGHFIVE_USE_XTENSOR:BOOL=ON + -DHIGHFIVE_TEST_SINGLE_INCLUDES=ON + ) + source $GITHUB_WORKSPACE/.github/build.sh + + - name: Test + working-directory: ${{github.workspace}}/build + shell: bash -l {0} + run: ctest --output-on-failure -C $BUILD_TYPE + + # Job producing code coverage report + # ================================== + Code_coverage: + # When ubuntu version will be upgrade, you should look if xtensor is nowavailable + runs-on: ubuntu-20.04 + + steps: + - name: "Install libraries" + run: | + sudo apt-get update + sudo apt-get install lcov libboost-all-dev libhdf5-dev libeigen3-dev libopencv-dev libsz2 ninja-build + + - uses: actions/checkout@v3 + with: + fetch-depth: 2 + submodules: true + + - name: Build and test for code coverage + run: | + CMAKE_OPTIONS=( + -GNinja + -DHIGHFIVE_USE_BOOST:BOOL=ON + -DHIGHFIVE_USE_EIGEN:BOOL=ON + -DHIGHFIVE_USE_OPENCV:BOOL=ON + #-DHIGHFIVE_USE_XTENSOR:BOOL=ON + -DHIGHFIVE_TEST_SINGLE_INCLUDES=ON + -DHIGHFIVE_BUILD_DOCS:BOOL=FALSE + -DCMAKE_CXX_FLAGS="-coverage -O0" + ) + source $GITHUB_WORKSPACE/.github/build.sh + cd $HIGHFIVE_BUILD + (cd $GITHUB_WORKSPACE; lcov --capture --initial --directory . --no-external --output-file build/coverage-base.info) + cmake --build $HIGHFIVE_BUILD --target test + (cd $GITHUB_WORKSPACE; lcov --capture --directory . --no-external --output-file build/coverage-run.info) + lcov --add-tracefile coverage-base.info --add-tracefile coverage-run.info --output-file coverage-combined.info + bash <(curl -s https://codecov.io/bash) -f coverage-combined.info diff --git a/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/.github/workflows/clang_format.yml b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/.github/workflows/clang_format.yml new file mode 100644 index 0000000000..99cb6e1b3b --- /dev/null +++ b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/.github/workflows/clang_format.yml @@ -0,0 +1,36 @@ +name: ClangFormat + +concurrency: + group: ${{ github.workflow }}#${{ github.ref }} + cancel-in-progress: true + +on: + pull_request: + branches: + - master + paths-ignore: + - '**.md' + - '**.rst' + - 'doc/**' + +jobs: + Code_Format: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + + - name: Run clang-format + run: | + clang-format --version + for i in $(git ls-files | grep ".[ch]pp$"); + do + clang-format -i "$i" > /dev/null 2>&1; + done + modified_files=$(git diff --name-only) + if [ -n "$modified_files" ]; + then + echo "Some files are not well formatted:" + echo $modified_files + exit 1 + fi diff --git a/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/.github/workflows/gh-pages.yml b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/.github/workflows/gh-pages.yml new file mode 100644 index 0000000000..0f51447c46 --- /dev/null +++ b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/.github/workflows/gh-pages.yml @@ -0,0 +1,53 @@ +name: gh-pages + +on: + push: + branches: + - master + pull_request: + branches: + - master + +jobs: + + publish: + + runs-on: ubuntu-latest + + defaults: + run: + shell: bash -l {0} + + steps: + + - uses: actions/checkout@v3 + with: + submodules: 'recursive' + + - uses: mamba-org/provision-with-micromamba@main + with: + environment-file: doc/environment.yaml + environment-name: doc-build + + - name: Run doxygen + run: | + CMAKE_OPTIONS=( + -DHIGHFIVE_UNIT_TESTS=OFF + -DHIGHFIVE_USE_BOOST:BOOL=ON + -DHIGHFIVE_USE_EIGEN:BOOL=ON + -DHIGHFIVE_USE_XTENSOR:BOOL=ON + ) + cmake -B build -S . "${CMAKE_OPTIONS[@]}" + cmake --build build --target doc + cp -r doc/poster build/doc/html/ + + - name: Deploy to GitHub Pages + if: ${{ success() && github.ref == 'refs/heads/master' && github.event_name == 'push' }} + uses: crazy-max/ghaction-github-pages@v2 + with: + target_branch: gh-pages + build_dir: build/doc/html + jekyll: false + keep_history: false + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/.github/workflows/integration_trigger.yml b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/.github/workflows/integration_trigger.yml new file mode 100644 index 0000000000..3fe65f329f --- /dev/null +++ b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/.github/workflows/integration_trigger.yml @@ -0,0 +1,15 @@ +name: Integration Test Trigger +on: + pull_request: + types: [closed] +jobs: + merge-PR: + if: github.event.pull_request.merged == true + runs-on: ubuntu-latest + steps: + - name: Trigger integration tests on BlueBrain/HighFive-testing + run: | + curl -X POST https://api.github.com/repos/BlueBrain/HighFive-testing/dispatches \ + -H 'Accept: application/vnd.github.everest-preview+json' \ + -u ${{ secrets.ACCESS_TOKEN }} \ + --data '{"event_type": "merge", "client_payload": { "repository": "'"$GITHUB_REPOSITORY"'" }}' diff --git a/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/.gitignore b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/.gitignore new file mode 100644 index 0000000000..75c4e044b8 --- /dev/null +++ b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/.gitignore @@ -0,0 +1,5 @@ +build +tests/test_project +.idea + +.vs/ diff --git a/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/.gitmodules b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/.gitmodules new file mode 100644 index 0000000000..615f78fe15 --- /dev/null +++ b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/.gitmodules @@ -0,0 +1,3 @@ +[submodule "deps/catch2"] + path = deps/catch2 + url = https://github.com/catchorg/Catch2.git diff --git a/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/.travis.yml b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/.travis.yml new file mode 100644 index 0000000000..bc5d340810 --- /dev/null +++ b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/.travis.yml @@ -0,0 +1,138 @@ +# Adapted from various sources, including: +# - Louis Dionne's Hana: https://github.com/ldionne/hana +# - Paul Fultz II's FIT: https://github.com/pfultz2/Fit +# - Eric Niebler's range-v3: https://github.com/ericniebler/range-v3 +# - Gabi Melman spdlog: https://github.com/gabime/spdlog + +sudo: required +language: cpp + +addons: &gcc7 + apt: + packages: + - g++-7 + - libboost-all-dev + - libhdf5-openmpi-dev + - libeigen3-dev + - ninja-build + sources: + - ubuntu-toolchain-r-test + +matrix: + include: + # Older linux (trusty) with default gcc + # Install serial hdf5 + build serial + - os: linux + dist: trusty + env: + - HIGHFIVE_USE_XTENSOR=False + - HIGHFIVE_USE_OPENCV=False + - HIGHFIVE_PARALLEL_HDF5=False + - IS_BASE_ENVIRON=1 + addons: + apt: + packages: + - libboost-all-dev + - libeigen3-dev + - libhdf5-serial-dev + - ninja-build + + # Linux gcc-7 + # Install parallel hdf5 + build parallel + - os: linux + dist: xenial + env: + - GCC_VERSION=7 + - HIGHFIVE_USE_XTENSOR=True + - HIGHFIVE_USE_OPENCV=False + - HIGHFIVE_PARALLEL_HDF5=True + addons: *gcc7 + + # Mac OSX XCode 10 + - os: osx + osx_image: xcode10.3 + env: + - HIGHFIVE_USE_XTENSOR=True + - HIGHFIVE_USE_OPENCV=True + - HIGHFIVE_PARALLEL_HDF5=False + + # Windows + - os: windows + env: + - HIGHFIVE_USE_XTENSOR=True + - HIGHFIVE_USE_OPENCV=True + - HIGHFIVE_PARALLEL_HDF5=False + +env: + global: + - MINCONDA_VERSION="latest" + - MINCONDA_LINUX="Linux-x86_64" + - MINCONDA_OSX="MacOSX-x86_64" + +install: + - export HOMEBREW_NO_AUTO_UPDATE=1 # for reproducibility, dont autoupdate + + - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then + MINCONDA_OS=$MINCONDA_LINUX; + elif [[ "$TRAVIS_OS_NAME" == "osx" ]]; then + if [ "$BREW_USE_LATEST" ]; then + brew update; + brew install hdf5; brew upgrade hdf5; + fi; + brew install boost hdf5 eigen ninja; + MINCONDA_OS=$MINCONDA_OSX; + fi + + - if [[ "$TRAVIS_OS_NAME" == "windows" ]]; then + export CMAKE_GENERATOR="Visual Studio 15 2017 Win64" ; + export TESTS_TARGET="RUN_TESTS"; + choco install --yes miniconda3 ; + source C:/Tools/miniconda3/Scripts/activate ; + else + export CMAKE_GENERATOR="Ninja" ; + export TESTS_TARGET="test"; + wget "http://repo.continuum.io/miniconda/Miniconda3-$MINCONDA_VERSION-$MINCONDA_OS.sh" -O miniconda.sh; + bash miniconda.sh -b -p $HOME/miniconda ; + source $HOME/miniconda/bin/activate; + hash -r ; + fi + - conda config --set always_yes yes --set changeps1 no + - conda update -q conda + - conda install -c conda-forge mamba + - if [[ "$HIGHFIVE_USE_XTENSOR" == "True" ]]; then + mamba install -c conda-forge xtl xsimd xtensor; + fi + - if [[ "$HIGHFIVE_USE_OPENCV" == "True" ]]; then + mamba install -c conda-forge libopencv opencv; + fi + - if [[ "$TRAVIS_OS_NAME" == "windows" ]]; then + mamba install -c conda-forge boost-cpp hdf5 eigen; + fi + +before_script: + - if [ -n "$GCC_VERSION" ]; then export CXX="g++-${GCC_VERSION}" CC="gcc-${GCC_VERSION}"; fi + - if [ -n "$CLANG_VERSION" ]; then export CXX="clang++-${CLANG_VERSION}" CC="clang-${CLANG_VERSION}"; fi + - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then export CXX="clang++" CC="clang"; fi + - which $CXX + - which $CC + - $CXX --version + - cmake --version + +script: + - cd ${TRAVIS_BUILD_DIR} + - mkdir -p build && pushd build + - > + cmake --warn-uninitialized --debug-output + -DCMAKE_VERBOSE_MAKEFILE:BOOL=ON + -DHIGHFIVE_TEST_SINGLE_INCLUDES:BOOL=ON + -DHIGHFIVE_PARALLEL_HDF5:BOOL=${HIGHFIVE_PARALLEL_HDF5} + -DHIGHFIVE_USE_EIGEN:BOOL=ON + -DHIGHFIVE_USE_XTENSOR:BOOL=${HIGHFIVE_USE_XTENSOR} + -DHIGHFIVE_USE_OPENCV:BOOL=${HIGHFIVE_USE_OPENCV} + -G "${CMAKE_GENERATOR}" ../ + - cmake --build . + - CTEST_OUTPUT_ON_FAILURE=1 cmake --build . --target ${TESTS_TARGET} + - popd + - if [ $IS_BASE_ENVIRON ]; then + bash tests/test_project_integration.sh; + fi diff --git a/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/AUTHORS.txt b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/AUTHORS.txt new file mode 100644 index 0000000000..ed89f76832 --- /dev/null +++ b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/AUTHORS.txt @@ -0,0 +1,52 @@ +Adrien Devresse +Alexandru Săvulescu +Ali Can Demiralp +Angelos Plastropoulos +Chris Byrohl +Chris De Grendele +@contre +Daniel Nachbaur +Dmitri Bichko +@eudoxos +Fernando L. Pereira +@guoxy +Haoran Ni +Henry Schreiner +@JaWSnl +Jia Li +John W. Peterson +Jonas Karlsson +Jorge Blanco Alonso +Kerim Khemraev +Luc Grosheintz +Marian Heil +Mario Emmenlauer +Mark Bicknell +Mathieu Bernard +Matthias Wolf +Maximilian Nöthe +@Mightrider +Mike DePalatis +Mike Gevaert +Nico Jahn +Nicolas Cornu (maintainer) +Omar Awile +Pablo Toharia +Philip Deegan +Philipp Gloor +Pramod Kumbhar +Richard Shaw +Rick Nitsche +Rob Latham +Sergio Botelh +Sergio Rivas-Gomez +@spacescientist +Taiguara Tupinambás +@timocafe +Tino Wagner +Tobias Klauser +Tom de Geus +Tom Vander Aa +Tristan Carel +Wolf Vollprecht +Y. Yang diff --git a/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/CHANGELOG.md b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/CHANGELOG.md new file mode 100644 index 0000000000..f6bf0bb2fa --- /dev/null +++ b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/CHANGELOG.md @@ -0,0 +1,220 @@ +## Version 2.6.2 - 2022-11-10 +### Bug Fix + - Allow CMake to use Config mode to find HDF5. + +## Version 2.6.1 - 2022-11-08 +### Bug Fix + - Version bump in `CMakeLists.txt`. + +## Version 2.6.0 - 2022-11-08 +### New Features + - Enable page buffered reading (#639). + +### Improvements + - Warn when detecting lossy reads or write of floating point data (#636). + +## Version 2.5.1 - 2022-11-07 +### Bug Fix + - Fix missing `inline` for collective metadata properties. + +## Version 2.5.0 - 2022-11-03 +### New Features + - Enable collective MPI IO using the Data Transfer Property (#623). Thanks to Rob Latham. + - Add a support for half-precision (16-bit) floating-point based on the Half library (http://half.sourceforge.net) (#587). Thanks to Sergio Botelh. + - Enable choosing the allocation time of datasets (#627). + - Add possibility to get and set file space strategy. For page allocated files wrap the API to set/retrieve the page size (#618). + - Add API for getting Access and Create property lists of HighFive objects (#629). + - Let users configure metadata reads and writes at file level (#624). Thanks to Rob Latham. + +### Improvements + - MPIOFileDriver is now deprecated. Use FileAccessProps (#622). + - Support of block argument in API (#584). + - Serialization of types is now automagic and so recursive (#586). + - Add an argument to specific File Create Properties in File class construtor (#626). + +### Bug Fixes + - Padding of Compound Types (#581). + - Compilation with Visual Studio with C++17 or later (#578). Thanks to Mark Bicknell. + - Avoid leaking when printing stack for error (#583). + +## Version 2.4.1 - 2022-05-11 +### New Features + - Support `std::complex`. Thanks to Philipp. + +### Improvements + - Improve EnumType/CompoundType + - Revert quirky behaviour of `select(const HyperSlab&)`. + - All `get_name` functions takes `size_t` and not `hsize_t`. + - Remove nix recipes. + +### Bug Fixes + - Computation of padding. + - Related to `0` being an invalid hid but not equal to `H5I_INVALID_HID`. + +## Version 2.4.0 - 2022-04-05 +### New Features + - Construct a compound type from an already existing hid (#469). Thanks to Maximilian Nöthe. + - Add support for long double (#494) + - Add support for H5Pset_libver_bounds and H5Pset_meta_block_size support (#500) + - New interface to select complex hyperslabs, irregular hyperslabs are limited to/from 1D array (#538 and #545) +### Improvements + - Use inline where it is needed, otherwise some code can lead to "multiple definition" (#516). Thanks to Chris Byrohl. + - Use Catch2 instead of boost for tests, reduces dependencies (#521) + - CI reworked to test external libraries more thoroughly (boost, eigen, xtensor) (#536) +### Bug Fixes + - Better support of const types (#460). Thanks to Philip Deegan. + - Vector of size zero was previously lead to UB (#502). Thanks to Haoran Ni. + - Use H5T_NATIVE_SCHAR instead of H5T_NATIVE_CHAR for "signed char" (#518) + +## Version 2.3.1 - 2021-08-04 +### Improvements + - Clean cmake files from old code (#465) + - Adding path to type warning message (#471) + - Adding compound types example, w dataset and attr (#467) + +### Bug Fixes + - Resolve an issue where padding of nested compound types were being calculated incorrectly (#461) (#468) + - GHA: drop previous runs (#462) + +## Version 2.3 - 2021-05-07 +### New Features: + - Add SZIP support (#435) + - Add option *parents* to createDataSet (#425) + - Implementing getting the filename dynamically (#424) + - Ability to create soft and external links (#421) + - Generalizing getPath and adding getFile as PathTraits (#417) + +### Improvements: + - Unified reading/writing attributes and datasets (#450) + - Old compilers have been removed from docker image (#430) + - Cleaning up and improving property lists (#429) + - An example using hdf5 references (#396) (#397) + - Add all property lists alias for completeness (#427) + - Add property CreateIntermediateGroup (#423) + - Add code coverage through codecov.io (#420) + - Introducing GitHub Actions CI (#416) + - Create issue and PR templates (#412) + - Initialize SilenceHDF5 to true in _exist (#411) + - Generalizing xtensor API (#407) + - Minor doc updates (#409) + - Fixing minor error in GH Action (#408) + - Uploading docs to gh-pages using GitHub Actions (#403) + - Various minor documentation updates (#405) + - optional documentation building in cmake (#377) + - From can be automatic now (#384) + - get_dim_vector in inspector (#383) + - Put type_of_array in inspector (#382) + - Move array_dims in the future manipulator (#381) + - Unify interface of H5Attribute with H5Slice_traits (#378) + - Use std::move in NRVO depending of version of GCC (#375) + - Fixed typo '-DD' to '-D' in 'Dependencies'. (#371) + - Changing date format (#364) + +### Bug fixes: + - Fix use before initialization (#414) + - Adding CMake include guard (#389) + +## Version 2.2.2 - 2020-07-30 +### New Features: + - [H5Easy] Adding OpenCV support (#343) + - [H5Easy] Enabling compression & Adding attributes (#337) + - Adding missing function to H5Attribute (#337) + - Add methods to retrieve Node paths or Dataset names and rename objects (#346) + - Add a file with the current version number of HighFive (#349) + +### Improvements + - [H5Easy] Updating error message dump (#335) + - [H5Easy] Switching implementation to partial specialization based on static dispatch (#327) + - Simplifying imports, new policy (#324) + +## Version 2.2.1 - 2020-04-28 +### Improvements + - Add a mechanism to not include target HighFive several times (#336) + - Fix SilenceHDF5 initialization for NodeTraits (#333) + +## Version 2.2 - 2020-03-23 +### New Features: + - Compound Types: API to register and read/write structs (#78). Thanks to Richard Shaw. + - Fixed-length strings. API via char[] and `FixedLenStringArray`(#277) + - Enum data types (#297) + - Datasets of HDF5 References. Support to dereference groups and datasets (#306) + - Objects (hard/soft link) can now be deleted with `unlink` (#284). Thanks to Tom Vander Aa. + - Attributes can be deleted with `deleteAttribute` (#239) + +### Improvements: + - `Attribute`s (metadata) now support additional types (#298) + - H5Easy: Reworked for compatibility with `Eigen::ref` and `Eigen::Map` (#291, #293) + - Hdf5 1.12 compatibility: working `Object::getInfo` and marking getAddress deprecated (#311) + - Strict compatibility with CMake 3.1 and C++11 (#304) + - CMake: Dependencies may be re-detected on FindPackage, fixed export targets and added integration tests (#255, #304, #312, #317) + - Support for array of `Eigen::Matrix` (#258) + - Selection: `ElementSet` working for N-dimensions (#247) + +### Bug Fixes: + - Shortcut syntax with c arrays (#273) + - Compatibility with in MSVC (Exception messages #263 and avoid throwing in `exist` check #308) + +## Version 2.1 - 2019-10-30 +### New Features: + - Inspection: API to get the type of links/objects and datasets data-types (#221) + - H5Easy: API for simple import/export to Eigen and xtensor (#141) + - Support for chunk and deflate configuration at dataset creation/open (#125). Added generic RawPropertyLists. (#157) + - Recursive `createGroup` and `exist` (#152) + - Shortcut syntax: ability to create a filled dataset in a single line (#130) + - DataSet now accepts `std::complex` and `std::array`'s (#128, #129) + +### Improvements: + - Improved compat with MSVC and ICC compilers + - CMake build system: modernized, create exported targets, better messages, etc. + - Building and publishing documentation: https://bluebrain.github.io/HighFive/ + - Several other. See #231 + +### Bug Fixes: + - Fixed header dependencies. They are now all include-able (#225) + - Fixed read/write of N-Dimensional data as nested vectors (#191) + - Fixed data broadcasting for reading (#136) + +## Version 2.0 - 2018-07-19 + - First version with C++11 enforcement + - Support for property list + - Support for Chunking + - Support for Compression / Deflate + - Fix: missing move constructor for properties + - Fix: typo in MPI IO driver + - Fix: several typo fixes + - Fix: Add missing include + +## Version 1.5 - 2018-01-06 + - SliceTraits::read split in two overloads, the first one for plain C arrays + and the second one for other types. + - Add support for complex number + - Add exist() method to the API + - Will be last release before 2.0 and enforcement of C++11 + +## Version 1.4 - 2017-08-25 + - Support id selection for the `select` function + - Suport STL containers of const elements + - Support scalar values and strings management + - Fix attribute assignment issue #40 + - Fix Object assignment operator missing unref (possible memory leak ) + - Introduce SilenceHDF5 for HDF5 error report + - Fix a unit test issue with SilenceHDF5 + +## Version 1.3 - 2017-06-21 + - Minor fixes + +## Version 1.2 - 2017-04-03 + - Add Attribute support for Dataset + - Extend testing of Attribute support + - Fix issue related to multiple definitions in default driver + - Add more examples about attribute support + +## Version 1.1 - 2017-03-23 + - Add support and examples for Parallel HDF5 + - Initial implementation for H5 Properties + - Support for Attributes + - Improve documentation + - Add example for boost.Ublas matrix support + +## Version 1.0 - Init + - Initial release diff --git a/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/CMake/HighFiveConfig.cmake.in b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/CMake/HighFiveConfig.cmake.in new file mode 100644 index 0000000000..c37fffdf34 --- /dev/null +++ b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/CMake/HighFiveConfig.cmake.in @@ -0,0 +1,67 @@ +function(copy_interface_properties target source) + foreach(prop + INTERFACE_COMPILE_DEFINITIONS + INTERFACE_COMPILE_FEATURES + INTERFACE_COMPILE_OPTIONS + INTERFACE_INCLUDE_DIRECTORIES + INTERFACE_LINK_LIBRARIES + INTERFACE_SOURCES + INTERFACE_SYSTEM_INCLUDE_DIRECTORIES) + set_property(TARGET ${target} APPEND PROPERTY ${prop} $) + endforeach() +endfunction() + +if(TARGET HighFive) + return() +endif() + +# Get HighFive targets +include("${CMAKE_CURRENT_LIST_DIR}/HighFiveTargets.cmake") + +# Recreate combined HighFive +add_library(HighFive INTERFACE IMPORTED) +set_property(TARGET HighFive APPEND PROPERTY INTERFACE_COMPILE_DEFINITIONS MPI_NO_CPPBIND) # No c++ bindings + +# Ensure we activate required C++ std +if(NOT DEFINED CMAKE_CXX_STANDARD) + if(CMAKE_VERSION VERSION_LESS 3.8) + message(WARNING "HighFive requires minimum C++11. (C++14 for XTensor) \ + You may need to set CMAKE_CXX_STANDARD in you project") + else() + # A client request for a higher std overrides this + target_compile_features(HighFive INTERFACE cxx_std_11) + endif() +endif() + +# If the user sets this flag, all dependencies are preserved. +# Useful in central deployments where dependencies are not prepared later +set(HIGHFIVE_USE_INSTALL_DEPS @HIGHFIVE_USE_INSTALL_DEPS@ CACHE BOOL "Use original Highfive dependencies") +if(HIGHFIVE_USE_INSTALL_DEPS) + # If enabled in the deploy config, request c++14 + if(@HIGHFIVE_USE_XTENSOR@ AND NOT CMAKE_VERSION VERSION_LESS 3.8) + set_property(TARGET HighFive APPEND PROPERTY INTERFACE_COMPILE_FEATURES cxx_std_14) + endif() + message(STATUS "HIGHFIVE @PROJECT_VERSION@: Using original dependencies (HIGHFIVE_USE_INSTALL_DEPS=YES)") + copy_interface_properties(HighFive HighFive_HighFive) + return() +endif() + +# When not using the pre-built dependencies, give user options +if(DEFINED HIGHFIVE_USE_BOOST) + set(HIGHFIVE_USE_BOOST ${HIGHFIVE_USE_BOOST} CACHE BOOL "Enable Boost Support") +else() + set(HIGHFIVE_USE_BOOST @HIGHFIVE_USE_BOOST@ CACHE BOOL "Enable Boost Support") +endif() +set(HIGHFIVE_USE_EIGEN "${HIGHFIVE_USE_EIGEN}" CACHE BOOL "Enable Eigen testing") +set(HIGHFIVE_USE_XTENSOR "${HIGHFIVE_USE_XTENSOR}" CACHE BOOL "Enable xtensor testing") +set(HIGHFIVE_PARALLEL_HDF5 @HIGHFIVE_PARALLEL_HDF5@ CACHE BOOL "Enable Parallel HDF5 support") + +if(HIGHFIVE_USE_XTENSOR AND NOT CMAKE_VERSION VERSION_LESS 3.8) + set_property(TARGET HighFive APPEND PROPERTY INTERFACE_COMPILE_FEATURES cxx_std_14) +endif() + +message(STATUS "HIGHFIVE @PROJECT_VERSION@: (Re)Detecting Highfive dependencies (HIGHFIVE_USE_INSTALL_DEPS=NO)") +include("${CMAKE_CURRENT_LIST_DIR}/HighFiveTargetDeps.cmake") +foreach(dependency HighFive_libheaders libdeps) + copy_interface_properties(HighFive ${dependency}) +endforeach() diff --git a/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/CMake/HighFiveTargetDeps.cmake b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/CMake/HighFiveTargetDeps.cmake new file mode 100644 index 0000000000..6f8dbaec56 --- /dev/null +++ b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/CMake/HighFiveTargetDeps.cmake @@ -0,0 +1,93 @@ +# Link against target system libs +# ------------------------------- + +if(NOT TARGET libdeps) + + # Independent target to make it possible to have new dependencies each build + add_library(libdeps INTERFACE) + + # HDF5 + if(NOT DEFINED HDF5_C_LIBRARIES) + set(HDF5_PREFER_PARALLEL ${HIGHFIVE_PARALLEL_HDF5}) + find_package(HDF5 REQUIRED) + endif() + + if(HIGHFIVE_PARALLEL_HDF5 AND NOT HDF5_IS_PARALLEL) + message(WARNING "Parallel HDF5 requested but libhdf5 doesnt support it") + endif() + + target_include_directories(libdeps SYSTEM INTERFACE ${HDF5_INCLUDE_DIRS}) + target_link_libraries(libdeps INTERFACE ${HDF5_LIBRARIES}) + target_compile_definitions(libdeps INTERFACE ${HDF5_DEFINITIONS}) + + # Boost + if(HIGHFIVE_USE_BOOST) + set(Boost_NO_BOOST_CMAKE TRUE) # Consistency + find_package(Boost REQUIRED COMPONENTS system serialization) + # Dont use imported targets yet, not avail before cmake 3.5 + target_include_directories(libdeps SYSTEM INTERFACE ${Boost_INCLUDE_DIR}) + target_compile_definitions(libdeps INTERFACE BOOST_ALL_NO_LIB H5_USE_BOOST) + endif() + + # Half + if(HIGHFIVE_USE_HALF_FLOAT) + find_file(FOUND_HALF half.hpp) + if (NOT FOUND_HALF) + message(FATAL_ERROR "Half-precision floating-point support requested but file half.hpp not found") + endif() + target_compile_definitions(libdeps INTERFACE H5_USE_HALF_FLOAT) + endif() + + # Eigen + if(HIGHFIVE_USE_EIGEN) + if (NOT EIGEN3_INCLUDE_DIRS) + find_package(Eigen3 NO_MODULE) + if(Eigen3_FOUND) + message(STATUS "Found Eigen ${Eigen3_VERSION}: ${EIGEN3_INCLUDE_DIRS}") + else() + find_package(PkgConfig) + pkg_check_modules(EIGEN3 REQUIRED eigen3) + endif() + endif() + if (NOT EIGEN3_INCLUDE_DIRS) + message(FATAL_ERROR "Eigen was requested but could not be found") + endif() + target_include_directories(libdeps SYSTEM INTERFACE ${EIGEN3_INCLUDE_DIRS}) + target_compile_definitions(libdeps INTERFACE H5_USE_EIGEN) + endif() + + # xtensor + if(HIGHFIVE_USE_XTENSOR) + if (NOT xtensor_INCLUDE_DIRS) + find_package(xtensor REQUIRED) + endif() + if (NOT xtl_INCLUDE_DIRS) + find_package(xtl REQUIRED) + endif() + target_include_directories(libdeps SYSTEM INTERFACE ${xtensor_INCLUDE_DIRS} ${xtl_INCLUDE_DIRS}) + target_compile_definitions(libdeps INTERFACE H5_USE_XTENSOR) + endif() + + # OpenCV + if(HIGHFIVE_USE_OPENCV) + if (NOT OpenCV_INCLUDE_DIRS) + find_package(OpenCV REQUIRED) + endif() + target_include_directories(libdeps SYSTEM INTERFACE ${OpenCV_INCLUDE_DIRS}) + target_link_libraries(libdeps INTERFACE ${OpenCV_LIBS}) + target_compile_definitions(libdeps INTERFACE H5_USE_OPENCV) + endif() + + # MPI + if(HIGHFIVE_PARALLEL_HDF5 OR HDF5_IS_PARALLEL) + find_package(MPI REQUIRED) + target_include_directories(libdeps SYSTEM INTERFACE ${MPI_CXX_INCLUDE_PATH}) + target_link_libraries(libdeps INTERFACE ${MPI_CXX_LIBRARIES}) + if(CMAKE_VERSION VERSION_LESS 3.13) + target_link_libraries(libdeps INTERFACE ${MPI_CXX_LINK_FLAGS}) + else() + target_link_options(libdeps INTERFACE "SHELL:${MPI_CXX_LINK_FLAGS}") + endif() + endif() + +endif() diff --git a/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/CMake/HighFiveTargetExport.cmake b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/CMake/HighFiveTargetExport.cmake new file mode 100644 index 0000000000..9906f39513 --- /dev/null +++ b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/CMake/HighFiveTargetExport.cmake @@ -0,0 +1,48 @@ + +# Define the HighFive INTERFACE library +add_library(libheaders INTERFACE) + +target_include_directories(libheaders INTERFACE + "$" + "$") + +# Combined HighFive +add_library(HighFive INTERFACE) +target_compile_definitions(HighFive INTERFACE MPI_NO_CPPBIND) # No c++ bindings +target_link_libraries(HighFive INTERFACE libheaders libdeps) + + +# Generate ${PROJECT_NAME}Config.cmake + +include(CMakePackageConfigHelpers) +configure_package_config_file(${CMAKE_CURRENT_LIST_DIR}/HighFiveConfig.cmake.in + ${PROJECT_BINARY_DIR}/${PROJECT_NAME}Config.cmake + INSTALL_DESTINATION share/${PROJECT_NAME}/CMake) + +write_basic_package_version_file( + ${PROJECT_NAME}ConfigVersion.cmake + VERSION ${PROJECT_VERSION} + COMPATIBILITY AnyNewerVersion) + +install(FILES + CMake/HighFiveTargetDeps.cmake + ${PROJECT_BINARY_DIR}/${PROJECT_NAME}Config.cmake + ${PROJECT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake + DESTINATION share/${PROJECT_NAME}/CMake) + + +# Provides IMPORTED targets when using this project from build/install trees. + +# Specify targets to include in the HighFive Exports +install(TARGETS HighFive libheaders libdeps + EXPORT HighFiveTargets) + +# Generate & install the Export for the INSTALL_INTERFACE +install(EXPORT HighFiveTargets + NAMESPACE HighFive_ + FILE HighFiveTargets.cmake + DESTINATION share/${PROJECT_NAME}/CMake) + +# Generate the Export for the BUILD_INTERACE (hardly used) +export(EXPORT HighFiveTargets + FILE "${PROJECT_BINARY_DIR}/HighFiveTargets.cmake") diff --git a/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/CMake/config/CompilerFlagsHelpers.cmake b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/CMake/config/CompilerFlagsHelpers.cmake new file mode 100644 index 0000000000..e3755ad8c6 --- /dev/null +++ b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/CMake/config/CompilerFlagsHelpers.cmake @@ -0,0 +1,59 @@ +# CompilerFlagsHelpers.cmake +# +# set of Convenience functions for portable compiler flags +# +# License: BSD 3 +# +# Copyright (c) 2016, Adrien Devresse +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: +# +# 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. +# +# 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. +# +# 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + + + +set(SUPPORTED_COMPILER_LANGUAGE_LIST "C;CXX") + +foreach(COMPILER_LANGUAGE ${SUPPORTED_COMPILER_LANGUAGE_LIST}) + + # XLC compiler + if(CMAKE_${COMPILER_LANGUAGE}_COMPILER_ID MATCHES "XL") + + # XLC -qinfo=all is awfully verbose on any platforms that use the GNU STL + # Enable by default only the relevant one + set(CMAKE_${COMPILER_LANGUAGE}_WARNING_ALL "-qformat=all -qinfo=lan:trx:ret:zea:cmp:ret") + + ## GCC, CLANG, rest of the world + elseif(CMAKE_${COMPILER_LANGUAGE}_COMPILER_ID MATCHES "Clang" + OR CMAKE_${COMPILER_LANGUAGE}_COMPILER_ID MATCHES "GNU" + OR CMAKE_${COMPILER_LANGUAGE}_COMPILER_ID MATCHES "Intel") + set(CMAKE_${COMPILER_LANGUAGE}_WARNING_ALL " -Wall -Wextra") + string(CONCAT CMAKE_${COMPILER_LANGUAGE}_WARNING_DEBUG + " -Werror -Wshadow -Wnon-virtual-dtor -Wunused -Woverloaded-virtual" + " -Wformat=2 -Wconversion -Wsign-conversion -Wno-error=deprecated-declarations" + ) + if(NOT CMAKE_${COMPILER_LANGUAGE}_COMPILER_IS_ICC) + string(CONCAT CMAKE_${COMPILER_LANGUAGE}_WARNING_DEBUG + ${CMAKE_${COMPILER_LANGUAGE}_WARNING_DEBUG} + " -Wpedantic -Wcast-align -Wdouble-promotion" + ) + endif() + endif() + + if(CMAKE_${COMPILER_LANGUAGE}_COMPILER_ID MATCHES "GNU" + AND (CMAKE_${COMPILER_LANGUAGE}_COMPILER_VERSION VERSION_GREATER "4.7.0")) + set(CMAKE_${COMPILER_LANGUAGE}_WARNING_ALL + "${CMAKE_${COMPILER_LANGUAGE}_WARNING_ALL} -Wno-unused-parameter") + endif() + +endforeach() + + + diff --git a/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/CMake/config/ReleaseDebugAutoFlags.cmake b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/CMake/config/ReleaseDebugAutoFlags.cmake new file mode 100644 index 0000000000..2b980698eb --- /dev/null +++ b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/CMake/config/ReleaseDebugAutoFlags.cmake @@ -0,0 +1,45 @@ +# ReleaseDebugAutoFlags.cmake +# +# Release / Debug configuration helper +# +# License: BSD 3 +# +# Copyright (c) 2016, Adrien Devresse +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: +# +# 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. +# +# 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. +# +# 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + + + +## default configuration +if(NOT CMAKE_BUILD_TYPE AND (NOT CMAKE_CONFIGURATION_TYPES)) + set(CMAKE_BUILD_TYPE RelWithDebInfo CACHE STRING "Choose the type of build." FORCE) + message(STATUS "Setting build type to '${CMAKE_BUILD_TYPE}' as none was specified.") +endif() + + +# Different configuration types: +# +# Debug : Optimized for debugging, include symbols +# Release : Release mode, no debuginfo +# RelWithDebInfo : Distribution mode, basic optimizations for potable code with debuginfos + +include(CompilerFlagsHelpers) + + +string(APPEND CMAKE_C_FLAGS_RELEASE "${CMAKE_C_WARNING_ALL}") +string(APPEND CMAKE_C_FLAGS_DEBUG "${CMAKE_C_WARNING_ALL}" "${CMAKE_C_WARNING_DEBUG}") +string(APPEND CMAKE_C_FLAGS_RELWITHDEBINFO "${CMAKE_C_WARNING_ALL}" "${CMAKE_C_WARNING_DEBUG}") + + +string(APPEND CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_WARNING_ALL}") +string(APPEND CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_WARNING_ALL}" "${CMAKE_CXX_WARNING_DEBUG}") +string(APPEND CMAKE_CXX_FLAGS_RELWITHDEBINFO "${CMAKE_CXX_WARNING_ALL}" "${CMAKE_C_WARNING_DEBUG}") diff --git a/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/CMake/config/TestHelpers.cmake b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/CMake/config/TestHelpers.cmake new file mode 100644 index 0000000000..f3ca1cb741 --- /dev/null +++ b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/CMake/config/TestHelpers.cmake @@ -0,0 +1,113 @@ +# TestHelpers.cmake +# +# set of Convenience functions for unit testing with cmake +# +# License: BSD 3 +# +# Copyright (c) 2016, Adrien Devresse +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: +# +# 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. +# +# 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. +# +# 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + + + +## +# enable or disable detection of SLURM and MPIEXEC +option(AUTO_TEST_WITH_SLURM "automatically add srun as test prefix in a SLURM environment" TRUE) +option(AUTO_TEST_WITH_MPIEXEC "automatically add mpiexec as test prefix in a MPICH2/OpenMPI environment" TRUE) + +### +## +## Basic SLURM support +## the prefix "srun" is added to any test in the environment +## For a slurm test execution, simply run "salloc [your_exec_parameters] ctest" +## +## +if(AUTO_TEST_WITH_SLURM) + if(NOT DEFINED SLURM_SRUN_COMMAND) + find_program(SLURM_SRUN_COMMAND + NAMES "srun" + HINTS "${SLURM_ROOT}/bin") + endif() + + if(SLURM_SRUN_COMMAND) + set(TEST_EXEC_PREFIX_DEFAULT "${SLURM_SRUN_COMMAND}") + set(TEST_MPI_EXEC_PREFIX_DEFAULT "${SLURM_SRUN_COMMAND}") + set(TEST_MPI_EXEC_BIN_DEFAULT "${SLURM_SRUN_COMMAND}") + set(TEST_WITH_SLURM ON) + message(STATUS " - AUTO_TEST_WITH_SLURM with slurm cmd ${TEST_EXEC_PREFIX_DEFAULT} ") + message(STATUS " -- set test execution prefix to ${TEST_EXEC_PREFIX_DEFAULT} ") + message(STATUS " -- set MPI test execution prefix to ${TEST_MPI_EXEC_PREFIX_DEFAULT} ") + endif() + +endif() + +### +## Basic MPIExec support, will just forward mpiexec as prefix +## +if(AUTO_TEST_WITH_MPIEXEC AND NOT TEST_WITH_SLURM) + + if(NOT DEFINED MPIEXEC) + find_program(MPIEXEC + NAMES "mpiexec" + HINTS "${MPI_ROOT}/bin") + endif() + + + if(MPIEXEC) + set(TEST_MPI_EXEC_PREFIX_DEFAULT "${MPIEXEC}") + set(TEST_MPI_EXEC_BIN_DEFAULT "${MPIEXEC}") + set(TEST_WITH_MPIEXEC ON) + message(STATUS " - AUTO_TEST_WITH_MPIEXEC cmd ${MPIEXEC} ") + message(STATUS " -- set MPI test execution prefix to ${TEST_MPI_EXEC_PREFIX_DEFAULT} ") + + endif() + +endif() + + + +### +## MPI executor program path without arguments used for testing. +## default: srun or mpiexec if found +## +set(TEST_MPI_EXEC_BIN "${TEST_MPI_EXEC_BIN_DEFAULT}" CACHE STRING "path of the MPI executor (mpiexec, mpirun) for test execution") + + + +### +## Test execution prefix. Override this variable for any execution prefix required in clustered environment +## +## To specify manually a command with argument, e.g -DTEST_EXEC_PREFIX="/var/empty/bin/srun;-n;-4" for a srun execution +## with 4 nodes +## +## default: srun if found +## +set(TEST_EXEC_PREFIX "${TEST_EXEC_PREFIX_DEFAULT}" CACHE STRING "prefix command for the test executions") + + + +### +## Test execution prefix specific for MPI programs. +## +## To specify manually a command with argument, use the cmake list syntax. e.g -DTEST_EXEC_PREFIX="/var/empty/bin/mpiexec;-n;-4" for an MPI execution +## with 4 nodes +## +## default: srun or mpiexec if found +## +set(TEST_MPI_EXEC_PREFIX "${TEST_MPI_EXEC_PREFIX_DEFAULT}" CACHE STRING "prefix command for the MPI test executions") + + + + + + + diff --git a/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/CMakeLists.txt b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/CMakeLists.txt new file mode 100644 index 0000000000..27746c2ff6 --- /dev/null +++ b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/CMakeLists.txt @@ -0,0 +1,124 @@ +cmake_minimum_required(VERSION 3.1) +if(${CMAKE_VERSION} VERSION_LESS 3.13) + cmake_policy(VERSION ${CMAKE_MAJOR_VERSION}.${CMAKE_MINOR_VERSION}) +else() + cmake_policy(VERSION 3.13) +endif() + +project(HighFive VERSION 2.6.2) + +configure_file(${CMAKE_CURRENT_SOURCE_DIR}/include/highfive/H5Version.hpp.in + ${CMAKE_CURRENT_BINARY_DIR}/include/highfive/H5Version.hpp) +# INCLUDES +list(APPEND CMAKE_MODULE_PATH + ${PROJECT_SOURCE_DIR}/CMake + ${PROJECT_SOURCE_DIR}/CMake/portability + ${PROJECT_SOURCE_DIR}/CMake/config) + +# OPTIONS +# Compatibility within Highfive 2.x series +set(USE_BOOST ON CACHE BOOL "Enable Boost Support") +set(USE_EIGEN OFF CACHE BOOL "Enable Eigen testing") +set(USE_XTENSOR OFF CACHE BOOL "Enable xtensor testing") +set(USE_OPENCV OFF CACHE BOOL "Enable OpenCV testing") +mark_as_advanced(USE_BOOST USE_EIGEN USE_XTENSOR) + +set(HIGHFIVE_UNIT_TESTS AUTO CACHE STRING "Enable unit tests (requires Catch2 to be present)") +set_property(CACHE HIGHFIVE_UNIT_TESTS PROPERTY STRINGS AUTO ON OFF) + +option(HIGHFIVE_USE_BOOST "Enable Boost Support" ${USE_BOOST}) +option(HIGHFIVE_USE_HALF_FLOAT "Enable half-precision floats" ${USE_HALF_FLOAT}) +option(HIGHFIVE_USE_EIGEN "Enable Eigen testing" ${USE_EIGEN}) +option(HIGHFIVE_USE_OPENCV "Enable OpenCV testing" ${USE_OPENCV}) +option(HIGHFIVE_USE_XTENSOR "Enable xtensor testing" ${USE_XTENSOR}) +option(HIGHFIVE_EXAMPLES "Compile examples" ON) +option(HIGHFIVE_PARALLEL_HDF5 "Enable Parallel HDF5 support" OFF) +option(HIGHFIVE_BUILD_DOCS "Enable documentation building" ON) + +# In deployments we probably don't want/cant have dynamic dependencies +option(HIGHFIVE_USE_INSTALL_DEPS "End applications by default use detected dependencies here" OFF) +mark_as_advanced(HIGHFIVE_USE_INSTALL_DEPS) + + +# Check compiler cxx_std requirements +# ----------------------------------- + +if(CMAKE_CXX_STANDARD EQUAL 98) + message(FATAL_ERROR "HighFive needs to be compiled with at least C++11") +endif() + +if(NOT DEFINED CMAKE_CXX_STANDARD) + set(CMAKE_CXX_STANDARD 11) + set(CMAKE_CXX_STANDARD_REQUIRED ON) + set(CMAKE_CXX_EXTENSIONS OFF) +endif() + +if(HIGHFIVE_USE_XTENSOR) + set(CMAKE_CXX_STANDARD 14) + set(CMAKE_CXX_STANDARD_REQUIRED ON) +endif() + + +# Search dependencies (hdf5, boost, eigen, xtensor, mpi) and build target highfive_deps +include(${PROJECT_SOURCE_DIR}/CMake/HighFiveTargetDeps.cmake) + +# Set-up HighFive to be used in 3rd party project using exports. Create a HighFive target +include(${PROJECT_SOURCE_DIR}/CMake/HighFiveTargetExport.cmake) + +# Installation of headers (HighFive is only interface) +install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/include/ + DESTINATION "include" + PATTERN "*.in" EXCLUDE) + +# Installation of configured headers +install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/include/ + DESTINATION "include") + + +# Preparing local building (tests, examples) +# ------------------------------------------ + +# Disable test if Boost was expressly disabled, or if HighFive is a sub-project +if (NOT CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR) + if(HIGHFIVE_UNIT_TESTS) + message(WARNING "Unit tests have been DISABLED.") + endif() + set(HIGHFIVE_UNIT_TESTS FALSE) +endif() + +if(HIGHFIVE_UNIT_TESTS) + if(EXISTS ${CMAKE_CURRENT_LIST_DIR}/deps/catch2/CMakeLists.txt) + add_subdirectory(deps/catch2 EXCLUDE_FROM_ALL) + list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/deps/catch2/contrib) + else() + find_package(Catch2) + if(NOT HIGHFIVE_UNIT_TESTS STREQUAL "AUTO" AND HIGHFIVE_UNIT_TESTS AND NOT Catch2_FOUND) + message(FATAL_ERROR "Please provide a Catch2 installation or clone the submodule") + elseif(NOT Catch2_FOUND) + message(WARNING "No Catch2 installation was found; Disabling unit tests.") + set(HIGHFIVE_UNIT_TESTS OFF) + endif() + endif() +endif() + + +if(CMAKE_CXX_COMPILER_ID MATCHES "Intel") + # ICC gets mad if we shorten "int"s + add_definitions("-wd1682") +endif() + +# Set compile time flags _after_ including required dependencies +include(ReleaseDebugAutoFlags) + +if(HIGHFIVE_EXAMPLES) + add_subdirectory(src/examples) +endif() + +if(HIGHFIVE_UNIT_TESTS) + enable_testing() + add_subdirectory(tests/unit) +endif() + +if(HIGHFIVE_BUILD_DOCS) + add_subdirectory(doc) +endif() diff --git a/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/LICENSE b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/LICENSE new file mode 100644 index 0000000000..bc1edcab2e --- /dev/null +++ b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/LICENSE @@ -0,0 +1,25 @@ +Boost Software License - Version 1.0 - August 17th, 2003 + +Permission is hereby granted, free of charge, to any person or organization +obtaining a copy of the software and accompanying documentation covered by +this license (the "Software") to use, reproduce, display, distribute, +execute, and transmit the Software, and to prepare derivative works of the +Software, and to permit third-parties to whom the Software is furnished to +do so, all subject to the following: + +The copyright notices in the Software and this entire statement, including +the above license grant, this restriction and the following disclaimer, +must be included in all copies of the Software, in whole or in part, and +all derivative works of the Software, unless such copies or derivative +works are solely in the form of machine-executable object code generated by +a source language processor. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. + + diff --git a/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/README.md b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/README.md new file mode 100644 index 0000000000..953f534a0c --- /dev/null +++ b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/README.md @@ -0,0 +1,225 @@ +# HighFive - HDF5 header-only C++ Library + +[![Build Status](https://travis-ci.org/BlueBrain/HighFive.svg?branch=master)](https://travis-ci.org/BlueBrain/HighFive) +[![Coverity Statys](https://scan.coverity.com/projects/13635/badge.svg)](https://scan.coverity.com/projects/highfive) +[![Doxygen -> gh-pages](https://github.com/BlueBrain/HighFive/workflows/gh-pages/badge.svg)](https://BlueBrain.github.io/HighFive) +[![codecov](https://codecov.io/gh/BlueBrain/HighFive/branch/master/graph/badge.svg?token=UBKxHEn7RS)](https://codecov.io/gh/BlueBrain/HighFive) +[![HighFive_Integration_tests](https://github.com/BlueBrain/HighFive-testing/actions/workflows/integration.yml/badge.svg)](https://github.com/BlueBrain/HighFive-testing/actions/workflows/integration.yml) + +Documentation: https://bluebrain.github.io/HighFive/ + +## Brief + +HighFive is a modern header-only C++11 friendly interface for libhdf5. + +HighFive supports STL vector/string, Boost::UBLAS, Boost::Multi-array, Eigen and Xtensor. It handles C++ from/to HDF5 with automatic type mapping. +HighFive does not require additional libraries (see dependencies) and supports both HDF5 thread safety and Parallel HDF5 (contrary to the official hdf5 cpp) + +It integrates nicely with other CMake projects by defining (and exporting) a HighFive target. + + +### Design +- Simple C++-ish minimalist interface +- No other dependency than libhdf5 +- Zero overhead +- Support C++11 + +### Feature support +- create/read/write files, datasets, attributes, groups, dataspaces. +- automatic memory management / ref counting +- automatic conversion of `std::vector` and nested `std::vector` from/to any dataset with basic types +- automatic conversion of `std::string` to/from variable length string dataset +- selection() / slice support +- parallel Read/Write operations from several nodes with Parallel HDF5 +- Advanced types: Compound, Enum, Arrays of Fixed-length strings, References +- half-precision (16-bit) floating-point datasets +- etc... (see [ChangeLog](./CHANGELOG.md)) + +### Dependencies +- hdf5 (dev) +- hdf5-mpi (optional, opt-in with -D*HIGHFIVE_PARALLEL_HDF5*=ON) +- boost >= 1.41 (recommended, opt-out with -D*HIGHFIVE_USE_BOOST*=OFF) +- eigen3 (optional, opt-in with -D*HIGHFIVE_USE_EIGEN*=ON) +- xtensor (optional, opt-in with -D*HIGHFIVE_USE_XTENSOR*=ON) +- half (optional, opt-in with -D*HIGHFIVE_USE_HALF_FLOAT*=ON) + + +## Examples + +#### Write a std::vector to 1D HDF5 dataset and read it back + +```c++ +#include + +using namespace HighFive; + +std::string filename = "/tmp/new_file.h5"; + +{ + // We create an empty HDF55 file, by truncating an existing + // file if required: + File file(filename, File::Truncate); + + std::vector data(50, 1); + file.createDataSet("grp/data", data); +} + +{ + // We open the file as read-only: + File file(filename, File::ReadOnly); + auto dataset = file.getDataSet("grp/data"); + + // Read back, with allocating: + auto data = dataset.read>(); + + // Because `data` has the correct size, this will + // not cause `data` to be reallocated: + dataset.read(data); +} +``` + +**Note:** `H5File.hpp` is the top-level header of HighFive core which should be always included. + +**Note:** For advanced usecases the dataset can be created without immediately +writing to it. This is common in MPI-IO related patterns, or when growing a +dataset over the course of a simulation. + +#### Write a 2 dimensional C double float array to a 2D HDF5 dataset + +See [create_dataset_double.cpp](src/examples/create_dataset_double.cpp) + +#### Write and read a matrix of double float (boost::ublas) to a 2D HDF5 dataset + +See [boost_ublas_double.cpp](src/examples/boost_ublas_double.cpp) + +#### Write and read a subset of a 2D double dataset + +See [select_partial_dataset_cpp11.cpp](src/examples/select_partial_dataset_cpp11.cpp) + +#### Create, write and list HDF5 attributes + +See [create_attribute_string_integer.cpp](src/examples/create_attribute_string_integer.cpp) + +#### And others + +See [src/examples/](src/examples/) subdirectory for more info. + + +### Compiling with HighFive + +```bash +c++ -o program -I/path/to/highfive/include source.cpp -lhdf5 +``` + +### H5Easy + +For several 'standard' use cases the [highfive/H5Easy.hpp](include/highfive/H5Easy.hpp) interface is available. It allows: + +* Reading/writing in a single line of: + + - scalars (to/from an extendible DataSet), + - strings, + - vectors (of standard types), + - [Eigen::Matrix](http://eigen.tuxfamily.org) (optional, enable CMake option `HIGHFIVE_USE_EIGEN`), + - [xt::xarray](https://github.com/QuantStack/xtensor) and [xt::xtensor](https://github.com/QuantStack/xtensor) + (optional, enable CMake option `HIGHFIVE_USE_XTENSOR`). + - [cv::Mat_](https://docs.opencv.org/master/df/dfc/classcv_1_1Mat__.html) + (optional, enable CMake option `HIGHFIVE_USE_OPENCV`). + +* Getting in a single line: + + - the size of a DataSet, + - the shape of a DataSet. + +#### Example + +```cpp +#include + +int main() { + H5Easy::File file("example.h5", H5Easy::File::Overwrite); + + int A = ...; + H5Easy::dump(file, "/path/to/A", A); + + A = H5Easy::load(file, "/path/to/A"); +} +``` + +whereby the `int` type of this example can be replaced by any of the above types. See [easy_load_dump.cpp](src/examples/easy_load_dump.cpp) for more details. + +**Note:** Classes such as `H5Easy::File` are just short for the regular `HighFive` classes (in this case `HighFive::File`). They can thus be used interchangeably. + + +## CMake integration + +HighFive can easily be used by other C++ CMake projects. + +You may use HighFive from a folder in your project (typically a git submodule). +```cmake +cmake_minimum_required(VERSION 3.1 FATAL_ERROR) +project(foo) +set(CMAKE_CXX_STANDARD 11) + +add_subdirectory(highfive_folder) +add_executable(bar bar.cpp) +target_link_libraries(bar HighFive) +``` + +Alternativelly you can install HighFive once and use it in several projects via `find_package()`. + +A HighFive target will bring the compilation settings to find HighFive headers and all chosen dependencies. + +```cmake +# ... +find_package(HighFive REQUIRED) +add_executable(bar bar.cpp) +target_link_libraries(bar HighFive) +``` +**Note:** Like with other libraries you may need to provide CMake the location to find highfive: `CMAKE_PREFIX_PATH=` + +**Note:** `find_package(HighFive)` will search dependencies as well (e.g. Boost if requested). In order to use the same dependencies found at HighFive install time (e.g. for system deployments) you may set `HIGHFIVE_USE_INSTALL_DEPS=YES` + +### Installing +When installing via CMake, besides the headers, a HighFiveConfig.cmake is generated which provides the HighFive target, as seen before. Note: You may need to set `CMAKE_INSTALL_PREFIX`: +```bash +mkdir build && cd build +# Look up HighFive CMake options, consider inspecting with `ccmake` +cmake .. -DHIGHFIVE_EXAMPLES=OFF -DCMAKE_INSTALL_PREFIX="" +make install +``` + +### Test Compilation +As a header-only library, HighFive doesn't require compilation. You may however build tests and examples. + +```bash +mkdir build && cd build +cmake ../ +make # build tests and examples +make test # build and run unit tests +``` + +**Note:** Unit tests require Boost. In case it's unavailable you may use `-DHIGHFIVE_USE_BOOST=OFF`. +HighFive with disable support for Boost types as well as unit tests (though most examples will build). + +### Code formatting +If you want to propose pull requests to this project, do not forget to format code with +clang-format version 12. +The .clang-format is at the root of the git repository. + +# Questions? + +Do you have questions on how to use HighFive? Would you like to share an interesting example or +discuss HighFive features? Head over to the [Discussions](https://github.com/BlueBrain/HighFive/discussions) +forum and join the community. + +# Funding & Acknowledgment + +The development of this software was supported by funding to the Blue Brain Project, a research center of the École polytechnique fédérale de Lausanne (EPFL), from the Swiss government's ETH Board of the Swiss Federal Institutes of Technology. + +Copyright © 2015-2022 Blue Brain Project/EPFL + + +### License + +Boost Software License 1.0 diff --git a/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/VERSION b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/VERSION new file mode 100644 index 0000000000..b1b25a5ffa --- /dev/null +++ b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/VERSION @@ -0,0 +1 @@ +2.2.2 diff --git a/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/doc/CMakeLists.txt b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/doc/CMakeLists.txt new file mode 100644 index 0000000000..2538af62d2 --- /dev/null +++ b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/doc/CMakeLists.txt @@ -0,0 +1,7 @@ +find_package(Doxygen) +if(Doxygen_FOUND) + configure_file(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY) + add_custom_target(doc COMMAND Doxygen::doxygen ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile) +else() + message(STATUS " Documentation (doc) cannot be built since Doxygen is not available.") +endif() diff --git a/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/doc/Doxyfile b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/doc/Doxyfile new file mode 100644 index 0000000000..52638f15ca --- /dev/null +++ b/externals/coda-oss/modules/drivers/highfive/HighFive-2.6.2/doc/Doxyfile @@ -0,0 +1,2618 @@ +# Doxyfile 1.9.1 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the configuration +# file that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = HighFive + +# 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 = @PROJECT_VERSION@ + +# 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 = "HighFive - Header-only C++ HDF5 interface" + +# 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 = + +# 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 + +# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all generated output in the proper direction. +# Possible values are: None, LTR, RTL and Context. +# The default value is: None. + +OUTPUT_TEXT_DIRECTION = None + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = @CMAKE_CURRENT_SOURCE_DIR@/../include + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by doxygen. +# The default value is: NO. + +JAVADOC_BANNER = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# By default Python docstrings are displayed as preformatted text and doxygen's +# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the +# doxygen's special commands can be used and the contents of the docstring +# documentation blocks is shown as doxygen documentation. +# The default value is: YES. + +PYTHON_DOCSTRING = YES + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\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 (in the resulting output). You can put ^^ in the value part of an +# alias to insert a newline as if a physical newline was in the original file. +# When you need a literal { or } or , in the value part of an alias you have to +# escape them by means of a backslash (\), this can lead to conflicts with the +# commands \{ and \} for these it is advised to use the version @{ and @} or use +# a double escape (\\{ and \\}) + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, +# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL, +# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser +# tries to guess whether the code is fixed or free formatted code, this is the +# default for Fortran type files). For instance to make doxygen treat .inc files +# as Fortran files (default is PHP), and .f files as C (default is Fortran), +# use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. When specifying no_extension you should add +# * to the FILE_PATTERNS. +# +# Note see also the list of default file extension mappings. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See https://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 5. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 0 + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use +# during processing. When set to 0 doxygen will based this on the number of +# cores available in the system. You can set it explicitly to a value larger +# than 0 to get more control over the balance between CPU load and processing +# speed. At this moment only the input processing can be done using multiple +# threads. Since this is still an experimental feature the default is set to 1, +# which efficively disables parallel processing. Please report any issues you +# encounter. Generating dot graphs in parallel is controlled by the +# DOT_NUM_THREADS setting. +# Minimum value: 0, maximum value: 32, default value: 1. + +NUM_PROC_THREADS = 1 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If this flag is set to YES, the name of an unnamed parameter in a declaration +# will be determined by the corresponding definition. By default unnamed +# parameters remain unnamed in the output. +# The default value is: YES. + +RESOLVE_UNNAMED_PARAMS = YES + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# declarations. If set to NO, these declarations will be included in the +# documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# With the correct setting of option CASE_SENSE_NAMES doxygen will better be +# able to match the capabilities of the underlying filesystem. In case the +# filesystem is case sensitive (i.e. it supports files in the same directory +# whose names only differ in casing), the option must be set to YES to properly +# deal with such files in case they appear in the input. For filesystems that +# are not case sensitive the option should be be set to NO to properly deal with +# output files written for symbols that only differ in casing, such as for two +# classes, one named CLASS and the other named Class, and to also support +# references to files without having to specify the exact matching casing. On +# Windows (including Cygwin) and MacOS, users should typically set this option +# to NO, whereas on Linux or other Unix flavors it should typically be set to +# YES. +# The default value is: system dependent. + +CASE_SENSE_NAMES = NO + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_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 = @CMAKE_CURRENT_SOURCE_DIR@/DoxygenLayout.xml + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = YES + +# 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. If +# EXTRACT_ALL is set to YES then this flag will automatically be disabled. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS +# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but +# at the end of the doxygen process doxygen will return with a non-zero status. +# Possible values are: NO, YES and FAIL_ON_WARNINGS. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = @CMAKE_CURRENT_SOURCE_DIR@/../include \ + @CMAKE_CURRENT_SOURCE_DIR@/mainpage.md + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: +# https://www.gnu.org/software/libiconv/) for the list of possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# Note the list of default checked file patterns might differ from the list of +# default file extension mappings. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, +# *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment), +# *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, *.vhdl, +# *.ucf, *.qsf and *.ice. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.idl \ + *.ddl \ + *.odl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.cs \ + *.d \ + *.php \ + *.php4 \ + *.php5 \ + *.phtml \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.pyw \ + *.f90 \ + *.f95 \ + *.f03 \ + *.f08 \ + *.f \ + *.for \ + *.tcl \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = *detail* + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# entity all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see https://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = 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 = @CMAKE_CURRENT_SOURCE_DIR@/doxygen-awesome-css/doxygen-awesome.css + +# 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 +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use 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_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via JavaScript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have JavaScript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: +# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To +# create a documentation set, doxygen will generate a Makefile in the HTML +# output directory. Running make will produce the docset in that directory and +# running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.html for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: +# https://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 main .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location (absolute path +# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to +# run qhelpgenerator on the generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. 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 = YES + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg +# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see +# https://inkscape.org) to generate formulas as SVG images instead of PNGs for +# the HTML output. These images will generally look nicer at scaled resolutions. +# Possible values are: png (the default) and svg (looks nicer but requires the +# pdf2svg or inkscape tool). +# The default value is: png. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FORMULA_FORMAT = png + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANSPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. + +FORMULA_MACROFILE = + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://www.mathjax.org) which uses client side JavaScript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# 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/v2.7-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 https://www.mathjax.org before deployment. +# The default value is: https://cdn.jsdelivr.net/npm/mathjax@2. +# 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/v2.7-latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /