From ff9b8bb838ecdfbfc1dc81038fcf3b2a87636982 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20Zrounba?= <6691770+clement-z@users.noreply.github.com> Date: Sat, 30 Sep 2023 23:06:01 +0200 Subject: Initial release --- .clang-format | 121 ++ .config.gitlab-ci.mk | 28 + .gitignore | 32 + .gitlab-ci.yml | 79 + .gitmodules | 6 + LICENSE.txt | 166 ++ Makefile | 299 +++ QUICKSTART.md | 102 ++ README.md | 5 + circuits/add_drop.cir | 41 + circuits/add_drop_pyspecs.cir | 28 + circuits/add_drop_sub.cir | 15 + circuits/common_definitions.def | 5 + circuits/double_ring.cir | 57 + circuits/paul_3ring_puf.cir | 58 + circuits/paul_simple_ring.cir | 28 + circuits/subckt_test.cir | 10 + circuits/subckt_tests.cir | 51 + circuits/test_include.cir | 1 + circuits/triple_ring.cir | 76 + config.mk | 35 + doc/Doxyfile | 2543 ++++++++++++++++++++++++++ doc/custom.css | 13 + doc/mainpage.md | 14 + doc/resources/cheatsheet.pdf | Bin 0 -> 71515 bytes doc/resources/delayedwriter.svg | 39 + doc/resources/gdrsoc_poster.pdf | Bin 0 -> 1114814 bytes doc/resources/signals.svg | 35 + install.sh | 46 + pyspecs/__init__.py | 0 pyspecs/draw_graph_from_json.py | 145 ++ pyspecs/pyspecs_example.ipynb | 682 +++++++ pyspecs/specs.py | 236 +++ pyspecs/specsparse.py | 301 +++ src/devices/alldevices.h | 44 + src/devices/bitstream_source.cpp | 76 + src/devices/bitstream_source.h | 105 ++ src/devices/clements.cpp | 137 ++ src/devices/clements.h | 66 + src/devices/crossing.cpp | 129 ++ src/devices/crossing.h | 113 ++ src/devices/crow.cpp | 97 + src/devices/crow.h | 98 + src/devices/cw_source.cpp | 45 + src/devices/cw_source.h | 76 + src/devices/detector.cpp | 136 ++ src/devices/detector.h | 89 + src/devices/directional_coupler.cpp | 318 ++++ src/devices/directional_coupler.h | 133 ++ src/devices/electrical_value_list_source.cpp | 67 + src/devices/electrical_value_list_source.h | 128 ++ src/devices/generic_2x2_coupler.h | 86 + src/devices/generic_transmission_device.cpp | 224 +++ src/devices/generic_transmission_device.h | 94 + src/devices/generic_waveguide.h | 119 ++ src/devices/merger.cpp | 69 + src/devices/merger.h | 51 + src/devices/mesh_col.cpp | 243 +++ src/devices/mesh_col.h | 76 + src/devices/mzi.cpp | 55 + src/devices/mzi.h | 67 + src/devices/mzi_active.cpp | 206 +++ src/devices/mzi_active.h | 179 ++ src/devices/octane_cell.cpp | 91 + src/devices/octane_cell.h | 61 + src/devices/octane_matrix.cpp | 365 ++++ src/devices/octane_matrix.h | 99 + src/devices/octane_segment.cpp | 396 ++++ src/devices/octane_segment.h | 98 + src/devices/pcm_device.cpp | 150 ++ src/devices/pcm_device.h | 60 + src/devices/phaseshifter.cpp | 198 ++ src/devices/phaseshifter.h | 166 ++ src/devices/probe.cpp | 164 ++ src/devices/probe.h | 131 ++ src/devices/ring.cpp | 8 + src/devices/ring.h | 99 + src/devices/splitter.cpp | 41 + src/devices/splitter.h | 88 + src/devices/spx_module.h | 36 + src/devices/subcircuit_instance.h | 25 + src/devices/time_monitor.cpp | 152 ++ src/devices/time_monitor.h | 26 + src/devices/value_list_source.cpp | 69 + src/devices/value_list_source.h | 140 ++ src/devices/waveguide.cpp | 280 +++ src/devices/waveguide.h | 154 ++ src/main.cpp | 325 ++++ src/optical_output_port.cpp | 424 +++++ src/optical_output_port.h | 178 ++ src/optical_signal.cpp | 157 ++ src/optical_signal.h | 251 +++ src/parser/parse_analysis.cpp | 109 ++ src/parser/parse_analysis.h | 94 + src/parser/parse_directive.cpp | 132 ++ src/parser/parse_directive.h | 68 + src/parser/parse_element.cpp | 1266 +++++++++++++ src/parser/parse_element.h | 104 ++ src/parser/parse_tree.cpp | 972 ++++++++++ src/parser/parse_tree.h | 890 +++++++++ src/parser/parser.l | 438 +++++ src/parser/parser.y | 961 ++++++++++ src/specs.cpp | 383 ++++ src/specs.h | 159 ++ src/tb/alltestbenches.cpp | 28 + src/tb/alltestbenches.h | 22 + src/tb/crow_tb.cpp | 216 +++ src/tb/crow_tb.h | 30 + src/tb/detector_tb.cpp | 127 ++ src/tb/detector_tb.h | 30 + src/tb/directional_coupler_tb.cpp | 150 ++ src/tb/directional_coupler_tb.h | 31 + src/tb/freqsweep_tb.cpp | 213 +++ src/tb/freqsweep_tb.h | 33 + src/tb/lambda_tb.cpp | 102 ++ src/tb/lambda_tb.h | 31 + src/tb/merger_tb.cpp | 126 ++ src/tb/merger_tb.h | 30 + src/tb/mesh_tb.cpp | 130 ++ src/tb/mesh_tb.h | 29 + src/tb/mzi_tb.cpp | 86 + src/tb/mzi_tb.h | 31 + src/tb/pcm_device_tb.cpp | 129 ++ src/tb/pcm_device_tb.h | 29 + src/tb/phase_shifter_tb.cpp | 129 ++ src/tb/phase_shifter_tb.h | 32 + src/tb/ring_tb.cpp | 85 + src/tb/ring_tb.h | 29 + src/tb/splitter_tb.cpp | 123 ++ src/tb/splitter_tb.h | 29 + src/tb/wg_tb.cpp | 143 ++ src/tb/wg_tb.h | 28 + src/utils/general_utils.cpp | 1 + src/utils/general_utils.h | 35 + src/utils/pqueue.h | 35 + src/utils/strutils.h | 79 + src/utils/sysc_utils.cpp | 70 + src/utils/sysc_utils.h | 67 + thirdparty/args | 1 + thirdparty/systemc | 1 + todo.txt | 52 + utils/analyze_detector_trace.py | 444 +++++ utils/draw_graph_from_json.py | 145 ++ utils/openwave.sh | 55 + utils/specs.kicad_sym | 1986 ++++++++++++++++++++ 145 files changed, 23803 insertions(+) create mode 100644 .clang-format create mode 100644 .config.gitlab-ci.mk create mode 100644 .gitignore create mode 100644 .gitlab-ci.yml create mode 100644 .gitmodules create mode 100644 LICENSE.txt create mode 100644 Makefile create mode 100644 QUICKSTART.md create mode 100644 README.md create mode 100644 circuits/add_drop.cir create mode 100644 circuits/add_drop_pyspecs.cir create mode 100644 circuits/add_drop_sub.cir create mode 100644 circuits/common_definitions.def create mode 100644 circuits/double_ring.cir create mode 100644 circuits/paul_3ring_puf.cir create mode 100644 circuits/paul_simple_ring.cir create mode 100644 circuits/subckt_test.cir create mode 100644 circuits/subckt_tests.cir create mode 100644 circuits/test_include.cir create mode 100644 circuits/triple_ring.cir create mode 100644 config.mk create mode 100644 doc/Doxyfile create mode 100644 doc/custom.css create mode 100644 doc/mainpage.md create mode 100644 doc/resources/cheatsheet.pdf create mode 100644 doc/resources/delayedwriter.svg create mode 100644 doc/resources/gdrsoc_poster.pdf create mode 100644 doc/resources/signals.svg create mode 100644 install.sh create mode 100644 pyspecs/__init__.py create mode 100644 pyspecs/draw_graph_from_json.py create mode 100644 pyspecs/pyspecs_example.ipynb create mode 100644 pyspecs/specs.py create mode 100644 pyspecs/specsparse.py create mode 100644 src/devices/alldevices.h create mode 100644 src/devices/bitstream_source.cpp create mode 100644 src/devices/bitstream_source.h create mode 100644 src/devices/clements.cpp create mode 100644 src/devices/clements.h create mode 100644 src/devices/crossing.cpp create mode 100644 src/devices/crossing.h create mode 100644 src/devices/crow.cpp create mode 100644 src/devices/crow.h create mode 100644 src/devices/cw_source.cpp create mode 100644 src/devices/cw_source.h create mode 100644 src/devices/detector.cpp create mode 100644 src/devices/detector.h create mode 100644 src/devices/directional_coupler.cpp create mode 100644 src/devices/directional_coupler.h create mode 100644 src/devices/electrical_value_list_source.cpp create mode 100644 src/devices/electrical_value_list_source.h create mode 100644 src/devices/generic_2x2_coupler.h create mode 100644 src/devices/generic_transmission_device.cpp create mode 100644 src/devices/generic_transmission_device.h create mode 100644 src/devices/generic_waveguide.h create mode 100644 src/devices/merger.cpp create mode 100644 src/devices/merger.h create mode 100644 src/devices/mesh_col.cpp create mode 100644 src/devices/mesh_col.h create mode 100644 src/devices/mzi.cpp create mode 100644 src/devices/mzi.h create mode 100644 src/devices/mzi_active.cpp create mode 100644 src/devices/mzi_active.h create mode 100644 src/devices/octane_cell.cpp create mode 100644 src/devices/octane_cell.h create mode 100644 src/devices/octane_matrix.cpp create mode 100644 src/devices/octane_matrix.h create mode 100644 src/devices/octane_segment.cpp create mode 100644 src/devices/octane_segment.h create mode 100644 src/devices/pcm_device.cpp create mode 100644 src/devices/pcm_device.h create mode 100644 src/devices/phaseshifter.cpp create mode 100644 src/devices/phaseshifter.h create mode 100644 src/devices/probe.cpp create mode 100644 src/devices/probe.h create mode 100644 src/devices/ring.cpp create mode 100644 src/devices/ring.h create mode 100644 src/devices/splitter.cpp create mode 100644 src/devices/splitter.h create mode 100644 src/devices/spx_module.h create mode 100644 src/devices/subcircuit_instance.h create mode 100644 src/devices/time_monitor.cpp create mode 100644 src/devices/time_monitor.h create mode 100644 src/devices/value_list_source.cpp create mode 100644 src/devices/value_list_source.h create mode 100644 src/devices/waveguide.cpp create mode 100644 src/devices/waveguide.h create mode 100644 src/main.cpp create mode 100644 src/optical_output_port.cpp create mode 100644 src/optical_output_port.h create mode 100644 src/optical_signal.cpp create mode 100644 src/optical_signal.h create mode 100644 src/parser/parse_analysis.cpp create mode 100644 src/parser/parse_analysis.h create mode 100644 src/parser/parse_directive.cpp create mode 100644 src/parser/parse_directive.h create mode 100644 src/parser/parse_element.cpp create mode 100644 src/parser/parse_element.h create mode 100644 src/parser/parse_tree.cpp create mode 100644 src/parser/parse_tree.h create mode 100644 src/parser/parser.l create mode 100644 src/parser/parser.y create mode 100644 src/specs.cpp create mode 100644 src/specs.h create mode 100644 src/tb/alltestbenches.cpp create mode 100644 src/tb/alltestbenches.h create mode 100644 src/tb/crow_tb.cpp create mode 100644 src/tb/crow_tb.h create mode 100644 src/tb/detector_tb.cpp create mode 100644 src/tb/detector_tb.h create mode 100644 src/tb/directional_coupler_tb.cpp create mode 100644 src/tb/directional_coupler_tb.h create mode 100644 src/tb/freqsweep_tb.cpp create mode 100644 src/tb/freqsweep_tb.h create mode 100644 src/tb/lambda_tb.cpp create mode 100644 src/tb/lambda_tb.h create mode 100644 src/tb/merger_tb.cpp create mode 100644 src/tb/merger_tb.h create mode 100644 src/tb/mesh_tb.cpp create mode 100644 src/tb/mesh_tb.h create mode 100644 src/tb/mzi_tb.cpp create mode 100644 src/tb/mzi_tb.h create mode 100644 src/tb/pcm_device_tb.cpp create mode 100644 src/tb/pcm_device_tb.h create mode 100644 src/tb/phase_shifter_tb.cpp create mode 100644 src/tb/phase_shifter_tb.h create mode 100644 src/tb/ring_tb.cpp create mode 100644 src/tb/ring_tb.h create mode 100644 src/tb/splitter_tb.cpp create mode 100644 src/tb/splitter_tb.h create mode 100644 src/tb/wg_tb.cpp create mode 100644 src/tb/wg_tb.h create mode 100644 src/utils/general_utils.cpp create mode 100644 src/utils/general_utils.h create mode 100644 src/utils/pqueue.h create mode 100644 src/utils/strutils.h create mode 100644 src/utils/sysc_utils.cpp create mode 100644 src/utils/sysc_utils.h create mode 160000 thirdparty/args create mode 160000 thirdparty/systemc create mode 100644 todo.txt create mode 100644 utils/analyze_detector_trace.py create mode 100644 utils/draw_graph_from_json.py create mode 100644 utils/openwave.sh create mode 100644 utils/specs.kicad_sym diff --git a/.clang-format b/.clang-format new file mode 100644 index 0000000..b586a0e --- /dev/null +++ b/.clang-format @@ -0,0 +1,121 @@ +--- +Language: Cpp +# BasedOnStyle: WebKit +AccessModifierOffset: -4 +AlignAfterOpenBracket: Align +AlignConsecutiveAssignments: false +AlignConsecutiveDeclarations: false +AlignEscapedNewlines: Right +AlignOperands: false +AlignTrailingComments: false +AllowAllParametersOfDeclarationOnNextLine: true +AllowShortBlocksOnASingleLine: false +AllowShortCaseLabelsOnASingleLine: false +AllowShortFunctionsOnASingleLine: InlineOnly +AllowShortIfStatementsOnASingleLine: false +AllowShortLoopsOnASingleLine: false +AlwaysBreakAfterDefinitionReturnType: None +AlwaysBreakAfterReturnType: None +AlwaysBreakBeforeMultilineStrings: false +AlwaysBreakTemplateDeclarations: false +BinPackArguments: false +BinPackParameters: false +BraceWrapping: + AfterClass: false + AfterControlStatement: false + AfterEnum: false + AfterFunction: true + AfterNamespace: false + AfterObjCDeclaration: false + AfterStruct: false + AfterUnion: false + AfterExternBlock: false + BeforeCatch: false + BeforeElse: false + IndentBraces: false + SplitEmptyFunction: false + SplitEmptyRecord: true + SplitEmptyNamespace: true +BreakBeforeBinaryOperators: All +BreakBeforeBraces: Custom +BreakBeforeInheritanceComma: false +BreakInheritanceList: BeforeColon +BreakBeforeTernaryOperators: true +BreakConstructorInitializersBeforeComma: false +BreakConstructorInitializers: BeforeComma +BreakAfterJavaFieldAnnotations: false +BreakStringLiterals: true +ColumnLimit: 88 +CommentPragmas: '^ IWYU pragma:' +CompactNamespaces: false +ConstructorInitializerAllOnOneLineOrOnePerLine: false +ConstructorInitializerIndentWidth: 4 +ContinuationIndentWidth: 4 +Cpp11BracedListStyle: false +DerivePointerAlignment: false +DisableFormat: false +ExperimentalAutoDetectBinPacking: false +FixNamespaceComments: false +ForEachMacros: + - foreach + - Q_FOREACH + - BOOST_FOREACH +IncludeBlocks: Preserve +IncludeCategories: + - Regex: '^"(llvm|llvm-c|clang|clang-c)/' + Priority: 2 + - Regex: '^(<|"(gtest|gmock|isl|json)/)' + Priority: 3 + - Regex: '.*' + Priority: 1 +IncludeIsMainRegex: '(Test)?$' +IndentCaseLabels: false +IndentPPDirectives: None +IndentWidth: 4 +IndentWrappedFunctionNames: false +JavaScriptQuotes: Leave +JavaScriptWrapImports: true +KeepEmptyLinesAtTheStartOfBlocks: true +MacroBlockBegin: '' +MacroBlockEnd: '' +MaxEmptyLinesToKeep: 1 +NamespaceIndentation: Inner +ObjCBinPackProtocolList: Auto +ObjCBlockIndentWidth: 4 +ObjCSpaceAfterProperty: true +ObjCSpaceBeforeProtocolList: true +PenaltyBreakAssignment: 2 +PenaltyBreakBeforeFirstCallParameter: 19 +PenaltyBreakComment: 300 +PenaltyBreakFirstLessLess: 120 +PenaltyBreakString: 1000 +PenaltyBreakTemplateDeclaration: 10 +PenaltyExcessCharacter: 1000000 +PenaltyReturnTypeOnItsOwnLine: 60 +PointerAlignment: Right +ReflowComments: true +SortIncludes: true +SortUsingDeclarations: true +SpaceAfterCStyleCast: false +SpaceAfterTemplateKeyword: true +SpaceBeforeAssignmentOperators: true +SpaceBeforeCpp11BracedList: true +SpaceBeforeCtorInitializerColon: true +SpaceBeforeInheritanceColon: true +SpaceBeforeParens: ControlStatements +SpaceBeforeRangeBasedForLoopColon: true +SpaceInEmptyParentheses: false +SpacesBeforeTrailingComments: 1 +SpacesInAngles: false +SpacesInContainerLiterals: true +SpacesInCStyleCastParentheses: false +SpacesInParentheses: false +SpacesInSquareBrackets: false +Standard: Cpp11 +StatementMacros: + - Q_UNUSED + - QT_REQUIRE_VERSION +TabWidth: 4 +UseTab: Never +... + diff --git a/.config.gitlab-ci.mk b/.config.gitlab-ci.mk new file mode 100644 index 0000000..d59f3d0 --- /dev/null +++ b/.config.gitlab-ci.mk @@ -0,0 +1,28 @@ +#### PROJECT SETTINGS #### +# The name of the executable to be created +BIN_NAME = specs +LIB_NAME = libspecs.so + +# Compiler used +CXX = g++ +CCACHE = + +BUILD_TB ?= 1 + +# Path to the source directory, relative to the makefile +SRC_PATH = src + +# General compiler flags +CXXFLAGS = -std=c++17 -Wall -Wextra +CXXFLAGS += -O2 -march=native + +# Add additional include paths (SRC_PATH and subdirectories are automatically added) +INCLUDES += -isystem thirdparty/args + +# General linker settings +LDFLAGS += -lsystemc -lm + +# Destination directory +BUILD_PATH = build + +#### END PROJECT SETTINGS #### diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..fa7b2f8 --- /dev/null +++ b/.gitignore @@ -0,0 +1,32 @@ +*~ +*.vcd +*.o +*.d +**/__pycache__/ +build/ +sim +src.old/ +compile_commands.json +README.html +resources/out/ +doc/html +doc/*.tar.xz +bitstream.txt +Pout.png +Pout.obj +detector_trace.txt +.cache +.vscode/** +**/.vscode/** +**/.clangd/** +detector_traces/** +.vimrc.local +config.local.mk +specs +libspecs.so +gmon.out +**/main +**/a.out +*.exe +*.cir +tmp/ diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml new file mode 100644 index 0000000..f41da7d --- /dev/null +++ b/.gitlab-ci.yml @@ -0,0 +1,79 @@ +# Currently using alpine as base +#image: alpine:latest +image: alpine:latest +# TODO: Migrate to another base including all the dependencies +# in order to avoid fetching and installing everything each time + +stages: + - build + - test + - deploy + +variables: + # Recursive submodule update + GIT_SUBMODULE_STRATEGY: recursive + +before_script: + # Add the testing repo for SystemC + - echo http://dl-cdn.alpinelinux.org/alpine/edge/testing >> /etc/apk/repositories + # Install all dependencies + - apk update + - apk add --no-cache + bash findutils + build-base bison flex + doxygen graphviz + systemc-dev + - cp .config.gitlab-ci.mk config.local.mk + +build: + stage: build + script: + - make -j$(nproc) bin V=1 + - make -j$(nproc) lib V=1 + artifacts: + paths: + - "./specs" + - "./libspecs.so" + +test: + stage: test + script: + # Only running a few tests manually for now + - ./specs -t wg + #- ./specs -t dc + #- ./specs -t splitter + #- ./specs -t merger + #- ./specs -t detector + #- ./specs -t phaseshifter + # TODO: add other tests (both from -t and the circuit test files) + dependencies: + - build + artifacts: + paths: + - "traces/*.vcd" + +doc: + stage: build + script: + - make doc + artifacts: + paths: + - doc/pcm-doc.tar.xz + - doc/html/ + only: + - master + + +pages: + stage: deploy + script: + - mkdir public + - cp -R doc/html/* public + dependencies: + - doc + artifacts: + paths: + - public + only: + - master + diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..a469512 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,6 @@ +[submodule "deps/args"] + path = thirdparty/args + url = https://github.com/Taywee/args +[submodule "thirdparty/systemc"] + path = thirdparty/systemc + url = https://github.com/accellera-official/systemc diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..5357f69 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,166 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. + diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..1975007 --- /dev/null +++ b/Makefile @@ -0,0 +1,299 @@ +# Use bash as the shell +SHELL = /bin/bash + +LOCAL_CONFIG_EXISTS = $(shell (test -e config.local.mk && echo 1) || echo 0) +ifeq "${LOCAL_CONFIG_EXISTS}" "1" + CONFIG_MK_FILE = config.local.mk + #CONFIG_MK_FILE = config.windows.mk +else + CONFIG_MK_FILE = config.mk +endif + +include $(CONFIG_MK_FILE) + +BUILD_TB ?= 0 +BUILD_PATH_LIB ?= $(BUILD_PATH)-lib + +CXX_LD ?= $(CXX) + +CXXFLAGS += -MMD -MP +CXXFLAGS_LIB = $(CXXFLAGS) -fpic +LDFLAGS_LIB = $(LDFLAGS) -shared -Wl,-soname,libspecs.so +BISONFLAGS += --warnings -Wall #-Wcex + +# Find all source files in the source directory +SOURCES_BIN = $(shell find $(SRC_PATH) -name '*.cpp' -not -ipath '*/tb/*') +SOURCES_LIB = $(shell find $(SRC_PATH) -name '*.cpp' -not -ipath '*/tb/*' -not -name 'main.cpp' -not -ipath '*/parser/*.cpp') +SOURCES_TB = $(shell find $(SRC_PATH) -name '*.cpp' -ipath '*/tb/*') +SOURCES_TB_MAIN = $(shell find $(SRC_PATH) -name 'alltestbenches.cpp' -ipath '*/tb/*') +SOURCES_ALLFILES = $(shell find $(SRC_PATH) -name '*.cpp' -or -name '*.h') + +# Add the whole source directory tree to INCLUDES +INCLUDES += $(addprefix -I,$(shell find $(SRC_PATH) -type d)) + +# Find all bison/flex source files +# - Note: bison/flex sources must have a matching filename +FLEX_SOURCES = $(shell find $(SRC_PATH) -name '*.l') +BISON_SOURCES = $(shell find $(SRC_PATH) -name '*.y') + +# Set the object filenames from the cpp sources +OBJECTS_BIN = $(SOURCES_BIN:$(SRC_PATH)/%.cpp=$(BUILD_PATH)/%.o) +ifeq ($(BUILD_TB), 1) + OBJECTS_BIN += $(SOURCES_TB:$(SRC_PATH)/%.cpp=$(BUILD_PATH)/%.o) + CXXFLAGS += -DBUILD_TB +else + OBJECTS_BIN += $(SOURCES_TB_MAIN:$(SRC_PATH)/%.cpp=$(BUILD_PATH)/%.o) +endif + +# Add the objects filenames from the bison/flex sources +OBJECTS_PARSE = $(FLEX_SOURCES:$(SRC_PATH)/%.l=$(BUILD_PATH)/%.yy.o) +OBJECTS_PARSE += $(BISON_SOURCES:$(SRC_PATH)/%.y=$(BUILD_PATH)/%.tab.o) + +# Same without main (without testbenches) +OBJECTS_LIB = $(SOURCES_LIB:$(SRC_PATH)/%.cpp=$(BUILD_PATH_LIB)/%.o) + +# Set the dependency files that will be used to add header dependencies +DEPS = $(OBJECTS_BIN:.o=.d) +DEPS_PARSE = $(OBJECTS_PARSE:.o=.d) +DEPS_LIB = $(OBJECTS_LIB:.o=.d) + +# Set other dependencies that should trigger rebuilding .o files +ADDITIONAL_DEPS = Makefile $(CONFIG_MK_FILE) + +# Find the latest trace according to modification time +LATEST_TRACE_NAME = $(shell ls -1rt --group-directories-first traces | tail -1) + +# Be verbose +V ?= 0 + +# Set/Unset the Q flag according to the V flag +ifeq ($(V),1) + Q = + QQ = @ +else + Q = @ + QQ = @ +endif + +# Clear known suffixes rules +.SUFFIXES: + +# Define phony targets +.PHONY: todos format waves newwaves print-% help cleandoc cleanoldtraces \ + cleantraces cleanall clean compiledb view-doc upload-doc doc readme \ + all bin lib + +# Instruct make not to remove intermediate files from bison/flex compilation +.SECONDARY: $(FLEX_SOURCES:$(SRC_PATH)/%.l=$(BUILD_PATH)/%.yy.h) +.SECONDARY: $(FLEX_SOURCES:$(SRC_PATH)/%.l=$(BUILD_PATH)/%.yy.cpp) +.SECONDARY: $(FLEX_SOURCES:$(SRC_PATH)/%.l=$(BUILD_PATH)/%.tab.h) +.SECONDARY: $(BISON_SOURCES:$(SRC_PATH)/%.y=$(BUILD_PATH)/%.tab.cpp) + +# Default rule +all: bin + +# Build executable +bin: $(BIN_NAME) + +# Build shared library +lib: $(LIB_NAME) + +# Link all objects together into executable +$(BIN_NAME): $(OBJECTS_BIN) $(OBJECTS_PARSE) + @echo "Linking binary" + $(Q)$(CCACHE) $(CXX_LD) $(OBJECTS_BIN) $(OBJECTS_PARSE) $(LDFLAGS) -o $@ + @echo "Done" + +# Link all objects together into library +$(LIB_NAME): $(OBJECTS_LIB) + @echo "Linking library" + $(Q)$(CCACHE) $(CXX_LD) $(OBJECTS_LIB) $(LDFLAGS_LIB) -o $@ + @echo "Done" + +# Objects depend on their directories +$(OBJECTS_PARSE): $(ADDITIONAL_DEPS) | $(dir $(OBJECTS_PARSE)) + +# Objects depend on their directories +$(OBJECTS_BIN): $(ADDITIONAL_DEPS) | $(dir $(OBJECTS_BIN)) $(OBJECTS_PARSE) + +# Objects depend on their directories +$(OBJECTS_LIB): $(ADDITIONAL_DEPS) | $(dir $(OBJECTS_LIB)) + +# Rule to create the $(BUILD_PATH) directory +$(BUILD_PATH)/: + $(Q)mkdir -p $@ + +# Rule to create a subdirectory in $(BUILD_PATH) +$(BUILD_PATH)/%/: + $(Q)mkdir -p $@ + +# Rule to create the $(BUILD_PATH_LIB) directory +$(BUILD_PATH_LIB)/: + $(Q)mkdir -p $@ + +# Rule to create a subdirectory in $(BUILD_PATH_LIB) +$(BUILD_PATH_LIB)/%/: + $(Q)mkdir -p $@ + +# Default .cpp → .o compilation rule +$(BUILD_PATH)/%.o: $(SRC_PATH)/%.cpp + @echo "Compiling $<" + $(Q)$(CCACHE) $(CXX) $(CXXFLAGS) $(INCLUDES) -c $< -o $@ + +# Default .cpp → .o compilation rule for library +$(BUILD_PATH_LIB)/%.o: $(SRC_PATH)/%.cpp + @echo "Compiling $<" + $(Q)$(CCACHE) $(CXX) $(CXXFLAGS_LIB) $(INCLUDES) -MMD -MP -c $< -o $@ + +# Special .cpp compilation rule for flex generated sources +%.yy.o: %.yy.cpp %.tab.h + @echo "Compiling $<" + $(Q)$(CCACHE) $(CXX) $(CXXFLAGS) $(INCLUDES) -iquote"$(dir $@)" -c $< -o $@ + +# Special .cpp compilation rule for bison generated sources +%.tab.o: %.tab.cpp %.yy.h + @echo "Compiling $<" + $(Q)$(CCACHE) $(CXX) $(CXXFLAGS) $(INCLUDES) -iquote"$(dir $@)" -c $< -o $@ + +# Default .l → .yy.cpp compilation rule +$(BUILD_PATH)/%.yy.cpp: $(SRC_PATH)/%.l | $(dir $($@)) + @echo "Lexing $<" + $(Q)flex --header-file="$(@:.cpp=.h)" -o $@ $< + +# Default .y → .tab.{h,cpp} compilation rule +$(BUILD_PATH)/%.tab.cpp: $(SRC_PATH)/%.y $(BUILD_PATH)/%.yy.cpp | $(dir $($@)) + @echo "Bisoning $<" + $(Q)bison $(BISONFLAGS) --defines="$(@:.cpp=.h)" -o $@ -d $< + +# Dependency rule for .tab.h (bison output, needed to compile flex output) +%.tab.h: | %.tab.cpp + @: + +# Dependency rule for .yy.h (bison output, needed to compile flex output) +%.yy.h: | %.yy.cpp + @: + +#$(ADDITIONAL_DEPS): +#@: + +# Add dependency files, if they exist +-include $(DEPS) +-include $(DEPS_LIB) +-include $(DEPS_PARSE) + +# Generation of documentation using Doxygen +doc: + @echo "Generating documentation" + @mkdir -p doc/html + @cp -r doc/resources/ doc/html/ + $(Q)doxygen doc/Doxyfile + #$(Q)tar -c -f doc/pcm-doc.tar.xz -C doc/html . + +# Regenerate compile_commands.json for YouCompleteMe +compiledb: compile_commands.json + +# Regenerate compile_commands.json for YouCompleteMe +compile_commands.json: clean + @echo "Generating compile_commands.json" + $(Q)compiledb --verbose make -j8 + $(Q)sed -i '/"-MMD"\|"-MP"/d' $@ + +# Clean build artifacts +clean: + @echo "Removing build artifacts" + $(QQ)#[ ! -d 'build' ] || rm -rf build/ + $(QQ)#[ ! -d 'build-lib' ] || rm -rf build-lib/ + $(Q)[ ! -d "$(BUILD_PATH)" ] || rm -rf "$(BUILD_PATH)" + $(Q)[ ! -d "$(BUILD_PATH_LIB)" ] || rm -rf "$(BUILD_PATH_LIB)" + +# Remove any product of the build (build, trace, doc, bin) +cleanall: clean cleantraces cleandoc + @echo "Removing binary" + $(Q)rm -f Pout.obj Pout.png detector_trace.txt + $(Q)rm -f sim specs libspecs.so + +# Clean all traces +cleantraces: + @echo "Removing all traces" + $(Q)find traces/ -maxdepth 1 -type f -and -iname '*.vcd' -delete + +# Clean all traces but the newest +cleanoldtraces: + @echo "Removing all traces but newest" + $(Q)find traces/ -maxdepth 1 -iname '*.vcd' -and -type f -and ! -iname "$(LATEST_TRACE_NAME)" -delete + +# Clean documentation output +cleandoc: + @echo "Removing generated documentation" + $(Q)rm -rf doc/html doc/pcm-doc.tar.xz + +# Show the latest trace with a blank GTKWave config +newwaves: + @echo "Opening latest trace file" + @mkdir -p traces/configs + @bash utils/openwave.sh "traces/$(LATEST_TRACE_NAME)" + +# Show the latest trace with a menu to select which GTKWave config to use +waves: + @echo "Opening latest trace file" + @mkdir -p traces/configs + @bash utils/openwave.sh "traces/$(LATEST_TRACE_NAME)" traces/configs + +test: + @echo "Running all tests" + $(Q)./specs -t waveguide + $(Q)./specs -t splitter + $(Q)./specs -t merger + $(Q)./specs -t detector + $(Q)./specs -t directional_coupler + $(Q)./specs -t phaseshifter + $(Q)./specs -t mzi + $(Q)./specs -t pcm + $(Q)#./specs -t ring + $(Q)#./specs -t ac_add_drop + $(Q)#./specs -t ac_crow + $(Q)#./specs -t mesh + +rc: all + ./${BIN_NAME} -fcircuits/rc_mohab.cir + + +# TODO: add a gate so we don't accidentally "mess up" the working +# directory by shadowing real changes. Maybe do a commit or something +# like this ? or check the git status whether there are changes ? +# Automatic formatting should be automatically run on write, but if +# modifying a file with a different format and re-formatting, changes +# seen by git could be far from obvious to re-read later +# Run clang-format on the source (in place) +format: + @echo "Formatting source" + @clang-format -i $(SOURCES_ALLFILES) + +# Print all TODOs found in the source and other files +todos: + @echo "TODO (from code):" + @find $(SRC_PATH) -type f | xargs awk '/TODO:/ {split($$0, arr, "TODO:"); content = arr[2]; print "- " content, "("FILENAME":"FNR")"}' || true + @#find module_definitions/ -type f | xargs awk '/TODO:/ {split($$0, arr, "TODO:"); content = arr[2]; print "- " content, "("FILENAME":"FNR")"}' || true + @find utils/ -type f | xargs awk '/TODO:/ {split($$0, arr, "TODO:"); content = arr[2]; print "- " content, "("FILENAME":"FNR")"}' || true + @cat todo.txt || true + +# Print a given variable +print-%: + $(Q)echo $* = $($*) + +# FIXME: cannot have ":" in rule descriptions +# Show this help prompt +help: + @ echo + @ echo ' Usage:' + @ echo '' + @ echo ' make [flags...]' + @ echo '' + @ echo ' Targets:' + @ echo '' + @ awk '/^#/{ comment = substr($$0,3) } comment && /^[a-zA-Z][a-zA-Z0-9_-]+ ?:/{ print " ", $$1, comment }' $(MAKEFILE_LIST) | column -t -s ':' | sort + @ echo '' + @ echo ' Flags:' + @ echo '' + @awk '/^#/{ comment = substr($$0,3) } comment && /^[a-zA-Z][a-zA-Z0-9_-]*/ && /\??=/ && /[01]$$/{ print " " $$1 " (default = " $$3 ")",":",comment }' $(MAKEFILE_LIST) | column -t -s ':' | sort + @ echo '' diff --git a/QUICKSTART.md b/QUICKSTART.md new file mode 100644 index 0000000..70509ec --- /dev/null +++ b/QUICKSTART.md @@ -0,0 +1,102 @@ +# Quickstart guide {#quickstart} + +[TOC] + +# Dependencies + +## Building toolchain + +* `git` +* `bash` +* `find` +* `make` +* a c++ compiler that supports c++14 or c++17 (`g++` or `clang++`) +* GNU `flex` (`lex` is untested) +* GNU `bison` (`yacc` is untested) + +Optional: + +* `python3` for generating the sources using the module definitions +* ... + +## External build dependencies + +* `systemc` (v2.3.3) + +## Documentation generation + +* `doxygen` +* `dot` (via `graphviz` for example) + +## Traces visualization + +* GTKWave +* `python3` +* `python3-matplotlib` +* ... + +# Building + +* First, make sure to install all the dependencies on your system, either locally or globally. +* Then, fetch the code: + + % git clone git@gitlab.inl90.ec-lyon.fr:czrounba/systemc-pcm-matrix-multiplication-simulator.git + % git submodule update --init --recursive + +* Copy `config.mk` to `config.local.mk` and update the compiler/library information there +* If you installed systemc in a non-default path, you might need to update the +`INCLUDES` and `LD_FLAGS` make variables in `config.mk`. +* Finally, build `specs` + % make -j$(nproc) +* Run a test circuits + % ./sim -t {waveguide,splitter,pcm,...} + +# Running + +Simulating a circuit from a netlist is straightforward: + + % ./sim -f .cir + +Look at the [cheatsheet](doc/resources/cheatsheet.pdf) for more information on the syntax to use. +[](TODO: add a page for info on syntax of circuit files) + +After running, you can find results in the VCD tracefile (the file name can be specified in the circuit file with option `-o`). + +# Generating documentation (OUTDATED) + +First make sure `doxygen` and `graphviz` are installed, then: + +* To generate the doc, run: + + % make doc + +* To open it in your default browser, run: + + % make view-doc + +The generated documentation is available as HTML under `doc/html/` and compressed +into a `tar.xz` archive under `doc/`. Other ouput formats are supported by `doxygen`. + +# Troubleshooting + + diff --git a/README.md b/README.md new file mode 100644 index 0000000..9a2644d --- /dev/null +++ b/README.md @@ -0,0 +1,5 @@ +# Scalable Photonic Event-driven Circuit Simulator (SPECS) + +For the moment, refer to our user guide to see how to download and use SPECS + +https://demo.zrounba.fr/specs/doc/index.html diff --git a/circuits/add_drop.cir b/circuits/add_drop.cir new file mode 100644 index 0000000..bc0ee01 --- /dev/null +++ b/circuits/add_drop.cir @@ -0,0 +1,41 @@ +* An Add-drop filter + +* Circuit parameters +.assign lambda0 = 1.55e-6 +.assign neff = 2.3 +.assign length_2pi = {lambda0}/{neff} +.assign k = 0.85 + +.subckt test p1 p2 length=100e-6 att=1 neff=2.2 ng=4.3 +wg1 p1 0 length={length} att={att} neff={neff} ng={ng} +wg2 0 p2 length={length} att={att} neff={neff} ng={ng} +.ends + +* Circuit definition +cwsrc1 in_ wl=1.55e-6 power=1 +x1 in_ in test length=1e-3 neff=1 ng=4 att=0 +;wg_access in_ in length={length_2pi} neff={neff} ng=4 + +coupler1 in ring_bl out ring_br k={k} +coupler2 add ring_tr drop ring_tl k={k} + +wg_ring_l ring_tl ring_bl att=2 length=101*{length_2pi} neff={neff} ng=4.3 +wg_ring_r ring_br ring_tr att=2 length=101*{length_2pi} neff={neff} ng=4.3 + +* Simulator options +.options abstol=1e-12 reltol=1e-6 timescale=-15 + +* DC analysis (CW sweep) parameters +.assign lambda_min = {lambda0} - 15e-9 +.assign lambda_max = 2*{lambda0}-{lambda_min} +.assign dlambda = 1*1e-9 + +* Analysis +;.dc WL(cwsrc1) {lambda_min} {lambda_max} {dlambda} P(cwsrc1) 0 1 0.01 +.dc /cwsrc1/WL {lambda_min} {lambda_max} {dlambda} +;.dc P(cwsrc1) 0 1 0.1 +;.dc FREQ(cwsrc1) 192e12 194e12 1e9 +;.dc WL(cwsrc1) +;.op +;.tran +;.dc wl(osrc1)=[{lambda_min},{lambda_max},{npoints}] diff --git a/circuits/add_drop_pyspecs.cir b/circuits/add_drop_pyspecs.cir new file mode 100644 index 0000000..cc724d4 --- /dev/null +++ b/circuits/add_drop_pyspecs.cir @@ -0,0 +1,28 @@ +* An Add-drop filter + +* Circuit parameters +.assign lambda0 = 1.55e-6 + +* Circuit definition +;cwsrc1 in wl=1.55e-6 power=1 +vlsrc1 in values=[[0.5e-9,1,{lambda0}],[2e-9,0,{lambda0}]] + +coupler1 in 1 out 2 k=0.15 +coupler2 add 3 drop 4 k=0.15 + +wg_ring_l 4 1 length=300e-6 neff=3.999 +wg_ring_r 2 3 length=300e-6 neff=3.999 + +probe1 out +probe2 drop +probe3 in + +* Simulator options +.options abstol=1e-6 reltol=1e-8 timescale=-12 traceall=1 + +* Analysis parameter +.assign dlambda = 1e-12 + +* Analysis +;.dc /cwsrc1/WL 1549.9e-9 1550.1e-9 {dlambda} +.tran 3e-9 diff --git a/circuits/add_drop_sub.cir b/circuits/add_drop_sub.cir new file mode 100644 index 0000000..1d96aed --- /dev/null +++ b/circuits/add_drop_sub.cir @@ -0,0 +1,15 @@ +* An Add-drop filter subcircuit + +.subckt add_drop_filter in drop out add radius_ring=50e-6 k1=0.85 k2=0.85 att_wg=2 neff_wg=2.2 ng_wg=4.3 + +* Circuit parameters +.assign length_wg = {pi}*{radius_ring} + +* Circuit definition +coupler1 in ring_bl out ring_br k={k1} +coupler2 add ring_tr drop ring_tl k={k2} + +wg_ring_l ring_tl ring_bl att={att_wg} length={length_wg} neff={neff_wg} ng={ng_wg} +wg_ring_r ring_br ring_tr att={att_wg} length={length_wg} neff={neff_wg} ng={ng_wg} + +.ends diff --git a/circuits/common_definitions.def b/circuits/common_definitions.def new file mode 100644 index 0000000..9c25105 --- /dev/null +++ b/circuits/common_definitions.def @@ -0,0 +1,5 @@ +.assign lambda0 = 1.55e-6 ; m +.assign neff = 2.3 +.assign ng = 4.3 +.assign att_wg = 2 ; db/cm +.assign length_2pi = {lambda0}/{neff} diff --git a/circuits/double_ring.cir b/circuits/double_ring.cir new file mode 100644 index 0000000..0e4addb --- /dev/null +++ b/circuits/double_ring.cir @@ -0,0 +1,57 @@ +* Show bitstream source + +* Initialize the sources +one 0 +clk 1 100p + +*bsrc 0 1 2 {0, 0, 0} +bsrc 0 1 2 {0, 252, 15, 0} 1550.0e-9 +*bsrc 0 1 2 {0, 252, 15, 0} 1545.0e-9 + +* split +dc 2 3 4 5 +dc 6 7 8 9 +dc 12 13 10 11 +dc 16 17 14 15 + +wg 10 3 350.85477427u +*wg 5 18 350.85477427u +wg 5 12 350.85477427u + +* resonance at 1545 +*wg 14 7 351.08113608611u +*wg 9 16 351.08113608611u +* resonance at 1550 +wg 14 7 350.85477427u +wg 9 16 350.85477427u + +wg 4 6 701.12011675u +wg 15 13 701.12011675u + + +* feed into detector +* Input +pdet 2 35 24 + +* Inside ring1 +pdet 12 36 23 + +* Through 1 port +*pdet 4 37 25 + +* Through 2 port +pdet 8 38 26 + +* Drop port +pdet 11 39 27 + +* Inside ring2 +pdet 13 40 28 + +*tracefile "traces/double_ring" +*tracenet 20 "SIG_IN" +*tracenet 2 "SIG_IN_1" +*tracenet 4 "SIG_ADD_1" +*tracenet 11 "SIG_DROP_1" +*tracenet 8 "SIG_ADD_2" +*tracenet 15 "SIG_DROP_2" diff --git a/circuits/paul_3ring_puf.cir b/circuits/paul_3ring_puf.cir new file mode 100644 index 0000000..0854975 --- /dev/null +++ b/circuits/paul_3ring_puf.cir @@ -0,0 +1,58 @@ +* Paul 3 ring PUF + +.assign wl0=1.55e-6 +.assign neff=2.44 ng=4.3 att=3 +.assign R=10e-6 dR=10e-9 k=0.22360679774997896 +.assign L_r2r=3e-6 L_access=0e-6 +.assign R1={R} R2=({R}+{dR}) R3={R}+(2*{dR}) +.assign tau=1e-12 +.assign filename="inputstream.csv" +.assign filename="inputstream_25wl.csv" +.assign filename="paul_puf_bitstream_16bit_25wl.csv" +.assign filename="paul_puf_bitstream_158b_3wl.csv" +;.assign filename="paul_puf_bitstream_temp.csv" + +.include circuits/add_drop_sub.cir + +;CWSRC1 in wl={wl0} power=1 +VLSRC1 in values={filename} +;VLSRC_bot in_top values={filename} +;VLSRC_bot in_bot values={filename} +;VLSRC_top in_top values=[[0,0,{wl0}],[{tau},1,],[2*{tau},0,],[3*{tau},1,],[4*{tau},0,]] +;VLSRC_bot in_bot values=[[0,0,{wl0}],[{tau},1,],[2*{tau},0,],[3*{tau},1,],[4*{tau},0,]] + +SPLITTER1 in in_top in_bot +MERGER1 drop_top_1 drop_bot_1 out_drop +MLPROBE1 in [1.55e-6, 1.5599999999999999e-06, 1.57e-6] +;PDETin in _ 1e-15 +PDET1 out_drop _ 1e-15 +PROBE1 out_drop + +WG1 in_top in_top_1 L={L_access} att={att} neff={neff} ng={ng} +WG2 in_bot in_bot_1 L={L_access} att={att} neff={neff} ng={ng} + +WG3 through_bot_1 in_bot_2 L={L_r2r} att={att} neff={neff} ng={ng} +WG4 through_bot_2 in_bot_3 L={L_r2r} att={att} neff={neff} ng={ng} +WG5 through_top_2 in_top_3 L={L_r2r} att={att} neff={neff} ng={ng} +WG6 through_top_1 in_top_2 L={L_r2r} att={att} neff={neff} ng={ng} + +XAD_top_1 in_top_1 drop_top_1 through_top_1 add_top_1 add_drop_filter radius_ring={R1} k1={k} k2={k} neff_wg={neff} ng_wg={ng} att_wg={att} +XAD_top_2 in_top_2 drop_top_2 through_top_2 add_top_2 add_drop_filter radius_ring={R2} k1={k} k2={k} neff_wg={neff} ng_wg={ng} att_wg={att} +XAD_top_3 in_top_3 drop_top_3 through_top_3 nothing add_drop_filter radius_ring={R3} k1={k} k2={k} neff_wg={neff} ng_wg={ng} att_wg={att} + +XAD_bot_1 in_bot_1 drop_bot_1 through_bot_1 add_bot_1 add_drop_filter radius_ring={R1} k1={k} k2={k} neff_wg={neff} ng_wg={ng} att_wg={att} +XAD_bot_2 in_bot_2 drop_bot_2 through_bot_2 add_bot_2 add_drop_filter radius_ring={R2} k1={k} k2={k} neff_wg={neff} ng_wg={ng} att_wg={att} +XAD_bot_3 in_bot_3 drop_bot_3 through_bot_3 nothing add_drop_filter radius_ring={R3} k1={k} k2={k} neff_wg={neff} ng_wg={ng} att_wg={att} + +WG13 drop_bot_3 add_bot_2 L={L_r2r} att={att} neff={neff} ng={ng} +WG14 drop_bot_2 add_bot_1 L={L_r2r} att={att} neff={neff} ng={ng} +WG16 drop_top_3 add_top_2 L={L_r2r} att={att} neff={neff} ng={ng} +WG17 drop_top_2 add_top_1 L={L_r2r} att={att} neff={neff} ng={ng} + +WG18 through_top_3 out_top L={L_access} att={att} neff={neff} ng={ng} +WG15 through_bot_3 out_bot L={L_access} att={att} neff={neff} ng={ng} + +.options abstol=1e-5 reltol=1e-4 traceall=0 timescale=-14 resolution=1 +.tran 8e-9 +;.dc WL(CWSRC1) 1.54e-6 1.56e-6 1e-11 +;.tran 300e-12 diff --git a/circuits/paul_simple_ring.cir b/circuits/paul_simple_ring.cir new file mode 100644 index 0000000..a6e6b2f --- /dev/null +++ b/circuits/paul_simple_ring.cir @@ -0,0 +1,28 @@ +* Show bitstream source + +* Initialize the sources +one 0 +clk 1 100p + +*bsrc 0 1 13 {0, 0, 0} +bsrc 0 1 2 {0, 252, 15, 0, 0, 0} + +* split +dc 2 3 4 5 +dc 12 13 10 11 + +wg 10 3 350.85477427u +wg 5 12 350.85477427u + +* feed into detector +* Input +pdet 2 35 24 + +* Inside ring +pdet 12 36 23 + +* Through 1 port +pdet 4 37 25 + +* Drop port +pdet 11 39 27 diff --git a/circuits/subckt_test.cir b/circuits/subckt_test.cir new file mode 100644 index 0000000..fd3eec0 --- /dev/null +++ b/circuits/subckt_test.cir @@ -0,0 +1,10 @@ +.subckt AAA 1 2 len=3 +WG 1 2 length={len} neff=1 ng=1 att=0 +.ends + +cwsrc in pow=1 wl=1.55e-6 +X1 in out AAA +;probe out type=power + +.op + diff --git a/circuits/subckt_tests.cir b/circuits/subckt_tests.cir new file mode 100644 index 0000000..98f8e7b --- /dev/null +++ b/circuits/subckt_tests.cir @@ -0,0 +1,51 @@ +* An Add-drop filter + +** Circuit parameters +.assign lambda0 = 1.55e-6 +.assign neff = 2.3 +.assign length_2pi = {lambda0}/{neff} +.assign k = 0.85 + +** Include definition of add-drop subcircuit +.include circuits/add_drop_sub.cir + +.subckt test p1 p2 +.assign L=3e-3 + +.subckt test 1 p2 L={L} +wg1 1 p2 length={L} +.ends + +x1 p1 1 test +x2 1 2 test L=0 +wg1 2 p2 L=1e-3 + +.ends + +** Circuit definition +vlsrc1 in values=[[1e-9,1,{lambda0}], [2e-9,2,], [3e-9, -2,], [4e-9, 0,]] + +;cwsrc1 in wl=1.55e-6 power=1 + +x1 in drop out add add_drop_filter radius_ring={length_2pi}*109.5 +x2 out out_ test + +** Simulator options +.options abstol=1e-12 reltol=1e-6 timescale=-15 + +* DC analysis (CW sweep) parameters +.assign lambda_min = {lambda0} - 15e-9 +.assign lambda_max = 2*{lambda0}-{lambda_min} +.assign dlambda = 0.1*1e-9 + +** Analysis +;.dc WL(cwsrc1) {lambda_min} {lambda_max} {dlambda} P(cwsrc1) 0 1 0.01 +;.dc WL(cwsrc1) {lambda_min} {lambda_max} {dlambda} +;.dc P(cwsrc1) 0 1 0.1 +;.dc FREQ(cwsrc1) 192e12 194e12 1e9 +;.dc WL(cwsrc1) +;.op +.tran +;.dc wl(osrc1)=[{lambda_min},{lambda_max},{npoints}] + + diff --git a/circuits/test_include.cir b/circuits/test_include.cir new file mode 100644 index 0000000..d40e7de --- /dev/null +++ b/circuits/test_include.cir @@ -0,0 +1 @@ +include circuits/double_ring.cir diff --git a/circuits/triple_ring.cir b/circuits/triple_ring.cir new file mode 100644 index 0000000..2642f34 --- /dev/null +++ b/circuits/triple_ring.cir @@ -0,0 +1,76 @@ +* Show bitstream source + +* Initialize the sources +one 0 +clk 1 100p + +*bsrc 0 1 2 {0, 0, 0} +bsrc 0 1 2 {0, 252, 15, 0} 1550.0e-9 +*bsrc 0 1 2 {0, 252, 15, 0} 1545.0e-9 + +* split +dc 2 3 4 5 +dc 6 7 8 9 + +dc 12 13 10 11 +dc 16 17 14 15 + +dc 18 19 20 21 +dc 24 25 22 23 + +* ring 1 +wg 10 3 350.85477427u +wg 5 12 350.85477427u + +* ring 2 +* resonance at 1545 +*wg 14 7 351.08113608611u +*wg 9 16 351.08113608611u +* resonance at 1550 +wg 14 7 350.85477427u +wg 9 16 350.85477427u + +* ring 1 to ring 2 +wg 4 6 701.12011675u +wg 15 13 701.12011675u + +* ring 2 to ring 3 +wg 8 18 1701.12011675u +wg 23 17 1701.12011675u + +* ring 3 +wg 22 19 350.85477427u +wg 21 24 350.85477427u + +* feed into detector +* Input +pdet 2 100 200 + +* Inside ring1 +pdet 5 101 201 + +* Inside ring2 +pdet 9 102 202 + +* Inside ring3 +pdet 21 103 203 + +* Through 1 port +*pdet 4 104 204 + +* Through 2 port +pdet 8 105 205 + +* Through 3 port +pdet 20 106 206 + +* Drop port +pdet 11 107 207 + +*tracefile "traces/double_ring" +*tracenet 20 "SIG_IN" +*tracenet 2 "SIG_IN_1" +*tracenet 4 "SIG_ADD_1" +*tracenet 11 "SIG_DROP_1" +*tracenet 8 "SIG_ADD_2" +*tracenet 15 "SIG_DROP_2" diff --git a/config.mk b/config.mk new file mode 100644 index 0000000..c866e63 --- /dev/null +++ b/config.mk @@ -0,0 +1,35 @@ +#### PROJECT SETTINGS #### +# The name of the executable to be created +BIN_NAME = specs +LIB_NAME = libspecs.so + +SYSTEMC_PATH_ROOT = $(abspath ./thirdparty/systemc/sc_install) +SYSTEMC_PATH_LIBS = ${SYSTEMC_PATH_ROOT}/lib +SYSTEMC_PATH_INCLUDE = ${SYSTEMC_PATH_ROOT}/include + +# Compiler used +CXX = g++ +#CXX = clang++ +CCACHE = +#CCACHE = ccache + +# Path to the source directory, relative to the makefile +SRC_PATH = src + +# General compiler flags +CXXFLAGS = -std=c++17 -Wall -Wextra +CXXFLAGS += -O2 -march=native +#CXXFLAGS += -DYYDEBUG=1 +CXXFLAGS += -g + +# Add additional include paths (SRC_PATH and subdirectories are automatically added) +INCLUDES = -I${SYSTEMC_PATH_INCLUDE} -isystem thirdparty/args + +# General linker settings +LDFLAGS += -L${SYSTEMC_PATH_LIBS} -lsystemc -lm +LDFLAGS += -Wl,-rpath -Wl,${SYSTEMC_PATH_LIBS} + +# Destination directory +BUILD_PATH = build +BUILD_TB ?= 1 +#### END PROJECT SETTINGS #### diff --git a/doc/Doxyfile b/doc/Doxyfile new file mode 100644 index 0000000..c135f5e --- /dev/null +++ b/doc/Doxyfile @@ -0,0 +1,2543 @@ +# Doxyfile 1.8.16 + +# 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 = "SPECS" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = doc + +# 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 = + +# 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 = YES + +# 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 + +# 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 = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# 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, +# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser +# tries to guess whether the code is fixed or free formatted code, this is the +# default for Fortran type files), VHDL, tcl. For instance to make doxygen treat +# .inc files as Fortran files (default is PHP), and .f files as C (default is +# Fortran), use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See https://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 5. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 5 + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = YES + +# 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 = YES + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = YES + +# 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 = YES + +# 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 = YES + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO, these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES, upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# (including Cygwin) ands Mac users are advised to set this option to NO. +# 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 = YES + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as 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. +# 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 = src/ \ + doc/mainpage.md \ + README.md \ + QUICKSTART.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. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, +# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, +# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, *.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 \ + *.ice \ + *.y \ + *.l + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = doc/mainpage.md + +#--------------------------------------------------------------------------- +# 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 = YES + +# 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 + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = doc/custom.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 = 198 + +# 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 = 139 + +# 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 = 194 + +# 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 = YES + +# 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 master .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: 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 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 + +# 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 + +# 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/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://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/ + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /