diff --git a/CMakeLists.txt b/CMakeLists.txt
index df8a4d769477f175ceaedf9369418b24851f07ac..6918ae0daca738de58ac149df974adcd1ad7cac3 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -6,6 +6,8 @@ set (CMAKE_CXX_STANDARD 20)
option(PROFILE_ENABLED "instrument for gprof" OFF)
+find_package(Doxygen)
+
set(SRC_FILES
componant/componant.cpp
componant/cap.cpp
@@ -136,3 +138,27 @@ target_link_libraries(${PROJECT_NAME}_export ${LIBS_TEST})
target_include_directories(${PROJECT_NAME}_export PUBLIC eisgenerator)
set_target_properties(${PROJECT_NAME}_export PROPERTIES COMPILE_FLAGS ${COMMON_COMPILE_FLAGS} LINK_FLAGS ${COMMON_LINK_FLAGS})
install(TARGETS ${PROJECT_NAME}_export DESTINATION bin)
+
+if (DOXYGEN_FOUND)
+ set(DOXYGEN_IN ${CMAKE_CURRENT_SOURCE_DIR}/doc/libeisgenerator.doxygen.in)
+ set(DOXYGEN_OUT ${CMAKE_CURRENT_BINARY_DIR}/doc/libeisgenerator.doxygen)
+ configure_file(${DOXYGEN_IN} ${DOXYGEN_OUT} @ONLY)
+
+ set(MAINPAGE_IN ${CMAKE_CURRENT_SOURCE_DIR}/doc/mainpage.md.in)
+ set(MAINPAGE_OUT ${CMAKE_CURRENT_BINARY_DIR}/doc/mainpage.md)
+ configure_file(${MAINPAGE_IN} ${MAINPAGE_OUT} @ONLY)
+
+ set(MODELS_IN ${CMAKE_CURRENT_SOURCE_DIR}/doc/modelspage.md.in)
+ set(MODELS_OUT ${CMAKE_CURRENT_BINARY_DIR}/doc/modelspage.md)
+ configure_file(${MODELS_IN} ${MODELS_OUT} @ONLY)
+
+ message("Doxygen build started")
+
+ add_custom_target(doc
+ COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_OUT}
+ WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+ COMMENT "Generating API documentation with Doxygen"
+ VERBATIM )
+else (DOXYGEN_FOUND)
+ message("Doxygen needs to be installed to generate the doxygen documentation")
+endif (DOXYGEN_FOUND)
diff --git a/basicmath.cpp b/basicmath.cpp
index dda06ece53ba619863f11998215a12907a5b17e7..f5f1d73afdb7c6019593ce3c5ff90d6a1c0d0bc9 100644
--- a/basicmath.cpp
+++ b/basicmath.cpp
@@ -304,9 +304,9 @@ static eis::DataPoint linearExtrapoloatePoint(fvalue omega, const std::vector<ei
omegas.reserve(dist.size());
im.reserve(dist.size());
re.reserve(dist.size());
- for(size_t i = 0; i < 3; ++i)
+ for(size_t i = 0; i < std::min(static_cast<size_t>(6), data.size()); ++i)
{
- omegas.push_back(dist[i].second->omega);
+ omegas.push_back(log10(dist[i].second->omega));
im.push_back(dist[i].second->im.imag());
re.push_back(dist[i].second->im.real());
}
@@ -314,15 +314,17 @@ static eis::DataPoint linearExtrapoloatePoint(fvalue omega, const std::vector<ei
LinearRegessionCalculator realReg(omegas, re);
LinearRegessionCalculator imagReg(omegas, im);
- eis::Log(eis::Log::DEBUG)<<"Real regression:\n\toffset: "<<realReg.offset
+ eis::Log(eis::Log::DEBUG)<<"Real regression for "<<omega<<":\n\toffset: "<<realReg.offset
<<"\n\tsloap: "<<realReg.slope<<"\n\tstderror: "<<realReg.stdError;
- eis::Log(eis::Log::DEBUG)<<"Imag regression:\n\toffset: "<<imagReg.offset
+ eis::Log(eis::Log::DEBUG)<<"Imag regression for "<<omega<<":\n\toffset: "<<imagReg.offset
<<"\n\tsloap: "<<imagReg.slope<<"\n\tstderror: "<<imagReg.stdError;
- if(realReg.stdError > 1 || imagReg.stdError > 1)
+ if(realReg.stdError > 3 || imagReg.stdError > 3)
throw std::invalid_argument("input data must be sufficantly linear");
- return eis::DataPoint({realReg.slope*omega+realReg.offset, imagReg.slope*omega+imagReg.offset}, omega);
+ std::complex<fvalue> expIm(realReg.slope*log10(omega)+realReg.offset, imagReg.slope*log10(omega)+imagReg.offset);
+
+ return eis::DataPoint(expIm, omega);
}
std::vector<eis::DataPoint> eis::fitToFrequencies(std::vector<fvalue> omegas, const std::vector<eis::DataPoint>& data, bool linearExtrapolation)
diff --git a/doc/CompiledExecution.odg b/doc/CompiledExecution.odg
new file mode 100644
index 0000000000000000000000000000000000000000..48d26b1bd4010d02ce795f348362cd04272f012d
Binary files /dev/null and b/doc/CompiledExecution.odg differ
diff --git a/doc/CompiledExecution.svg b/doc/CompiledExecution.svg
new file mode 100644
index 0000000000000000000000000000000000000000..5ec6990096d8c73544e1546e7f523e9fbe4c56e5
--- /dev/null
+++ b/doc/CompiledExecution.svg
@@ -0,0 +1,688 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+ version="1.2"
+ width="314.64221mm"
+ height="22.51222mm"
+ viewBox="0 0 31464.221 2251.222"
+ preserveAspectRatio="xMidYMid"
+ fill-rule="evenodd"
+ stroke-width="28.222"
+ stroke-linejoin="round"
+ xml:space="preserve"
+ id="svg73"
+ sodipodi:docname="CompiledExecution.svg"
+ inkscape:version="1.3.2 (091e20ef0f, 2023-11-25, custom)"
+ xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+ xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+ xmlns="http://www.w3.org/2000/svg"
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns:ooo="http://xml.openoffice.org/svg/export"><sodipodi:namedview
+ id="namedview73"
+ pagecolor="#ffffff"
+ bordercolor="#000000"
+ borderopacity="0.25"
+ inkscape:showpageshadow="2"
+ inkscape:pageopacity="0.0"
+ inkscape:pagecheckerboard="0"
+ inkscape:deskcolor="#d1d1d1"
+ inkscape:document-units="mm"
+ inkscape:zoom="0.72886409"
+ inkscape:cx="620.82905"
+ inkscape:cy="41.159937"
+ inkscape:window-width="1882"
+ inkscape:window-height="1054"
+ inkscape:window-x="1920"
+ inkscape:window-y="0"
+ inkscape:window-maximized="1"
+ inkscape:current-layer="svg73" />
+ <defs
+ class="ClipPathGroup"
+ id="defs2">
+ <clipPath
+ id="presentation_clip_path"
+ clipPathUnits="userSpaceOnUse">
+ <rect
+ x="0"
+ y="0"
+ width="42000"
+ height="29700"
+ id="rect1" />
+ </clipPath>
+ <clipPath
+ id="presentation_clip_path_shrink"
+ clipPathUnits="userSpaceOnUse">
+ <rect
+ x="42"
+ y="29"
+ width="41916"
+ height="29641"
+ id="rect2" />
+ </clipPath>
+ </defs>
+ <defs
+ id="defs29">
+ <font
+ id="EmbeddedFont_1"
+ horiz-adv-x="2048"
+ horiz-origin-x="0"
+ horiz-origin-y="0"
+ vert-origin-x="512"
+ vert-origin-y="768"
+ vert-adv-y="1024">
+ <font-face
+ font-family="Nimbus Sans embedded"
+ units-per-em="2048"
+ font-weight="normal"
+ font-style="normal"
+ ascent="1482"
+ descent="556"
+ id="font-face2" />
+ <missing-glyph
+ horiz-adv-x="2048"
+ d="M 0,0 L 2047,0 2047,2047 0,2047 0,0 Z"
+ id="missing-glyph2" />
+ <glyph
+ unicode="”"
+ horiz-adv-x="557"
+ d="M 100,1452 L 100,1239 199,1239 C 201,1120 172,1065 100,1055 L 100,977 C 223,985 291,1081 291,1245 L 291,1452 100,1452 Z M 428,1452 L 428,1239 526,1239 C 528,1120 500,1065 428,1055 L 428,977 C 551,985 619,1081 619,1245 L 619,1452 428,1452 Z"
+ id="glyph2" />
+ <glyph
+ unicode="“"
+ horiz-adv-x="557"
+ d="M 289,977 L 289,1190 190,1190 C 188,1307 219,1364 289,1374 L 289,1452 C 168,1442 98,1346 98,1184 L 98,977 289,977 Z M 612,977 L 612,1190 514,1190 C 512,1307 543,1364 612,1374 L 612,1452 C 492,1442 422,1346 422,1184 L 422,977 612,977 Z"
+ id="glyph3" />
+ <glyph
+ unicode="z"
+ horiz-adv-x="901"
+ d="M 907,1073 L 107,1073 107,924 705,924 63,154 63,0 936,0 936,150 270,150 907,922 907,1073 Z"
+ id="glyph4" />
+ <glyph
+ unicode="x"
+ horiz-adv-x="954"
+ d="M 598,555 L 958,1073 766,1073 508,684 250,1073 55,1073 414,547 35,0 229,0 502,412 770,0 969,0 598,555 Z"
+ id="glyph5" />
+ <glyph
+ unicode="v"
+ horiz-adv-x="1006"
+ d="M 584,0 L 995,1073 803,1073 500,203 213,1073 20,1073 397,0 584,0 Z"
+ id="glyph6" />
+ <glyph
+ unicode="u"
+ horiz-adv-x="874"
+ d="M 987,0 L 987,1073 817,1073 817,465 C 817,246 702,102 524,102 389,102 303,184 303,313 L 303,1073 133,1073 133,246 C 133,68 266,-47 475,-47 633,-47 733,8 834,150 L 834,0 987,0 Z"
+ id="glyph7" />
+ <glyph
+ unicode="t"
+ horiz-adv-x="504"
+ d="M 520,1073 L 344,1073 344,1368 174,1368 174,1073 29,1073 29,934 174,934 174,123 C 174,12 248,-47 381,-47 426,-47 463,-43 520,-33 L 520,111 C 496,104 473,102 438,102 365,102 344,123 344,199 L 344,934 520,934 520,1073 Z"
+ id="glyph8" />
+ <glyph
+ unicode="s"
+ horiz-adv-x="901"
+ d="M 897,774 C 895,985 756,1104 508,1104 258,1104 96,975 96,776 96,608 182,528 436,467 L 596,428 C 715,399 762,356 762,281 762,178 662,111 512,111 420,111 342,137 299,182 272,213 260,244 250,319 L 70,319 C 78,72 217,-47 498,-47 768,-47 940,86 940,293 940,453 850,541 637,592 L 473,631 C 334,664 274,709 274,784 274,885 363,946 502,946 639,946 713,887 717,774 L 897,774 Z"
+ id="glyph9" />
+ <glyph
+ unicode="r"
+ horiz-adv-x="530"
+ d="M 141,1073 L 141,0 313,0 313,557 C 315,815 422,930 657,924 L 657,1098 C 629,1102 612,1104 592,1104 481,1104 397,1038 299,879 L 299,1073 141,1073 Z"
+ id="glyph10" />
+ <glyph
+ unicode="p"
+ horiz-adv-x="980"
+ d="M 111,-446 L 283,-446 283,113 C 373,2 473,-47 612,-47 891,-47 1071,176 1071,518 1071,879 895,1104 610,1104 465,1104 348,1038 268,911 L 268,1073 111,1073 111,-446 Z M 582,944 C 770,944 893,778 893,522 893,279 768,113 582,113 399,113 283,276 283,528 283,780 399,944 582,944 Z"
+ id="glyph11" />
+ <glyph
+ unicode="o"
+ horiz-adv-x="1006"
+ d="M 557,1104 C 254,1104 74,889 74,528 74,166 254,-47 559,-47 862,-47 1044,168 1044,520 1044,893 868,1104 557,1104 Z M 559,946 C 752,946 866,788 866,522 866,268 748,111 559,111 369,111 252,268 252,528 252,788 369,946 559,946 Z"
+ id="glyph12" />
+ <glyph
+ unicode="m"
+ horiz-adv-x="1430"
+ d="M 143,1073 L 143,0 315,0 315,674 C 315,829 428,954 567,954 694,954 766,877 766,739 L 766,0 938,0 938,674 C 938,829 1051,954 1190,954 1315,954 1389,875 1389,739 L 1389,0 1561,0 1561,805 C 1561,997 1450,1104 1249,1104 1106,1104 1020,1061 920,940 856,1055 770,1104 631,1104 487,1104 391,1051 301,922 L 301,1073 143,1073 Z"
+ id="glyph13" />
+ <glyph
+ unicode="l"
+ horiz-adv-x="187"
+ d="M 311,1493 L 139,1493 139,0 311,0 311,1493 Z"
+ id="glyph14" />
+ <glyph
+ unicode="j"
+ horiz-adv-x="372"
+ d="M 143,1073 L 143,-156 C 143,-262 111,-297 4,-297 -8,-297 -14,-297 -37,-295 L -37,-440 C -16,-444 -6,-446 20,-446 213,-446 313,-371 313,-223 L 313,1073 143,1073 Z M 313,1493 L 143,1493 143,1278 313,1278 313,1493 Z"
+ id="glyph15" />
+ <glyph
+ unicode="i"
+ horiz-adv-x="187"
+ d="M 307,1073 L 137,1073 137,0 307,0 307,1073 Z M 307,1493 L 135,1493 135,1278 307,1278 307,1493 Z"
+ id="glyph16" />
+ <glyph
+ unicode="f"
+ horiz-adv-x="504"
+ d="M 528,1073 L 350,1073 350,1241 C 350,1313 389,1350 469,1350 483,1350 489,1350 528,1348 L 528,1489 C 489,1497 467,1499 432,1499 274,1499 180,1409 180,1255 L 180,1073 37,1073 37,934 180,934 180,0 350,0 350,934 528,934 528,1073 Z"
+ id="glyph17" />
+ <glyph
+ unicode="e"
+ horiz-adv-x="980"
+ d="M 1051,479 C 1051,643 1038,741 1008,821 938,997 774,1104 573,1104 274,1104 82,877 82,522 82,168 266,-47 569,-47 815,-47 985,92 1028,326 L 856,326 C 809,184 713,111 575,111 467,111 375,160 317,250 276,311 262,373 260,479 L 1051,479 Z M 264,619 C 279,817 399,946 571,946 745,946 866,811 866,619 L 264,619 Z"
+ id="glyph18" />
+ <glyph
+ unicode="d"
+ horiz-adv-x="980"
+ d="M 1014,1493 L 844,1493 844,938 C 772,1047 657,1104 514,1104 236,1104 53,881 53,539 53,176 229,-47 520,-47 668,-47 770,8 862,141 L 862,0 1014,0 1014,1493 Z M 543,944 C 727,944 844,782 844,524 844,276 725,113 545,113 356,113 231,279 231,528 231,778 356,944 543,944 Z"
+ id="glyph19" />
+ <glyph
+ unicode="c"
+ horiz-adv-x="927"
+ d="M 965,713 C 956,817 934,885 893,944 819,1044 690,1104 541,1104 250,1104 63,875 63,518 63,172 248,-47 539,-47 795,-47 956,107 977,369 L 805,369 C 776,197 688,111 543,111 354,111 242,264 242,518 242,786 352,946 539,946 682,946 772,862 793,713 L 965,713 Z"
+ id="glyph20" />
+ <glyph
+ unicode="b"
+ horiz-adv-x="980"
+ d="M 111,1493 L 111,0 264,0 264,137 C 346,12 455,-47 604,-47 887,-47 1071,184 1071,541 1071,889 897,1104 612,1104 465,1104 360,1049 281,928 L 281,1493 111,1493 Z M 580,944 C 770,944 893,778 893,522 893,279 766,113 580,113 397,113 281,276 281,528 281,780 397,944 580,944 Z"
+ id="glyph21" />
+ <glyph
+ unicode="a"
+ horiz-adv-x="1033"
+ d="M 1096,100 C 1077,96 1069,96 1059,96 999,96 967,127 967,180 L 967,811 C 967,1001 827,1104 563,1104 406,1104 281,1059 207,979 158,924 137,862 133,756 L 305,756 C 319,887 397,946 557,946 713,946 797,889 797,786 L 797,741 C 795,668 758,641 619,623 377,592 340,584 274,557 150,504 86,410 86,270 86,76 221,-47 438,-47 573,-47 682,0 803,111 815,0 868,-47 979,-47 1016,-47 1038,-43 1096,-29 L 1096,100 Z M 797,338 C 797,281 780,246 729,199 659,135 575,102 475,102 342,102 264,166 264,274 264,387 338,444 522,471 705,496 739,504 797,530 L 797,338 Z"
+ id="glyph22" />
+ <glyph
+ unicode="V"
+ horiz-adv-x="1271"
+ d="M 803,0 L 1321,1493 1118,1493 705,229 266,1493 61,1493 598,0 803,0 Z"
+ id="glyph23" />
+ <glyph
+ unicode="R"
+ horiz-adv-x="1218"
+ d="M 381,643 L 872,643 C 1042,643 1118,561 1118,377 L 1116,244 C 1116,152 1133,61 1159,0 L 1391,0 1391,47 C 1319,96 1305,150 1300,348 1298,594 1260,668 1098,737 1266,821 1333,922 1333,1094 1333,1352 1174,1493 879,1493 L 190,1493 190,0 381,0 381,643 Z M 381,811 L 381,1325 842,1325 C 948,1325 1010,1309 1057,1268 1108,1225 1135,1157 1135,1069 1135,891 1044,811 842,811 L 381,811 Z"
+ id="glyph24" />
+ <glyph
+ unicode="N"
+ horiz-adv-x="1192"
+ d="M 1323,1493 L 1143,1493 1143,272 363,1493 156,1493 156,0 336,0 336,1210 1108,0 1323,0 1323,1493 Z"
+ id="glyph25" />
+ <glyph
+ unicode="M"
+ horiz-adv-x="1430"
+ d="M 958,0 L 1378,1251 1378,0 1559,0 1559,1493 1294,1493 860,193 418,1493 154,1493 154,0 334,0 334,1251 758,0 958,0 Z"
+ id="glyph26" />
+ <glyph
+ unicode=":"
+ horiz-adv-x="239"
+ d="M 438,213 L 225,213 225,0 438,0 438,213 Z M 438,1073 L 225,1073 225,860 438,860 438,1073 Z"
+ id="glyph27" />
+ <glyph
+ unicode="-"
+ horiz-adv-x="504"
+ d="M 582,639 L 94,639 94,492 582,492 582,639 Z"
+ id="glyph28" />
+ <glyph
+ unicode=" "
+ horiz-adv-x="556"
+ id="glyph29" />
+ </font>
+ </defs>
+ <defs
+ class="TextShapeIndex"
+ id="defs30">
+ <g
+ ooo:slide="id1"
+ ooo:id-list="id3 id4 id5 id6 id7 id8 id9 id10 id11"
+ id="g29" />
+ </defs>
+ <defs
+ class="EmbeddedBulletChars"
+ id="defs39">
+ <g
+ id="bullet-char-template-57356"
+ transform="matrix(4.8828125e-4,0,0,-4.8828125e-4,0,0)">
+ <path
+ d="M 580,1141 1163,571 580,0 -4,571 Z"
+ id="path30" />
+ </g>
+ <g
+ id="bullet-char-template-57354"
+ transform="matrix(4.8828125e-4,0,0,-4.8828125e-4,0,0)">
+ <path
+ d="M 8,1128 H 1137 V 0 H 8 Z"
+ id="path31" />
+ </g>
+ <g
+ id="bullet-char-template-10146"
+ transform="matrix(4.8828125e-4,0,0,-4.8828125e-4,0,0)">
+ <path
+ d="M 174,0 602,739 174,1481 1456,739 Z M 1358,739 309,1346 659,739 Z"
+ id="path32" />
+ </g>
+ <g
+ id="bullet-char-template-10132"
+ transform="matrix(4.8828125e-4,0,0,-4.8828125e-4,0,0)">
+ <path
+ d="M 2015,739 1276,0 H 717 l 543,543 H 174 v 393 h 1086 l -543,545 h 557 z"
+ id="path33" />
+ </g>
+ <g
+ id="bullet-char-template-10007"
+ transform="matrix(4.8828125e-4,0,0,-4.8828125e-4,0,0)">
+ <path
+ d="m 0,-2 c -7,16 -16,29 -25,39 l 381,530 c -94,256 -141,385 -141,387 0,25 13,38 40,38 9,0 21,-2 34,-5 21,4 42,12 65,25 l 27,-13 111,-251 280,301 64,-25 24,25 c 21,-10 41,-24 62,-43 C 886,937 835,863 770,784 769,783 710,716 594,584 L 774,223 c 0,-27 -21,-55 -63,-84 l 16,-20 C 717,90 699,76 672,76 641,76 570,178 457,381 L 164,-76 c -22,-34 -53,-51 -92,-51 -42,0 -63,17 -64,51 -7,9 -10,24 -10,44 0,9 1,19 2,30 z"
+ id="path34" />
+ </g>
+ <g
+ id="bullet-char-template-10004"
+ transform="matrix(4.8828125e-4,0,0,-4.8828125e-4,0,0)">
+ <path
+ d="M 285,-33 C 182,-33 111,30 74,156 52,228 41,333 41,471 c 0,78 14,145 41,201 34,71 87,106 158,106 53,0 88,-31 106,-94 l 23,-176 c 8,-64 28,-97 59,-98 l 735,706 c 11,11 33,17 66,17 42,0 63,-15 63,-46 V 965 c 0,-36 -10,-64 -30,-84 L 442,47 C 390,-6 338,-33 285,-33 Z"
+ id="path35" />
+ </g>
+ <g
+ id="bullet-char-template-9679"
+ transform="matrix(4.8828125e-4,0,0,-4.8828125e-4,0,0)">
+ <path
+ d="M 813,0 C 632,0 489,54 383,161 276,268 223,411 223,592 c 0,181 53,324 160,431 106,107 249,161 430,161 179,0 323,-54 432,-161 108,-107 162,-251 162,-431 0,-180 -54,-324 -162,-431 C 1136,54 992,0 813,0 Z"
+ id="path36" />
+ </g>
+ <g
+ id="bullet-char-template-8226"
+ transform="matrix(4.8828125e-4,0,0,-4.8828125e-4,0,0)">
+ <path
+ d="m 346,457 c -73,0 -137,26 -191,78 -54,51 -81,114 -81,188 0,73 27,136 81,188 54,52 118,78 191,78 73,0 134,-26 185,-79 51,-51 77,-114 77,-187 0,-75 -25,-137 -76,-188 -50,-52 -112,-78 -186,-78 z"
+ id="path37" />
+ </g>
+ <g
+ id="bullet-char-template-8211"
+ transform="matrix(4.8828125e-4,0,0,-4.8828125e-4,0,0)">
+ <path
+ d="M -4,459 H 1135 V 606 H -4 Z"
+ id="path38" />
+ </g>
+ <g
+ id="bullet-char-template-61548"
+ transform="matrix(4.8828125e-4,0,0,-4.8828125e-4,0,0)">
+ <path
+ d="m 173,740 c 0,163 58,303 173,419 116,115 255,173 419,173 163,0 302,-58 418,-173 116,-116 174,-256 174,-419 0,-163 -58,-303 -174,-418 C 1067,206 928,148 765,148 601,148 462,206 346,322 231,437 173,577 173,740 Z"
+ id="path39" />
+ </g>
+ </defs>
+ <g
+ id="g39"
+ transform="translate(-4571.889,-13755.889)">
+ <g
+ id="id2"
+ class="Master_Slide">
+ <g
+ id="bg-id2"
+ class="Background" />
+ <g
+ id="bo-id2"
+ class="BackgroundObjects" />
+ </g>
+ </g>
+ <g
+ class="SlideGroup"
+ id="g73"
+ transform="translate(-4571.889,-13755.889)">
+ <g
+ id="g72">
+ <g
+ id="container-id1">
+ <g
+ id="id1"
+ class="Slide"
+ clip-path="url(#presentation_clip_path)">
+ <g
+ class="Page"
+ id="g71">
+ <g
+ class="com.sun.star.drawing.CustomShape"
+ id="g47">
+ <g
+ id="id3">
+ <rect
+ class="BoundingBox"
+ stroke="none"
+ fill="none"
+ x="4585"
+ y="13769"
+ width="4767"
+ height="2226"
+ id="rect39" />
+ <path
+ fill="#ffffff"
+ stroke="none"
+ d="m 9350,14882 c 0,195 -110,386 -319,555 -209,169 -510,310 -872,407 -362,98 -773,149 -1191,149 -418,0 -829,-51 -1191,-149 -362,-97 -663,-238 -872,-407 -209,-169 -319,-360 -319,-555 0,-196 110,-387 319,-556 209,-169 510,-310 872,-407 362,-98 773,-149 1191,-149 418,0 829,51 1191,149 362,97 663,238 872,407 209,169 319,360 319,555 z"
+ id="path40" />
+ <path
+ fill="none"
+ stroke="#000000"
+ d="m 9350,14882 c 0,195 -110,386 -319,555 -209,169 -510,310 -872,407 -362,98 -773,149 -1191,149 -418,0 -829,-51 -1191,-149 -362,-97 -663,-238 -872,-407 -209,-169 -319,-360 -319,-555 0,-196 110,-387 319,-556 209,-169 510,-310 872,-407 362,-98 773,-149 1191,-149 418,0 829,51 1191,149 362,97 663,238 872,407 209,169 319,360 319,555 z"
+ id="path41" />
+ <text
+ class="SVGTextShape"
+ id="text47"><tspan
+ class="TextParagraph"
+ font-family="'Nimbus Sans', sans-serif"
+ font-size="635px"
+ font-weight="400"
+ id="tspan43"><tspan
+ class="TextPosition"
+ x="6105"
+ y="14707"
+ id="tspan42"><tspan
+ fill="#000000"
+ stroke="none"
+ style="white-space:pre"
+ id="tspan41">Model</tspan></tspan></tspan><tspan
+ class="TextParagraph"
+ font-family="'Nimbus Sans', sans-serif"
+ font-size="635px"
+ font-weight="400"
+ id="tspan47"><tspan
+ class="TextPosition"
+ x="6293"
+ y="15342"
+ id="tspan46"><tspan
+ fill="#000000"
+ stroke="none"
+ style="white-space:pre"
+ id="tspan44">“</tspan><tspan
+ fill="#000000"
+ stroke="none"
+ style="white-space:pre"
+ id="tspan45">r-rc”</tspan></tspan></tspan></text>
+ </g>
+ </g>
+ <g
+ class="com.sun.star.drawing.CustomShape"
+ id="g50">
+ <g
+ id="id4">
+ <rect
+ class="BoundingBox"
+ stroke="none"
+ fill="none"
+ x="31257"
+ y="13769"
+ width="4767"
+ height="2226"
+ id="rect47" />
+ <path
+ fill="#ffffff"
+ stroke="none"
+ d="m 36022,14882 c 0,195 -110,386 -319,555 -209,169 -510,310 -872,407 -362,98 -773,149 -1191,149 -418,0 -829,-51 -1191,-149 -362,-97 -663,-238 -872,-407 -209,-169 -319,-360 -319,-555 0,-196 110,-387 319,-556 209,-169 510,-310 872,-407 362,-98 773,-149 1191,-149 418,0 829,51 1191,149 362,97 663,238 872,407 209,169 319,360 319,555 z"
+ id="path47" />
+ <path
+ fill="none"
+ stroke="#000000"
+ d="m 36022,14882 c 0,195 -110,386 -319,555 -209,169 -510,310 -872,407 -362,98 -773,149 -1191,149 -418,0 -829,-51 -1191,-149 -362,-97 -663,-238 -872,-407 -209,-169 -319,-360 -319,-555 0,-196 110,-387 319,-556 209,-169 510,-310 872,-407 362,-98 773,-149 1191,-149 418,0 829,51 1191,149 362,97 663,238 872,407 209,169 319,360 319,555 z"
+ id="path48" />
+ <text
+ class="SVGTextShape"
+ id="text50"><tspan
+ class="TextParagraph"
+ font-family="'Nimbus Sans', sans-serif"
+ font-size="635px"
+ font-weight="400"
+ id="tspan50"><tspan
+ class="TextPosition"
+ x="32743"
+ y="15024"
+ id="tspan49"><tspan
+ fill="#000000"
+ stroke="none"
+ style="white-space:pre"
+ id="tspan48">Result</tspan></tspan></tspan></text>
+ </g>
+ </g>
+ <g
+ class="com.sun.star.drawing.CustomShape"
+ id="g53">
+ <g
+ id="id5">
+ <rect
+ class="BoundingBox"
+ stroke="none"
+ fill="none"
+ x="10654"
+ y="13769"
+ width="4965"
+ height="2225"
+ id="rect50" />
+ <path
+ fill="#ffffff"
+ stroke="none"
+ d="m 13136,15992 h -2481 v -2222 h 4962 v 2222 z"
+ id="path50" />
+ <path
+ fill="none"
+ stroke="#000000"
+ d="m 13136,15992 h -2481 v -2222 h 4962 v 2222 z"
+ id="path51" />
+ <text
+ class="SVGTextShape"
+ id="text53"><tspan
+ class="TextParagraph"
+ font-family="'Nimbus Sans', sans-serif"
+ font-size="635px"
+ font-weight="400"
+ id="tspan53"><tspan
+ class="TextPosition"
+ x="11004"
+ y="15024"
+ id="tspan52"><tspan
+ fill="#000000"
+ stroke="none"
+ style="white-space:pre"
+ id="tspan51">Model::compile</tspan></tspan></tspan></text>
+ </g>
+ </g>
+ <g
+ class="com.sun.star.drawing.CustomShape"
+ id="g60">
+ <g
+ id="id6">
+ <rect
+ class="BoundingBox"
+ stroke="none"
+ fill="none"
+ x="16868"
+ y="13819"
+ width="7090"
+ height="2126"
+ id="rect53" />
+ <path
+ fill="#ffffff"
+ stroke="none"
+ d="m 23956,14882 c 0,186 -164,369 -475,530 -311,162 -758,296 -1297,389 -538,93 -1149,142 -1771,142 -623,0 -1234,-49 -1772,-142 -539,-93 -986,-227 -1297,-389 -311,-161 -475,-344 -475,-530 0,-187 164,-370 475,-531 311,-162 758,-296 1297,-389 538,-93 1149,-142 1771,-142 623,0 1234,49 1772,142 539,93 986,227 1297,389 311,161 475,344 475,530 z"
+ id="path53" />
+ <path
+ fill="none"
+ stroke="#000000"
+ d="m 23956,14882 c 0,186 -164,369 -475,530 -311,162 -758,296 -1297,389 -538,93 -1149,142 -1771,142 -623,0 -1234,-49 -1772,-142 -539,-93 -986,-227 -1297,-389 -311,-161 -475,-344 -475,-530 0,-187 164,-370 475,-531 311,-162 758,-296 1297,-389 538,-93 1149,-142 1771,-142 623,0 1234,49 1772,142 539,93 986,227 1297,389 311,161 475,344 475,530 z"
+ id="path54" />
+ <text
+ class="SVGTextShape"
+ id="text60"><tspan
+ class="TextParagraph"
+ font-family="'Nimbus Sans', sans-serif"
+ font-size="635px"
+ font-weight="400"
+ id="tspan60"><tspan
+ class="TextPosition"
+ x="18942"
+ y="14389"
+ id="tspan55"><tspan
+ fill="#000000"
+ stroke="none"
+ style="white-space:pre"
+ id="tspan54">Vectorized </tspan></tspan><tspan
+ class="TextPosition"
+ x="18750"
+ y="15024"
+ id="tspan57"><tspan
+ fill="#000000"
+ stroke="none"
+ style="white-space:pre"
+ id="tspan56">Native code </tspan></tspan><tspan
+ class="TextPosition"
+ x="18347"
+ y="15659"
+ id="tspan59"><tspan
+ fill="#000000"
+ stroke="none"
+ style="white-space:pre"
+ id="tspan58">object for “r-rc”</tspan></tspan></tspan></text>
+ </g>
+ </g>
+ <g
+ class="com.sun.star.drawing.CustomShape"
+ id="g63">
+ <g
+ id="id7">
+ <rect
+ class="BoundingBox"
+ stroke="none"
+ fill="none"
+ x="25254"
+ y="13769"
+ width="4965"
+ height="2225"
+ id="rect60" />
+ <path
+ fill="#ffffff"
+ stroke="none"
+ d="m 27736,15992 h -2481 v -2222 h 4962 v 2222 z"
+ id="path60" />
+ <path
+ fill="none"
+ stroke="#000000"
+ d="m 27736,15992 h -2481 v -2222 h 4962 v 2222 z"
+ id="path61" />
+ <text
+ class="SVGTextShape"
+ id="text63"><tspan
+ class="TextParagraph"
+ font-family="'Nimbus Sans', sans-serif"
+ font-size="635px"
+ font-weight="400"
+ id="tspan63"><tspan
+ class="TextPosition"
+ x="26010"
+ y="15024"
+ id="tspan62"><tspan
+ fill="#000000"
+ stroke="none"
+ style="white-space:pre"
+ id="tspan61">r-rc::execute</tspan></tspan></tspan></text>
+ </g>
+ </g>
+ <g
+ class="com.sun.star.drawing.ConnectorShape"
+ id="g64">
+ <g
+ id="id8">
+ <rect
+ class="BoundingBox"
+ stroke="none"
+ fill="none"
+ x="9349"
+ y="14731"
+ width="1307"
+ height="301"
+ id="rect63" />
+ <path
+ fill="none"
+ stroke="#000000"
+ d="m 9350,14881 h 1025"
+ id="path63" />
+ <path
+ fill="#000000"
+ stroke="none"
+ d="m 10355,14731 300,150 -300,150 z"
+ id="path64" />
+ </g>
+ </g>
+ <g
+ class="com.sun.star.drawing.ConnectorShape"
+ id="g66">
+ <g
+ id="id9">
+ <rect
+ class="BoundingBox"
+ stroke="none"
+ fill="none"
+ x="15616"
+ y="14731"
+ width="1254"
+ height="301"
+ id="rect64" />
+ <path
+ fill="none"
+ stroke="#000000"
+ d="m 15617,14881 h 972"
+ id="path65" />
+ <path
+ fill="#000000"
+ stroke="none"
+ d="m 16569,14731 300,150 -300,150 z"
+ id="path66" />
+ </g>
+ </g>
+ <g
+ class="com.sun.star.drawing.ConnectorShape"
+ id="g68">
+ <g
+ id="id10">
+ <rect
+ class="BoundingBox"
+ stroke="none"
+ fill="none"
+ x="23954"
+ y="14731"
+ width="1302"
+ height="301"
+ id="rect66" />
+ <path
+ fill="none"
+ stroke="#000000"
+ d="m 23955,14881 h 1020"
+ id="path67" />
+ <path
+ fill="#000000"
+ stroke="none"
+ d="m 24955,14731 300,150 -300,150 z"
+ id="path68" />
+ </g>
+ </g>
+ <g
+ class="com.sun.star.drawing.ConnectorShape"
+ id="g70">
+ <g
+ id="id11">
+ <rect
+ class="BoundingBox"
+ stroke="none"
+ fill="none"
+ x="30216"
+ y="14731"
+ width="1044"
+ height="301"
+ id="rect68" />
+ <path
+ fill="none"
+ stroke="#000000"
+ d="m 30217,14881 h 762"
+ id="path69" />
+ <path
+ fill="#000000"
+ stroke="none"
+ d="m 30959,14731 300,150 -300,150 z"
+ id="path70" />
+ </g>
+ </g>
+ </g>
+ </g>
+ </g>
+ </g>
+ </g>
+</svg>
diff --git a/doc/DirectExecution.odg b/doc/DirectExecution.odg
new file mode 100644
index 0000000000000000000000000000000000000000..51a23e61d60e382b60a6717aa093501923c53360
Binary files /dev/null and b/doc/DirectExecution.odg differ
diff --git a/doc/DirectExecution.svg b/doc/DirectExecution.svg
new file mode 100644
index 0000000000000000000000000000000000000000..4145831f2be49bc20c4ad0b040628c90e10939ee
--- /dev/null
+++ b/doc/DirectExecution.svg
@@ -0,0 +1,883 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+ version="1.2"
+ width="262.64221mm"
+ height="140.45049mm"
+ viewBox="0 0 26264.221 14045.049"
+ preserveAspectRatio="xMidYMid"
+ fill-rule="evenodd"
+ stroke-width="28.222"
+ stroke-linejoin="round"
+ xml:space="preserve"
+ id="svg81"
+ sodipodi:docname="DirectExecution.svg"
+ inkscape:version="1.3.2 (091e20ef0f, 2023-11-25, custom)"
+ xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+ xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+ xmlns="http://www.w3.org/2000/svg"
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns:ooo="http://xml.openoffice.org/svg/export"><sodipodi:namedview
+ id="namedview81"
+ pagecolor="#ffffff"
+ bordercolor="#000000"
+ borderopacity="0.25"
+ inkscape:showpageshadow="2"
+ inkscape:pageopacity="0.0"
+ inkscape:pagecheckerboard="0"
+ inkscape:deskcolor="#d1d1d1"
+ inkscape:document-units="mm"
+ inkscape:zoom="0.72865591"
+ inkscape:cx="564.73844"
+ inkscape:cy="214.09282"
+ inkscape:window-width="1882"
+ inkscape:window-height="1054"
+ inkscape:window-x="1920"
+ inkscape:window-y="0"
+ inkscape:window-maximized="1"
+ inkscape:current-layer="svg81" />
+ <defs
+ class="ClipPathGroup"
+ id="defs2">
+ <clipPath
+ id="presentation_clip_path"
+ clipPathUnits="userSpaceOnUse">
+ <rect
+ x="0"
+ y="0"
+ width="42012"
+ height="29693"
+ id="rect1" />
+ </clipPath>
+ <clipPath
+ id="presentation_clip_path_shrink"
+ clipPathUnits="userSpaceOnUse">
+ <rect
+ x="42"
+ y="29"
+ width="41928"
+ height="29634"
+ id="rect2" />
+ </clipPath>
+ </defs>
+ <defs
+ id="defs23">
+ <font
+ id="EmbeddedFont_1"
+ horiz-adv-x="2048"
+ horiz-origin-x="0"
+ horiz-origin-y="0"
+ vert-origin-x="512"
+ vert-origin-y="768"
+ vert-adv-y="1024">
+ <font-face
+ font-family="Nimbus Sans embedded"
+ units-per-em="2048"
+ font-weight="normal"
+ font-style="normal"
+ ascent="1482"
+ descent="556"
+ id="font-face2" />
+ <missing-glyph
+ horiz-adv-x="2048"
+ d="M 0,0 L 2047,0 2047,2047 0,2047 0,0 Z"
+ id="missing-glyph2" />
+ <glyph
+ unicode="”"
+ horiz-adv-x="557"
+ d="M 100,1452 L 100,1239 199,1239 C 201,1120 172,1065 100,1055 L 100,977 C 223,985 291,1081 291,1245 L 291,1452 100,1452 Z M 428,1452 L 428,1239 526,1239 C 528,1120 500,1065 428,1055 L 428,977 C 551,985 619,1081 619,1245 L 619,1452 428,1452 Z"
+ id="glyph2" />
+ <glyph
+ unicode="“"
+ horiz-adv-x="557"
+ d="M 289,977 L 289,1190 190,1190 C 188,1307 219,1364 289,1374 L 289,1452 C 168,1442 98,1346 98,1184 L 98,977 289,977 Z M 612,977 L 612,1190 514,1190 C 512,1307 543,1364 612,1374 L 612,1452 C 492,1442 422,1346 422,1184 L 422,977 612,977 Z"
+ id="glyph3" />
+ <glyph
+ unicode="x"
+ horiz-adv-x="954"
+ d="M 598,555 L 958,1073 766,1073 508,684 250,1073 55,1073 414,547 35,0 229,0 502,412 770,0 969,0 598,555 Z"
+ id="glyph4" />
+ <glyph
+ unicode="u"
+ horiz-adv-x="874"
+ d="M 987,0 L 987,1073 817,1073 817,465 C 817,246 702,102 524,102 389,102 303,184 303,313 L 303,1073 133,1073 133,246 C 133,68 266,-47 475,-47 633,-47 733,8 834,150 L 834,0 987,0 Z"
+ id="glyph5" />
+ <glyph
+ unicode="t"
+ horiz-adv-x="504"
+ d="M 520,1073 L 344,1073 344,1368 174,1368 174,1073 29,1073 29,934 174,934 174,123 C 174,12 248,-47 381,-47 426,-47 463,-43 520,-33 L 520,111 C 496,104 473,102 438,102 365,102 344,123 344,199 L 344,934 520,934 520,1073 Z"
+ id="glyph6" />
+ <glyph
+ unicode="s"
+ horiz-adv-x="901"
+ d="M 897,774 C 895,985 756,1104 508,1104 258,1104 96,975 96,776 96,608 182,528 436,467 L 596,428 C 715,399 762,356 762,281 762,178 662,111 512,111 420,111 342,137 299,182 272,213 260,244 250,319 L 70,319 C 78,72 217,-47 498,-47 768,-47 940,86 940,293 940,453 850,541 637,592 L 473,631 C 334,664 274,709 274,784 274,885 363,946 502,946 639,946 713,887 717,774 L 897,774 Z"
+ id="glyph7" />
+ <glyph
+ unicode="r"
+ horiz-adv-x="530"
+ d="M 141,1073 L 141,0 313,0 313,557 C 315,815 422,930 657,924 L 657,1098 C 629,1102 612,1104 592,1104 481,1104 397,1038 299,879 L 299,1073 141,1073 Z"
+ id="glyph8" />
+ <glyph
+ unicode="p"
+ horiz-adv-x="980"
+ d="M 111,-446 L 283,-446 283,113 C 373,2 473,-47 612,-47 891,-47 1071,176 1071,518 1071,879 895,1104 610,1104 465,1104 348,1038 268,911 L 268,1073 111,1073 111,-446 Z M 582,944 C 770,944 893,778 893,522 893,279 768,113 582,113 399,113 283,276 283,528 283,780 399,944 582,944 Z"
+ id="glyph9" />
+ <glyph
+ unicode="o"
+ horiz-adv-x="1006"
+ d="M 557,1104 C 254,1104 74,889 74,528 74,166 254,-47 559,-47 862,-47 1044,168 1044,520 1044,893 868,1104 557,1104 Z M 559,946 C 752,946 866,788 866,522 866,268 748,111 559,111 369,111 252,268 252,528 252,788 369,946 559,946 Z"
+ id="glyph10" />
+ <glyph
+ unicode="l"
+ horiz-adv-x="187"
+ d="M 311,1493 L 139,1493 139,0 311,0 311,1493 Z"
+ id="glyph11" />
+ <glyph
+ unicode="i"
+ horiz-adv-x="187"
+ d="M 307,1073 L 137,1073 137,0 307,0 307,1073 Z M 307,1493 L 135,1493 135,1278 307,1278 307,1493 Z"
+ id="glyph12" />
+ <glyph
+ unicode="e"
+ horiz-adv-x="980"
+ d="M 1051,479 C 1051,643 1038,741 1008,821 938,997 774,1104 573,1104 274,1104 82,877 82,522 82,168 266,-47 569,-47 815,-47 985,92 1028,326 L 856,326 C 809,184 713,111 575,111 467,111 375,160 317,250 276,311 262,373 260,479 L 1051,479 Z M 264,619 C 279,817 399,946 571,946 745,946 866,811 866,619 L 264,619 Z"
+ id="glyph13" />
+ <glyph
+ unicode="d"
+ horiz-adv-x="980"
+ d="M 1014,1493 L 844,1493 844,938 C 772,1047 657,1104 514,1104 236,1104 53,881 53,539 53,176 229,-47 520,-47 668,-47 770,8 862,141 L 862,0 1014,0 1014,1493 Z M 543,944 C 727,944 844,782 844,524 844,276 725,113 545,113 356,113 231,279 231,528 231,778 356,944 543,944 Z"
+ id="glyph14" />
+ <glyph
+ unicode="c"
+ horiz-adv-x="927"
+ d="M 965,713 C 956,817 934,885 893,944 819,1044 690,1104 541,1104 250,1104 63,875 63,518 63,172 248,-47 539,-47 795,-47 956,107 977,369 L 805,369 C 776,197 688,111 543,111 354,111 242,264 242,518 242,786 352,946 539,946 682,946 772,862 793,713 L 965,713 Z"
+ id="glyph15" />
+ <glyph
+ unicode="a"
+ horiz-adv-x="1033"
+ d="M 1096,100 C 1077,96 1069,96 1059,96 999,96 967,127 967,180 L 967,811 C 967,1001 827,1104 563,1104 406,1104 281,1059 207,979 158,924 137,862 133,756 L 305,756 C 319,887 397,946 557,946 713,946 797,889 797,786 L 797,741 C 795,668 758,641 619,623 377,592 340,584 274,557 150,504 86,410 86,270 86,76 221,-47 438,-47 573,-47 682,0 803,111 815,0 868,-47 979,-47 1016,-47 1038,-43 1096,-29 L 1096,100 Z M 797,338 C 797,281 780,246 729,199 659,135 575,102 475,102 342,102 264,166 264,274 264,387 338,444 522,471 705,496 739,504 797,530 L 797,338 Z"
+ id="glyph16" />
+ <glyph
+ unicode="S"
+ horiz-adv-x="1192"
+ d="M 1221,1055 C 1221,1157 1214,1186 1182,1255 1100,1427 926,1518 674,1518 346,1518 143,1350 143,1079 143,897 240,782 436,731 L 807,633 C 997,584 1081,508 1081,391 1081,311 1038,229 975,184 915,141 821,121 700,121 537,121 428,160 356,246 301,311 276,383 279,475 L 98,475 C 100,338 127,248 186,166 289,25 461,-47 688,-47 866,-47 1012,-6 1108,68 1208,147 1272,281 1272,410 1272,594 1157,729 954,784 L 580,885 C 399,934 334,991 334,1106 334,1257 467,1358 668,1358 905,1358 1038,1251 1040,1055 L 1221,1055 Z"
+ id="glyph17" />
+ <glyph
+ unicode="R"
+ horiz-adv-x="1218"
+ d="M 381,643 L 872,643 C 1042,643 1118,561 1118,377 L 1116,244 C 1116,152 1133,61 1159,0 L 1391,0 1391,47 C 1319,96 1305,150 1300,348 1298,594 1260,668 1098,737 1266,821 1333,922 1333,1094 1333,1352 1174,1493 879,1493 L 190,1493 190,0 381,0 381,643 Z M 381,811 L 381,1325 842,1325 C 948,1325 1010,1309 1057,1268 1108,1225 1135,1157 1135,1069 1135,891 1044,811 842,811 L 381,811 Z"
+ id="glyph18" />
+ <glyph
+ unicode="P"
+ horiz-adv-x="1086"
+ d="M 377,633 L 846,633 C 963,633 1055,668 1135,739 1225,821 1264,918 1264,1055 1264,1335 1098,1493 803,1493 L 186,1493 186,0 377,0 377,633 Z M 377,801 L 377,1325 774,1325 C 956,1325 1065,1227 1065,1063 1065,899 956,801 774,801 L 377,801 Z"
+ id="glyph19" />
+ <glyph
+ unicode="M"
+ horiz-adv-x="1430"
+ d="M 958,0 L 1378,1251 1378,0 1559,0 1559,1493 1294,1493 860,193 418,1493 154,1493 154,0 334,0 334,1251 758,0 958,0 Z"
+ id="glyph20" />
+ <glyph
+ unicode="C"
+ horiz-adv-x="1324"
+ d="M 1356,1030 C 1296,1358 1108,1518 780,1518 580,1518 418,1454 307,1331 172,1184 98,971 98,729 98,483 174,272 313,127 430,8 578,-47 772,-47 1137,-47 1341,150 1387,545 L 1190,545 C 1174,442 1153,373 1122,313 1061,190 934,121 774,121 477,121 289,358 289,731 289,1114 467,1350 758,1350 879,1350 991,1315 1053,1255 1108,1204 1139,1143 1161,1030 L 1356,1030 Z"
+ id="glyph21" />
+ <glyph
+ unicode=":"
+ horiz-adv-x="239"
+ d="M 438,213 L 225,213 225,0 438,0 438,213 Z M 438,1073 L 225,1073 225,860 438,860 438,1073 Z"
+ id="glyph22" />
+ <glyph
+ unicode="-"
+ horiz-adv-x="504"
+ d="M 582,639 L 94,639 94,492 582,492 582,639 Z"
+ id="glyph23" />
+ </font>
+ </defs>
+ <defs
+ class="TextShapeIndex"
+ id="defs24">
+ <g
+ ooo:slide="id1"
+ ooo:id-list="id3 id4 id5 id6 id7 id8 id9 id10 id11 id12 id13 id14 id15 id16 id17 id18 id19"
+ id="g23" />
+ </defs>
+ <defs
+ class="EmbeddedBulletChars"
+ id="defs33">
+ <g
+ id="bullet-char-template-57356"
+ transform="matrix(4.8828125e-4,0,0,-4.8828125e-4,0,0)">
+ <path
+ d="M 580,1141 1163,571 580,0 -4,571 Z"
+ id="path24" />
+ </g>
+ <g
+ id="bullet-char-template-57354"
+ transform="matrix(4.8828125e-4,0,0,-4.8828125e-4,0,0)">
+ <path
+ d="M 8,1128 H 1137 V 0 H 8 Z"
+ id="path25" />
+ </g>
+ <g
+ id="bullet-char-template-10146"
+ transform="matrix(4.8828125e-4,0,0,-4.8828125e-4,0,0)">
+ <path
+ d="M 174,0 602,739 174,1481 1456,739 Z M 1358,739 309,1346 659,739 Z"
+ id="path26" />
+ </g>
+ <g
+ id="bullet-char-template-10132"
+ transform="matrix(4.8828125e-4,0,0,-4.8828125e-4,0,0)">
+ <path
+ d="M 2015,739 1276,0 H 717 l 543,543 H 174 v 393 h 1086 l -543,545 h 557 z"
+ id="path27" />
+ </g>
+ <g
+ id="bullet-char-template-10007"
+ transform="matrix(4.8828125e-4,0,0,-4.8828125e-4,0,0)">
+ <path
+ d="m 0,-2 c -7,16 -16,29 -25,39 l 381,530 c -94,256 -141,385 -141,387 0,25 13,38 40,38 9,0 21,-2 34,-5 21,4 42,12 65,25 l 27,-13 111,-251 280,301 64,-25 24,25 c 21,-10 41,-24 62,-43 C 886,937 835,863 770,784 769,783 710,716 594,584 L 774,223 c 0,-27 -21,-55 -63,-84 l 16,-20 C 717,90 699,76 672,76 641,76 570,178 457,381 L 164,-76 c -22,-34 -53,-51 -92,-51 -42,0 -63,17 -64,51 -7,9 -10,24 -10,44 0,9 1,19 2,30 z"
+ id="path28" />
+ </g>
+ <g
+ id="bullet-char-template-10004"
+ transform="matrix(4.8828125e-4,0,0,-4.8828125e-4,0,0)">
+ <path
+ d="M 285,-33 C 182,-33 111,30 74,156 52,228 41,333 41,471 c 0,78 14,145 41,201 34,71 87,106 158,106 53,0 88,-31 106,-94 l 23,-176 c 8,-64 28,-97 59,-98 l 735,706 c 11,11 33,17 66,17 42,0 63,-15 63,-46 V 965 c 0,-36 -10,-64 -30,-84 L 442,47 C 390,-6 338,-33 285,-33 Z"
+ id="path29" />
+ </g>
+ <g
+ id="bullet-char-template-9679"
+ transform="matrix(4.8828125e-4,0,0,-4.8828125e-4,0,0)">
+ <path
+ d="M 813,0 C 632,0 489,54 383,161 276,268 223,411 223,592 c 0,181 53,324 160,431 106,107 249,161 430,161 179,0 323,-54 432,-161 108,-107 162,-251 162,-431 0,-180 -54,-324 -162,-431 C 1136,54 992,0 813,0 Z"
+ id="path30" />
+ </g>
+ <g
+ id="bullet-char-template-8226"
+ transform="matrix(4.8828125e-4,0,0,-4.8828125e-4,0,0)">
+ <path
+ d="m 346,457 c -73,0 -137,26 -191,78 -54,51 -81,114 -81,188 0,73 27,136 81,188 54,52 118,78 191,78 73,0 134,-26 185,-79 51,-51 77,-114 77,-187 0,-75 -25,-137 -76,-188 -50,-52 -112,-78 -186,-78 z"
+ id="path31" />
+ </g>
+ <g
+ id="bullet-char-template-8211"
+ transform="matrix(4.8828125e-4,0,0,-4.8828125e-4,0,0)">
+ <path
+ d="M -4,459 H 1135 V 606 H -4 Z"
+ id="path32" />
+ </g>
+ <g
+ id="bullet-char-template-61548"
+ transform="matrix(4.8828125e-4,0,0,-4.8828125e-4,0,0)">
+ <path
+ d="m 173,740 c 0,163 58,303 173,419 116,115 255,173 419,173 163,0 302,-58 418,-173 116,-116 174,-256 174,-419 0,-163 -58,-303 -174,-418 C 1067,206 928,148 765,148 601,148 462,206 346,322 231,437 173,577 173,740 Z"
+ id="path33" />
+ </g>
+ </defs>
+ <g
+ id="g33"
+ transform="translate(-6064.889,-9178.0621)">
+ <g
+ id="id2"
+ class="Master_Slide">
+ <g
+ id="bg-id2"
+ class="Background" />
+ <g
+ id="bo-id2"
+ class="BackgroundObjects" />
+ </g>
+ </g>
+ <g
+ class="SlideGroup"
+ id="g81"
+ transform="translate(-6064.889,-9178.0621)">
+ <g
+ id="g80">
+ <g
+ id="container-id1">
+ <g
+ id="id1"
+ class="Slide"
+ clip-path="url(#presentation_clip_path)">
+ <g
+ class="Page"
+ id="g79">
+ <g
+ class="com.sun.star.drawing.CustomShape"
+ id="g37">
+ <g
+ id="id3">
+ <rect
+ class="BoundingBox"
+ stroke="none"
+ fill="none"
+ x="12094"
+ y="12648"
+ width="5083"
+ height="1908"
+ id="rect33" />
+ <path
+ fill="#ffffff"
+ stroke="none"
+ d="m 14635,14554 h -2540 v -1905 h 5080 v 1905 z"
+ id="path34" />
+ <path
+ fill="none"
+ stroke="#000000"
+ d="m 14635,14554 h -2540 v -1905 h 5080 v 1905 z"
+ id="path35" />
+ <text
+ class="SVGTextShape"
+ id="text37"><tspan
+ class="TextParagraph"
+ font-family="'Nimbus Sans', sans-serif"
+ font-size="635px"
+ font-weight="400"
+ id="tspan37"><tspan
+ class="TextPosition"
+ x="12560"
+ y="13745"
+ id="tspan36"><tspan
+ fill="#000000"
+ stroke="none"
+ style="white-space:pre"
+ id="tspan35">Serial::execute</tspan></tspan></tspan></text>
+ </g>
+ </g>
+ <g
+ class="com.sun.star.drawing.CustomShape"
+ id="g44">
+ <g
+ id="id4">
+ <rect
+ class="BoundingBox"
+ stroke="none"
+ fill="none"
+ x="6078"
+ y="12490"
+ width="4767"
+ height="2226"
+ id="rect37" />
+ <path
+ fill="#ffffff"
+ stroke="none"
+ d="m 10843,13603 c 0,195 -110,386 -319,555 -209,169 -510,310 -872,407 -362,98 -773,149 -1191,149 -418,0 -829,-51 -1191,-149 -362,-97 -663,-238 -872,-407 -209,-169 -319,-360 -319,-555 0,-196 110,-387 319,-556 209,-169 510,-310 872,-407 362,-98 773,-149 1191,-149 418,0 829,51 1191,149 362,97 663,238 872,407 209,169 319,360 319,556 z"
+ id="path37" />
+ <path
+ fill="none"
+ stroke="#000000"
+ d="m 10843,13603 c 0,195 -110,386 -319,555 -209,169 -510,310 -872,407 -362,98 -773,149 -1191,149 -418,0 -829,-51 -1191,-149 -362,-97 -663,-238 -872,-407 -209,-169 -319,-360 -319,-555 0,-196 110,-387 319,-556 209,-169 510,-310 872,-407 362,-98 773,-149 1191,-149 418,0 829,51 1191,149 362,97 663,238 872,407 209,169 319,360 319,556 z"
+ id="path38" />
+ <text
+ class="SVGTextShape"
+ id="text44"><tspan
+ class="TextParagraph"
+ font-family="'Nimbus Sans', sans-serif"
+ font-size="635px"
+ font-weight="400"
+ id="tspan40"><tspan
+ class="TextPosition"
+ x="7598"
+ y="13428"
+ id="tspan39"><tspan
+ fill="#000000"
+ stroke="none"
+ style="white-space:pre"
+ id="tspan38">Model</tspan></tspan></tspan><tspan
+ class="TextParagraph"
+ font-family="'Nimbus Sans', sans-serif"
+ font-size="635px"
+ font-weight="400"
+ id="tspan44"><tspan
+ class="TextPosition"
+ x="7786"
+ y="14063"
+ id="tspan43"><tspan
+ fill="#000000"
+ stroke="none"
+ style="white-space:pre"
+ id="tspan41">“</tspan><tspan
+ fill="#000000"
+ stroke="none"
+ style="white-space:pre"
+ id="tspan42">r-rc”</tspan></tspan></tspan></text>
+ </g>
+ </g>
+ <g
+ class="com.sun.star.drawing.CustomShape"
+ id="g47">
+ <g
+ id="id5">
+ <rect
+ class="BoundingBox"
+ stroke="none"
+ fill="none"
+ x="19544"
+ y="18146"
+ width="5401"
+ height="1908"
+ id="rect44" />
+ <path
+ fill="#ffffff"
+ stroke="none"
+ d="m 22244,20052 h -2699 v -1905 h 5398 v 1905 z"
+ id="path44" />
+ <path
+ fill="none"
+ stroke="#000000"
+ d="m 22244,20052 h -2699 v -1905 h 5398 v 1905 z"
+ id="path45" />
+ <text
+ class="SVGTextShape"
+ id="text47"><tspan
+ class="TextParagraph"
+ font-family="'Nimbus Sans', sans-serif"
+ font-size="635px"
+ font-weight="400"
+ id="tspan47"><tspan
+ class="TextPosition"
+ x="19934"
+ y="19243"
+ id="tspan46"><tspan
+ fill="#000000"
+ stroke="none"
+ style="white-space:pre"
+ id="tspan45">Parallel::execute</tspan></tspan></tspan></text>
+ </g>
+ </g>
+ <g
+ class="com.sun.star.drawing.CustomShape"
+ id="g50">
+ <g
+ id="id6">
+ <rect
+ class="BoundingBox"
+ stroke="none"
+ fill="none"
+ x="19543"
+ y="10114"
+ width="5718"
+ height="1908"
+ id="rect47" />
+ <path
+ fill="#ffffff"
+ stroke="none"
+ d="m 22402,12020 h -2858 v -1905 h 5715 v 1905 z"
+ id="path47" />
+ <path
+ fill="none"
+ stroke="#000000"
+ d="m 22402,12020 h -2858 v -1905 h 5715 v 1905 z"
+ id="path48" />
+ <text
+ class="SVGTextShape"
+ id="text50"><tspan
+ class="TextParagraph"
+ font-family="'Nimbus Sans', sans-serif"
+ font-size="635px"
+ font-weight="400"
+ id="tspan50"><tspan
+ class="TextPosition"
+ x="19986"
+ y="11211"
+ id="tspan49"><tspan
+ fill="#000000"
+ stroke="none"
+ style="white-space:pre"
+ id="tspan48">Resistor::execute</tspan></tspan></tspan></text>
+ </g>
+ </g>
+ <g
+ class="com.sun.star.drawing.CustomShape"
+ id="g53">
+ <g
+ id="id7">
+ <rect
+ class="BoundingBox"
+ stroke="none"
+ fill="none"
+ x="25528"
+ y="15071"
+ width="5718"
+ height="1908"
+ id="rect50" />
+ <path
+ fill="#ffffff"
+ stroke="none"
+ d="m 28387,16977 h -2858 v -1905 h 5715 v 1905 z"
+ id="path50" />
+ <path
+ fill="none"
+ stroke="#000000"
+ d="m 28387,16977 h -2858 v -1905 h 5715 v 1905 z"
+ id="path51" />
+ <text
+ class="SVGTextShape"
+ id="text53"><tspan
+ class="TextParagraph"
+ font-family="'Nimbus Sans', sans-serif"
+ font-size="635px"
+ font-weight="400"
+ id="tspan53"><tspan
+ class="TextPosition"
+ x="25971"
+ y="16168"
+ id="tspan52"><tspan
+ fill="#000000"
+ stroke="none"
+ style="white-space:pre"
+ id="tspan51">Resistor::execute</tspan></tspan></tspan></text>
+ </g>
+ </g>
+ <g
+ class="com.sun.star.drawing.CustomShape"
+ id="g56">
+ <g
+ id="id8">
+ <rect
+ class="BoundingBox"
+ stroke="none"
+ fill="none"
+ x="25528"
+ y="21303"
+ width="5718"
+ height="1908"
+ id="rect53" />
+ <path
+ fill="#ffffff"
+ stroke="none"
+ d="m 28387,23209 h -2858 v -1905 h 5715 v 1905 z"
+ id="path53" />
+ <path
+ fill="none"
+ stroke="#000000"
+ d="m 28387,23209 h -2858 v -1905 h 5715 v 1905 z"
+ id="path54" />
+ <text
+ class="SVGTextShape"
+ id="text56"><tspan
+ class="TextParagraph"
+ font-family="'Nimbus Sans', sans-serif"
+ font-size="635px"
+ font-weight="400"
+ id="tspan56"><tspan
+ class="TextPosition"
+ x="26544"
+ y="22400"
+ id="tspan55"><tspan
+ fill="#000000"
+ stroke="none"
+ style="white-space:pre"
+ id="tspan54">Cap::execute</tspan></tspan></tspan></text>
+ </g>
+ </g>
+ <g
+ class="com.sun.star.drawing.ConnectorShape"
+ id="g57">
+ <g
+ id="id9">
+ <rect
+ class="BoundingBox"
+ stroke="none"
+ fill="none"
+ x="17175"
+ y="11067"
+ width="9279"
+ height="2686"
+ id="rect56" />
+ <path
+ fill="none"
+ stroke="#0000cd"
+ d="m 25260,11068 c 750,0 4732,2497 -7801,2534"
+ id="path56" />
+ <path
+ fill="#0000cd"
+ stroke="none"
+ d="m 17475,13752 -300,-150 300,-150 z"
+ id="path57" />
+ </g>
+ </g>
+ <g
+ class="com.sun.star.drawing.ConnectorShape"
+ id="g59">
+ <g
+ id="id10">
+ <rect
+ class="BoundingBox"
+ stroke="none"
+ fill="none"
+ x="10842"
+ y="13452"
+ width="1254"
+ height="301"
+ id="rect57" />
+ <path
+ fill="none"
+ stroke="#000000"
+ d="m 10843,13602 h 972"
+ id="path58" />
+ <path
+ fill="#000000"
+ stroke="none"
+ d="m 11795,13452 300,150 -300,150 z"
+ id="path59" />
+ </g>
+ </g>
+ <g
+ class="com.sun.star.drawing.ConnectorShape"
+ id="g61">
+ <g
+ id="id11">
+ <rect
+ class="BoundingBox"
+ stroke="none"
+ fill="none"
+ x="17174"
+ y="10947"
+ width="2372"
+ height="2657"
+ id="rect59" />
+ <path
+ fill="none"
+ stroke="#000000"
+ d="m 17175,13602 c 1777,0 721,-2248 2089,-2509"
+ id="path60" />
+ <path
+ fill="#000000"
+ stroke="none"
+ d="m 19232,10947 313,121 -284,178 z"
+ id="path61" />
+ </g>
+ </g>
+ <g
+ class="com.sun.star.drawing.ConnectorShape"
+ id="g63">
+ <g
+ id="id12">
+ <rect
+ class="BoundingBox"
+ stroke="none"
+ fill="none"
+ x="17174"
+ y="13601"
+ width="2372"
+ height="5593"
+ id="rect61" />
+ <path
+ fill="none"
+ stroke="#000000"
+ d="m 17175,13602 c 1777,0 709,4938 2115,5454"
+ id="path62" />
+ <path
+ fill="#000000"
+ stroke="none"
+ d="m 19277,18898 268,202 -322,93 z"
+ id="path63" />
+ </g>
+ </g>
+ <g
+ class="com.sun.star.drawing.ConnectorShape"
+ id="g65">
+ <g
+ id="id13">
+ <rect
+ class="BoundingBox"
+ stroke="none"
+ fill="none"
+ x="22243"
+ y="15879"
+ width="3288"
+ height="2271"
+ id="rect63" />
+ <path
+ fill="none"
+ stroke="#000000"
+ d="m 22244,18148 c 0,-1416 1001,-2059 3003,-2119"
+ id="path64" />
+ <path
+ fill="#000000"
+ stroke="none"
+ d="m 25228,15880 302,145 -298,155 z"
+ id="path65" />
+ </g>
+ </g>
+ <g
+ class="com.sun.star.drawing.ConnectorShape"
+ id="g67">
+ <g
+ id="id14">
+ <rect
+ class="BoundingBox"
+ stroke="none"
+ fill="none"
+ x="22243"
+ y="20052"
+ width="3288"
+ height="2352"
+ id="rect65" />
+ <path
+ fill="none"
+ stroke="#000000"
+ d="m 22244,20053 c 0,1470 1001,2138 3003,2200"
+ id="path66" />
+ <path
+ fill="#000000"
+ stroke="none"
+ d="m 25232,22102 298,155 -302,145 z"
+ id="path67" />
+ </g>
+ </g>
+ <g
+ class="com.sun.star.drawing.ConnectorShape"
+ id="g69">
+ <g
+ id="id15">
+ <rect
+ class="BoundingBox"
+ stroke="none"
+ fill="none"
+ x="24943"
+ y="18950"
+ width="7355"
+ height="3309"
+ id="rect67" />
+ <path
+ fill="none"
+ stroke="#0000cd"
+ d="m 31245,22257 c 750,0 3842,-3098 -6017,-3156"
+ id="path68" />
+ <path
+ fill="#0000cd"
+ stroke="none"
+ d="m 25243,19251 -300,-151 300,-149 z"
+ id="path69" />
+ </g>
+ </g>
+ <g
+ class="com.sun.star.drawing.ConnectorShape"
+ id="g71">
+ <g
+ id="id16">
+ <rect
+ class="BoundingBox"
+ stroke="none"
+ fill="none"
+ x="24943"
+ y="16024"
+ width="7355"
+ height="3227"
+ id="rect69" />
+ <path
+ fill="none"
+ stroke="#0000cd"
+ d="m 31245,16025 c 750,0 3842,3017 -6017,3074"
+ id="path70" />
+ <path
+ fill="#0000cd"
+ stroke="none"
+ d="m 25243,19249 -300,-149 300,-151 z"
+ id="path71" />
+ </g>
+ </g>
+ <g
+ class="com.sun.star.drawing.ConnectorShape"
+ id="g73">
+ <g
+ id="id17">
+ <rect
+ class="BoundingBox"
+ stroke="none"
+ fill="none"
+ x="14634"
+ y="9191"
+ width="15301"
+ height="3461"
+ id="rect71" />
+ <path
+ fill="none"
+ stroke="#0000cd"
+ d="m 14635,12650 c 0,-4704 13968,-3491 15211,-2738"
+ id="path72" />
+ <path
+ fill="#0000cd"
+ stroke="none"
+ d="m 29840,9693 94,322 -314,-118 z"
+ id="path73" />
+ </g>
+ </g>
+ <g
+ class="com.sun.star.drawing.CustomShape"
+ id="g77">
+ <g
+ id="id18">
+ <rect
+ class="BoundingBox"
+ stroke="none"
+ fill="none"
+ x="27550"
+ y="10014"
+ width="4767"
+ height="2226"
+ id="rect73" />
+ <path
+ fill="#ffffff"
+ stroke="none"
+ d="m 32315,11127 c 0,195 -110,386 -319,555 -209,169 -510,310 -872,407 -362,98 -773,149 -1191,149 -418,0 -829,-51 -1191,-149 -362,-97 -663,-238 -872,-407 -209,-169 -319,-360 -319,-555 0,-196 110,-387 319,-556 209,-169 510,-310 872,-407 362,-98 773,-149 1191,-149 418,0 829,51 1191,149 362,97 663,238 872,407 209,169 319,360 319,555 z"
+ id="path74" />
+ <path
+ fill="none"
+ stroke="#000000"
+ d="m 32315,11127 c 0,195 -110,386 -319,555 -209,169 -510,310 -872,407 -362,98 -773,149 -1191,149 -418,0 -829,-51 -1191,-149 -362,-97 -663,-238 -872,-407 -209,-169 -319,-360 -319,-555 0,-196 110,-387 319,-556 209,-169 510,-310 872,-407 362,-98 773,-149 1191,-149 418,0 829,51 1191,149 362,97 663,238 872,407 209,169 319,360 319,555 z"
+ id="path75" />
+ <text
+ class="SVGTextShape"
+ id="text77"><tspan
+ class="TextParagraph"
+ font-family="'Nimbus Sans', sans-serif"
+ font-size="635px"
+ font-weight="400"
+ id="tspan77"><tspan
+ class="TextPosition"
+ x="29036"
+ y="11269"
+ id="tspan76"><tspan
+ fill="#000000"
+ stroke="none"
+ style="white-space:pre"
+ id="tspan75">Result</tspan></tspan></tspan></text>
+ </g>
+ </g>
+ <g
+ class="com.sun.star.drawing.ConnectorShape"
+ id="g78">
+ <g
+ id="id19">
+ <rect
+ class="BoundingBox"
+ stroke="none"
+ fill="none"
+ x="14487"
+ y="14555"
+ width="7759"
+ height="6488"
+ id="rect77" />
+ <path
+ fill="none"
+ stroke="#0000cd"
+ d="m 22244,20053 c 0,750 -7457,3444 -7607,-5230"
+ id="path77" />
+ <path
+ fill="#0000cd"
+ stroke="none"
+ d="m 14488,14856 147,-301 153,299 z"
+ id="path78" />
+ </g>
+ </g>
+ </g>
+ </g>
+ </g>
+ </g>
+ </g>
+</svg>
diff --git a/doc/DoxygenLayout.xml b/doc/DoxygenLayout.xml
new file mode 100644
index 0000000000000000000000000000000000000000..1f6595aaee15833a279337d04eaeb803c348e32a
--- /dev/null
+++ b/doc/DoxygenLayout.xml
@@ -0,0 +1,265 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<doxygenlayout version="1.0">
+ <!-- Generated by doxygen 1.9.8 -->
+ <!-- Navigation index tabs for HTML output -->
+ <navindex>
+ <tab type="mainpage" visible="yes" title=""/>
+ <tab type="pages" visible="yes" title="" intro=""/>
+ <tab type="topics" visible="yes" title="Modules" intro="Here is a list of the modules in this project"/>
+ <tab type="modules" visible="yes" title="" intro="">
+ <tab type="modulelist" visible="yes" title="" intro=""/>
+ <tab type="modulemembers" visible="yes" title="" intro=""/>
+ </tab>
+ <tab type="namespaces" visible="yes" title="">
+ <tab type="namespacelist" visible="yes" title="" intro=""/>
+ <tab type="namespacemembers" visible="yes" title="" intro=""/>
+ </tab>
+ <tab type="concepts" visible="yes" title="">
+ </tab>
+ <tab type="interfaces" visible="yes" title="">
+ <tab type="interfacelist" visible="yes" title="" intro=""/>
+ <tab type="interfaceindex" visible="$ALPHABETICAL_INDEX" title=""/>
+ <tab type="interfacehierarchy" visible="yes" title="" intro=""/>
+ </tab>
+ <tab type="classes" visible="yes" title="">
+ <tab type="classlist" visible="yes" title="" intro=""/>
+ <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
+ <tab type="hierarchy" visible="yes" title="" intro=""/>
+ <tab type="classmembers" visible="yes" title="" intro=""/>
+ </tab>
+ <tab type="structs" visible="yes" title="">
+ <tab type="structlist" visible="yes" title="" intro=""/>
+ <tab type="structindex" visible="$ALPHABETICAL_INDEX" title=""/>
+ </tab>
+ <tab type="exceptions" visible="yes" title="">
+ <tab type="exceptionlist" visible="yes" title="" intro=""/>
+ <tab type="exceptionindex" visible="$ALPHABETICAL_INDEX" title=""/>
+ <tab type="exceptionhierarchy" visible="yes" title="" intro=""/>
+ </tab>
+ <tab type="files" visible="yes" title="">
+ <tab type="filelist" visible="yes" title="" intro=""/>
+ <tab type="globals" visible="yes" title="" intro=""/>
+ </tab>
+ <tab type="examples" visible="yes" title="" intro=""/>
+ </navindex>
+
+ <!-- Layout definition for a class page -->
+ <class>
+ <briefdescription visible="yes"/>
+ <includes visible="$SHOW_HEADERFILE"/>
+ <inheritancegraph visible="$CLASS_GRAPH"/>
+ <collaborationgraph visible="yes"/>
+ <memberdecl>
+ <nestedclasses visible="yes" title=""/>
+ <publictypes title=""/>
+ <services title=""/>
+ <interfaces title=""/>
+ <publicslots title=""/>
+ <signals title=""/>
+ <publicmethods title=""/>
+ <publicstaticmethods title=""/>
+ <publicattributes title=""/>
+ <publicstaticattributes title=""/>
+ <protectedtypes title=""/>
+ <protectedslots title=""/>
+ <protectedmethods title=""/>
+ <protectedstaticmethods title=""/>
+ <protectedattributes title=""/>
+ <protectedstaticattributes title=""/>
+ <packagetypes title=""/>
+ <packagemethods title=""/>
+ <packagestaticmethods title=""/>
+ <packageattributes title=""/>
+ <packagestaticattributes title=""/>
+ <properties title=""/>
+ <events title=""/>
+ <privatetypes title=""/>
+ <privateslots title=""/>
+ <privatemethods title=""/>
+ <privatestaticmethods title=""/>
+ <privateattributes title=""/>
+ <privatestaticattributes title=""/>
+ <friends title=""/>
+ <related title="" subtitle=""/>
+ <membergroups visible="yes"/>
+ </memberdecl>
+ <detaileddescription title=""/>
+ <memberdef>
+ <inlineclasses title=""/>
+ <typedefs title=""/>
+ <enums title=""/>
+ <services title=""/>
+ <interfaces title=""/>
+ <constructors title=""/>
+ <functions title=""/>
+ <related title=""/>
+ <variables title=""/>
+ <properties title=""/>
+ <events title=""/>
+ </memberdef>
+ <allmemberslink visible="yes"/>
+ <usedfiles visible="$SHOW_USED_FILES"/>
+ <authorsection visible="yes"/>
+ </class>
+
+ <!-- Layout definition for a namespace page -->
+ <namespace>
+ <briefdescription visible="yes"/>
+ <memberdecl>
+ <nestednamespaces visible="yes" title=""/>
+ <constantgroups visible="yes" title=""/>
+ <interfaces visible="yes" title=""/>
+ <classes visible="yes" title=""/>
+ <concepts visible="yes" title=""/>
+ <structs visible="yes" title=""/>
+ <exceptions visible="yes" title=""/>
+ <typedefs title=""/>
+ <sequences title=""/>
+ <dictionaries title=""/>
+ <enums title=""/>
+ <functions title=""/>
+ <variables title=""/>
+ <membergroups visible="yes"/>
+ </memberdecl>
+ <detaileddescription title=""/>
+ <memberdef>
+ <inlineclasses title=""/>
+ <typedefs title=""/>
+ <sequences title=""/>
+ <dictionaries title=""/>
+ <enums title=""/>
+ <functions title=""/>
+ <variables title=""/>
+ </memberdef>
+ <authorsection visible="yes"/>
+ </namespace>
+
+ <!-- Layout definition for a concept page -->
+ <concept>
+ <briefdescription visible="yes"/>
+ <includes visible="$SHOW_HEADERFILE"/>
+ <definition visible="yes" title=""/>
+ <detaileddescription title=""/>
+ <authorsection visible="yes"/>
+ </concept>
+
+ <!-- Layout definition for a file page -->
+ <file>
+ <briefdescription visible="yes"/>
+ <includes visible="$SHOW_INCLUDE_FILES"/>
+ <includegraph visible="yes"/>
+ <includedbygraph visible="yes"/>
+ <sourcelink visible="yes"/>
+ <memberdecl>
+ <interfaces visible="yes" title=""/>
+ <classes visible="yes" title=""/>
+ <structs visible="yes" title=""/>
+ <exceptions visible="yes" title=""/>
+ <namespaces visible="yes" title=""/>
+ <concepts visible="yes" title=""/>
+ <constantgroups visible="yes" title=""/>
+ <defines title=""/>
+ <typedefs title=""/>
+ <sequences title=""/>
+ <dictionaries title=""/>
+ <enums title=""/>
+ <functions title=""/>
+ <variables title=""/>
+ <membergroups visible="yes"/>
+ </memberdecl>
+ <detaileddescription title=""/>
+ <memberdef>
+ <inlineclasses title=""/>
+ <defines title=""/>
+ <typedefs title=""/>
+ <sequences title=""/>
+ <dictionaries title=""/>
+ <enums title=""/>
+ <functions title=""/>
+ <variables title=""/>
+ </memberdef>
+ <authorsection/>
+ </file>
+
+ <!-- Layout definition for a group page -->
+ <group>
+ <briefdescription visible="yes"/>
+ <groupgraph visible="yes"/>
+ <memberdecl>
+ <nestedgroups visible="yes" title=""/>
+ <modules visible="yes" title=""/>
+ <dirs visible="yes" title=""/>
+ <files visible="yes" title=""/>
+ <namespaces visible="yes" title=""/>
+ <concepts visible="yes" title=""/>
+ <classes visible="yes" title=""/>
+ <defines title=""/>
+ <typedefs title=""/>
+ <sequences title=""/>
+ <dictionaries title=""/>
+ <enums title=""/>
+ <enumvalues title=""/>
+ <functions title=""/>
+ <variables title=""/>
+ <signals title=""/>
+ <publicslots title=""/>
+ <protectedslots title=""/>
+ <privateslots title=""/>
+ <events title=""/>
+ <properties title=""/>
+ <friends title=""/>
+ <membergroups visible="yes"/>
+ </memberdecl>
+ <detaileddescription title=""/>
+ <memberdef>
+ <pagedocs/>
+ <inlineclasses title=""/>
+ <defines title=""/>
+ <typedefs title=""/>
+ <sequences title=""/>
+ <dictionaries title=""/>
+ <enums title=""/>
+ <enumvalues title=""/>
+ <functions title=""/>
+ <variables title=""/>
+ <signals title=""/>
+ <publicslots title=""/>
+ <protectedslots title=""/>
+ <privateslots title=""/>
+ <events title=""/>
+ <properties title=""/>
+ <friends title=""/>
+ </memberdef>
+ <authorsection visible="yes"/>
+ </group>
+
+ <!-- Layout definition for a C++20 module page -->
+ <module>
+ <briefdescription visible="yes"/>
+ <exportedmodules visible="yes"/>
+ <memberdecl>
+ <concepts visible="yes" title=""/>
+ <classes visible="yes" title=""/>
+ <enums title=""/>
+ <typedefs title=""/>
+ <functions title=""/>
+ <variables title=""/>
+ <membergroups title=""/>
+ </memberdecl>
+ <detaileddescription title=""/>
+ <memberdecl>
+ <files visible="yes"/>
+ </memberdecl>
+ </module>
+
+ <!-- Layout definition for a directory page -->
+ <directory>
+ <briefdescription visible="yes"/>
+ <directorygraph visible="yes"/>
+ <memberdecl>
+ <dirs visible="yes"/>
+ <files visible="yes"/>
+ </memberdecl>
+ <detaileddescription title=""/>
+ </directory>
+</doxygenlayout>
diff --git a/doc/TorchExecution.odg b/doc/TorchExecution.odg
new file mode 100644
index 0000000000000000000000000000000000000000..a85663ac5cf95a35046ab94762ab86b83cd677b8
Binary files /dev/null and b/doc/TorchExecution.odg differ
diff --git a/doc/TorchExecution.svg b/doc/TorchExecution.svg
new file mode 100644
index 0000000000000000000000000000000000000000..f3fefd112d94fba38c8cb368d1a6b0030a5e205d
--- /dev/null
+++ b/doc/TorchExecution.svg
@@ -0,0 +1,933 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+ version="1.2"
+ width="346.52222mm"
+ height="67.722221mm"
+ viewBox="0 0 34652.222 6772.2221"
+ preserveAspectRatio="xMidYMid"
+ fill-rule="evenodd"
+ stroke-width="28.222"
+ stroke-linejoin="round"
+ xml:space="preserve"
+ id="svg97"
+ sodipodi:docname="TorchExecution.svg"
+ inkscape:version="1.3.2 (091e20ef0f, 2023-11-25, custom)"
+ xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+ xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+ xmlns="http://www.w3.org/2000/svg"
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns:ooo="http://xml.openoffice.org/svg/export"><sodipodi:namedview
+ id="namedview97"
+ pagecolor="#ffffff"
+ bordercolor="#000000"
+ borderopacity="0.25"
+ inkscape:showpageshadow="2"
+ inkscape:pageopacity="0.0"
+ inkscape:pagecheckerboard="0"
+ inkscape:deskcolor="#d1d1d1"
+ inkscape:document-units="mm"
+ inkscape:zoom="0.72886409"
+ inkscape:cx="646.89701"
+ inkscape:cy="185.21972"
+ inkscape:window-width="1882"
+ inkscape:window-height="1054"
+ inkscape:window-x="1920"
+ inkscape:window-y="0"
+ inkscape:window-maximized="1"
+ inkscape:current-layer="svg97" />
+ <defs
+ class="ClipPathGroup"
+ id="defs2">
+ <clipPath
+ id="presentation_clip_path"
+ clipPathUnits="userSpaceOnUse">
+ <rect
+ x="0"
+ y="0"
+ width="42000"
+ height="29700"
+ id="rect1" />
+ </clipPath>
+ <clipPath
+ id="presentation_clip_path_shrink"
+ clipPathUnits="userSpaceOnUse">
+ <rect
+ x="42"
+ y="29"
+ width="41916"
+ height="29641"
+ id="rect2" />
+ </clipPath>
+ </defs>
+ <defs
+ id="defs31">
+ <font
+ id="EmbeddedFont_1"
+ horiz-adv-x="2048"
+ horiz-origin-x="0"
+ horiz-origin-y="0"
+ vert-origin-x="512"
+ vert-origin-y="768"
+ vert-adv-y="1024">
+ <font-face
+ font-family="Nimbus Sans embedded"
+ units-per-em="2048"
+ font-weight="normal"
+ font-style="normal"
+ ascent="1482"
+ descent="556"
+ id="font-face2" />
+ <missing-glyph
+ horiz-adv-x="2048"
+ d="M 0,0 L 2047,0 2047,2047 0,2047 0,0 Z"
+ id="missing-glyph2" />
+ <glyph
+ unicode="”"
+ horiz-adv-x="557"
+ d="M 100,1452 L 100,1239 199,1239 C 201,1120 172,1065 100,1055 L 100,977 C 223,985 291,1081 291,1245 L 291,1452 100,1452 Z M 428,1452 L 428,1239 526,1239 C 528,1120 500,1065 428,1055 L 428,977 C 551,985 619,1081 619,1245 L 619,1452 428,1452 Z"
+ id="glyph2" />
+ <glyph
+ unicode="“"
+ horiz-adv-x="557"
+ d="M 289,977 L 289,1190 190,1190 C 188,1307 219,1364 289,1374 L 289,1452 C 168,1442 98,1346 98,1184 L 98,977 289,977 Z M 612,977 L 612,1190 514,1190 C 512,1307 543,1364 612,1374 L 612,1452 C 492,1442 422,1346 422,1184 L 422,977 612,977 Z"
+ id="glyph3" />
+ <glyph
+ unicode="w"
+ horiz-adv-x="1456"
+ d="M 1135,0 L 1450,1073 1257,1073 1044,238 834,1073 625,1073 420,238 201,1073 12,1073 324,0 516,0 723,842 940,0 1135,0 Z"
+ id="glyph4" />
+ <glyph
+ unicode="u"
+ horiz-adv-x="874"
+ d="M 987,0 L 987,1073 817,1073 817,465 C 817,246 702,102 524,102 389,102 303,184 303,313 L 303,1073 133,1073 133,246 C 133,68 266,-47 475,-47 633,-47 733,8 834,150 L 834,0 987,0 Z"
+ id="glyph5" />
+ <glyph
+ unicode="t"
+ horiz-adv-x="504"
+ d="M 520,1073 L 344,1073 344,1368 174,1368 174,1073 29,1073 29,934 174,934 174,123 C 174,12 248,-47 381,-47 426,-47 463,-43 520,-33 L 520,111 C 496,104 473,102 438,102 365,102 344,123 344,199 L 344,934 520,934 520,1073 Z"
+ id="glyph6" />
+ <glyph
+ unicode="s"
+ horiz-adv-x="901"
+ d="M 897,774 C 895,985 756,1104 508,1104 258,1104 96,975 96,776 96,608 182,528 436,467 L 596,428 C 715,399 762,356 762,281 762,178 662,111 512,111 420,111 342,137 299,182 272,213 260,244 250,319 L 70,319 C 78,72 217,-47 498,-47 768,-47 940,86 940,293 940,453 850,541 637,592 L 473,631 C 334,664 274,709 274,784 274,885 363,946 502,946 639,946 713,887 717,774 L 897,774 Z"
+ id="glyph7" />
+ <glyph
+ unicode="r"
+ horiz-adv-x="530"
+ d="M 141,1073 L 141,0 313,0 313,557 C 315,815 422,930 657,924 L 657,1098 C 629,1102 612,1104 592,1104 481,1104 397,1038 299,879 L 299,1073 141,1073 Z"
+ id="glyph8" />
+ <glyph
+ unicode="p"
+ horiz-adv-x="980"
+ d="M 111,-446 L 283,-446 283,113 C 373,2 473,-47 612,-47 891,-47 1071,176 1071,518 1071,879 895,1104 610,1104 465,1104 348,1038 268,911 L 268,1073 111,1073 111,-446 Z M 582,944 C 770,944 893,778 893,522 893,279 768,113 582,113 399,113 283,276 283,528 283,780 399,944 582,944 Z"
+ id="glyph9" />
+ <glyph
+ unicode="o"
+ horiz-adv-x="1006"
+ d="M 557,1104 C 254,1104 74,889 74,528 74,166 254,-47 559,-47 862,-47 1044,168 1044,520 1044,893 868,1104 557,1104 Z M 559,946 C 752,946 866,788 866,522 866,268 748,111 559,111 369,111 252,268 252,528 252,788 369,946 559,946 Z"
+ id="glyph10" />
+ <glyph
+ unicode="m"
+ horiz-adv-x="1430"
+ d="M 143,1073 L 143,0 315,0 315,674 C 315,829 428,954 567,954 694,954 766,877 766,739 L 766,0 938,0 938,674 C 938,829 1051,954 1190,954 1315,954 1389,875 1389,739 L 1389,0 1561,0 1561,805 C 1561,997 1450,1104 1249,1104 1106,1104 1020,1061 920,940 856,1055 770,1104 631,1104 487,1104 391,1051 301,922 L 301,1073 143,1073 Z"
+ id="glyph11" />
+ <glyph
+ unicode="l"
+ horiz-adv-x="187"
+ d="M 311,1493 L 139,1493 139,0 311,0 311,1493 Z"
+ id="glyph12" />
+ <glyph
+ unicode="j"
+ horiz-adv-x="372"
+ d="M 143,1073 L 143,-156 C 143,-262 111,-297 4,-297 -8,-297 -14,-297 -37,-295 L -37,-440 C -16,-444 -6,-446 20,-446 213,-446 313,-371 313,-223 L 313,1073 143,1073 Z M 313,1493 L 143,1493 143,1278 313,1278 313,1493 Z"
+ id="glyph13" />
+ <glyph
+ unicode="i"
+ horiz-adv-x="187"
+ d="M 307,1073 L 137,1073 137,0 307,0 307,1073 Z M 307,1493 L 135,1493 135,1278 307,1278 307,1493 Z"
+ id="glyph14" />
+ <glyph
+ unicode="h"
+ horiz-adv-x="874"
+ d="M 143,1493 L 143,0 313,0 313,592 C 313,811 428,954 604,954 662,954 715,938 756,907 805,870 825,819 825,743 L 825,0 995,0 995,811 C 995,991 866,1104 657,1104 506,1104 414,1057 313,926 L 313,1493 143,1493 Z"
+ id="glyph15" />
+ <glyph
+ unicode="f"
+ horiz-adv-x="504"
+ d="M 528,1073 L 350,1073 350,1241 C 350,1313 389,1350 469,1350 483,1350 489,1350 528,1348 L 528,1489 C 489,1497 467,1499 432,1499 274,1499 180,1409 180,1255 L 180,1073 37,1073 37,934 180,934 180,0 350,0 350,934 528,934 528,1073 Z"
+ id="glyph16" />
+ <glyph
+ unicode="e"
+ horiz-adv-x="980"
+ d="M 1051,479 C 1051,643 1038,741 1008,821 938,997 774,1104 573,1104 274,1104 82,877 82,522 82,168 266,-47 569,-47 815,-47 985,92 1028,326 L 856,326 C 809,184 713,111 575,111 467,111 375,160 317,250 276,311 262,373 260,479 L 1051,479 Z M 264,619 C 279,817 399,946 571,946 745,946 866,811 866,619 L 264,619 Z"
+ id="glyph17" />
+ <glyph
+ unicode="d"
+ horiz-adv-x="980"
+ d="M 1014,1493 L 844,1493 844,938 C 772,1047 657,1104 514,1104 236,1104 53,881 53,539 53,176 229,-47 520,-47 668,-47 770,8 862,141 L 862,0 1014,0 1014,1493 Z M 543,944 C 727,944 844,782 844,524 844,276 725,113 545,113 356,113 231,279 231,528 231,778 356,944 543,944 Z"
+ id="glyph18" />
+ <glyph
+ unicode="c"
+ horiz-adv-x="927"
+ d="M 965,713 C 956,817 934,885 893,944 819,1044 690,1104 541,1104 250,1104 63,875 63,518 63,172 248,-47 539,-47 795,-47 956,107 977,369 L 805,369 C 776,197 688,111 543,111 354,111 242,264 242,518 242,786 352,946 539,946 682,946 772,862 793,713 L 965,713 Z"
+ id="glyph19" />
+ <glyph
+ unicode="b"
+ horiz-adv-x="980"
+ d="M 111,1493 L 111,0 264,0 264,137 C 346,12 455,-47 604,-47 887,-47 1071,184 1071,541 1071,889 897,1104 612,1104 465,1104 360,1049 281,928 L 281,1493 111,1493 Z M 580,944 C 770,944 893,778 893,522 893,279 766,113 580,113 397,113 281,276 281,528 281,780 397,944 580,944 Z"
+ id="glyph20" />
+ <glyph
+ unicode="a"
+ horiz-adv-x="1033"
+ d="M 1096,100 C 1077,96 1069,96 1059,96 999,96 967,127 967,180 L 967,811 C 967,1001 827,1104 563,1104 406,1104 281,1059 207,979 158,924 137,862 133,756 L 305,756 C 319,887 397,946 557,946 713,946 797,889 797,786 L 797,741 C 795,668 758,641 619,623 377,592 340,584 274,557 150,504 86,410 86,270 86,76 221,-47 438,-47 573,-47 682,0 803,111 815,0 868,-47 979,-47 1016,-47 1038,-43 1096,-29 L 1096,100 Z M 797,338 C 797,281 780,246 729,199 659,135 575,102 475,102 342,102 264,166 264,274 264,387 338,444 522,471 705,496 739,504 797,530 L 797,338 Z"
+ id="glyph21" />
+ <glyph
+ unicode="T"
+ horiz-adv-x="1192"
+ d="M 725,1325 L 1214,1325 1214,1493 43,1493 43,1325 535,1325 535,0 725,0 725,1325 Z"
+ id="glyph22" />
+ <glyph
+ unicode="S"
+ horiz-adv-x="1192"
+ d="M 1221,1055 C 1221,1157 1214,1186 1182,1255 1100,1427 926,1518 674,1518 346,1518 143,1350 143,1079 143,897 240,782 436,731 L 807,633 C 997,584 1081,508 1081,391 1081,311 1038,229 975,184 915,141 821,121 700,121 537,121 428,160 356,246 301,311 276,383 279,475 L 98,475 C 100,338 127,248 186,166 289,25 461,-47 688,-47 866,-47 1012,-6 1108,68 1208,147 1272,281 1272,410 1272,594 1157,729 954,784 L 580,885 C 399,934 334,991 334,1106 334,1257 467,1358 668,1358 905,1358 1038,1251 1040,1055 L 1221,1055 Z"
+ id="glyph23" />
+ <glyph
+ unicode="M"
+ horiz-adv-x="1430"
+ d="M 958,0 L 1378,1251 1378,0 1559,0 1559,1493 1294,1493 860,193 418,1493 154,1493 154,0 334,0 334,1251 758,0 958,0 Z"
+ id="glyph24" />
+ <glyph
+ unicode="H"
+ horiz-adv-x="1165"
+ d="M 1128,680 L 1128,0 1319,0 1319,1493 1128,1493 1128,848 360,848 360,1493 170,1493 170,0 360,0 360,680 1128,680 Z"
+ id="glyph25" />
+ <glyph
+ unicode="G"
+ horiz-adv-x="1377"
+ d="M 1452,788 L 829,788 829,621 1284,621 1284,580 C 1284,313 1087,121 815,121 664,121 526,176 438,272 340,379 281,557 281,741 281,1108 489,1350 805,1350 1032,1350 1196,1233 1237,1040 L 1432,1040 C 1378,1343 1149,1518 807,1518 625,1518 477,1470 360,1374 186,1231 90,999 90,731 90,272 371,-47 774,-47 977,-47 1137,29 1284,190 L 1331,-8 1452,-8 1452,788 Z"
+ id="glyph26" />
+ <glyph
+ unicode="C"
+ horiz-adv-x="1324"
+ d="M 1356,1030 C 1296,1358 1108,1518 780,1518 580,1518 418,1454 307,1331 172,1184 98,971 98,729 98,483 174,272 313,127 430,8 578,-47 772,-47 1137,-47 1341,150 1387,545 L 1190,545 C 1174,442 1153,373 1122,313 1061,190 934,121 774,121 477,121 289,358 289,731 289,1114 467,1350 758,1350 879,1350 991,1315 1053,1255 1108,1204 1139,1143 1161,1030 L 1356,1030 Z"
+ id="glyph27" />
+ <glyph
+ unicode=":"
+ horiz-adv-x="239"
+ d="M 438,213 L 225,213 225,0 438,0 438,213 Z M 438,1073 L 225,1073 225,860 438,860 438,1073 Z"
+ id="glyph28" />
+ <glyph
+ unicode="/"
+ horiz-adv-x="609"
+ d="M 469,1493 L -16,-41 96,-41 582,1493 469,1493 Z"
+ id="glyph29" />
+ <glyph
+ unicode="-"
+ horiz-adv-x="504"
+ d="M 582,639 L 94,639 94,492 582,492 582,639 Z"
+ id="glyph30" />
+ <glyph
+ unicode=" "
+ horiz-adv-x="556"
+ id="glyph31" />
+ </font>
+ </defs>
+ <defs
+ class="TextShapeIndex"
+ id="defs32">
+ <g
+ ooo:slide="id1"
+ ooo:id-list="id3 id4 id5 id6 id7 id8 id9 id10 id11 id12 id13 id14 id15 id16 id17"
+ id="g31" />
+ </defs>
+ <defs
+ class="EmbeddedBulletChars"
+ id="defs41">
+ <g
+ id="bullet-char-template-57356"
+ transform="matrix(4.8828125e-4,0,0,-4.8828125e-4,0,0)">
+ <path
+ d="M 580,1141 1163,571 580,0 -4,571 Z"
+ id="path32" />
+ </g>
+ <g
+ id="bullet-char-template-57354"
+ transform="matrix(4.8828125e-4,0,0,-4.8828125e-4,0,0)">
+ <path
+ d="M 8,1128 H 1137 V 0 H 8 Z"
+ id="path33" />
+ </g>
+ <g
+ id="bullet-char-template-10146"
+ transform="matrix(4.8828125e-4,0,0,-4.8828125e-4,0,0)">
+ <path
+ d="M 174,0 602,739 174,1481 1456,739 Z M 1358,739 309,1346 659,739 Z"
+ id="path34" />
+ </g>
+ <g
+ id="bullet-char-template-10132"
+ transform="matrix(4.8828125e-4,0,0,-4.8828125e-4,0,0)">
+ <path
+ d="M 2015,739 1276,0 H 717 l 543,543 H 174 v 393 h 1086 l -543,545 h 557 z"
+ id="path35" />
+ </g>
+ <g
+ id="bullet-char-template-10007"
+ transform="matrix(4.8828125e-4,0,0,-4.8828125e-4,0,0)">
+ <path
+ d="m 0,-2 c -7,16 -16,29 -25,39 l 381,530 c -94,256 -141,385 -141,387 0,25 13,38 40,38 9,0 21,-2 34,-5 21,4 42,12 65,25 l 27,-13 111,-251 280,301 64,-25 24,25 c 21,-10 41,-24 62,-43 C 886,937 835,863 770,784 769,783 710,716 594,584 L 774,223 c 0,-27 -21,-55 -63,-84 l 16,-20 C 717,90 699,76 672,76 641,76 570,178 457,381 L 164,-76 c -22,-34 -53,-51 -92,-51 -42,0 -63,17 -64,51 -7,9 -10,24 -10,44 0,9 1,19 2,30 z"
+ id="path36" />
+ </g>
+ <g
+ id="bullet-char-template-10004"
+ transform="matrix(4.8828125e-4,0,0,-4.8828125e-4,0,0)">
+ <path
+ d="M 285,-33 C 182,-33 111,30 74,156 52,228 41,333 41,471 c 0,78 14,145 41,201 34,71 87,106 158,106 53,0 88,-31 106,-94 l 23,-176 c 8,-64 28,-97 59,-98 l 735,706 c 11,11 33,17 66,17 42,0 63,-15 63,-46 V 965 c 0,-36 -10,-64 -30,-84 L 442,47 C 390,-6 338,-33 285,-33 Z"
+ id="path37" />
+ </g>
+ <g
+ id="bullet-char-template-9679"
+ transform="matrix(4.8828125e-4,0,0,-4.8828125e-4,0,0)">
+ <path
+ d="M 813,0 C 632,0 489,54 383,161 276,268 223,411 223,592 c 0,181 53,324 160,431 106,107 249,161 430,161 179,0 323,-54 432,-161 108,-107 162,-251 162,-431 0,-180 -54,-324 -162,-431 C 1136,54 992,0 813,0 Z"
+ id="path38" />
+ </g>
+ <g
+ id="bullet-char-template-8226"
+ transform="matrix(4.8828125e-4,0,0,-4.8828125e-4,0,0)">
+ <path
+ d="m 346,457 c -73,0 -137,26 -191,78 -54,51 -81,114 -81,188 0,73 27,136 81,188 54,52 118,78 191,78 73,0 134,-26 185,-79 51,-51 77,-114 77,-187 0,-75 -25,-137 -76,-188 -50,-52 -112,-78 -186,-78 z"
+ id="path39" />
+ </g>
+ <g
+ id="bullet-char-template-8211"
+ transform="matrix(4.8828125e-4,0,0,-4.8828125e-4,0,0)">
+ <path
+ d="M -4,459 H 1135 V 606 H -4 Z"
+ id="path40" />
+ </g>
+ <g
+ id="bullet-char-template-61548"
+ transform="matrix(4.8828125e-4,0,0,-4.8828125e-4,0,0)">
+ <path
+ d="m 173,740 c 0,163 58,303 173,419 116,115 255,173 419,173 163,0 302,-58 418,-173 116,-116 174,-256 174,-419 0,-163 -58,-303 -174,-418 C 1067,206 928,148 765,148 601,148 462,206 346,322 231,437 173,577 173,740 Z"
+ id="path41" />
+ </g>
+ </defs>
+ <g
+ id="g41"
+ transform="translate(-3871.889,-9956.889)">
+ <g
+ id="id2"
+ class="Master_Slide">
+ <g
+ id="bg-id2"
+ class="Background" />
+ <g
+ id="bo-id2"
+ class="BackgroundObjects" />
+ </g>
+ </g>
+ <g
+ class="SlideGroup"
+ id="g97"
+ transform="translate(-3871.889,-9956.889)">
+ <g
+ id="g96">
+ <g
+ id="container-id1">
+ <g
+ id="id1"
+ class="Slide"
+ clip-path="url(#presentation_clip_path)">
+ <g
+ class="Page"
+ id="g95">
+ <g
+ class="com.sun.star.drawing.CustomShape"
+ id="g49">
+ <g
+ id="id3">
+ <rect
+ class="BoundingBox"
+ stroke="none"
+ fill="none"
+ x="3885"
+ y="9970"
+ width="4767"
+ height="2226"
+ id="rect41" />
+ <path
+ fill="#ffffff"
+ stroke="none"
+ d="m 8650,11083 c 0,195 -110,386 -319,555 -209,169 -510,310 -872,407 -362,98 -773,149 -1191,149 -418,0 -829,-51 -1191,-149 -362,-97 -663,-238 -872,-407 -209,-169 -319,-360 -319,-555 0,-196 110,-387 319,-556 209,-169 510,-310 872,-407 362,-98 773,-149 1191,-149 418,0 829,51 1191,149 362,97 663,238 872,407 209,169 319,360 319,556 z"
+ id="path42" />
+ <path
+ fill="none"
+ stroke="#000000"
+ d="m 8650,11083 c 0,195 -110,386 -319,555 -209,169 -510,310 -872,407 -362,98 -773,149 -1191,149 -418,0 -829,-51 -1191,-149 -362,-97 -663,-238 -872,-407 -209,-169 -319,-360 -319,-555 0,-196 110,-387 319,-556 209,-169 510,-310 872,-407 362,-98 773,-149 1191,-149 418,0 829,51 1191,149 362,97 663,238 872,407 209,169 319,360 319,556 z"
+ id="path43" />
+ <text
+ class="SVGTextShape"
+ id="text49"><tspan
+ class="TextParagraph"
+ font-family="'Nimbus Sans', sans-serif"
+ font-size="635px"
+ font-weight="400"
+ id="tspan45"><tspan
+ class="TextPosition"
+ x="5405"
+ y="10908"
+ id="tspan44"><tspan
+ fill="#000000"
+ stroke="none"
+ style="white-space:pre"
+ id="tspan43">Model</tspan></tspan></tspan><tspan
+ class="TextParagraph"
+ font-family="'Nimbus Sans', sans-serif"
+ font-size="635px"
+ font-weight="400"
+ id="tspan49"><tspan
+ class="TextPosition"
+ x="5593"
+ y="11543"
+ id="tspan48"><tspan
+ fill="#000000"
+ stroke="none"
+ style="white-space:pre"
+ id="tspan46">“</tspan><tspan
+ fill="#000000"
+ stroke="none"
+ style="white-space:pre"
+ id="tspan47">r-rc”</tspan></tspan></tspan></text>
+ </g>
+ </g>
+ <g
+ class="com.sun.star.drawing.CustomShape"
+ id="g55">
+ <g
+ id="id4">
+ <rect
+ class="BoundingBox"
+ stroke="none"
+ fill="none"
+ x="31657"
+ y="9970"
+ width="4767"
+ height="2226"
+ id="rect49" />
+ <path
+ fill="#ffffff"
+ stroke="none"
+ d="m 36422,11083 c 0,195 -110,386 -319,555 -209,169 -510,310 -872,407 -362,98 -773,149 -1191,149 -418,0 -829,-51 -1191,-149 -362,-97 -663,-238 -872,-407 -209,-169 -319,-360 -319,-555 0,-196 110,-387 319,-556 209,-169 510,-310 872,-407 362,-98 773,-149 1191,-149 418,0 829,51 1191,149 362,97 663,238 872,407 209,169 319,360 319,556 z"
+ id="path49" />
+ <path
+ fill="none"
+ stroke="#000000"
+ d="m 36422,11083 c 0,195 -110,386 -319,555 -209,169 -510,310 -872,407 -362,98 -773,149 -1191,149 -418,0 -829,-51 -1191,-149 -362,-97 -663,-238 -872,-407 -209,-169 -319,-360 -319,-555 0,-196 110,-387 319,-556 209,-169 510,-310 872,-407 362,-98 773,-149 1191,-149 418,0 829,51 1191,149 362,97 663,238 872,407 209,169 319,360 319,556 z"
+ id="path50" />
+ <text
+ class="SVGTextShape"
+ id="text55"><tspan
+ class="TextParagraph"
+ font-family="'Nimbus Sans', sans-serif"
+ font-size="635px"
+ font-weight="400"
+ id="tspan52"><tspan
+ class="TextPosition"
+ x="32720"
+ y="10908"
+ id="tspan51"><tspan
+ fill="#000000"
+ stroke="none"
+ style="white-space:pre"
+ id="tspan50">Hip/Cuda</tspan></tspan></tspan><tspan
+ class="TextParagraph"
+ font-family="'Nimbus Sans', sans-serif"
+ font-size="635px"
+ font-weight="400"
+ id="tspan55"><tspan
+ class="TextPosition"
+ x="32663"
+ y="11543"
+ id="tspan54"><tspan
+ fill="#000000"
+ stroke="none"
+ style="white-space:pre"
+ id="tspan53">Gpu code</tspan></tspan></tspan></text>
+ </g>
+ </g>
+ <g
+ class="com.sun.star.drawing.CustomShape"
+ id="g58">
+ <g
+ id="id5">
+ <rect
+ class="BoundingBox"
+ stroke="none"
+ fill="none"
+ x="9906"
+ y="9970"
+ width="5901"
+ height="2225"
+ id="rect55" />
+ <path
+ fill="#ffffff"
+ stroke="none"
+ d="M 12856,12193 H 9907 V 9971 h 5898 v 2222 z"
+ id="path55" />
+ <path
+ fill="none"
+ stroke="#000000"
+ d="M 12856,12193 H 9907 V 9971 h 5898 v 2222 z"
+ id="path56" />
+ <text
+ class="SVGTextShape"
+ id="text58"><tspan
+ class="TextParagraph"
+ font-family="'Nimbus Sans', sans-serif"
+ font-size="635px"
+ font-weight="400"
+ id="tspan58"><tspan
+ class="TextPosition"
+ x="10307"
+ y="11225"
+ id="tspan57"><tspan
+ fill="#000000"
+ stroke="none"
+ style="white-space:pre"
+ id="tspan56">Model::torchScript</tspan></tspan></tspan></text>
+ </g>
+ </g>
+ <g
+ class="com.sun.star.drawing.CustomShape"
+ id="g65">
+ <g
+ id="id6">
+ <rect
+ class="BoundingBox"
+ stroke="none"
+ fill="none"
+ x="17168"
+ y="10020"
+ width="7090"
+ height="2126"
+ id="rect58" />
+ <path
+ fill="#ffffff"
+ stroke="none"
+ d="m 24256,11083 c 0,186 -164,369 -475,530 -311,162 -758,296 -1297,389 -538,93 -1149,142 -1771,142 -623,0 -1234,-49 -1772,-142 -539,-93 -986,-227 -1297,-389 -311,-161 -475,-344 -475,-530 0,-187 164,-370 475,-531 311,-162 758,-296 1297,-389 538,-93 1149,-142 1771,-142 623,0 1234,49 1772,142 539,93 986,227 1297,389 311,161 475,344 475,530 z"
+ id="path58" />
+ <path
+ fill="none"
+ stroke="#000000"
+ d="m 24256,11083 c 0,186 -164,369 -475,530 -311,162 -758,296 -1297,389 -538,93 -1149,142 -1771,142 -623,0 -1234,-49 -1772,-142 -539,-93 -986,-227 -1297,-389 -311,-161 -475,-344 -475,-530 0,-187 164,-370 475,-531 311,-162 758,-296 1297,-389 538,-93 1149,-142 1771,-142 623,0 1234,49 1772,142 539,93 986,227 1297,389 311,161 475,344 475,530 z"
+ id="path59" />
+ <text
+ class="SVGTextShape"
+ id="text65"><tspan
+ class="TextParagraph"
+ font-family="'Nimbus Sans', sans-serif"
+ font-size="635px"
+ font-weight="400"
+ id="tspan61"><tspan
+ class="TextPosition"
+ x="18667"
+ y="10908"
+ id="tspan60"><tspan
+ fill="#000000"
+ stroke="none"
+ style="white-space:pre"
+ id="tspan59">TorchScript for</tspan></tspan></tspan><tspan
+ class="TextParagraph"
+ font-family="'Nimbus Sans', sans-serif"
+ font-size="635px"
+ font-weight="400"
+ id="tspan65"><tspan
+ class="TextPosition"
+ x="20038"
+ y="11543"
+ id="tspan64"><tspan
+ fill="#000000"
+ stroke="none"
+ style="white-space:pre"
+ id="tspan62">“</tspan><tspan
+ fill="#000000"
+ stroke="none"
+ style="white-space:pre"
+ id="tspan63">r-rc”</tspan></tspan></tspan></text>
+ </g>
+ </g>
+ <g
+ class="com.sun.star.drawing.CustomShape"
+ id="g68">
+ <g
+ id="id7">
+ <rect
+ class="BoundingBox"
+ stroke="none"
+ fill="none"
+ x="25454"
+ y="9970"
+ width="5275"
+ height="2225"
+ id="rect65" />
+ <path
+ fill="#ffffff"
+ stroke="none"
+ d="M 28091,12193 H 25455 V 9971 h 5272 v 2222 z"
+ id="path65" />
+ <path
+ fill="none"
+ stroke="#000000"
+ d="M 28091,12193 H 25455 V 9971 h 5272 v 2222 z"
+ id="path66" />
+ <text
+ class="SVGTextShape"
+ id="text68"><tspan
+ class="TextParagraph"
+ font-family="'Nimbus Sans', sans-serif"
+ font-size="635px"
+ font-weight="400"
+ id="tspan68"><tspan
+ class="TextPosition"
+ x="25715"
+ y="11225"
+ id="tspan67"><tspan
+ fill="#000000"
+ stroke="none"
+ style="white-space:pre"
+ id="tspan66">torch::jit::compile</tspan></tspan></tspan></text>
+ </g>
+ </g>
+ <g
+ class="com.sun.star.drawing.ConnectorShape"
+ id="g69">
+ <g
+ id="id8">
+ <rect
+ class="BoundingBox"
+ stroke="none"
+ fill="none"
+ x="8649"
+ y="10932"
+ width="1259"
+ height="301"
+ id="rect68" />
+ <path
+ fill="none"
+ stroke="#000000"
+ d="m 8650,11082 h 977"
+ id="path68" />
+ <path
+ fill="#000000"
+ stroke="none"
+ d="m 9607,10932 300,150 -300,150 z"
+ id="path69" />
+ </g>
+ </g>
+ <g
+ class="com.sun.star.drawing.ConnectorShape"
+ id="g71">
+ <g
+ id="id9">
+ <rect
+ class="BoundingBox"
+ stroke="none"
+ fill="none"
+ x="15804"
+ y="10932"
+ width="1366"
+ height="301"
+ id="rect69" />
+ <path
+ fill="none"
+ stroke="#000000"
+ d="m 15805,11082 h 1084"
+ id="path70" />
+ <path
+ fill="#000000"
+ stroke="none"
+ d="m 16869,10932 300,150 -300,150 z"
+ id="path71" />
+ </g>
+ </g>
+ <g
+ class="com.sun.star.drawing.ConnectorShape"
+ id="g73">
+ <g
+ id="id10">
+ <rect
+ class="BoundingBox"
+ stroke="none"
+ fill="none"
+ x="24254"
+ y="10932"
+ width="1202"
+ height="301"
+ id="rect71" />
+ <path
+ fill="none"
+ stroke="#000000"
+ d="m 24255,11082 h 920"
+ id="path72" />
+ <path
+ fill="#000000"
+ stroke="none"
+ d="m 25155,10932 300,150 -300,150 z"
+ id="path73" />
+ </g>
+ </g>
+ <g
+ class="com.sun.star.drawing.ConnectorShape"
+ id="g75">
+ <g
+ id="id11">
+ <rect
+ class="BoundingBox"
+ stroke="none"
+ fill="none"
+ x="30726"
+ y="10932"
+ width="934"
+ height="301"
+ id="rect73" />
+ <path
+ fill="none"
+ stroke="#000000"
+ d="m 30727,11082 h 652"
+ id="path74" />
+ <path
+ fill="#000000"
+ stroke="none"
+ d="m 31359,10932 300,150 -300,150 z"
+ id="path75" />
+ </g>
+ </g>
+ <g
+ class="com.sun.star.drawing.CustomShape"
+ id="g79">
+ <g
+ id="id12">
+ <rect
+ class="BoundingBox"
+ stroke="none"
+ fill="none"
+ x="11005"
+ y="14491"
+ width="7438"
+ height="2225"
+ id="rect75" />
+ <path
+ fill="#ffffff"
+ stroke="none"
+ d="m 14724,16714 h -3718 v -2222 h 7435 v 2222 z"
+ id="path76" />
+ <path
+ fill="none"
+ stroke="#000000"
+ d="m 14724,16714 h -3718 v -2222 h 7435 v 2222 z"
+ id="path77" />
+ <text
+ class="SVGTextShape"
+ id="text79"><tspan
+ class="TextParagraph"
+ font-family="'Nimbus Sans', sans-serif"
+ font-size="635px"
+ font-weight="400"
+ id="tspan79"><tspan
+ class="TextPosition"
+ x="11575"
+ y="15746"
+ id="tspan78"><tspan
+ fill="#000000"
+ stroke="none"
+ style="white-space:pre"
+ id="tspan77">torch::module::forward</tspan></tspan></tspan></text>
+ </g>
+ </g>
+ <g
+ class="com.sun.star.drawing.CustomShape"
+ id="g82">
+ <g
+ id="id13">
+ <rect
+ class="BoundingBox"
+ stroke="none"
+ fill="none"
+ x="21405"
+ y="14491"
+ width="7438"
+ height="2225"
+ id="rect79" />
+ <path
+ fill="#ffffff"
+ stroke="none"
+ d="m 25124,16714 h -3718 v -2222 h 7435 v 2222 z"
+ id="path79" />
+ <path
+ fill="none"
+ stroke="#000000"
+ d="m 25124,16714 h -3718 v -2222 h 7435 v 2222 z"
+ id="path80" />
+ <text
+ class="SVGTextShape"
+ id="text82"><tspan
+ class="TextParagraph"
+ font-family="'Nimbus Sans', sans-serif"
+ font-size="635px"
+ font-weight="400"
+ id="tspan82"><tspan
+ class="TextPosition"
+ x="23101"
+ y="15746"
+ id="tspan81"><tspan
+ fill="#000000"
+ stroke="none"
+ style="white-space:pre"
+ id="tspan80">rocblas/cublas</tspan></tspan></tspan></text>
+ </g>
+ </g>
+ <g
+ class="com.sun.star.drawing.CustomShape"
+ id="g89">
+ <g
+ id="id14">
+ <rect
+ class="BoundingBox"
+ stroke="none"
+ fill="none"
+ x="33745"
+ y="14491"
+ width="4767"
+ height="2226"
+ id="rect82" />
+ <path
+ fill="#ffffff"
+ stroke="none"
+ d="m 38510,15604 c 0,195 -110,386 -319,555 -209,169 -510,310 -872,407 -362,98 -773,149 -1191,149 -418,0 -829,-51 -1191,-149 -362,-97 -663,-238 -872,-407 -209,-169 -319,-360 -319,-555 0,-196 110,-387 319,-556 209,-169 510,-310 872,-407 362,-98 773,-149 1191,-149 418,0 829,51 1191,149 362,97 663,238 872,407 209,169 319,360 319,556 z"
+ id="path82" />
+ <path
+ fill="none"
+ stroke="#000000"
+ d="m 38510,15604 c 0,195 -110,386 -319,555 -209,169 -510,310 -872,407 -362,98 -773,149 -1191,149 -418,0 -829,-51 -1191,-149 -362,-97 -663,-238 -872,-407 -209,-169 -319,-360 -319,-555 0,-196 110,-387 319,-556 209,-169 510,-310 872,-407 362,-98 773,-149 1191,-149 418,0 829,51 1191,149 362,97 663,238 872,407 209,169 319,360 319,556 z"
+ id="path83" />
+ <text
+ class="SVGTextShape"
+ id="text89"><tspan
+ class="TextParagraph"
+ font-family="'Nimbus Sans', sans-serif"
+ font-size="635px"
+ font-weight="400"
+ id="tspan85"><tspan
+ class="TextPosition"
+ x="35265"
+ y="15429"
+ id="tspan84"><tspan
+ fill="#000000"
+ stroke="none"
+ style="white-space:pre"
+ id="tspan83">Model</tspan></tspan></tspan><tspan
+ class="TextParagraph"
+ font-family="'Nimbus Sans', sans-serif"
+ font-size="635px"
+ font-weight="400"
+ id="tspan89"><tspan
+ class="TextPosition"
+ x="35453"
+ y="16064"
+ id="tspan88"><tspan
+ fill="#000000"
+ stroke="none"
+ style="white-space:pre"
+ id="tspan86">“</tspan><tspan
+ fill="#000000"
+ stroke="none"
+ style="white-space:pre"
+ id="tspan87">r-rc”</tspan></tspan></tspan></text>
+ </g>
+ </g>
+ <g
+ class="com.sun.star.drawing.ConnectorShape"
+ id="g90">
+ <g
+ id="id15">
+ <rect
+ class="BoundingBox"
+ stroke="none"
+ fill="none"
+ x="18441"
+ y="15453"
+ width="2967"
+ height="301"
+ id="rect89" />
+ <path
+ fill="none"
+ stroke="#000000"
+ d="m 18442,15603 h 2685"
+ id="path89" />
+ <path
+ fill="#000000"
+ stroke="none"
+ d="m 21107,15453 300,150 -300,150 z"
+ id="path90" />
+ </g>
+ </g>
+ <g
+ class="com.sun.star.drawing.ConnectorShape"
+ id="g92">
+ <g
+ id="id16">
+ <rect
+ class="BoundingBox"
+ stroke="none"
+ fill="none"
+ x="28841"
+ y="15453"
+ width="4907"
+ height="301"
+ id="rect90" />
+ <path
+ fill="none"
+ stroke="#000000"
+ d="m 28842,15603 h 4625"
+ id="path91" />
+ <path
+ fill="#000000"
+ stroke="none"
+ d="m 33447,15453 300,150 -300,150 z"
+ id="path92" />
+ </g>
+ </g>
+ <g
+ class="com.sun.star.drawing.ConnectorShape"
+ id="g94">
+ <g
+ id="id17">
+ <rect
+ class="BoundingBox"
+ stroke="none"
+ fill="none"
+ x="14683"
+ y="12192"
+ width="19360"
+ height="2301"
+ id="rect92" />
+ <path
+ fill="none"
+ stroke="#000000"
+ d="m 34041,12193 c 0,1725 -18256,638 -19273,2162"
+ id="path93" />
+ <path
+ fill="#000000"
+ stroke="none"
+ d="m 14966,14260 -242,232 -41,-333 z"
+ id="path94" />
+ </g>
+ </g>
+ </g>
+ </g>
+ </g>
+ </g>
+ </g>
+</svg>
diff --git a/doc/_r-c_r.svg b/doc/_r-c_r.svg
new file mode 100644
index 0000000000000000000000000000000000000000..2c7bb4cb21db45558f23939aaee8a23f2ac2016a
--- /dev/null
+++ b/doc/_r-c_r.svg
@@ -0,0 +1,632 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+
+<svg
+ width="32.0457mm"
+ height="18.419706mm"
+ viewBox="0 0 32.0457 18.419706"
+ version="1.1"
+ id="svg1"
+ inkscape:version="1.3.2 (091e20ef0f, 2023-11-25, custom)"
+ sodipodi:docname="--rc--r.svg"
+ xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+ xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+ xmlns="http://www.w3.org/2000/svg"
+ xmlns:svg="http://www.w3.org/2000/svg">
+ <sodipodi:namedview
+ id="namedview1"
+ pagecolor="#ffffff"
+ bordercolor="#000000"
+ borderopacity="0.25"
+ inkscape:showpageshadow="2"
+ inkscape:pageopacity="0.0"
+ inkscape:pagecheckerboard="0"
+ inkscape:deskcolor="#d1d1d1"
+ inkscape:document-units="mm"
+ inkscape:zoom="0.73940797"
+ inkscape:cx="-4.7335167"
+ inkscape:cy="-12.1719"
+ inkscape:window-width="1920"
+ inkscape:window-height="1054"
+ inkscape:window-x="0"
+ inkscape:window-y="0"
+ inkscape:window-maximized="1"
+ inkscape:current-layer="layer1" />
+ <defs
+ id="defs1" />
+ <g
+ inkscape:label="Layer 1"
+ inkscape:groupmode="layer"
+ id="layer1"
+ transform="translate(-106.09791,-151.87083)">
+ <g
+ id="g1337"
+ transform="translate(20.838315,13.572534)">
+ <g
+ id="g1336">
+ <g
+ id="g1335">
+ <g
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ id="g1005">
+ <g
+ id="g990" />
+ <g
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.254;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ id="g991">
+ <rect
+ x="101.6"
+ y="154.55901"
+ width="5.0799999"
+ height="2.0320001"
+ rx="0.000000"
+ id="rect990" />
+ </g>
+ <g
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ id="g1004">
+ <path
+ d="m 101.6,155.575 h -1.27"
+ id="path991" />
+ <path
+ d="m 106.68,155.575 h 1.27"
+ id="path992" />
+ <text
+ x="104.14"
+ y="152.39999"
+ textLength="1.4732"
+ font-size="1.6933px"
+ lengthAdjust="spacingAndGlyphs"
+ text-anchor="middle"
+ opacity="0"
+ id="text992">R</text>
+ <g
+ class="stroked-text"
+ id="g1003">
+ <desc
+ id="desc992">R</desc>
+ <path
+ d="m 104.533,152.3445 -0.4233,-0.6047"
+ id="path993" />
+ <path
+ d="m 103.8073,152.3445 v -1.27"
+ id="path994" />
+ <path
+ d="m 103.8073,151.0745 h 0.4838"
+ id="path995" />
+ <path
+ d="m 104.2911,151.0745 0.121,0.0605"
+ id="path996" />
+ <path
+ d="m 104.4121,151.135 0.0605,0.0605"
+ id="path997" />
+ <path
+ d="m 104.4726,151.1955 0.0604,0.1209"
+ id="path998" />
+ <path
+ d="m 104.533,151.3164 v 0.1815"
+ id="path999" />
+ <path
+ d="m 104.533,151.4979 -0.0604,0.1209"
+ id="path1000" />
+ <path
+ d="m 104.4726,151.6188 -0.0605,0.0605"
+ id="path1001" />
+ <path
+ d="m 104.4121,151.6793 -0.121,0.0605"
+ id="path1002" />
+ <path
+ d="m 104.2911,151.7398 h -0.4838"
+ id="path1003" />
+ </g>
+ </g>
+ </g>
+ <g
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ id="g1026">
+ <g
+ id="g1006" />
+ <g
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.508;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ id="g1007">
+ <path
+ style="fill:none;fill-opacity:0;stroke:#000000;stroke-width:0.508;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ d="m 104.902,146.177 v -4.064"
+ id="path1006" />
+ <path
+ style="fill:none;fill-opacity:0;stroke:#000000;stroke-width:0.508;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ d="m 103.378,146.177 v -4.064"
+ id="path1007" />
+ </g>
+ <g
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ id="g1025">
+ <path
+ d="M 103.124,144.145 H 100.33"
+ id="path1008" />
+ <path
+ d="m 105.156,144.145 h 2.794"
+ id="path1009" />
+ <text
+ x="104.14"
+ y="139.7"
+ textLength="1.4732"
+ font-size="1.6933px"
+ lengthAdjust="spacingAndGlyphs"
+ text-anchor="middle"
+ opacity="0"
+ id="text1009">C</text>
+ <g
+ class="stroked-text"
+ id="g1024">
+ <desc
+ id="desc1009">C</desc>
+ <path
+ d="m 104.533,139.5236 -0.0604,0.0605"
+ id="path1010" />
+ <path
+ d="m 104.4726,139.5841 -0.1815,0.0604"
+ id="path1011" />
+ <path
+ d="m 104.2911,139.6445 h -0.1209"
+ id="path1012" />
+ <path
+ d="m 104.1702,139.6445 -0.1814,-0.0604"
+ id="path1013" />
+ <path
+ d="m 103.9888,139.5841 -0.121,-0.121"
+ id="path1014" />
+ <path
+ d="m 103.8678,139.4631 -0.0605,-0.121"
+ id="path1015" />
+ <path
+ d="m 103.8073,139.3421 -0.0604,-0.2419"
+ id="path1016" />
+ <path
+ d="m 103.7469,139.1002 v -0.1814"
+ id="path1017" />
+ <path
+ d="m 103.7469,138.9188 0.0604,-0.2419"
+ id="path1018" />
+ <path
+ d="m 103.8073,138.6769 0.0605,-0.1209"
+ id="path1019" />
+ <path
+ d="m 103.8678,138.556 0.121,-0.121"
+ id="path1020" />
+ <path
+ d="m 103.9888,138.435 0.1814,-0.0605"
+ id="path1021" />
+ <path
+ d="m 104.1702,138.3745 h 0.1209"
+ id="path1022" />
+ <path
+ d="m 104.2911,138.3745 0.1815,0.0605"
+ id="path1023" />
+ <path
+ d="m 104.4726,138.435 0.0604,0.0605"
+ id="path1024" />
+ </g>
+ </g>
+ </g>
+ <g
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ id="g1042">
+ <g
+ id="g1027" />
+ <g
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.254;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ id="g1028">
+ <rect
+ x="93.980003"
+ y="143.129"
+ width="5.0799999"
+ height="2.0320001"
+ rx="0.000000"
+ id="rect1027" />
+ </g>
+ <g
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ id="g1041">
+ <path
+ d="M 93.98,144.145 H 92.71"
+ id="path1028" />
+ <path
+ d="m 99.06,144.145 h 1.27"
+ id="path1029" />
+ <text
+ x="96.519997"
+ y="140.97"
+ textLength="1.4732"
+ font-size="1.6933px"
+ lengthAdjust="spacingAndGlyphs"
+ text-anchor="middle"
+ opacity="0"
+ id="text1029">R</text>
+ <g
+ class="stroked-text"
+ id="g1040">
+ <desc
+ id="desc1029">R</desc>
+ <path
+ d="m 96.913,140.9145 -0.4233,-0.6047"
+ id="path1030" />
+ <path
+ d="m 96.1873,140.9145 v -1.27"
+ id="path1031" />
+ <path
+ d="m 96.1873,139.6445 h 0.4838"
+ id="path1032" />
+ <path
+ d="m 96.6711,139.6445 0.121,0.0605"
+ id="path1033" />
+ <path
+ d="m 96.7921,139.705 0.0605,0.0605"
+ id="path1034" />
+ <path
+ d="m 96.8526,139.7655 0.0604,0.1209"
+ id="path1035" />
+ <path
+ d="m 96.913,139.8864 v 0.1815"
+ id="path1036" />
+ <path
+ d="m 96.913,140.0679 -0.0604,0.1209"
+ id="path1037" />
+ <path
+ d="m 96.8526,140.1888 -0.0605,0.0605"
+ id="path1038" />
+ <path
+ d="m 96.7921,140.2493 -0.121,0.0605"
+ id="path1039" />
+ <path
+ d="M 96.6711,140.3098 H 96.1873"
+ id="path1040" />
+ </g>
+ </g>
+ </g>
+ <g
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ id="g1172">
+ <text
+ x="113.1888"
+ y="149.95081"
+ textLength="3.2269001"
+ font-size="1.6933px"
+ lengthAdjust="spacingAndGlyphs"
+ text-anchor="start"
+ opacity="0"
+ id="text1144">out</text>
+ <g
+ class="stroked-text"
+ id="g1171">
+ <desc
+ id="desc1144">out</desc>
+ <path
+ d="m 113.7728,149.8953 -0.121,-0.0604"
+ id="path1144" />
+ <path
+ d="m 113.6518,149.8349 -0.0605,-0.0605"
+ id="path1145" />
+ <path
+ d="m 113.5913,149.7744 -0.0604,-0.121"
+ id="path1146" />
+ <path
+ d="m 113.5309,149.6534 v -0.3628"
+ id="path1147" />
+ <path
+ d="m 113.5309,149.2906 0.0604,-0.121"
+ id="path1148" />
+ <path
+ d="m 113.5913,149.1696 0.0605,-0.0605"
+ id="path1149" />
+ <path
+ d="m 113.6518,149.1091 0.121,-0.0604"
+ id="path1150" />
+ <path
+ d="m 113.7728,149.0487 h 0.1814"
+ id="path1151" />
+ <path
+ d="m 113.9542,149.0487 0.1209,0.0604"
+ id="path1152" />
+ <path
+ d="m 114.0751,149.1091 0.0605,0.0605"
+ id="path1153" />
+ <path
+ d="m 114.1356,149.1696 0.0605,0.121"
+ id="path1154" />
+ <path
+ d="m 114.1961,149.2906 v 0.3628"
+ id="path1155" />
+ <path
+ d="m 114.1961,149.6534 -0.0605,0.121"
+ id="path1156" />
+ <path
+ d="m 114.1356,149.7744 -0.0605,0.0605"
+ id="path1157" />
+ <path
+ d="m 114.0751,149.8349 -0.1209,0.0604"
+ id="path1158" />
+ <path
+ d="m 113.9542,149.8953 h -0.1814"
+ id="path1159" />
+ <path
+ d="m 115.2846,149.0487 v 0.8466"
+ id="path1160" />
+ <path
+ d="m 114.7403,149.0487 v 0.6652"
+ id="path1161" />
+ <path
+ d="m 114.7403,149.7139 0.0605,0.121"
+ id="path1162" />
+ <path
+ d="m 114.8008,149.8349 0.121,0.0604"
+ id="path1163" />
+ <path
+ d="m 114.9218,149.8953 h 0.1814"
+ id="path1164" />
+ <path
+ d="m 115.1032,149.8953 0.1209,-0.0604"
+ id="path1165" />
+ <path
+ d="m 115.2241,149.8349 0.0605,-0.0605"
+ id="path1166" />
+ <path
+ d="m 115.7079,149.0487 h 0.4838"
+ id="path1167" />
+ <path
+ d="m 115.8893,148.6253 v 1.0886"
+ id="path1168" />
+ <path
+ d="m 115.8893,149.7139 0.0605,0.121"
+ id="path1169" />
+ <path
+ d="m 115.9498,149.8349 0.121,0.0604"
+ id="path1170" />
+ <path
+ d="m 116.0708,149.8953 h 0.1209"
+ id="path1171" />
+ </g>
+ <path
+ style="fill:none;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ d="m 111.76,149.225 1.1113,1.2704 h 4.3578 v -1.2704 -1.2704 h -4.3578 z"
+ id="path1172" />
+ </g>
+ <g
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ id="g1258">
+ <text
+ x="88.106201"
+ y="149.95081"
+ textLength="1.957"
+ font-size="1.6933px"
+ lengthAdjust="spacingAndGlyphs"
+ text-anchor="end"
+ opacity="0"
+ id="text1245">in</text>
+ <g
+ class="stroked-text"
+ id="g1257">
+ <desc
+ id="desc1245">in</desc>
+ <path
+ d="m 86.5545,149.8953 v -0.8466"
+ id="path1245" />
+ <path
+ d="m 86.5545,148.6253 -0.0604,0.0605"
+ id="path1246" />
+ <path
+ d="m 86.4941,148.6858 0.0604,0.0605"
+ id="path1247" />
+ <path
+ d="m 86.5545,148.7463 0.0605,-0.0605"
+ id="path1248" />
+ <path
+ d="m 86.615,148.6858 -0.0605,-0.0605"
+ id="path1249" />
+ <path
+ d="m 86.5545,148.6253 v 0.121"
+ id="path1250" />
+ <path
+ d="m 87.1593,149.0487 v 0.8466"
+ id="path1251" />
+ <path
+ d="m 87.1593,149.1696 0.0605,-0.0605"
+ id="path1252" />
+ <path
+ d="m 87.2198,149.1091 0.121,-0.0604"
+ id="path1253" />
+ <path
+ d="m 87.3408,149.0487 h 0.1814"
+ id="path1254" />
+ <path
+ d="m 87.5222,149.0487 0.1209,0.0604"
+ id="path1255" />
+ <path
+ d="m 87.6431,149.1091 0.0605,0.121"
+ id="path1256" />
+ <path
+ d="m 87.7036,149.2301 v 0.6652"
+ id="path1257" />
+ </g>
+ <path
+ style="fill:none;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ d="m 89.535,149.225 -1.1113,-1.2704 h -3.0879 v 1.2704 1.2704 h 3.0879 z"
+ id="path1258" />
+ </g>
+ <path
+ d="M 92.71,144.145 H 90.805"
+ id="path1274"
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1" />
+ <path
+ d="m 90.805,155.575 h 9.525"
+ id="path1275"
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1" />
+ <path
+ d="m 90.805,144.145 v 5.08"
+ id="path1279"
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1" />
+ <path
+ d="m 107.95,149.225 v 6.35"
+ id="path1280"
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1" />
+ <path
+ d="m 107.95,149.225 h 3.81"
+ id="path1287"
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1" />
+ <path
+ d="m 107.95,144.145 v 5.08"
+ id="path1288"
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1" />
+ <path
+ d="m 89.535,149.225 h 1.27"
+ id="path1289"
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1" />
+ <path
+ d="m 90.805,149.225 v 6.35"
+ id="path1291"
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1" />
+ <text
+ x="96.519997"
+ y="140.97"
+ textLength="1.4732"
+ font-size="1.6933px"
+ lengthAdjust="spacingAndGlyphs"
+ text-anchor="middle"
+ opacity="0"
+ id="text1296"
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1">R</text>
+ <g
+ class="stroked-text"
+ id="g1307"
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1">
+ <desc
+ id="desc1296">R</desc>
+ <path
+ d="m 96.913,140.9145 -0.4233,-0.6047"
+ id="path1297" />
+ <path
+ d="m 96.1873,140.9145 v -1.27"
+ id="path1298" />
+ <path
+ d="m 96.1873,139.6445 h 0.4838"
+ id="path1299" />
+ <path
+ d="m 96.6711,139.6445 0.121,0.0605"
+ id="path1300" />
+ <path
+ d="m 96.7921,139.705 0.0605,0.0605"
+ id="path1301" />
+ <path
+ d="m 96.8526,139.7655 0.0604,0.1209"
+ id="path1302" />
+ <path
+ d="m 96.913,139.8864 v 0.1815"
+ id="path1303" />
+ <path
+ d="m 96.913,140.0679 -0.0604,0.1209"
+ id="path1304" />
+ <path
+ d="m 96.8526,140.1888 -0.0605,0.0605"
+ id="path1305" />
+ <path
+ d="m 96.7921,140.2493 -0.121,0.0605"
+ id="path1306" />
+ <path
+ d="M 96.6711,140.3098 H 96.1873"
+ id="path1307" />
+ </g>
+ <path
+ d="M 93.98,144.145 H 92.71"
+ id="path1308"
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1" />
+ <path
+ d="m 99.06,144.145 h 1.27"
+ id="path1309"
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1" />
+ <text
+ x="104.14"
+ y="139.7"
+ textLength="1.4732"
+ font-size="1.6933px"
+ lengthAdjust="spacingAndGlyphs"
+ text-anchor="middle"
+ opacity="0"
+ id="text1309"
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1">C</text>
+ <g
+ class="stroked-text"
+ id="g1324"
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1">
+ <desc
+ id="desc1309">C</desc>
+ <path
+ d="m 104.533,139.5236 -0.0604,0.0605"
+ id="path1310" />
+ <path
+ d="m 104.4726,139.5841 -0.1815,0.0604"
+ id="path1311" />
+ <path
+ d="m 104.2911,139.6445 h -0.1209"
+ id="path1312" />
+ <path
+ d="m 104.1702,139.6445 -0.1814,-0.0604"
+ id="path1313" />
+ <path
+ d="m 103.9888,139.5841 -0.121,-0.121"
+ id="path1314" />
+ <path
+ d="m 103.8678,139.4631 -0.0605,-0.121"
+ id="path1315" />
+ <path
+ d="m 103.8073,139.3421 -0.0604,-0.2419"
+ id="path1316" />
+ <path
+ d="m 103.7469,139.1002 v -0.1814"
+ id="path1317" />
+ <path
+ d="m 103.7469,138.9188 0.0604,-0.2419"
+ id="path1318" />
+ <path
+ d="m 103.8073,138.6769 0.0605,-0.1209"
+ id="path1319" />
+ <path
+ d="m 103.8678,138.556 0.121,-0.121"
+ id="path1320" />
+ <path
+ d="m 103.9888,138.435 0.1814,-0.0605"
+ id="path1321" />
+ <path
+ d="m 104.1702,138.3745 h 0.1209"
+ id="path1322" />
+ <path
+ d="m 104.2911,138.3745 0.1815,0.0605"
+ id="path1323" />
+ <path
+ d="m 104.4726,138.435 0.0604,0.0605"
+ id="path1324" />
+ </g>
+ <path
+ d="M 103.124,144.145 H 100.33"
+ id="path1325"
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1" />
+ <path
+ d="m 105.156,144.145 h 2.794"
+ id="path1326"
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1" />
+ </g>
+ </g>
+ <circle
+ cx="90.805"
+ cy="149.22501"
+ r="0.45719999"
+ id="circle1326"
+ style="fill:#000000;fill-opacity:1;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1" />
+ <circle
+ cx="107.95"
+ cy="149.22501"
+ r="0.45719999"
+ id="circle1330"
+ style="fill:#000000;fill-opacity:1;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1" />
+ </g>
+ </g>
+</svg>
diff --git a/doc/libeisgenerator.doxygen.in b/doc/libeisgenerator.doxygen.in
new file mode 100644
index 0000000000000000000000000000000000000000..8f33eeb714e0a470843874b5b01ec1d9ff821a2b
--- /dev/null
+++ b/doc/libeisgenerator.doxygen.in
@@ -0,0 +1,2603 @@
+# Doxyfile 1.9.3
+
+# 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 = @PROJECT_NAME@
+
+# 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 = 1.0.x
+
+# 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
+
+# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
+# descriptions after the members that are listed in the file and class
+# documentation (similar to Javadoc). Set to NO to disable this.
+# The default value is: YES.
+
+BRIEF_MEMBER_DESC = YES
+
+# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
+# description of a member or function before the detailed description
+#
+# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
+# brief descriptions will be completely suppressed.
+# The default value is: YES.
+
+REPEAT_BRIEF = YES
+
+# This tag implements a quasi-intelligent brief description abbreviator that is
+# used to form the text in various listings. Each string in this list, if found
+# as the leading text of the brief description, will be stripped from the text
+# and the result, after processing the whole list, is used as the annotated
+# text. Otherwise, the brief description is used as-is. If left blank, the
+# following values are used ($name is automatically replaced with the name of
+# the entity):The $name class, The $name widget, The $name file, is, provides,
+# specifies, contains, represents, a, an and the.
+
+ABBREVIATE_BRIEF =
+
+# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
+# doxygen will generate a detailed section even if there is only a brief
+# description.
+# The default value is: NO.
+
+ALWAYS_DETAILED_SEC = NO
+
+# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
+# inherited members of a class in the documentation of that class as if those
+# members were ordinary class members. Constructors, destructors and assignment
+# operators of the base classes will not be shown.
+# The default value is: NO.
+
+INLINE_INHERITED_MEMB = NO
+
+# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
+# before files name in the file list and in the header files. If set to NO the
+# shortest path that makes the file name unique will be used
+# The default value is: YES.
+
+FULL_PATH_NAMES = NO
+
+# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
+# Stripping is only done if one of the specified strings matches the left-hand
+# part of the path. The tag can be used to show relative paths in the file list.
+# If left blank the directory from which doxygen is run is used as the path to
+# strip.
+#
+# Note that you can specify absolute paths here, but also relative paths, which
+# will be relative from the directory where doxygen is started.
+# This tag requires that the tag FULL_PATH_NAMES is set to YES.
+
+STRIP_FROM_PATH =
+
+# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
+# path mentioned in the documentation of a class, which tells the reader which
+# header file to include in order to use a class. If left blank only the name of
+# the header file containing the class definition is used. Otherwise one should
+# specify the list of include paths that are normally passed to the compiler
+# using the -I flag.
+
+STRIP_FROM_INC_PATH =
+
+# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
+# less readable) file names. This can be useful is your file systems doesn't
+# support long names like on DOS, Mac, or CD-ROM.
+# The default value is: NO.
+
+SHORT_NAMES = NO
+
+# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
+# first line (until the first dot) of a Javadoc-style comment as the brief
+# description. If set to NO, the Javadoc-style will behave just like regular Qt-
+# style comments (thus requiring an explicit @brief command for a brief
+# description.)
+# The default value is: NO.
+
+JAVADOC_AUTOBRIEF = 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 = YES
+
+# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
+# line (until the first dot) of a Qt-style comment as the brief description. If
+# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
+# requiring an explicit \brief command for a brief description.)
+# The default value is: NO.
+
+QT_AUTOBRIEF = NO
+
+# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
+# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
+# a brief description. This used to be the default behavior. The new default is
+# to treat a multi-line C++ comment block as a detailed description. Set this
+# tag to YES if you prefer the old behavior instead.
+#
+# Note that setting this tag to YES also means that rational rose comments are
+# not recognized any more.
+# The default value is: NO.
+
+MULTILINE_CPP_IS_BRIEF = NO
+
+# By default Python docstrings are displayed as preformatted text and doxygen's
+# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the
+# doxygen's special commands can be used and the contents of the docstring
+# documentation blocks is shown as doxygen documentation.
+# The default value is: YES.
+
+PYTHON_DOCSTRING = YES
+
+# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
+# documentation from any documented member that it re-implements.
+# The default value is: YES.
+
+INHERIT_DOCS = YES
+
+# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
+# page for each member. If set to NO, the documentation of a member will be part
+# of the file/class/namespace that contains it.
+# The default value is: NO.
+
+SEPARATE_MEMBER_PAGES = NO
+
+# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
+# uses this value to replace tabs by spaces in code fragments.
+# Minimum value: 1, maximum value: 16, default value: 4.
+
+TAB_SIZE = 8
+
+# This tag can be used to specify a number of aliases that act as commands in
+# the documentation. An alias has the form:
+# name=value
+# For example adding
+# "sideeffect=@par Side Effects:^^"
+# will allow you to put the command \sideeffect (or @sideeffect) in the
+# documentation, which will result in a user-defined paragraph with heading
+# "Side Effects:". Note that you cannot put \n's in the value part of an alias
+# to insert newlines (in the resulting output). You can put ^^ in the value part
+# of an alias to insert a newline as if a physical newline was in the original
+# file. When you need a literal { or } or , in the value part of an alias you
+# have to escape them by means of a backslash (\), this can lead to conflicts
+# with the commands \{ and \} for these it is advised to use the version @{ and
+# @} or use a double escape (\\{ and \\})
+
+ALIASES =
+
+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
+# only. Doxygen will then generate output that is more tailored for C. For
+# instance, some of the names that are used will be different. The list of all
+# members will be omitted, etc.
+# The default value is: NO.
+
+OPTIMIZE_OUTPUT_FOR_C = YES
+
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
+# Python sources only. Doxygen will then generate output that is more tailored
+# for that language. For instance, namespaces will be presented as packages,
+# qualified scopes will look different, etc.
+# The default value is: NO.
+
+OPTIMIZE_OUTPUT_JAVA = NO
+
+# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
+# sources. Doxygen will then generate output that is tailored for Fortran.
+# The default value is: NO.
+
+OPTIMIZE_FOR_FORTRAN = NO
+
+# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
+# sources. Doxygen will then generate output that is tailored for VHDL.
+# The default value is: NO.
+
+OPTIMIZE_OUTPUT_VHDL = NO
+
+# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
+# sources only. Doxygen will then generate output that is more tailored for that
+# language. For instance, namespaces will be presented as modules, types will be
+# separated into more groups, etc.
+# The default value is: NO.
+
+OPTIMIZE_OUTPUT_SLICE = NO
+
+# Doxygen selects the parser to use depending on the extension of the files it
+# parses. With this tag you can assign which parser to use for a given
+# extension. Doxygen has a built-in mapping, but you can override or extend it
+# using this tag. The format is ext=language, where ext is a file extension, and
+# language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
+# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice,
+# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
+# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
+# tries to guess whether the code is fixed or free formatted code, this is the
+# default for Fortran type files). For instance to make doxygen treat .inc files
+# as Fortran files (default is PHP), and .f files as C (default is Fortran),
+# use: inc=Fortran f=C.
+#
+# Note: For files without extension you can use no_extension as a placeholder.
+#
+# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
+# the files are not read by doxygen. When specifying no_extension you should add
+# * to the FILE_PATTERNS.
+#
+# Note see also the list of default file extension mappings.
+
+EXTENSION_MAPPING =
+
+# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
+# according to the Markdown format, which allows for more readable
+# documentation. See https://daringfireball.net/projects/markdown/ for details.
+# The output of markdown processing is further processed by doxygen, so you can
+# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
+# case of backward compatibilities issues.
+# The default value is: YES.
+
+MARKDOWN_SUPPORT = YES
+
+# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
+# to that level are automatically included in the table of contents, even if
+# they do not have an id attribute.
+# Note: This feature currently applies only to Markdown headings.
+# Minimum value: 0, maximum value: 99, default value: 5.
+# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
+
+TOC_INCLUDE_HEADINGS = 5
+
+# When enabled doxygen tries to link words that correspond to documented
+# classes, or namespaces to their corresponding documentation. Such a link can
+# be prevented in individual cases by putting a % sign in front of the word or
+# globally by setting AUTOLINK_SUPPORT to NO.
+# The default value is: YES.
+
+AUTOLINK_SUPPORT = YES
+
+# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
+# to include (a tag file for) the STL sources as input, then you should set this
+# tag to YES in order to let doxygen match functions declarations and
+# definitions whose arguments contain STL classes (e.g. func(std::string);
+# versus func(std::string) {}). This also make the inheritance and collaboration
+# diagrams that involve STL classes more complete and accurate.
+# The default value is: NO.
+
+BUILTIN_STL_SUPPORT = NO
+
+# If you use Microsoft's C++/CLI language, you should set this option to YES to
+# enable parsing support.
+# The default value is: NO.
+
+CPP_CLI_SUPPORT = NO
+
+# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
+# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
+# will parse them like normal C++ but will assume all classes use public instead
+# of private inheritance when no explicit protection keyword is present.
+# The default value is: NO.
+
+SIP_SUPPORT = NO
+
+# For Microsoft's IDL there are propget and propput attributes to indicate
+# getter and setter methods for a property. Setting this option to YES will make
+# doxygen to replace the get and set methods by a property in the documentation.
+# This will only work if the methods are indeed getting or setting a simple
+# type. If this is not the case, or you want to show the methods anyway, you
+# should set this option to NO.
+# The default value is: YES.
+
+IDL_PROPERTY_SUPPORT = YES
+
+# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
+# tag is set to YES then doxygen will reuse the documentation of the first
+# member in the group (if any) for the other members of the group. By default
+# all members of a group must be documented explicitly.
+# The default value is: NO.
+
+DISTRIBUTE_GROUP_DOC = NO
+
+# If one adds a struct or class to a group and this option is enabled, then also
+# any nested class or struct is added to the same group. By default this option
+# is disabled and one has to add nested compounds explicitly via \ingroup.
+# The default value is: NO.
+
+GROUP_NESTED_COMPOUNDS = NO
+
+# Set the SUBGROUPING tag to YES to allow class member groups of the same type
+# (for instance a group of public functions) to be put as a subgroup of that
+# type (e.g. under the Public Functions section). Set it to NO to prevent
+# subgrouping. Alternatively, this can be done per class using the
+# \nosubgrouping command.
+# The default value is: YES.
+
+SUBGROUPING = YES
+
+# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
+# are shown inside the group in which they are included (e.g. using \ingroup)
+# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
+# and RTF).
+#
+# Note that this feature does not work in combination with
+# SEPARATE_MEMBER_PAGES.
+# The default value is: NO.
+
+INLINE_GROUPED_CLASSES = NO
+
+# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
+# with only public data fields or simple typedef fields will be shown inline in
+# the documentation of the scope in which they are defined (i.e. file,
+# namespace, or group documentation), provided this scope is documented. If set
+# to NO, structs, classes, and unions are shown on a separate page (for HTML and
+# Man pages) or section (for LaTeX and RTF).
+# The default value is: NO.
+
+INLINE_SIMPLE_STRUCTS = NO
+
+# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
+# enum is documented as struct, union, or enum with the name of the typedef. So
+# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
+# with name TypeT. When disabled the typedef will appear as a member of a file,
+# namespace, or class. And the struct will be named TypeS. This can typically be
+# useful for C code in case the coding convention dictates that all compound
+# types are typedef'ed and only the typedef is referenced, never the tag name.
+# The default value is: NO.
+
+TYPEDEF_HIDES_STRUCT = YES
+
+# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
+# cache is used to resolve symbols given their name and scope. Since this can be
+# an expensive process and often the same symbol appears multiple times in the
+# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
+# doxygen will become slower. If the cache is too large, memory is wasted. The
+# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
+# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
+# symbols. At the end of a run doxygen will report the cache usage and suggest
+# the optimal cache size from a speed point of view.
+# Minimum value: 0, maximum value: 9, default value: 0.
+
+LOOKUP_CACHE_SIZE = 0
+
+# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use
+# during processing. When set to 0 doxygen will based this on the number of
+# cores available in the system. You can set it explicitly to a value larger
+# than 0 to get more control over the balance between CPU load and processing
+# speed. At this moment only the input processing can be done using multiple
+# threads. Since this is still an experimental feature the default is set to 1,
+# which effectively disables parallel processing. Please report any issues you
+# encounter. Generating dot graphs in parallel is controlled by the
+# DOT_NUM_THREADS setting.
+# Minimum value: 0, maximum value: 32, default value: 1.
+
+NUM_PROC_THREADS = 1
+
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+
+# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
+# documentation are documented, even if no documentation was available. Private
+# class members and static file members will be hidden unless the
+# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
+# Note: This will also disable the warnings about undocumented members that are
+# normally produced when WARNINGS is set to YES.
+# The default value is: NO.
+
+EXTRACT_ALL = NO
+
+# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
+# be included in the documentation.
+# The default value is: NO.
+
+EXTRACT_PRIVATE = NO
+
+# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
+# methods of a class will be included in the documentation.
+# The default value is: NO.
+
+EXTRACT_PRIV_VIRTUAL = NO
+
+# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
+# scope will be included in the documentation.
+# The default value is: NO.
+
+EXTRACT_PACKAGE = NO
+
+# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
+# included in the documentation.
+# The default value is: NO.
+
+EXTRACT_STATIC = 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 this flag is set to YES, the name of an unnamed parameter in a declaration
+# will be determined by the corresponding definition. By default unnamed
+# parameters remain unnamed in the output.
+# The default value is: YES.
+
+RESOLVE_UNNAMED_PARAMS = YES
+
+# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
+# undocumented members inside documented classes or files. If set to NO these
+# members will be included in the various overviews, but no documentation
+# section is generated. This option has no effect if EXTRACT_ALL is enabled.
+# The default value is: NO.
+
+HIDE_UNDOC_MEMBERS = NO
+
+# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
+# undocumented classes that are normally visible in the class hierarchy. If set
+# to NO, these classes will be included in the various overviews. This option
+# has no effect if EXTRACT_ALL is enabled.
+# The default value is: NO.
+
+HIDE_UNDOC_CLASSES = NO
+
+# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
+# declarations. If set to NO, these declarations will be included in the
+# documentation.
+# The default value is: NO.
+
+HIDE_FRIEND_COMPOUNDS = NO
+
+# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
+# documentation blocks found inside the body of a function. If set to NO, these
+# blocks will be appended to the function's detailed documentation block.
+# The default value is: NO.
+
+HIDE_IN_BODY_DOCS = NO
+
+# The INTERNAL_DOCS tag determines if documentation that is typed after a
+# \internal command is included. If the tag is set to NO then the documentation
+# will be excluded. Set it to YES to include the internal documentation.
+# The default value is: NO.
+
+INTERNAL_DOCS = NO
+
+# With the correct setting of option CASE_SENSE_NAMES doxygen will better be
+# able to match the capabilities of the underlying filesystem. In case the
+# filesystem is case sensitive (i.e. it supports files in the same directory
+# whose names only differ in casing), the option must be set to YES to properly
+# deal with such files in case they appear in the input. For filesystems that
+# are not case sensitive the option should be be set to NO to properly deal with
+# output files written for symbols that only differ in casing, such as for two
+# classes, one named CLASS and the other named Class, and to also support
+# references to files without having to specify the exact matching casing. On
+# Windows (including Cygwin) and MacOS, users should typically set this option
+# to NO, whereas on Linux or other Unix flavors it should typically be set to
+# YES.
+# The default value is: system dependent.
+
+CASE_SENSE_NAMES = YES
+
+# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
+# their full class and namespace scopes in the documentation. If set to YES, the
+# scope will be hidden.
+# The default value is: NO.
+
+HIDE_SCOPE_NAMES = NO
+
+# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
+# append additional text to a page's title, such as Class Reference. If set to
+# YES the compound reference will be hidden.
+# The default value is: NO.
+
+HIDE_COMPOUND_REFERENCE= NO
+
+# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class
+# will show which file needs to be included to use the class.
+# The default value is: YES.
+
+SHOW_HEADERFILE = YES
+
+# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
+# the files that are included by a file in the documentation of that file.
+# The default value is: YES.
+
+SHOW_INCLUDE_FILES = YES
+
+# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
+# grouped member an include statement to the documentation, telling the reader
+# which file to include in order to use the member.
+# The default value is: NO.
+
+SHOW_GROUPED_MEMB_INC = NO
+
+# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
+# files with double quotes in the documentation rather than with sharp brackets.
+# The default value is: NO.
+
+FORCE_LOCAL_INCLUDES = NO
+
+# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
+# documentation for inline members.
+# The default value is: YES.
+
+INLINE_INFO = YES
+
+# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
+# (detailed) documentation of file and class members alphabetically by member
+# name. If set to NO, the members will appear in declaration order.
+# The default value is: YES.
+
+SORT_MEMBER_DOCS = YES
+
+# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
+# descriptions of file, namespace and class members alphabetically by member
+# name. If set to NO, the members will appear in declaration order. Note that
+# this will also influence the order of the classes in the class list.
+# The default value is: NO.
+
+SORT_BRIEF_DOCS = NO
+
+# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
+# (brief and detailed) documentation of class members so that constructors and
+# destructors are listed first. If set to NO the constructors will appear in the
+# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
+# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
+# member documentation.
+# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
+# detailed member documentation.
+# The default value is: NO.
+
+SORT_MEMBERS_CTORS_1ST = NO
+
+# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
+# of group names into alphabetical order. If set to NO the group names will
+# appear in their defined order.
+# The default value is: NO.
+
+SORT_GROUP_NAMES = NO
+
+# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
+# fully-qualified names, including namespaces. If set to NO, the class list will
+# be sorted only by class name, not including the namespace part.
+# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
+# Note: This option applies only to the class list, not to the alphabetical
+# list.
+# The default value is: NO.
+
+SORT_BY_SCOPE_NAME = NO
+
+# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
+# type resolution of all parameters of a function it will reject a match between
+# the prototype and the implementation of a member function even if there is
+# only one candidate or it is obvious which candidate to choose by doing a
+# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
+# accept a match between prototype and implementation in such cases.
+# The default value is: NO.
+
+STRICT_PROTO_MATCHING = NO
+
+# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
+# list. This list is created by putting \todo commands in the documentation.
+# The default value is: YES.
+
+GENERATE_TODOLIST = YES
+
+# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
+# list. This list is created by putting \test commands in the documentation.
+# The default value is: YES.
+
+GENERATE_TESTLIST = YES
+
+# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
+# list. This list is created by putting \bug commands in the documentation.
+# The default value is: YES.
+
+GENERATE_BUGLIST = YES
+
+# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
+# the deprecated list. This list is created by putting \deprecated commands in
+# the documentation.
+# The default value is: YES.
+
+GENERATE_DEPRECATEDLIST= YES
+
+# The ENABLED_SECTIONS tag can be used to enable conditional documentation
+# sections, marked by \if <section_label> ... \endif and \cond <section_label>
+# ... \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 = NO
+
+# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
+# will remove the Files entry from the Quick Index and from the Folder Tree View
+# (if specified).
+# The default value is: YES.
+
+SHOW_FILES = YES
+
+# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
+# page. This will remove the Namespaces entry from the Quick Index and from the
+# Folder Tree View (if specified).
+# The default value is: YES.
+
+SHOW_NAMESPACES = YES
+
+# The FILE_VERSION_FILTER tag can be used to specify a program or script that
+# doxygen should invoke to get the current version for each file (typically from
+# the version control system). Doxygen will invoke the program by executing (via
+# popen()) the command command input-file, where command is the value of the
+# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
+# by doxygen. Whatever the program writes to standard output is used as the file
+# version. For an example see the documentation.
+
+FILE_VERSION_FILTER =
+
+# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
+# by doxygen. The layout file controls the global structure of the generated
+# output files in an output format independent way. To create the layout file
+# that represents doxygen's defaults, run doxygen with the -l option. You can
+# optionally specify a file name after the option, if omitted DoxygenLayout.xml
+# will be used as the name of the layout file. See also section "Changing the
+# layout of pages" for information.
+#
+# Note that if you run doxygen from a directory containing a file called
+# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
+# tag is left empty.
+
+LAYOUT_FILE = @CMAKE_CURRENT_SOURCE_DIR@/doc/DoxygenLayout.xml
+
+# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
+# the reference definitions. This must be a list of .bib files. The .bib
+# extension is automatically appended if omitted. This requires the bibtex tool
+# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
+# For LaTeX the style of the bibliography can be controlled using
+# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
+# search path. See also \cite for info how to create references.
+
+CITE_BIB_FILES =
+
+#---------------------------------------------------------------------------
+# Configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+
+# The QUIET tag can be used to turn on/off the messages that are generated to
+# standard output by doxygen. If QUIET is set to YES this implies that the
+# messages are off.
+# The default value is: NO.
+
+QUIET = NO
+
+# The WARNINGS tag can be used to turn on/off the warning messages that are
+# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
+# this implies that the warnings are on.
+#
+# Tip: Turn warnings on while writing the documentation.
+# The default value is: YES.
+
+WARNINGS = YES
+
+# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
+# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
+# will automatically be disabled.
+# The default value is: YES.
+
+WARN_IF_UNDOCUMENTED = YES
+
+# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
+# potential errors in the documentation, such as documenting some parameters in
+# a documented function twice, or documenting parameters that don't exist or
+# using markup commands wrongly.
+# The default value is: YES.
+
+WARN_IF_DOC_ERROR = YES
+
+# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete
+# function parameter documentation. If set to NO, doxygen will accept that some
+# parameters have no documentation without warning.
+# The default value is: YES.
+
+WARN_IF_INCOMPLETE_DOC = YES
+
+# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
+# are documented, but have no documentation for their parameters or return
+# value. If set to NO, doxygen will only warn about wrong parameter
+# documentation, but not about the absence of documentation. If EXTRACT_ALL is
+# set to YES then this flag will automatically be disabled. See also
+# WARN_IF_INCOMPLETE_DOC
+# The default value is: NO.
+
+WARN_NO_PARAMDOC = YES
+
+# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
+# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
+# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
+# at the end of the doxygen process doxygen will return with a non-zero status.
+# Possible values are: NO, YES and FAIL_ON_WARNINGS.
+# The default value is: NO.
+
+WARN_AS_ERROR = NO
+
+# The WARN_FORMAT tag determines the format of the warning messages that doxygen
+# can produce. The string should contain the $file, $line, and $text tags, which
+# will be replaced by the file and line number from which the warning originated
+# and the warning text. Optionally the format may contain $version, which will
+# be replaced by the version of the file (if it could be obtained via
+# FILE_VERSION_FILTER)
+# The default value is: $file:$line: $text.
+
+WARN_FORMAT = "$file:$line: $text"
+
+# The WARN_LOGFILE tag can be used to specify a file to which warning and error
+# messages should be written. If left blank the output is written to standard
+# error (stderr). In case the file specified cannot be opened for writing the
+# warning and error messages are written to standard error. When as file - is
+# specified the warning and error messages are written to standard output
+# (stdout).
+
+WARN_LOGFILE =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the input files
+#---------------------------------------------------------------------------
+
+# The INPUT tag is used to specify the files and/or directories that contain
+# documented source files. You may enter file names like myfile.cpp or
+# directories like /usr/src/myproject. Separate the files or directories with
+# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
+# Note: If this tag is empty the current directory is searched.
+
+INPUT = @CMAKE_CURRENT_SOURCE_DIR@/eisgenerator @CMAKE_CURRENT_BINARY_DIR@/doc/mainpage.md @CMAKE_CURRENT_BINARY_DIR@/doc/modelspage.md
+
+# This tag can be used to specify the character encoding of the source files
+# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
+# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
+# documentation (see:
+# https://www.gnu.org/software/libiconv/) for the list of possible encodings.
+# The default value is: UTF-8.
+
+INPUT_ENCODING = UTF-8
+
+# If the value of the INPUT tag contains directories, you can use the
+# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
+# *.h) to filter out the source-files in the directories.
+#
+# Note that for custom extensions or not directly supported extensions you also
+# need to set EXTENSION_MAPPING for the extension otherwise the files are not
+# read by doxygen.
+#
+# Note the list of default checked file patterns might differ from the list of
+# default file extension mappings.
+#
+# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
+# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
+# *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml,
+# *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C
+# comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd,
+# *.vhdl, *.ucf, *.qsf and *.ice.
+
+FILE_PATTERNS =
+
+# 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,
+# ANamespace::AClass, 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 = @CMAKE_CURRENT_SOURCE_DIR@/examples
+
+# 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 = @CMAKE_CURRENT_SOURCE_DIR@/doc/
+
+# 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:
+#
+# <filter> <input-file>
+#
+# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
+# name of an input file. Doxygen will then use the output that the filter
+# program writes to standard output. If FILTER_PATTERNS is specified, this tag
+# will be ignored.
+#
+# Note that the filter must not add or remove lines; it is applied before the
+# code is scanned, but not when the output code is generated. If lines are added
+# or removed, the anchors will not be placed correctly.
+#
+# Note that for custom extensions or not directly supported extensions you also
+# need to set EXTENSION_MAPPING for the extension otherwise the files are not
+# properly processed by doxygen.
+
+INPUT_FILTER =
+
+# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
+# basis. Doxygen will compare the file name with each pattern and apply the
+# filter if there is a match. The filters are a list of the form: pattern=filter
+# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
+# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
+# patterns match the file name, INPUT_FILTER is applied.
+#
+# Note that for custom extensions or not directly supported extensions you also
+# need to set EXTENSION_MAPPING for the extension otherwise the files are not
+# properly processed by doxygen.
+
+FILTER_PATTERNS =
+
+# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
+# INPUT_FILTER) will also be used to filter the input files that are used for
+# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
+# The default value is: NO.
+
+FILTER_SOURCE_FILES = NO
+
+# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
+# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
+# it is also possible to disable source filtering for a specific pattern using
+# *.ext= (so without naming a filter).
+# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
+
+FILTER_SOURCE_PATTERNS =
+
+# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
+# is part of the input, its contents will be placed on the main page
+# (index.html). This can be useful if you have a project on for instance GitHub
+# and want to reuse the introduction page also for the doxygen output.
+
+USE_MDFILE_AS_MAINPAGE =
+
+#---------------------------------------------------------------------------
+# Configuration options related to source browsing
+#---------------------------------------------------------------------------
+
+# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
+# generated. Documented entities will be cross-referenced with these sources.
+#
+# Note: To get rid of all source code in the generated output, make sure that
+# also VERBATIM_HEADERS is set to NO.
+# The default value is: NO.
+
+SOURCE_BROWSER = NO
+
+# Setting the INLINE_SOURCES tag to YES will include the body of functions,
+# classes and enums directly into the documentation.
+# The default value is: NO.
+
+INLINE_SOURCES = NO
+
+# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
+# special comment blocks from generated source code fragments. Normal C, C++ and
+# Fortran comments will always remain visible.
+# The default value is: YES.
+
+STRIP_CODE_COMMENTS = YES
+
+# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
+# entity all documented functions referencing it will be listed.
+# The default value is: NO.
+
+REFERENCED_BY_RELATION = YES
+
+# 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 = YES
+
+# 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 = NO
+
+# In case all classes in a project start with a common prefix, all classes will
+# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
+# can be used to specify a prefix (or a list of prefixes) that should be ignored
+# while generating the index headers.
+# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
+
+IGNORE_PREFIX =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the HTML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
+# The default value is: YES.
+
+GENERATE_HTML = YES
+
+# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it.
+# The default directory is: html.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_OUTPUT = html
+
+# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
+# generated HTML page (for example: .htm, .php, .asp).
+# The default value is: .html.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_FILE_EXTENSION = .html
+
+# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
+# each generated HTML page. If the tag is left blank doxygen will generate a
+# standard header.
+#
+# To get valid HTML the header file that includes any scripts and style sheets
+# that doxygen needs, which is dependent on the configuration options used (e.g.
+# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
+# default header using
+# doxygen -w html new_header.html new_footer.html new_stylesheet.css
+# YourConfigFile
+# and then modify the file new_header.html. See also section "Doxygen usage"
+# for information on how to generate the default header that doxygen normally
+# uses.
+# Note: The header is subject to change so you typically have to regenerate the
+# default header when upgrading to a newer version of doxygen. For a description
+# of the possible markers and block names see the documentation.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_HEADER =
+
+# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
+# generated HTML page. If the tag is left blank doxygen will generate a standard
+# footer. See HTML_HEADER for more information on how to generate a default
+# footer and what special commands can be used inside the footer. See also
+# section "Doxygen usage" for information on how to generate the default footer
+# that doxygen normally uses.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_FOOTER =
+
+# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
+# sheet that is used by each HTML page. It can be used to fine-tune the look of
+# the HTML output. If left blank doxygen will generate a default style sheet.
+# See also section "Doxygen usage" for information on how to generate the style
+# sheet that doxygen normally uses.
+# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
+# it is more robust and this tag (HTML_STYLESHEET) will in the future become
+# obsolete.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_STYLESHEET =
+
+# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
+# cascading style sheets that are included after the standard style sheets
+# created by doxygen. Using this option one can overrule certain style aspects.
+# This is preferred over using HTML_STYLESHEET since it does not replace the
+# standard style sheet and is therefore more robust against future updates.
+# Doxygen will copy the style sheet files to the output directory.
+# Note: The order of the extra style sheet files is of importance (e.g. the last
+# style sheet in the list overrules the setting of the previous ones in the
+# list). For an example see the documentation.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_EXTRA_STYLESHEET =
+
+# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
+# other source files which should be copied to the HTML output directory. Note
+# that these files will be copied to the base HTML output directory. Use the
+# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
+# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
+# files will be copied as-is; there are no commands or markers available.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_EXTRA_FILES =
+
+# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
+# will adjust the colors in the style sheet and background images according to
+# this color. Hue is specified as an angle on a color-wheel, see
+# https://en.wikipedia.org/wiki/Hue for more information. For instance the value
+# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
+# purple, and 360 is red again.
+# Minimum value: 0, maximum value: 359, default value: 220.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_COLORSTYLE_HUE = 220
+
+# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
+# in the HTML output. For a value of 0 the output will use gray-scales only. A
+# value of 255 will produce the most vivid colors.
+# Minimum value: 0, maximum value: 255, default value: 100.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_COLORSTYLE_SAT = 100
+
+# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
+# luminance component of the colors in the HTML output. Values below 100
+# gradually make the output lighter, whereas values above 100 make the output
+# darker. The value divided by 100 is the actual gamma applied, so 80 represents
+# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
+# change the gamma.
+# Minimum value: 40, maximum value: 240, default value: 80.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_COLORSTYLE_GAMMA = 80
+
+# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
+# page will contain the date and time when the page was generated. Setting this
+# to YES can help to show when doxygen was last run and thus if the
+# documentation is up to date.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_TIMESTAMP = NO
+
+# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
+# documentation will contain a main index with vertical navigation menus that
+# are dynamically created via JavaScript. If disabled, the navigation index will
+# consists of multiple levels of tabs that are statically embedded in every HTML
+# page. Disable this option to support browsers that do not have JavaScript,
+# like the Qt help browser.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_DYNAMIC_MENUS = YES
+
+# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
+# documentation will contain sections that can be hidden and shown after the
+# page has loaded.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_DYNAMIC_SECTIONS = NO
+
+# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
+# shown in the various tree structured indices initially; the user can expand
+# and collapse entries dynamically later on. Doxygen will expand the tree to
+# such a level that at most the specified number of entries are visible (unless
+# a fully collapsed tree already exceeds this amount). So setting the number of
+# entries 1 will produce a full collapsed tree by default. 0 is a special value
+# representing an infinite number of entries and will result in a full expanded
+# tree by default.
+# Minimum value: 0, maximum value: 9999, default value: 100.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_INDEX_NUM_ENTRIES = 100
+
+# If the GENERATE_DOCSET tag is set to YES, additional index files will be
+# generated that can be used as input for Apple's Xcode 3 integrated development
+# environment (see:
+# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To
+# create a documentation set, doxygen will generate a Makefile in the HTML
+# output directory. Running make will produce the docset in that directory and
+# running make install will install the docset in
+# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
+# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
+# genXcode/_index.html for more information.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_DOCSET = NO
+
+# This tag determines the name of the docset feed. A documentation feed provides
+# an umbrella under which multiple documentation sets from a single provider
+# (such as a company or product suite) can be grouped.
+# The default value is: Doxygen generated docs.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
+DOCSET_FEEDNAME = "Doxygen generated docs"
+
+# This tag determines the URL 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.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
+DOCSET_FEEDURL =
+
+# This tag specifies a string that should uniquely identify the documentation
+# set bundle. This should be a reverse domain-name style string, e.g.
+# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
+# The default value is: org.doxygen.Project.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
+DOCSET_BUNDLE_ID = org.doxygen.Project
+
+# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
+# the documentation publisher. This should be a reverse domain-name style
+# string, e.g. com.mycompany.MyDocSet.documentation.
+# The default value is: org.doxygen.Publisher.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
+DOCSET_PUBLISHER_ID = org.doxygen.Publisher
+
+# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
+# The default value is: Publisher.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
+DOCSET_PUBLISHER_NAME = Publisher
+
+# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
+# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
+# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
+# on Windows. In the beginning of 2021 Microsoft took the original page, with
+# a.o. the download links, offline the HTML help workshop was already many years
+# in maintenance mode). You can download the HTML help workshop from the web
+# archives at Installation executable (see:
+# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo
+# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe).
+#
+# The HTML Help Workshop contains a compiler that can convert all HTML output
+# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
+# files are now used as the Windows 98 help format, and will replace the old
+# Windows help format (.hlp) on all Windows platforms in the future. Compressed
+# HTML files also contain an index, a table of contents, and you can search for
+# words in the documentation. The HTML workshop also contains a viewer for
+# compressed HTML files.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_HTMLHELP = NO
+
+# The CHM_FILE tag can be used to specify the file name of the resulting .chm
+# file. You can add a path in front of the file if the result should not be
+# written to the html output directory.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+CHM_FILE =
+
+# The HHC_LOCATION tag can be used to specify the location (absolute path
+# including file name) of the HTML help compiler (hhc.exe). If non-empty,
+# doxygen will try to run the HTML help compiler on the generated index.hhp.
+# The file has to be specified with full path.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+HHC_LOCATION =
+
+# The GENERATE_CHI flag controls if a separate .chi index file is generated
+# (YES) or that it should be included in the main .chm file (NO).
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+GENERATE_CHI = NO
+
+# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
+# and project file content.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+CHM_INDEX_ENCODING =
+
+# The BINARY_TOC flag controls whether a binary table of contents is generated
+# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
+# enables the Previous and Next buttons.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+BINARY_TOC = NO
+
+# The TOC_EXPAND flag can be set to YES to add extra items for group members to
+# the table of contents of the HTML help documentation and to the tree view.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+TOC_EXPAND = NO
+
+# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
+# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
+# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
+# (.qch) of the generated HTML documentation.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_QHP = NO
+
+# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
+# the file name of the resulting .qch file. The path specified is relative to
+# the HTML output folder.
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QCH_FILE =
+
+# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
+# Project output. For more information please see Qt Help Project / Namespace
+# (see:
+# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
+# The default value is: org.doxygen.Project.
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_NAMESPACE = org.doxygen.Project
+
+# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
+# Help Project output. For more information please see Qt Help Project / Virtual
+# Folders (see:
+# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders).
+# The default value is: doc.
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_VIRTUAL_FOLDER = doc
+
+# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
+# filter to add. For more information please see Qt Help Project / Custom
+# Filters (see:
+# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_CUST_FILTER_NAME =
+
+# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
+# custom filter to add. For more information please see Qt Help Project / Custom
+# Filters (see:
+# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_CUST_FILTER_ATTRS =
+
+# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
+# project's filter section matches. Qt Help Project / Filter Attributes (see:
+# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_SECT_FILTER_ATTRS =
+
+# The QHG_LOCATION tag can be used to specify the location (absolute path
+# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to
+# run qhelpgenerator on the generated .qhp file.
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHG_LOCATION =
+
+# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
+# generated, together with the HTML files, they form an Eclipse help plugin. To
+# install this plugin and make it available under the help contents menu in
+# Eclipse, the contents of the directory containing the HTML and XML files needs
+# to be copied into the plugins directory of eclipse. The name of the directory
+# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
+# After copying Eclipse needs to be restarted before the help appears.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_ECLIPSEHELP = NO
+
+# A unique identifier for the Eclipse help plugin. When installing the plugin
+# the directory name containing the HTML and XML files should also have this
+# name. Each documentation set should have its own identifier.
+# The default value is: org.doxygen.Project.
+# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
+
+ECLIPSE_DOC_ID = org.doxygen.Project
+
+# If you want full control over the layout of the generated HTML pages it might
+# be necessary to disable the index and replace it with your own. The
+# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
+# of each HTML page. A value of NO enables the index and the value YES disables
+# it. Since the tabs in the index contain the same information as the navigation
+# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+DISABLE_INDEX = NO
+
+# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
+# structure should be generated to display hierarchical information. If the tag
+# value is set to YES, a side panel will be generated containing a tree-like
+# index structure (just like the one that is generated for HTML Help). For this
+# to work a browser that supports JavaScript, DHTML, CSS and frames is required
+# (i.e. any modern browser). Windows users are probably better off using the
+# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
+# further fine tune the look of the index (see "Fine-tuning the output"). As an
+# example, the default style sheet generated by doxygen has an example that
+# shows how to put an image at the root of the tree instead of the PROJECT_NAME.
+# Since the tree basically has the same information as the tab index, you could
+# consider setting DISABLE_INDEX to YES when enabling this option.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_TREEVIEW = NO
+
+# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the
+# FULL_SIDEBAR option determines if the side bar is limited to only the treeview
+# area (value NO) or if it should extend to the full height of the window (value
+# YES). Setting this to YES gives a layout similar to
+# https://docs.readthedocs.io with more room for contents, but less room for the
+# project logo, title, and description. If either GENERATE_TREEVIEW or
+# DISABLE_INDEX is set to NO, this option has no effect.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+FULL_SIDEBAR = NO
+
+# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
+# doxygen will group on one line in the generated HTML documentation.
+#
+# Note that a value of 0 will completely suppress the enum values from appearing
+# in the overview section.
+# Minimum value: 0, maximum value: 20, default value: 4.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+ENUM_VALUES_PER_LINE = 4
+
+# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
+# to set the initial width (in pixels) of the frame in which the tree is shown.
+# Minimum value: 0, maximum value: 1500, default value: 250.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+TREEVIEW_WIDTH = 250
+
+# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
+# external symbols imported via tag files in a separate window.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+EXT_LINKS_IN_WINDOW = NO
+
+# If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email
+# addresses.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+OBFUSCATE_EMAILS = YES
+
+# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
+# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see
+# https://inkscape.org) to generate formulas as SVG images instead of PNGs for
+# the HTML output. These images will generally look nicer at scaled resolutions.
+# Possible values are: png (the default) and svg (looks nicer but requires the
+# pdf2svg or inkscape tool).
+# The default value is: png.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_FORMULA_FORMAT = png
+
+# Use this tag to change the font size of LaTeX formulas included as images in
+# the HTML documentation. When you change the font size after a successful
+# doxygen run you need to manually remove any form_*.png images from the HTML
+# output directory to force them to be regenerated.
+# Minimum value: 8, maximum value: 50, default value: 10.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+FORMULA_FONTSIZE = 10
+
+# Use the FORMULA_TRANSPARENT tag to determine whether or not the images
+# generated for formulas are transparent PNGs. Transparent PNGs are not
+# supported properly for IE 6.0, but are supported on all modern browsers.
+#
+# Note that when changing this option you need to delete any form_*.png files in
+# the HTML output directory before the changes have effect.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+FORMULA_TRANSPARENT = YES
+
+# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
+# to create new LaTeX commands to be used in formulas as building blocks. See
+# the section "Including formulas" for details.
+
+FORMULA_MACROFILE =
+
+# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
+# https://www.mathjax.org) which uses client side JavaScript for the rendering
+# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
+# installed or if you want to formulas look prettier in the HTML output. When
+# enabled you may also need to install MathJax separately and configure the path
+# to it using the MATHJAX_RELPATH option.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+USE_MATHJAX = NO
+
+# With MATHJAX_VERSION it is possible to specify the MathJax version to be used.
+# Note that the different versions of MathJax have different requirements with
+# regards to the different settings, so it is possible that also other MathJax
+# settings have to be changed when switching between the different MathJax
+# versions.
+# Possible values are: MathJax_2 and MathJax_3.
+# The default value is: MathJax_2.
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_VERSION = MathJax_2
+
+# When MathJax is enabled you can set the default output format to be used for
+# the MathJax output. For more details about the output format see MathJax
+# version 2 (see:
+# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3
+# (see:
+# http://docs.mathjax.org/en/latest/web/components/output.html).
+# Possible values are: HTML-CSS (which is slower, but has the best
+# compatibility. This is the name for Mathjax version 2, for MathJax version 3
+# this will be translated into chtml), NativeMML (i.e. MathML. Only supported
+# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This
+# is the name for Mathjax version 3, for MathJax version 2 this will be
+# translated into HTML-CSS) and SVG.
+# The default value is: HTML-CSS.
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_FORMAT = HTML-CSS
+
+# When MathJax is enabled you need to specify the location relative to the HTML
+# output directory using the MATHJAX_RELPATH option. The destination directory
+# should contain the MathJax.js script. For instance, if the mathjax directory
+# is located at the same level as the HTML output directory, then
+# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
+# Content Delivery Network so you can quickly see the result without installing
+# MathJax. However, it is strongly recommended to install a local copy of
+# MathJax from https://www.mathjax.org before deployment. The default value is:
+# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2
+# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_RELPATH =
+
+# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
+# extension names that should be enabled during MathJax rendering. For example
+# for MathJax version 2 (see
+# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions):
+# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
+# For example for MathJax version 3 (see
+# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html):
+# MATHJAX_EXTENSIONS = ams
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_EXTENSIONS =
+
+# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
+# of code that will be used on startup of the MathJax code. See the MathJax site
+# (see:
+# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an
+# example see the documentation.
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_CODEFILE =
+
+# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
+# the HTML output. The underlying search engine uses javascript and DHTML and
+# should work on any modern browser. Note that when using HTML help
+# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
+# there is already a search function so this one should typically be disabled.
+# For large projects the javascript based search engine can be slow, then
+# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
+# search using the keyboard; to jump to the search box use <access key> + S
+# (what the <access key> is depends on the OS and browser, but it is typically
+# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
+# key> to jump into the search results window, the results can be navigated
+# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
+# the search. The filter options can be selected when the cursor is inside the
+# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
+# to select a filter and <Enter> or <escape> to activate or cancel the filter
+# option.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+SEARCHENGINE = NO
+
+# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
+# implemented using a web server instead of a web client using JavaScript. There
+# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
+# setting. When disabled, doxygen will generate a PHP script for searching and
+# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
+# and searching needs to be provided by external tools. See the section
+# "External Indexing and Searching" for details.
+# The default value is: NO.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+SERVER_BASED_SEARCH = NO
+
+# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
+# script for searching. Instead the search results are written to an XML file
+# which needs to be processed by an external indexer. Doxygen will invoke an
+# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
+# search results.
+#
+# Doxygen ships with an example indexer (doxyindexer) and search engine
+# (doxysearch.cgi) which are based on the open source search engine library
+# Xapian (see:
+# https://xapian.org/).
+#
+# See the section "External Indexing and Searching" for details.
+# The default value is: NO.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+EXTERNAL_SEARCH = NO
+
+# The SEARCHENGINE_URL should point to a search engine hosted by a web server
+# which will return the search results when EXTERNAL_SEARCH is enabled.
+#
+# Doxygen ships with an example indexer (doxyindexer) and search engine
+# (doxysearch.cgi) which are based on the open source search engine library
+# Xapian (see:
+# https://xapian.org/). See the section "External Indexing and Searching" for
+# details.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+SEARCHENGINE_URL =
+
+# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
+# search data is written to a file for indexing by an external tool. With the
+# SEARCHDATA_FILE tag the name of this file can be specified.
+# The default file is: searchdata.xml.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+SEARCHDATA_FILE = searchdata.xml
+
+# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
+# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
+# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
+# projects and redirect the results back to the right project.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+EXTERNAL_SEARCH_ID =
+
+# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
+# projects other than the one defined by this configuration file, but that are
+# all added to the same external search index. Each project needs to have a
+# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
+# to a relative location where the documentation can be found. The format is:
+# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+EXTRA_SEARCH_MAPPINGS =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
+# The default value is: YES.
+
+GENERATE_LATEX = YES
+
+# The LATEX_OUTPUT tag is used to specify where the LaTeX 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: latex.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_OUTPUT = latex
+
+# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
+# invoked.
+#
+# Note that when not enabling USE_PDFLATEX the default is latex when enabling
+# USE_PDFLATEX the default is pdflatex and when in the later case latex is
+# chosen this is overwritten by pdflatex. For specific output languages the
+# default can have been set differently, this depends on the implementation of
+# the output language.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_CMD_NAME = latex
+
+# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
+# index for LaTeX.
+# Note: This tag is used in the Makefile / make.bat.
+# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
+# (.tex).
+# The default file is: makeindex.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+MAKEINDEX_CMD_NAME = makeindex
+
+# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
+# generate index for LaTeX. In case there is no backslash (\) as first character
+# it will be automatically added in the LaTeX code.
+# Note: This tag is used in the generated output file (.tex).
+# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
+# The default value is: makeindex.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_MAKEINDEX_CMD = makeindex
+
+# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
+# documents. This may be useful for small projects and may help to save some
+# trees in general.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+COMPACT_LATEX = NO
+
+# The PAPER_TYPE tag can be used to set the paper type that is used by the
+# printer.
+# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
+# 14 inches) and executive (7.25 x 10.5 inches).
+# The default value is: a4.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+PAPER_TYPE = a4
+
+# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
+# that should be included in the LaTeX output. The package can be specified just
+# by its name or with the correct syntax as to be used with the LaTeX
+# \usepackage command. To get the times font for instance you can specify :
+# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
+# To use the option intlimits with the amsmath package you can specify:
+# EXTRA_PACKAGES=[intlimits]{amsmath}
+# If left blank no extra packages will be included.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+EXTRA_PACKAGES =
+
+# The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for
+# the generated LaTeX document. The header should contain everything until the
+# first chapter. If it is left blank doxygen will generate a standard header. It
+# is highly recommended to start with a default header using
+# doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty
+# and then modify the file new_header.tex. See also section "Doxygen usage" for
+# information on how to generate the default header that doxygen normally uses.
+#
+# Note: Only use a user-defined header if you know what you are doing!
+# Note: The header is subject to change so you typically have to regenerate the
+# default header when upgrading to a newer version of doxygen. The following
+# commands have a special meaning inside the header (and footer): For a
+# description of the possible markers and block names see the documentation.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_HEADER =
+
+# The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for
+# the generated LaTeX document. The footer should contain everything after the
+# last chapter. If it is left blank doxygen will generate a standard footer. See
+# LATEX_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. Note: Only use a user-defined footer if you know what you are
+# doing!
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_FOOTER =
+
+# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
+# LaTeX style sheets that are included after the standard style sheets created
+# by doxygen. Using this option one can overrule certain style aspects. 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).
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_EXTRA_STYLESHEET =
+
+# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
+# other source files which should be copied to the LATEX_OUTPUT output
+# directory. Note that the files will be copied as-is; there are no commands or
+# markers available.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_EXTRA_FILES =
+
+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
+# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
+# contain links (just like the HTML output) instead of page references. This
+# makes the output suitable for online browsing using a PDF viewer.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+PDF_HYPERLINKS = NO
+
+# If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as
+# specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX
+# files. Set this option to YES, to get a higher quality PDF documentation.
+#
+# See also section LATEX_CMD_NAME for selecting the engine.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+USE_PDFLATEX = NO
+
+# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
+# command to the generated LaTeX files. This will instruct LaTeX to keep running
+# if errors occur, instead of asking the user for help.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_BATCHMODE = NO
+
+# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
+# index chapters (such as File Index, Compound Index, etc.) in the output.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_HIDE_INDICES = NO
+
+# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
+# bibliography, e.g. plainnat, or ieeetr. See
+# https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
+# The default value is: plain.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_BIB_STYLE = plain
+
+# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
+# page will contain the date and time when the page was generated. Setting this
+# to NO can help when comparing the output of multiple runs.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_TIMESTAMP = NO
+
+# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
+# path from which the emoji images will be read. If a relative path is entered,
+# it will be relative to the LATEX_OUTPUT directory. If left blank the
+# LATEX_OUTPUT directory will be used.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_EMOJI_DIRECTORY =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the RTF output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
+# RTF output is optimized for Word 97 and may not look too pretty with other RTF
+# readers/editors.
+# The default value is: NO.
+
+GENERATE_RTF = NO
+
+# The RTF_OUTPUT tag is used to specify where the RTF 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: rtf.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_OUTPUT = rtf
+
+# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
+# documents. This may be useful for small projects and may help to save some
+# trees in general.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+COMPACT_RTF = NO
+
+# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
+# contain hyperlink fields. The RTF file will contain links (just like the HTML
+# output) instead of page references. This makes the output suitable for online
+# browsing using Word or some other Word compatible readers that support those
+# fields.
+#
+# Note: WordPad (write) and others do not support links.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_HYPERLINKS = NO
+
+# Load stylesheet definitions from file. Syntax is similar to doxygen's
+# configuration file, i.e. a series of assignments. You only have to provide
+# replacements, missing definitions are set to their default value.
+#
+# See also section "Doxygen usage" for information on how to generate the
+# default style sheet that doxygen normally uses.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_STYLESHEET_FILE =
+
+# Set optional variables used in the generation of an RTF document. Syntax is
+# similar to doxygen's configuration file. A template extensions file can be
+# generated using doxygen -e rtf extensionFile.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_EXTENSIONS_FILE =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the man page output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
+# classes and files.
+# The default value is: NO.
+
+GENERATE_MAN = NO
+
+# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it. A directory man3 will be created inside the directory specified by
+# MAN_OUTPUT.
+# The default directory is: man.
+# This tag requires that the tag GENERATE_MAN is set to YES.
+
+MAN_OUTPUT = man
+
+# The MAN_EXTENSION tag determines the extension that is added to the generated
+# man pages. In case the manual section does not start with a number, the number
+# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
+# optional.
+# The default value is: .3.
+# This tag requires that the tag GENERATE_MAN is set to YES.
+
+MAN_EXTENSION = .3
+
+# The MAN_SUBDIR tag determines the name of the directory created within
+# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
+# MAN_EXTENSION with the initial . removed.
+# This tag requires that the tag GENERATE_MAN is set to YES.
+
+MAN_SUBDIR =
+
+# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
+# will generate one additional man file for each entity documented in the real
+# man page(s). These additional files only source the real man page, but without
+# them the man command would be unable to find the correct page.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_MAN is set to YES.
+
+MAN_LINKS = NO
+
+#---------------------------------------------------------------------------
+# Configuration options related to the XML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
+# captures the structure of the code including all documentation.
+# The default value is: NO.
+
+GENERATE_XML = NO
+
+# The XML_OUTPUT tag is used to specify where the XML pages 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: xml.
+# This tag requires that the tag GENERATE_XML is set to YES.
+
+XML_OUTPUT = xml
+
+# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
+# listings (including syntax highlighting and cross-referencing information) to
+# the XML output. Note that enabling this will significantly increase the size
+# of the XML output.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_XML is set to YES.
+
+XML_PROGRAMLISTING = YES
+
+# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
+# namespace members in file scope as well, matching the HTML output.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_XML is set to YES.
+
+XML_NS_MEMB_FILE_SCOPE = NO
+
+#---------------------------------------------------------------------------
+# Configuration options related to the DOCBOOK output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
+# that can be used to generate PDF.
+# The default value is: NO.
+
+GENERATE_DOCBOOK = NO
+
+# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages 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: docbook.
+# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
+
+DOCBOOK_OUTPUT = docbook
+
+#---------------------------------------------------------------------------
+# Configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
+# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures
+# the structure of the code including all documentation. Note that this feature
+# is still experimental and incomplete at the moment.
+# The default value is: NO.
+
+GENERATE_AUTOGEN_DEF = NO
+
+#---------------------------------------------------------------------------
+# Configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
+# file that captures the structure of the code including all documentation.
+#
+# Note that this feature is still experimental and incomplete at the moment.
+# The default value is: NO.
+
+GENERATE_PERLMOD = NO
+
+# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
+# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
+# output from the Perl module output.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
+
+PERLMOD_LATEX = NO
+
+# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
+# formatted so it can be parsed by a human reader. This is useful if you want to
+# understand what is going on. On the other hand, if this tag is set to NO, the
+# size of the Perl module output will be much smaller and Perl will parse it
+# just the same.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
+
+PERLMOD_PRETTY = YES
+
+# The names of the make variables in the generated doxyrules.make file are
+# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
+# so different doxyrules.make files included by the same Makefile don't
+# overwrite each other's variables.
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
+
+PERLMOD_MAKEVAR_PREFIX =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+
+# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
+# C-preprocessor directives found in the sources and include files.
+# The default value is: YES.
+
+ENABLE_PREPROCESSING = YES
+
+# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
+# in the source code. If set to NO, only conditional compilation will be
+# performed. Macro expansion can be done in a controlled way by setting
+# EXPAND_ONLY_PREDEF to YES.
+# The default value is: NO.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+MACRO_EXPANSION = NO
+
+# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
+# the macro expansion is limited to the macros specified with the PREDEFINED and
+# EXPAND_AS_DEFINED tags.
+# The default value is: NO.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+EXPAND_ONLY_PREDEF = NO
+
+# If the SEARCH_INCLUDES tag is set to YES, the include files in the
+# INCLUDE_PATH will be searched if a #include is found.
+# The default value is: YES.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+SEARCH_INCLUDES = YES
+
+# The INCLUDE_PATH tag can be used to specify one or more directories that
+# contain include files that are not input files but should be processed by the
+# preprocessor.
+# This tag requires that the tag SEARCH_INCLUDES is set to YES.
+
+INCLUDE_PATH =
+
+# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
+# patterns (like *.h and *.hpp) to filter out the header-files in the
+# directories. If left blank, the patterns specified with FILE_PATTERNS will be
+# used.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+INCLUDE_FILE_PATTERNS =
+
+# The PREDEFINED tag can be used to specify one or more macro names that are
+# defined before the preprocessor is started (similar to the -D option of e.g.
+# gcc). The argument of the tag is a list of macros of the form: name or
+# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
+# is assumed. To prevent a macro definition from being undefined via #undef or
+# recursively expanded use the := operator instead of the = operator.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+PREDEFINED =
+
+# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
+# tag can be used to specify a list of macro names that should be expanded. The
+# macro definition that is found in the sources will be used. Use the PREDEFINED
+# tag if you want to use a different macro definition that overrules the
+# definition found in the source code.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+EXPAND_AS_DEFINED =
+
+# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
+# remove all references to function-like macros that are alone on a line, have
+# an all uppercase name, and do not end with a semicolon. Such function macros
+# are typically used for boiler-plate code, and will confuse the parser if not
+# removed.
+# The default value is: YES.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+SKIP_FUNCTION_MACROS = YES
+
+#---------------------------------------------------------------------------
+# Configuration options related to external references
+#---------------------------------------------------------------------------
+
+# The TAGFILES tag can be used to specify one or more tag files. For each tag
+# file the location of the external documentation should be added. The format of
+# a tag file without this location is as follows:
+# TAGFILES = file1 file2 ...
+# Adding location for the tag files is done as follows:
+# TAGFILES = file1=loc1 "file2 = loc2" ...
+# where loc1 and loc2 can be relative or absolute paths or URLs. See the
+# section "Linking to external documentation" for more information about the use
+# of tag files.
+# Note: Each tag file must have a unique name (where the name does NOT include
+# the path). If a tag file is not located in the directory in which doxygen is
+# run, you must also specify the path to the tagfile here.
+
+TAGFILES =
+
+# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
+# tag file that is based on the input files it reads. See section "Linking to
+# external documentation" for more information about the usage of tag files.
+
+GENERATE_TAGFILE =
+
+# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
+# the class index. If set to NO, only the inherited external classes will be
+# listed.
+# The default value is: NO.
+
+ALLEXTERNALS = NO
+
+# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
+# in the modules index. If set to NO, only the current project's groups will be
+# listed.
+# The default value is: YES.
+
+EXTERNAL_GROUPS = YES
+
+# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
+# the related pages index. If set to NO, only the current project's pages will
+# be listed.
+# The default value is: YES.
+
+EXTERNAL_PAGES = YES
+
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool
+#---------------------------------------------------------------------------
+
+# You can include diagrams made with dia in doxygen documentation. Doxygen will
+# then run dia to produce the diagram and insert it in the documentation. The
+# DIA_PATH tag allows you to specify the directory where the dia binary resides.
+# If left empty dia is assumed to be found in the default search path.
+
+DIA_PATH =
+
+# If set to YES the inheritance and collaboration graphs will hide inheritance
+# and usage relations if the target is undocumented or is not a class.
+# The default value is: YES.
+
+HIDE_UNDOC_RELATIONS = YES
+
+# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
+# available from the path. This tool is part of Graphviz (see:
+# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
+# Bell Labs. The other options in this section have no effect if this option is
+# set to NO
+# The default value is: NO.
+
+HAVE_DOT = NO
+
+# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
+# to run in parallel. When set to 0 doxygen will base this on the number of
+# processors available in the system. You can set it explicitly to a value
+# larger than 0 to get control over the balance between CPU load and processing
+# speed.
+# Minimum value: 0, maximum value: 32, default value: 0.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_NUM_THREADS = 0
+
+# When you want a differently looking font in the dot files that doxygen
+# generates you can specify the font name using DOT_FONTNAME. You need to make
+# sure dot is able to find the font, which can be done by putting it in a
+# standard location or by setting the DOTFONTPATH environment variable or by
+# setting DOT_FONTPATH to the directory containing the font.
+# The default value is: Helvetica.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_FONTNAME =
+
+# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
+# dot graphs.
+# Minimum value: 4, maximum value: 24, default value: 10.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_FONTSIZE = 10
+
+# By default doxygen will tell dot to use the default font as specified with
+# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
+# the path where dot can find it using this tag.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_FONTPATH =
+
+# If the CLASS_GRAPH tag is set to YES (or GRAPH) then doxygen will generate a
+# graph for each documented class showing the direct and indirect inheritance
+# relations. In case HAVE_DOT is set as well dot will be used to draw the graph,
+# otherwise the built-in generator will be used. If the CLASS_GRAPH tag is set
+# to TEXT the direct and indirect inheritance relations will be shown as texts /
+# links.
+# Possible values are: NO, YES, TEXT and GRAPH.
+# The default value is: YES.
+
+CLASS_GRAPH = TEXT
+
+# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
+# graph for each documented class showing the direct and indirect implementation
+# dependencies (inheritance, containment, and class references variables) of the
+# class with other documented classes.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+COLLABORATION_GRAPH = YES
+
+# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
+# groups, showing the direct groups dependencies.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+GROUP_GRAPHS = YES
+
+# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
+# collaboration diagrams in a style similar to the OMG's Unified Modeling
+# Language.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+UML_LOOK = NO
+
+# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
+# class node. If there are many fields or methods and many nodes the graph may
+# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
+# number of items for each type to make the size more manageable. Set this to 0
+# for no limit. Note that the threshold may be exceeded by 50% before the limit
+# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
+# but if the number exceeds 15, the total amount of fields shown is limited to
+# 10.
+# Minimum value: 0, maximum value: 100, default value: 10.
+# This tag requires that the tag UML_LOOK is set to YES.
+
+UML_LIMIT_NUM_FIELDS = 10
+
+# If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and
+# methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS
+# tag is set to YES, doxygen will add type and arguments for attributes and
+# methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen
+# will not generate fields with class member information in the UML graphs. The
+# class diagrams will look similar to the default class diagrams but using UML
+# notation for the relationships.
+# Possible values are: NO, YES and NONE.
+# The default value is: NO.
+# This tag requires that the tag UML_LOOK is set to YES.
+
+DOT_UML_DETAILS = NO
+
+# The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters
+# to display on a single line. If the actual line length exceeds this threshold
+# significantly it will wrapped across multiple lines. Some heuristics are apply
+# to avoid ugly line breaks.
+# Minimum value: 0, maximum value: 1000, default value: 17.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_WRAP_THRESHOLD = 17
+
+# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
+# collaboration graphs will show the relations between templates and their
+# instances.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+TEMPLATE_RELATIONS = NO
+
+# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
+# YES then doxygen will generate a graph for each documented file showing the
+# direct and indirect include dependencies of the file with other documented
+# files.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+INCLUDE_GRAPH = NO
+
+# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
+# set to YES then doxygen will generate a graph for each documented file showing
+# the direct and indirect include dependencies of the file with other documented
+# files.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+INCLUDED_BY_GRAPH = YES
+
+# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
+# dependency graph for every global function or class method.
+#
+# Note that enabling this option will significantly increase the time of a run.
+# So in most cases it will be better to enable call graphs for selected
+# functions only using the \callgraph command. Disabling a call graph can be
+# accomplished by means of the command \hidecallgraph.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+CALL_GRAPH = NO
+
+# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
+# dependency graph for every global function or class method.
+#
+# Note that enabling this option will significantly increase the time of a run.
+# So in most cases it will be better to enable caller graphs for selected
+# functions only using the \callergraph command. Disabling a caller graph can be
+# accomplished by means of the command \hidecallergraph.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+CALLER_GRAPH = NO
+
+# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
+# hierarchy of all classes instead of a textual one.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+GRAPHICAL_HIERARCHY = YES
+
+# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
+# dependencies a directory has on other directories in a graphical way. The
+# dependency relations are determined by the #include relations between the
+# files in the directories.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DIRECTORY_GRAPH = YES
+
+# The DIR_GRAPH_MAX_DEPTH tag can be used to limit the maximum number of levels
+# of child directories generated in directory dependency graphs by dot.
+# Minimum value: 1, maximum value: 25, default value: 1.
+# This tag requires that the tag DIRECTORY_GRAPH is set to YES.
+
+DIR_GRAPH_MAX_DEPTH = 1
+
+# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
+# generated by dot. For an explanation of the image formats see the section
+# output formats in the documentation of the dot tool (Graphviz (see:
+# http://www.graphviz.org/)).
+# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
+# to make the SVG files visible in IE 9+ (other browsers do not have this
+# requirement).
+# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
+# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
+# png:gdiplus:gdiplus.
+# The default value is: png.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_IMAGE_FORMAT = png
+
+# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
+# enable generation of interactive SVG images that allow zooming and panning.
+#
+# Note that this requires a modern browser other than Internet Explorer. Tested
+# and working are Firefox, Chrome, Safari, and Opera.
+# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
+# the SVG files visible. Older versions of IE do not have SVG support.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+INTERACTIVE_SVG = NO
+
+# The DOT_PATH tag can be used to specify the path where the dot tool can be
+# found. If left blank, it is assumed the dot tool can be found in the path.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_PATH =
+
+# The DOTFILE_DIRS tag can be used to specify one or more directories that
+# contain dot files that are included in the documentation (see the \dotfile
+# command).
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOTFILE_DIRS =
+
+# The MSCFILE_DIRS tag can be used to specify one or more directories that
+# contain msc files that are included in the documentation (see the \mscfile
+# command).
+
+MSCFILE_DIRS =
+
+# The DIAFILE_DIRS tag can be used to specify one or more directories that
+# contain dia files that are included in the documentation (see the \diafile
+# command).
+
+DIAFILE_DIRS =
+
+# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
+# path where java can find the plantuml.jar file or to the filename of jar file
+# to be used. If left blank, it is assumed PlantUML is not used or called during
+# a preprocessing step. Doxygen will generate a warning when it encounters a
+# \startuml command in this case and will not generate output for the diagram.
+
+PLANTUML_JAR_PATH =
+
+# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
+# configuration file for plantuml.
+
+PLANTUML_CFG_FILE =
+
+# When using plantuml, the specified paths are searched for files specified by
+# the !include statement in a plantuml block.
+
+PLANTUML_INCLUDE_PATH =
+
+# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
+# that will be shown in the graph. If the number of nodes in a graph becomes
+# larger than this value, doxygen will truncate the graph, which is visualized
+# by representing a node as a red box. Note that doxygen if the number of direct
+# children of the root node in a graph is already larger than
+# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
+# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
+# Minimum value: 0, maximum value: 10000, default value: 50.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_GRAPH_MAX_NODES = 50
+
+# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
+# generated by dot. A depth value of 3 means that only nodes reachable from the
+# root by following a path via at most 3 edges will be shown. Nodes that lay
+# further from the root node will be omitted. Note that setting this option to 1
+# or 2 may greatly reduce the computation time needed for large code bases. Also
+# note that the size of a graph can be further restricted by
+# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
+# Minimum value: 0, maximum value: 1000, default value: 0.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+MAX_DOT_GRAPH_DEPTH = 0
+
+# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
+# background. This is disabled by default, because dot on Windows does not seem
+# to support this out of the box.
+#
+# Warning: Depending on the platform used, enabling this option may lead to
+# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
+# read).
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_TRANSPARENT = NO
+
+# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
+# files in one run (i.e. multiple -o and -T options on the command line). This
+# makes dot run faster, but since only newer versions of dot (>1.8.10) support
+# this, this feature is disabled by default.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_MULTI_TARGETS = NO
+
+# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
+# explaining the meaning of the various boxes and arrows in the dot generated
+# graphs.
+# Note: This tag requires that UML_LOOK isn't set, i.e. the doxygen internal
+# graphical representation for inheritance and collaboration diagrams is used.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+GENERATE_LEGEND = NO
+
+# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate
+# files that are used to generate the various graphs.
+#
+# Note: This setting is not only used for dot files but also for msc temporary
+# files.
+# The default value is: YES.
+
+DOT_CLEANUP = NO
diff --git a/doc/mainpage.md.in b/doc/mainpage.md.in
new file mode 100644
index 0000000000000000000000000000000000000000..1d77fb195878dc2673ef1848f2fd6a11dde9fc4b
--- /dev/null
+++ b/doc/mainpage.md.in
@@ -0,0 +1,46 @@
+\mainpage @PROJECT_NAME@ manual
+
+@PROJECT_NAME@ is a shared libary (lib@PROJECT_NAME@.so) and CLI application that allows one to generate EIS spectra with high performance. The target application is generateing test and example datasets for machine lerning applications.
+
+@PROJECT_NAME@'s development and target platform is GNU/Linux, but besides a c++20 compile and libstd++ it has no dependancies and should compile on nigh any platform.
+
+@PROJECT_NAME@ also has python bindings, not described here but note that useing these erases a lot of the performance benefit of using this libary
+
+for an example on how to use the libary see example tab above
+
+for a description on how the model description string used by this libary see \ref modelpage
+
+## Execution models:
+
+lib@PROJECT_NAME@ incoperates three execution models to choose from depending on your workloads requirements:
+
+### Tree execution
+
+Upon invocation of eis::Model::Model the model string is parsed into a tree of objects. In the default tree execution the model parameters and frequencies are passed down the tree with the help of the virtual function tables of the the objects in question (black arrows). The results are then passed up the tree (blue arrows), see figure below:
+
+\image html DirectExecution.svg width=800px
+
+This execution model has the advantage of very low latency at the expense of throughput. It is most optimal if few impedances are to be calcuated.
+This exection model will be chosen by default.
+
+### Compiled execution
+
+In compiled execution eis::Model::compile genreates a c++ function containing an implementation of of the equivalent circuit. This code is then compiled by gcc and loaded and cached by lib@PROJECT_NAME@. Subsiquent calls to eis::Model::compile will then use the cached object.
+Once a model has been compiled any Subsiquent use of the execute family of methods will us the compiled object instead of tree exection.
+This results in a speedup of 10x from the reduction in function call overhead and the usage of vectorization.
+
+\image html CompiledExecution.svg width=800px
+
+This execution model is the most performant option when evalution of many impedances is desired and exection is to be performed on a cpu.
+This exection model is only available on UNIX and UNIX-like platforms provideing [dlopen()](https://man7.org/linux/man-pages/man3/dlopen.3.html) and [fork()](https://www.man7.org/linux/man-pages/man2/fork.2.html).
+
+### TorchScript exection
+
+The final exection model generates a [TorchScript](https://pytorch.org/docs/stable/jit.html) for the equivalent circuit which can be compiled using [torch::jit::compile](https://pytorch.org/cppdocs/api/function_namespacetorch_1_1jit_1a8660dc13a6b82336aadac667e6dccba1.html) into a graph of torch/rocBLAS/cuBLAS gpu kernels for gpu exection. This provides the highesst possble performance. Due to the high latency associated with executing gpu kernels this methods should only be expected to outperform compiled execution if 10^8 or more datapoints are required and only performs well when a large batch of datapoints is required at a time. This version is also highly advantagous when calculateing impedance spectra as part of a larger system requireing gpu execution as in this case expensive device->host->device copies are avoided. Though torch autograd this version also provides analytic derivatives makeing it usefull where integration into machine-lerning backward passes is required. Due to defficanies in the windows port of Torch this version massively underperforms on Microsoft Windows and another platform should be used.
+
+\image html TorchExecution.svg width=800px
+
+-----------------------------------------------------------
+
+@PROJECT_NAME@ is licenced to you under the Gnu Lesser General Public License Version 3.0
+
diff --git a/doc/modelspage.md.in b/doc/modelspage.md.in
new file mode 100644
index 0000000000000000000000000000000000000000..2b57b81c24528fec12330bd903f435fc8773f371
--- /dev/null
+++ b/doc/modelspage.md.in
@@ -0,0 +1,55 @@
+\page modelpage Model Format
+
+The model format of @PROJECT_NAME@ encodes any sieres/ parralell combination of implemented impedances
+
+Curretly @PROJECT_NAME@ supports the following elements which eatch have a number of parameters:
+* c: cap
+ * one parameter: capacitance {C}
+* r: resistor
+ * one parameter: resistance {R}
+* l: inductor
+ * one parameter: inductance {L}
+* w: warburg element (infinite), one parameters {A}
+ * one parameter: Warburg coefficant {A}
+* p: constant phase element
+ * two parameters: {Q, alpha}
+* t: finite approximation of a transmition line
+ * three parameters: capacitance, resistance, approximation order {C, R, n}
+
+## Combinations
+
+Combinations of these elements are achived by writeing them against eatch other for a parralell combination, or with a '-' in between for serial combinatsions:
+
+"r-c" is thus a serial combination of a resistor and a capacitance:
+| r-c |
+| :---- |
+| \image html r-c.svg width=300px |
+
+While "cr" is a parralell combination of a resistor and a capacitance:
+| rc |
+| :---- |
+| \image html rc.svg width=300px |
+
+While "r-cr" is a parralell combination of a resistor and a capacitance in series with another resistance, not that the implicit parralell operator has operator precedence:
+| r-cr |
+| :---- |
+| \image html r-rc.svg width=300px |
+
+Brakets ( and ) are also support and modify the order of operations as one would expect "(r-c)r" is a series combination of a resistor and a capacitance in parralell with another resistance:
+| (r-c)r |
+| :---- |
+| \image html _r-c_r.svg width=300px |
+
+## Parameters
+
+To pass circut element parameters to @PROJECT_NAME@ a format embedded into the strings is perfered. Parameters are passed by adding them in braces behind the element thus "r{100}-c{3e-6}r{1e4}" is a 100 Ohm resistor in series with a 3 Microfarad capacitance that is in parralell with a 3 kOhm resistance.
+
+When a element takes multiple parameters, those are seperated by a ',' like so: r{5e4}-p{1e-5, 0.8}
+
+Ranges are also supported, here ~ is used as a seperator between the start and the end of a range, thus r{1~1e3} is a resistor with a value in a linear range between 1 and 1000 Ohms. By adding a trailing 'L' the range can be marked as distrobuted logathithmicly in base 10, thus r{1~1e3L} is sutch a logarithmic range.
+
+Ranges are used to make @PROJECT_NAME@ generate spectra for all combinations of parameters in the range(s) of the circuit elements.
+
+## Translators
+
+For interoperability with other software, translators to and from @PROJECT_NAME@ model generators are available see \ref TRANS
diff --git a/doc/r-c.svg b/doc/r-c.svg
new file mode 100644
index 0000000000000000000000000000000000000000..3c39d0a79756f08feb88004cf958abd99b4d2f8b
--- /dev/null
+++ b/doc/r-c.svg
@@ -0,0 +1,389 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+
+<svg
+ width="32.0457mm"
+ height="8.1327mm"
+ viewBox="0 0 32.0457 8.1327"
+ version="1.1"
+ id="svg1"
+ inkscape:version="1.3.2 (091e20ef0f, 2023-11-25, custom)"
+ sodipodi:docname="r-c.svg"
+ xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+ xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+ xmlns="http://www.w3.org/2000/svg"
+ xmlns:svg="http://www.w3.org/2000/svg">
+ <sodipodi:namedview
+ id="namedview1"
+ pagecolor="#ffffff"
+ bordercolor="#000000"
+ borderopacity="0.25"
+ inkscape:showpageshadow="2"
+ inkscape:pageopacity="0.0"
+ inkscape:pagecheckerboard="0"
+ inkscape:deskcolor="#d1d1d1"
+ inkscape:document-units="mm"
+ inkscape:zoom="0.73940797"
+ inkscape:cx="-146.73902"
+ inkscape:cy="-20.2865"
+ inkscape:window-width="1920"
+ inkscape:window-height="1054"
+ inkscape:window-x="0"
+ inkscape:window-y="0"
+ inkscape:window-maximized="1"
+ inkscape:current-layer="layer1" />
+ <defs
+ id="defs1" />
+ <g
+ inkscape:label="Layer 1"
+ inkscape:groupmode="layer"
+ id="layer1"
+ transform="translate(-143.93333,-153.9875)">
+ <g
+ id="g1332"
+ transform="translate(58.038733,67.124199)">
+ <g
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ id="g1063">
+ <g
+ id="g1043" />
+ <g
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.508;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ id="g1044">
+ <path
+ style="fill:none;fill-opacity:0;stroke:#000000;stroke-width:0.508;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ d="M 106.807,94.742 V 90.678"
+ id="path1043" />
+ <path
+ style="fill:none;fill-opacity:0;stroke:#000000;stroke-width:0.508;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ d="M 105.283,94.742 V 90.678"
+ id="path1044" />
+ </g>
+ <g
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ id="g1062">
+ <path
+ d="m 105.029,92.71 h -2.794"
+ id="path1045" />
+ <path
+ d="m 107.061,92.71 h 2.794"
+ id="path1046" />
+ <text
+ x="106.045"
+ y="88.264999"
+ textLength="1.4732"
+ font-size="1.6933px"
+ lengthAdjust="spacingAndGlyphs"
+ text-anchor="middle"
+ opacity="0"
+ id="text1046">C</text>
+ <g
+ class="stroked-text"
+ id="g1061">
+ <desc
+ id="desc1046">C</desc>
+ <path
+ d="m 106.438,88.0886 -0.0604,0.0605"
+ id="path1047" />
+ <path
+ d="m 106.3776,88.1491 -0.1815,0.0604"
+ id="path1048" />
+ <path
+ d="m 106.1961,88.2095 h -0.1209"
+ id="path1049" />
+ <path
+ d="m 106.0752,88.2095 -0.1814,-0.0604"
+ id="path1050" />
+ <path
+ d="m 105.8938,88.1491 -0.121,-0.121"
+ id="path1051" />
+ <path
+ d="m 105.7728,88.0281 -0.0605,-0.121"
+ id="path1052" />
+ <path
+ d="m 105.7123,87.9071 -0.0604,-0.2419"
+ id="path1053" />
+ <path
+ d="M 105.6519,87.6652 V 87.4838"
+ id="path1054" />
+ <path
+ d="m 105.6519,87.4838 0.0604,-0.2419"
+ id="path1055" />
+ <path
+ d="m 105.7123,87.2419 0.0605,-0.1209"
+ id="path1056" />
+ <path
+ d="M 105.7728,87.121 105.8938,87"
+ id="path1057" />
+ <path
+ d="m 105.8938,87 0.1814,-0.0605"
+ id="path1058" />
+ <path
+ d="m 106.0752,86.9395 h 0.1209"
+ id="path1059" />
+ <path
+ d="M 106.1961,86.9395 106.3776,87"
+ id="path1060" />
+ <path
+ d="m 106.3776,87 0.0604,0.0605"
+ id="path1061" />
+ </g>
+ </g>
+ </g>
+ <g
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ id="g1079">
+ <g
+ id="g1064" />
+ <g
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.254;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ id="g1065">
+ <rect
+ x="93.980003"
+ y="91.694"
+ width="5.0799999"
+ height="2.0320001"
+ rx="0.000000"
+ id="rect1064" />
+ </g>
+ <g
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ id="g1078">
+ <path
+ d="M 93.98,92.71 H 92.71"
+ id="path1065" />
+ <path
+ d="m 99.06,92.71 h 1.27"
+ id="path1066" />
+ <text
+ x="96.519997"
+ y="89.535004"
+ textLength="1.4732"
+ font-size="1.6933px"
+ lengthAdjust="spacingAndGlyphs"
+ text-anchor="middle"
+ opacity="0"
+ id="text1066">R</text>
+ <g
+ class="stroked-text"
+ id="g1077">
+ <desc
+ id="desc1066">R</desc>
+ <path
+ d="M 96.913,89.4795 96.4897,88.8748"
+ id="path1067" />
+ <path
+ d="m 96.1873,89.4795 v -1.27"
+ id="path1068" />
+ <path
+ d="m 96.1873,88.2095 h 0.4838"
+ id="path1069" />
+ <path
+ d="m 96.6711,88.2095 0.121,0.0605"
+ id="path1070" />
+ <path
+ d="m 96.7921,88.27 0.0605,0.0605"
+ id="path1071" />
+ <path
+ d="m 96.8526,88.3305 0.0604,0.1209"
+ id="path1072" />
+ <path
+ d="m 96.913,88.4514 v 0.1815"
+ id="path1073" />
+ <path
+ d="m 96.913,88.6329 -0.0604,0.1209"
+ id="path1074" />
+ <path
+ d="m 96.8526,88.7538 -0.0605,0.0605"
+ id="path1075" />
+ <path
+ d="m 96.7921,88.8143 -0.121,0.0605"
+ id="path1076" />
+ <path
+ d="M 96.6711,88.8748 H 96.1873"
+ id="path1077" />
+ </g>
+ </g>
+ </g>
+ <g
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ id="g1201">
+ <text
+ x="113.8238"
+ y="93.435799"
+ textLength="3.2269001"
+ font-size="1.6933px"
+ lengthAdjust="spacingAndGlyphs"
+ text-anchor="start"
+ opacity="0"
+ id="text1173">out</text>
+ <g
+ class="stroked-text"
+ id="g1200">
+ <desc
+ id="desc1173">out</desc>
+ <path
+ d="m 114.4078,93.3803 -0.121,-0.0604"
+ id="path1173" />
+ <path
+ d="m 114.2868,93.3199 -0.0605,-0.0605"
+ id="path1174" />
+ <path
+ d="m 114.2263,93.2594 -0.0604,-0.121"
+ id="path1175" />
+ <path
+ d="M 114.1659,93.1384 V 92.7756"
+ id="path1176" />
+ <path
+ d="m 114.1659,92.7756 0.0604,-0.121"
+ id="path1177" />
+ <path
+ d="m 114.2263,92.6546 0.0605,-0.0605"
+ id="path1178" />
+ <path
+ d="m 114.2868,92.5941 0.121,-0.0604"
+ id="path1179" />
+ <path
+ d="m 114.4078,92.5337 h 0.1814"
+ id="path1180" />
+ <path
+ d="m 114.5892,92.5337 0.1209,0.0604"
+ id="path1181" />
+ <path
+ d="m 114.7101,92.5941 0.0605,0.0605"
+ id="path1182" />
+ <path
+ d="m 114.7706,92.6546 0.0605,0.121"
+ id="path1183" />
+ <path
+ d="m 114.8311,92.7756 v 0.3628"
+ id="path1184" />
+ <path
+ d="m 114.8311,93.1384 -0.0605,0.121"
+ id="path1185" />
+ <path
+ d="m 114.7706,93.2594 -0.0605,0.0605"
+ id="path1186" />
+ <path
+ d="m 114.7101,93.3199 -0.1209,0.0604"
+ id="path1187" />
+ <path
+ d="m 114.5892,93.3803 h -0.1814"
+ id="path1188" />
+ <path
+ d="m 115.9196,92.5337 v 0.8466"
+ id="path1189" />
+ <path
+ d="m 115.3753,92.5337 v 0.6652"
+ id="path1190" />
+ <path
+ d="m 115.3753,93.1989 0.0605,0.121"
+ id="path1191" />
+ <path
+ d="m 115.4358,93.3199 0.121,0.0604"
+ id="path1192" />
+ <path
+ d="m 115.5568,93.3803 h 0.1814"
+ id="path1193" />
+ <path
+ d="m 115.7382,93.3803 0.1209,-0.0604"
+ id="path1194" />
+ <path
+ d="m 115.8591,93.3199 0.0605,-0.0605"
+ id="path1195" />
+ <path
+ d="m 116.3429,92.5337 h 0.4838"
+ id="path1196" />
+ <path
+ d="m 116.5243,92.1103 v 1.0886"
+ id="path1197" />
+ <path
+ d="m 116.5243,93.1989 0.0605,0.121"
+ id="path1198" />
+ <path
+ d="m 116.5848,93.3199 0.121,0.0604"
+ id="path1199" />
+ <path
+ d="m 116.7058,93.3803 h 0.1209"
+ id="path1200" />
+ </g>
+ <path
+ style="fill:none;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ d="m 112.395,92.71 1.1113,1.2704 h 4.3578 V 92.71 91.4396 h -4.3578 z"
+ id="path1201" />
+ </g>
+ <text
+ x="88.741203"
+ y="93.435799"
+ textLength="1.957"
+ font-size="1.6933px"
+ lengthAdjust="spacingAndGlyphs"
+ text-anchor="end"
+ opacity="0"
+ id="text1259"
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1">in</text>
+ <g
+ class="stroked-text"
+ id="g1271"
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1">
+ <desc
+ id="desc1259">in</desc>
+ <path
+ d="M 87.1895,93.3803 V 92.5337"
+ id="path1259" />
+ <path
+ d="m 87.1895,92.1103 -0.0604,0.0605"
+ id="path1260" />
+ <path
+ d="m 87.1291,92.1708 0.0604,0.0605"
+ id="path1261" />
+ <path
+ d="M 87.1895,92.2313 87.25,92.1708"
+ id="path1262" />
+ <path
+ d="M 87.25,92.1708 87.1895,92.1103"
+ id="path1263" />
+ <path
+ d="m 87.1895,92.1103 v 0.121"
+ id="path1264" />
+ <path
+ d="m 87.7943,92.5337 v 0.8466"
+ id="path1265" />
+ <path
+ d="m 87.7943,92.6546 0.0605,-0.0605"
+ id="path1266" />
+ <path
+ d="m 87.8548,92.5941 0.121,-0.0604"
+ id="path1267" />
+ <path
+ d="m 87.9758,92.5337 h 0.1814"
+ id="path1268" />
+ <path
+ d="m 88.1572,92.5337 0.1209,0.0604"
+ id="path1269" />
+ <path
+ d="m 88.2781,92.5941 0.0605,0.121"
+ id="path1270" />
+ <path
+ d="m 88.3386,92.7151 v 0.6652"
+ id="path1271" />
+ </g>
+ <path
+ style="fill:none;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ d="m 90.17,92.71 -1.1113,-1.2704 h -3.0879 v 1.2704 1.2704 h 3.0879 z"
+ id="path1272" />
+ <path
+ d="m 90.17,92.71 h 2.54"
+ id="path1273"
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1" />
+ <path
+ d="m 109.855,92.71 h 2.54"
+ id="path1294"
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1" />
+ <path
+ d="m 100.33,92.71 h 1.905"
+ id="path1295"
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1" />
+ </g>
+ </g>
+</svg>
diff --git a/doc/r-rc.svg b/doc/r-rc.svg
new file mode 100644
index 0000000000000000000000000000000000000000..067f2e3430aefffe3da905d0cc5e9560686f0f38
--- /dev/null
+++ b/doc/r-rc.svg
@@ -0,0 +1,475 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+
+<svg
+ width="32.0457mm"
+ height="18.419704mm"
+ viewBox="0 0 32.0457 18.419704"
+ version="1.1"
+ id="svg1"
+ xmlns="http://www.w3.org/2000/svg"
+ xmlns:svg="http://www.w3.org/2000/svg">
+ <defs
+ id="defs1" />
+ <g
+ id="layer1"
+ transform="translate(-96.043745,-160.07292)">
+ <g
+ id="g1339"
+ transform="translate(10.784145,42.729616)">
+ <g
+ id="g1334">
+ <g
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ id="g973">
+ <g
+ id="g958" />
+ <g
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.254;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ id="g959">
+ <rect
+ x="101.6"
+ y="133.604"
+ width="5.0799999"
+ height="2.0320001"
+ rx="0.000000"
+ id="rect958" />
+ </g>
+ <g
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ id="g972">
+ <path
+ d="m 101.6,134.62 h -1.27"
+ id="path959" />
+ <path
+ d="m 106.68,134.62 h 1.27"
+ id="path960" />
+ <text
+ x="104.14"
+ y="131.44501"
+ textLength="1.4732"
+ font-size="1.6933px"
+ lengthAdjust="spacingAndGlyphs"
+ text-anchor="middle"
+ opacity="0"
+ id="text960">R</text>
+ <g
+ class="stroked-text"
+ id="g971">
+ <desc
+ id="desc960">R</desc>
+ <path
+ d="m 104.533,131.3895 -0.4233,-0.6047"
+ id="path961" />
+ <path
+ d="m 103.8073,131.3895 v -1.27"
+ id="path962" />
+ <path
+ d="m 103.8073,130.1195 h 0.4838"
+ id="path963" />
+ <path
+ d="m 104.2911,130.1195 0.121,0.0605"
+ id="path964" />
+ <path
+ d="m 104.4121,130.18 0.0605,0.0605"
+ id="path965" />
+ <path
+ d="m 104.4726,130.2405 0.0604,0.1209"
+ id="path966" />
+ <path
+ d="m 104.533,130.3614 v 0.1815"
+ id="path967" />
+ <path
+ d="m 104.533,130.5429 -0.0604,0.1209"
+ id="path968" />
+ <path
+ d="m 104.4726,130.6638 -0.0605,0.0605"
+ id="path969" />
+ <path
+ d="m 104.4121,130.7243 -0.121,0.0605"
+ id="path970" />
+ <path
+ d="m 104.2911,130.7848 h -0.4838"
+ id="path971" />
+ </g>
+ </g>
+ </g>
+ <g
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ id="g989">
+ <g
+ id="g974" />
+ <g
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.254;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ id="g975">
+ <rect
+ x="92.074997"
+ y="127.254"
+ width="5.0799999"
+ height="2.0320001"
+ rx="0.000000"
+ id="rect974" />
+ </g>
+ <g
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ id="g988">
+ <path
+ d="m 92.075,128.27 h -1.27"
+ id="path975" />
+ <path
+ d="m 97.155,128.27 h 1.27"
+ id="path976" />
+ <text
+ x="94.614998"
+ y="125.095"
+ textLength="1.4732"
+ font-size="1.6933px"
+ lengthAdjust="spacingAndGlyphs"
+ text-anchor="middle"
+ opacity="0"
+ id="text976">R</text>
+ <g
+ class="stroked-text"
+ id="g987">
+ <desc
+ id="desc976">R</desc>
+ <path
+ d="m 95.008,125.0395 -0.4233,-0.6047"
+ id="path977" />
+ <path
+ d="m 94.2823,125.0395 v -1.27"
+ id="path978" />
+ <path
+ d="m 94.2823,123.7695 h 0.4838"
+ id="path979" />
+ <path
+ d="m 94.7661,123.7695 0.121,0.0605"
+ id="path980" />
+ <path
+ d="m 94.8871,123.83 0.0605,0.0605"
+ id="path981" />
+ <path
+ d="m 94.9476,123.8905 0.0604,0.1209"
+ id="path982" />
+ <path
+ d="m 95.008,124.0114 v 0.1815"
+ id="path983" />
+ <path
+ d="m 95.008,124.1929 -0.0604,0.1209"
+ id="path984" />
+ <path
+ d="m 94.9476,124.3138 -0.0605,0.0605"
+ id="path985" />
+ <path
+ d="m 94.8871,124.3743 -0.121,0.0605"
+ id="path986" />
+ <path
+ d="M 94.7661,124.4348 H 94.2823"
+ id="path987" />
+ </g>
+ </g>
+ </g>
+ <g
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ id="g1100">
+ <g
+ id="g1080" />
+ <g
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.508;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ id="g1081">
+ <path
+ style="fill:none;fill-opacity:0;stroke:#000000;stroke-width:0.508;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ d="m 104.902,125.222 v -4.064"
+ id="path1080" />
+ <path
+ style="fill:none;fill-opacity:0;stroke:#000000;stroke-width:0.508;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ d="m 103.378,125.222 v -4.064"
+ id="path1081" />
+ </g>
+ <g
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ id="g1099">
+ <path
+ d="M 103.124,123.19 H 100.33"
+ id="path1082" />
+ <path
+ d="m 105.156,123.19 h 2.794"
+ id="path1083" />
+ <text
+ x="104.14"
+ y="118.745"
+ textLength="1.4732"
+ font-size="1.6933px"
+ lengthAdjust="spacingAndGlyphs"
+ text-anchor="middle"
+ opacity="0"
+ id="text1083">C</text>
+ <g
+ class="stroked-text"
+ id="g1098">
+ <desc
+ id="desc1083">C</desc>
+ <path
+ d="m 104.533,118.5686 -0.0604,0.0605"
+ id="path1084" />
+ <path
+ d="m 104.4726,118.6291 -0.1815,0.0604"
+ id="path1085" />
+ <path
+ d="m 104.2911,118.6895 h -0.1209"
+ id="path1086" />
+ <path
+ d="m 104.1702,118.6895 -0.1814,-0.0604"
+ id="path1087" />
+ <path
+ d="m 103.9888,118.6291 -0.121,-0.121"
+ id="path1088" />
+ <path
+ d="m 103.8678,118.5081 -0.0605,-0.121"
+ id="path1089" />
+ <path
+ d="m 103.8073,118.3871 -0.0604,-0.2419"
+ id="path1090" />
+ <path
+ d="m 103.7469,118.1452 v -0.1814"
+ id="path1091" />
+ <path
+ d="m 103.7469,117.9638 0.0604,-0.2419"
+ id="path1092" />
+ <path
+ d="m 103.8073,117.7219 0.0605,-0.1209"
+ id="path1093" />
+ <path
+ d="m 103.8678,117.601 0.121,-0.121"
+ id="path1094" />
+ <path
+ d="m 103.9888,117.48 0.1814,-0.0605"
+ id="path1095" />
+ <path
+ d="m 104.1702,117.4195 h 0.1209"
+ id="path1096" />
+ <path
+ d="m 104.2911,117.4195 0.1815,0.0605"
+ id="path1097" />
+ <path
+ d="m 104.4726,117.48 0.0604,0.0605"
+ id="path1098" />
+ </g>
+ </g>
+ </g>
+ <g
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ id="g1143">
+ <text
+ x="88.106201"
+ y="128.9958"
+ textLength="1.957"
+ font-size="1.6933px"
+ lengthAdjust="spacingAndGlyphs"
+ text-anchor="end"
+ opacity="0"
+ id="text1130">in</text>
+ <g
+ class="stroked-text"
+ id="g1142">
+ <desc
+ id="desc1130">in</desc>
+ <path
+ d="m 86.5545,128.9403 v -0.8466"
+ id="path1130" />
+ <path
+ d="m 86.5545,127.6703 -0.0604,0.0605"
+ id="path1131" />
+ <path
+ d="m 86.4941,127.7308 0.0604,0.0605"
+ id="path1132" />
+ <path
+ d="m 86.5545,127.7913 0.0605,-0.0605"
+ id="path1133" />
+ <path
+ d="m 86.615,127.7308 -0.0605,-0.0605"
+ id="path1134" />
+ <path
+ d="m 86.5545,127.6703 v 0.121"
+ id="path1135" />
+ <path
+ d="m 87.1593,128.0937 v 0.8466"
+ id="path1136" />
+ <path
+ d="m 87.1593,128.2146 0.0605,-0.0605"
+ id="path1137" />
+ <path
+ d="m 87.2198,128.1541 0.121,-0.0604"
+ id="path1138" />
+ <path
+ d="m 87.3408,128.0937 h 0.1814"
+ id="path1139" />
+ <path
+ d="m 87.5222,128.0937 0.1209,0.0604"
+ id="path1140" />
+ <path
+ d="m 87.6431,128.1541 0.0605,0.121"
+ id="path1141" />
+ <path
+ d="m 87.7036,128.2751 v 0.6652"
+ id="path1142" />
+ </g>
+ <path
+ style="fill:none;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ d="m 89.535,128.27 -1.1113,-1.2704 h -3.0879 v 1.2704 1.2704 h 3.0879 z"
+ id="path1143" />
+ </g>
+ <g
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ id="g1230">
+ <text
+ x="113.1888"
+ y="128.9958"
+ textLength="3.2269001"
+ font-size="1.6933px"
+ lengthAdjust="spacingAndGlyphs"
+ text-anchor="start"
+ opacity="0"
+ id="text1202">out</text>
+ <g
+ class="stroked-text"
+ id="g1229">
+ <desc
+ id="desc1202">out</desc>
+ <path
+ d="m 113.7728,128.9403 -0.121,-0.0604"
+ id="path1202" />
+ <path
+ d="m 113.6518,128.8799 -0.0605,-0.0605"
+ id="path1203" />
+ <path
+ d="m 113.5913,128.8194 -0.0604,-0.121"
+ id="path1204" />
+ <path
+ d="m 113.5309,128.6984 v -0.3628"
+ id="path1205" />
+ <path
+ d="m 113.5309,128.3356 0.0604,-0.121"
+ id="path1206" />
+ <path
+ d="m 113.5913,128.2146 0.0605,-0.0605"
+ id="path1207" />
+ <path
+ d="m 113.6518,128.1541 0.121,-0.0604"
+ id="path1208" />
+ <path
+ d="m 113.7728,128.0937 h 0.1814"
+ id="path1209" />
+ <path
+ d="m 113.9542,128.0937 0.1209,0.0604"
+ id="path1210" />
+ <path
+ d="m 114.0751,128.1541 0.0605,0.0605"
+ id="path1211" />
+ <path
+ d="m 114.1356,128.2146 0.0605,0.121"
+ id="path1212" />
+ <path
+ d="m 114.1961,128.3356 v 0.3628"
+ id="path1213" />
+ <path
+ d="m 114.1961,128.6984 -0.0605,0.121"
+ id="path1214" />
+ <path
+ d="m 114.1356,128.8194 -0.0605,0.0605"
+ id="path1215" />
+ <path
+ d="m 114.0751,128.8799 -0.1209,0.0604"
+ id="path1216" />
+ <path
+ d="m 113.9542,128.9403 h -0.1814"
+ id="path1217" />
+ <path
+ d="m 115.2846,128.0937 v 0.8466"
+ id="path1218" />
+ <path
+ d="m 114.7403,128.0937 v 0.6652"
+ id="path1219" />
+ <path
+ d="m 114.7403,128.7589 0.0605,0.121"
+ id="path1220" />
+ <path
+ d="m 114.8008,128.8799 0.121,0.0604"
+ id="path1221" />
+ <path
+ d="m 114.9218,128.9403 h 0.1814"
+ id="path1222" />
+ <path
+ d="m 115.1032,128.9403 0.1209,-0.0604"
+ id="path1223" />
+ <path
+ d="m 115.2241,128.8799 0.0605,-0.0605"
+ id="path1224" />
+ <path
+ d="m 115.7079,128.0937 h 0.4838"
+ id="path1225" />
+ <path
+ d="m 115.8893,127.6703 v 1.0886"
+ id="path1226" />
+ <path
+ d="m 115.8893,128.7589 0.0605,0.121"
+ id="path1227" />
+ <path
+ d="m 115.9498,128.8799 0.121,0.0604"
+ id="path1228" />
+ <path
+ d="m 116.0708,128.9403 h 0.1209"
+ id="path1229" />
+ </g>
+ <path
+ style="fill:none;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ d="m 111.76,128.27 1.1113,1.2704 h 4.3578 v -1.2704 -1.2704 h -4.3578 z"
+ id="path1230" />
+ </g>
+ <path
+ d="m 89.535,128.27 h 1.27"
+ id="path1281"
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1" />
+ <path
+ d="m 100.33,128.27 v 6.35"
+ id="path1282"
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1" />
+ <path
+ d="m 107.95,128.27 v 6.35"
+ id="path1283"
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1" />
+ <path
+ d="m 98.425,128.27 h 1.905"
+ id="path1284"
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1" />
+ <path
+ d="m 107.95,123.19 v 5.08"
+ id="path1286"
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1" />
+ <path
+ d="m 100.33,123.19 v 5.08"
+ id="path1290"
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1" />
+ <path
+ d="m 107.95,128.27 h 3.81"
+ id="path1296"
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1" />
+ </g>
+ <g
+ id="g1338">
+ <circle
+ cx="107.95"
+ cy="128.27"
+ r="0.45719999"
+ id="circle1327"
+ style="fill:#000000;fill-opacity:1;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1" />
+ <circle
+ cx="100.33"
+ cy="128.27"
+ r="0.45719999"
+ id="circle1328"
+ style="fill:#000000;fill-opacity:1;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1" />
+ </g>
+ </g>
+ </g>
+</svg>
diff --git a/doc/rc.svg b/doc/rc.svg
new file mode 100644
index 0000000000000000000000000000000000000000..a483a4ae354372df58f8dd6ee6a952524d489339
--- /dev/null
+++ b/doc/rc.svg
@@ -0,0 +1,418 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+
+<svg
+ width="32.0457mm"
+ height="18.419703mm"
+ viewBox="0 0 32.0457 18.419703"
+ version="1.1"
+ id="svg1"
+ inkscape:version="1.3.2 (091e20ef0f, 2023-11-25, custom)"
+ sodipodi:docname="rc.svg"
+ xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+ xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+ xmlns="http://www.w3.org/2000/svg"
+ xmlns:svg="http://www.w3.org/2000/svg">
+ <sodipodi:namedview
+ id="namedview1"
+ pagecolor="#ffffff"
+ bordercolor="#000000"
+ borderopacity="0.25"
+ inkscape:showpageshadow="2"
+ inkscape:pageopacity="0.0"
+ inkscape:pagecheckerboard="0"
+ inkscape:deskcolor="#d1d1d1"
+ inkscape:document-units="mm"
+ inkscape:zoom="0.73940797"
+ inkscape:cx="-104.81359"
+ inkscape:cy="-81.146001"
+ inkscape:window-width="1920"
+ inkscape:window-height="1054"
+ inkscape:window-x="0"
+ inkscape:window-y="0"
+ inkscape:window-maximized="1"
+ inkscape:current-layer="layer1" />
+ <defs
+ id="defs1" />
+ <g
+ inkscape:label="Layer 1"
+ inkscape:groupmode="layer"
+ id="layer1"
+ transform="translate(-132.82083,-170.12708)">
+ <g
+ id="g1340"
+ transform="translate(47.561228,73.738781)">
+ <g
+ id="g1333">
+ <g
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ id="g936">
+ <g
+ id="g921" />
+ <g
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.254;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ id="g922">
+ <rect
+ x="97.790001"
+ y="112.649"
+ width="5.0799999"
+ height="2.0320001"
+ rx="0.000000"
+ id="rect921" />
+ </g>
+ <g
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ id="g935">
+ <path
+ d="M 97.79,113.665 H 96.52"
+ id="path922" />
+ <path
+ d="m 102.87,113.665 h 1.27"
+ id="path923" />
+ <text
+ x="100.33"
+ y="110.49"
+ textLength="1.4732"
+ font-size="1.6933px"
+ lengthAdjust="spacingAndGlyphs"
+ text-anchor="middle"
+ opacity="0"
+ id="text923">R</text>
+ <g
+ class="stroked-text"
+ id="g934">
+ <desc
+ id="desc923">R</desc>
+ <path
+ d="m 100.723,110.4345 -0.4233,-0.6047"
+ id="path924" />
+ <path
+ d="m 99.9973,110.4345 v -1.27"
+ id="path925" />
+ <path
+ d="m 99.9973,109.1645 h 0.4838"
+ id="path926" />
+ <path
+ d="m 100.4811,109.1645 0.121,0.0605"
+ id="path927" />
+ <path
+ d="m 100.6021,109.225 0.0605,0.0605"
+ id="path928" />
+ <path
+ d="m 100.6626,109.2855 0.0604,0.1209"
+ id="path929" />
+ <path
+ d="m 100.723,109.4064 v 0.1815"
+ id="path930" />
+ <path
+ d="m 100.723,109.5879 -0.0604,0.1209"
+ id="path931" />
+ <path
+ d="m 100.6626,109.7088 -0.0605,0.0605"
+ id="path932" />
+ <path
+ d="m 100.6021,109.7693 -0.121,0.0605"
+ id="path933" />
+ <path
+ d="M 100.4811,109.8298 H 99.9973"
+ id="path934" />
+ </g>
+ </g>
+ </g>
+ <g
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ id="g957">
+ <g
+ id="g937" />
+ <g
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.508;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ id="g938">
+ <path
+ style="fill:none;fill-opacity:0;stroke:#000000;stroke-width:0.508;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ d="m 101.092,104.267 v -4.064"
+ id="path937" />
+ <path
+ style="fill:none;fill-opacity:0;stroke:#000000;stroke-width:0.508;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ d="m 99.568,104.267 v -4.064"
+ id="path938" />
+ </g>
+ <g
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ id="g956">
+ <path
+ d="M 99.314,102.235 H 96.52"
+ id="path939" />
+ <path
+ d="m 101.346,102.235 h 2.794"
+ id="path940" />
+ <text
+ x="100.33"
+ y="97.790001"
+ textLength="1.4732"
+ font-size="1.6933px"
+ lengthAdjust="spacingAndGlyphs"
+ text-anchor="middle"
+ opacity="0"
+ id="text940">C</text>
+ <g
+ class="stroked-text"
+ id="g955">
+ <desc
+ id="desc940">C</desc>
+ <path
+ d="m 100.723,97.6136 -0.0604,0.0605"
+ id="path941" />
+ <path
+ d="m 100.6626,97.6741 -0.1815,0.0604"
+ id="path942" />
+ <path
+ d="m 100.4811,97.7345 h -0.1209"
+ id="path943" />
+ <path
+ d="m 100.3602,97.7345 -0.1814,-0.0604"
+ id="path944" />
+ <path
+ d="m 100.1788,97.6741 -0.121,-0.121"
+ id="path945" />
+ <path
+ d="m 100.0578,97.5531 -0.0605,-0.121"
+ id="path946" />
+ <path
+ d="M 99.9973,97.4321 99.9369,97.1902"
+ id="path947" />
+ <path
+ d="M 99.9369,97.1902 V 97.0088"
+ id="path948" />
+ <path
+ d="m 99.9369,97.0088 0.0604,-0.2419"
+ id="path949" />
+ <path
+ d="m 99.9973,96.7669 0.0605,-0.1209"
+ id="path950" />
+ <path
+ d="m 100.0578,96.646 0.121,-0.121"
+ id="path951" />
+ <path
+ d="m 100.1788,96.525 0.1814,-0.0605"
+ id="path952" />
+ <path
+ d="m 100.3602,96.4645 h 0.1209"
+ id="path953" />
+ <path
+ d="m 100.4811,96.4645 0.1815,0.0605"
+ id="path954" />
+ <path
+ d="m 100.6626,96.525 0.0604,0.0605"
+ id="path955" />
+ </g>
+ </g>
+ </g>
+ <g
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ id="g1129">
+ <text
+ x="113.1888"
+ y="108.0408"
+ textLength="3.2269001"
+ font-size="1.6933px"
+ lengthAdjust="spacingAndGlyphs"
+ text-anchor="start"
+ opacity="0"
+ id="text1101">out</text>
+ <g
+ class="stroked-text"
+ id="g1128">
+ <desc
+ id="desc1101">out</desc>
+ <path
+ d="m 113.7728,107.9853 -0.121,-0.0604"
+ id="path1101" />
+ <path
+ d="m 113.6518,107.9249 -0.0605,-0.0605"
+ id="path1102" />
+ <path
+ d="m 113.5913,107.8644 -0.0604,-0.121"
+ id="path1103" />
+ <path
+ d="m 113.5309,107.7434 v -0.3628"
+ id="path1104" />
+ <path
+ d="m 113.5309,107.3806 0.0604,-0.121"
+ id="path1105" />
+ <path
+ d="m 113.5913,107.2596 0.0605,-0.0605"
+ id="path1106" />
+ <path
+ d="m 113.6518,107.1991 0.121,-0.0604"
+ id="path1107" />
+ <path
+ d="m 113.7728,107.1387 h 0.1814"
+ id="path1108" />
+ <path
+ d="m 113.9542,107.1387 0.1209,0.0604"
+ id="path1109" />
+ <path
+ d="m 114.0751,107.1991 0.0605,0.0605"
+ id="path1110" />
+ <path
+ d="m 114.1356,107.2596 0.0605,0.121"
+ id="path1111" />
+ <path
+ d="m 114.1961,107.3806 v 0.3628"
+ id="path1112" />
+ <path
+ d="m 114.1961,107.7434 -0.0605,0.121"
+ id="path1113" />
+ <path
+ d="m 114.1356,107.8644 -0.0605,0.0605"
+ id="path1114" />
+ <path
+ d="m 114.0751,107.9249 -0.1209,0.0604"
+ id="path1115" />
+ <path
+ d="m 113.9542,107.9853 h -0.1814"
+ id="path1116" />
+ <path
+ d="m 115.2846,107.1387 v 0.8466"
+ id="path1117" />
+ <path
+ d="m 114.7403,107.1387 v 0.6652"
+ id="path1118" />
+ <path
+ d="m 114.7403,107.8039 0.0605,0.121"
+ id="path1119" />
+ <path
+ d="m 114.8008,107.9249 0.121,0.0604"
+ id="path1120" />
+ <path
+ d="m 114.9218,107.9853 h 0.1814"
+ id="path1121" />
+ <path
+ d="m 115.1032,107.9853 0.1209,-0.0604"
+ id="path1122" />
+ <path
+ d="m 115.2241,107.9249 0.0605,-0.0605"
+ id="path1123" />
+ <path
+ d="m 115.7079,107.1387 h 0.4838"
+ id="path1124" />
+ <path
+ d="m 115.8893,106.7153 v 1.0886"
+ id="path1125" />
+ <path
+ d="m 115.8893,107.8039 0.0605,0.121"
+ id="path1126" />
+ <path
+ d="m 115.9498,107.9249 0.121,0.0604"
+ id="path1127" />
+ <path
+ d="m 116.0708,107.9853 h 0.1209"
+ id="path1128" />
+ </g>
+ <path
+ style="fill:none;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ d="m 111.76,107.315 1.1113,1.2704 h 4.3578 v -1.2704 -1.2704 h -4.3578 z"
+ id="path1129" />
+ </g>
+ <g
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ id="g1244">
+ <text
+ x="88.106201"
+ y="108.0408"
+ textLength="1.957"
+ font-size="1.6933px"
+ lengthAdjust="spacingAndGlyphs"
+ text-anchor="end"
+ opacity="0"
+ id="text1231">in</text>
+ <g
+ class="stroked-text"
+ id="g1243">
+ <desc
+ id="desc1231">in</desc>
+ <path
+ d="m 86.5545,107.9853 v -0.8466"
+ id="path1231" />
+ <path
+ d="m 86.5545,106.7153 -0.0604,0.0605"
+ id="path1232" />
+ <path
+ d="m 86.4941,106.7758 0.0604,0.0605"
+ id="path1233" />
+ <path
+ d="m 86.5545,106.8363 0.0605,-0.0605"
+ id="path1234" />
+ <path
+ d="m 86.615,106.7758 -0.0605,-0.0605"
+ id="path1235" />
+ <path
+ d="m 86.5545,106.7153 v 0.121"
+ id="path1236" />
+ <path
+ d="m 87.1593,107.1387 v 0.8466"
+ id="path1237" />
+ <path
+ d="m 87.1593,107.2596 0.0605,-0.0605"
+ id="path1238" />
+ <path
+ d="m 87.2198,107.1991 0.121,-0.0604"
+ id="path1239" />
+ <path
+ d="m 87.3408,107.1387 h 0.1814"
+ id="path1240" />
+ <path
+ d="m 87.5222,107.1387 0.1209,0.0604"
+ id="path1241" />
+ <path
+ d="m 87.6431,107.1991 0.0605,0.121"
+ id="path1242" />
+ <path
+ d="m 87.7036,107.3201 v 0.6652"
+ id="path1243" />
+ </g>
+ <path
+ style="fill:none;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1"
+ d="m 89.535,107.315 -1.1113,-1.2704 h -3.0879 v 1.2704 1.2704 h 3.0879 z"
+ id="path1244" />
+ </g>
+ <path
+ d="m 96.52,107.315 v 6.35"
+ id="path1276"
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1" />
+ <path
+ d="m 104.14,107.315 v 6.35"
+ id="path1277"
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1" />
+ <path
+ d="m 96.52,107.315 v -5.08"
+ id="path1278"
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1" />
+ <path
+ d="M 89.535,107.315 H 96.52"
+ id="path1285"
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1" />
+ <path
+ d="m 104.14,102.235 v 5.08"
+ id="path1292"
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1" />
+ <path
+ d="m 104.14,107.315 h 7.62"
+ id="path1293"
+ style="fill:#000000;fill-opacity:0;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1" />
+ </g>
+ <circle
+ cx="104.14"
+ cy="107.315"
+ r="0.45719999"
+ id="circle1329"
+ style="fill:#000000;fill-opacity:1;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1" />
+ <circle
+ cx="96.519997"
+ cy="107.315"
+ r="0.45719999"
+ id="circle1331"
+ style="fill:#000000;fill-opacity:1;stroke:#000000;stroke-width:0.1524;stroke-linecap:round;stroke-linejoin:round;stroke-opacity:1" />
+ </g>
+ </g>
+</svg>
diff --git a/eisgenerator/basicmath.h b/eisgenerator/basicmath.h
index 1daab85c16628f8648497f53caa38730a36446b8..5fed9d57b2224c25996b0e46cf880d144062b610 100644
--- a/eisgenerator/basicmath.h
+++ b/eisgenerator/basicmath.h
@@ -2,24 +2,153 @@
#include <vector>
#include "eistype.h"
+
+
namespace eis
{
+ /**
+ Various math functions perfomed on eisgenerator types
+ * @defgroup MATH Math
+ * @{
+ */
+
+ /**
+ * @brief Calculates the element wise absolute gradiant at the given point of the data given
+ *
+ * @param data the data to calculate the gradiant on
+ * @param index the position in the data to calculate the gradiant at
+ * @return the element wise absolute gradiant abs(re(grad(a)))+abs(im(grad(a)))i
+ */
std::complex<fvalue> absGrad(const std::vector<eis::DataPoint>& data, size_t index);
+
+ /**
+ * @brief Calculates derivative at the given point of the data given
+ *
+ * @param data the data to calculate the gradiant on
+ * @param index the position in the data to calculate the gradiant at
+ * @return the derivative
+ */
fvalue grad(const std::vector<fvalue>& data, const std::vector<fvalue>& omega, size_t index);
+
+ /**
+ * @brief Calculates the gradiant at the given point of the data given
+ *
+ * @param data the data to calculate the gradiant on
+ * @param index the position in the data to calculate the gradiant at
+ * @return the gradiant
+ */
std::complex<fvalue> grad(const std::vector<eis::DataPoint>& data, size_t index);
+
+ /**
+ * @brief Calculates the mean of the given data
+ *
+ * @param data the data to calculate the mean of
+ * @return the mean
+ */
fvalue mean(const std::vector<fvalue>& data);
+
+ /**
+ * @brief Calculates the mean of the given data
+ *
+ * @param data the data to calculate the mean of
+ * @return the mean
+ */
std::complex<fvalue> mean(const std::vector<eis::DataPoint>& data);
+
+ /**
+ * @brief Calculates the median of the given data
+ *
+ * @param data the data to calculate the median of
+ * @return the median
+ */
fvalue median(std::vector<fvalue> data);
+
+ /**
+ * @brief Calculates the median of the given data
+ *
+ * @param data the data to calculate the median of
+ * @return the median
+ */
std::complex<fvalue> median(const std::vector<eis::DataPoint>& data);
+
+ /**
+ * @brief Resamples the data to the given amount of points
+ *
+ * @param data data to resample
+ * @param outputSize size to resample to
+ * @return the resampled data
+ */
std::vector<eis::DataPoint> rescale(const std::vector<eis::DataPoint>& data, size_t outputSize);
+
+ /**
+ * @brief Calculates the pearson correlation between the imaginary and the real part of the data
+ *
+ * @param data data caluclate the pearson correlation on
+ * @return the pearson correlation coefficent
+ */
fvalue pearsonCorrelation(const std::vector<eis::DataPoint>& data);
+
+ /**
+ * @brief Calculates the variance of the distance of the data from a centroid in the nyquist plane
+ *
+ * @param data the data to calculate on
+ * @param centroid the centroid to use, if nullptr is passed here, the mean of the data will be used as the centroid
+ * @return the pearson correlation coefficent
+ */
fvalue nyquistAreaVariance(const std::vector<eis::DataPoint>& data, eis::DataPoint* centroid = nullptr);
+
+ /**
+ * @brief Finds the maximum distance between subsiquent points in the data in the nyquist plane
+ *
+ * @param data the data to use
+ * @return the largest distance
+ */
fvalue maximumNyquistJump(const std::vector<eis::DataPoint>& data);
+
+ /**
+ * @brief Adds white noise to the data
+ *
+ * @param data the data to add noise to
+ * @param amplitude the amplitude of the noise
+ * @param relative if true the amplitude will be taken as relative to the magnitude of the data, otherwise it will be taken as an absolute value
+ */
void noise(std::vector<eis::DataPoint>& data, double amplitude, bool relative);
+
+ /**
+ * @brief Removes duplicate data points form the data
+ * duplicates are detected by checking the value of omega for samenes using fvalueEq with the default ulp
+ *
+ * @param data the data to remove duplicates from
+ */
void removeDuplicates(std::vector<eis::DataPoint>& data);
+
+ /**
+ * @brief Checks two fvalues for equality
+ *
+ * Equality is considered given when the values are within ulp epsilons at the magnitude of the sum of operands.
+ *
+ * @param a the first value to compeare
+ * @param b the second value to compeare
+ * @return true if equal, false if unequal
+ */
bool fvalueEq(fvalue a, fvalue b, unsigned int ulp = 4);
+
+ /**
+ * @brief this function resamples, extrapolates and intrapolates to fit the data given to the frequencies also given
+ *
+ * Data is resampled to the target size, iterpolation for datapoints is performed using linear interpolation
+ * extrapolation is performed using linear or base 10 logarithmic extrapolation.
+ *
+ * @param omegas the frequencies to resample the data to
+ * @param data the data to resample
+ * @param linearExtrapolation true if linear extrapolation is to be perfomed, otherwise base 10 logarithmic extrapolation is used
+ * @return the resampled data
+ */
std::vector<eis::DataPoint> fitToFrequencies(std::vector<fvalue> omegas,
const std::vector<eis::DataPoint>& data,
bool linearExtrapolation = false);
+
+ /** @} */
}
+
diff --git a/eisgenerator/eistype.h b/eisgenerator/eistype.h
index 78ed81b91ec55d9bbf48fd18515444712ee23b26..7da3023e0b57335dd7c7d7f828cecca8a01ac183 100644
--- a/eisgenerator/eistype.h
+++ b/eisgenerator/eistype.h
@@ -6,16 +6,28 @@
#include <cmath>
#include <filesystem>
+/**
+ * @brief Datatype for all calculations
+ */
typedef float fvalue;
namespace eis
{
+/**
+* Types used by eisgenerator
+* @defgroup TYPES Types
+* @{
+*/
+
+/**
+* @brief Basic singluar EIS data point
+*/
class DataPoint
{
public:
- std::complex<fvalue> im;
- fvalue omega;
+ std::complex<fvalue> im; /**< Complex impedance */
+ fvalue omega; /**< Frequency of the complex impedance */
DataPoint() = default;
DataPoint(std::complex<fvalue> imIn, fvalue omegaIn = 0): im(imIn), omega(omegaIn){}
bool operator<(const DataPoint& in) const
@@ -59,35 +71,68 @@ public:
im = im / in;
return *this;
}
+ /**
+ * @brief calculates the absolute value of the complex impedance
+ *
+ * @return absolute value of the complex impedance
+ */
fvalue complexVectorLength() const
{
return std::sqrt(std::pow(im.real(), 2) + std::pow(im.imag(), 2));
}
};
+
+/**
+* @brief A range
+*/
class Range
{
public:
- fvalue start;
- fvalue end;
- size_t count = 0;
- size_t step = 0;
- bool log = false;
+ fvalue start; /**< Start of the range*/
+ fvalue end; /**< End of the range*/
+ size_t count = 0; /**< Numer of elements in the range*/
+ size_t step = 0; /**< Currently active step*/
+ bool log = false; /**< True if the elements in the range are to be spaced in log10 increments*/
+ /**
+ * @brief calculats the distance between elements in the range
+ * will calcuate the log10 of the distance if the range is logarithmic
+ *
+ * @return the distance between steps of this range
+ */
fvalue stepSize() const
{
fvalue startL = log ? log10(start) : start;
fvalue endL = log ? log10(end) : end;
return (endL-startL)/(count-1);
}
+
+ /**
+ * @brief calucates the value of the current step
+ *
+ * @return the value of the current step
+ */
fvalue stepValue() const
{
return at(step);
}
+
+ /**
+ * @brief calucates the mean of the start and the end values
+ *
+ * @return the mean of the start and the end values
+ */
fvalue center() const
{
return (start+end)/2;
}
+
+ /**
+ * @brief calucates the value at the given index
+ *
+ * @return the value at the given index
+ */
fvalue at(size_t index) const
{
assert(index < count || (index == 0 && count == 0));
@@ -95,6 +140,7 @@ public:
return start;
return log ? pow(10, stepSize()*index+log10(start)) : stepSize()*index+start;
}
+
fvalue operator[](size_t index) const
{
return at(index);
@@ -117,13 +163,51 @@ public:
}
Range(fvalue startI, fvalue endI, size_t countI, bool logI = false): start(startI), end(endI), count(countI), log(logI){}
Range() = default;
+
+ /**
+ * @brief prints the range to stdout via eis::Log
+ *
+ * @param level the eis::Log::Level to print at
+ */
void print(int level) const;
+
+ /**
+ * @brief gets a machine parsable string encodeing this range
+ *
+ * @return the string
+ */
std::string getString() const;
+
+ /**
+ * @brief checks if the values of this range are sane
+ * this checks for some common errors like haveing a end < beign
+ *
+ * @return true if sane, false if not
+ */
bool isSane() const;
+
+ /**
+ * @brief this function consturcts a vector that contains all elements of this range
+ *
+ * @return the vector with the elments of this range
+ */
std::vector<fvalue> getRangeVector() const;
- static Range fromString(std::string str, size_t count);
- static std::vector<Range> rangesFromParamString(const std::string& paramStr, size_t count);
+ /**
+ * @brief this function creates a range from the parsable string
+ *
+ * @throw std::invalid_argument when the string syntax is incorrect
+ * @return the range that was parsed from the string
+ */
+ [[nodiscard]] static Range fromString(std::string str, size_t count);
+
+ /**
+ * @brief this function creates a vector ranges from the parsable parameter array string
+ *
+ * @throw std::invalid_argument when the string syntax is incorrect
+ * @return the vector of ranges that was parsed from the string
+ */
+ [[nodiscard]] static std::vector<Range> rangesFromParamString(const std::string& paramStr, size_t count);
};
class parse_errror: public std::exception
@@ -166,39 +250,204 @@ public:
std::vector<std::string> labelNames;
public:
- EisSpectra(const std::vector<DataPoint>& dataIn, const std::string& modelIn, const std::string& headerIn,
- std::vector<double> labelsIn = std::vector<double>(),
- std::vector<std::string> labelNamesIn = std::vector<std::string>());
- EisSpectra(const std::vector<DataPoint>& dataIn, const std::string& modelIn, const std::string& headerIn,
- std::vector<float> labelsIn, std::vector<std::string> labelNamesIn = std::vector<std::string>());
- EisSpectra(const std::vector<DataPoint>& dataIn, const std::string& modelIn, const std::string& headerIn,
- std::vector<size_t> labelsIn, std::vector<std::string> labelNamesIn = std::vector<std::string>());
- EisSpectra(const std::vector<DataPoint>& dataIn, const std::string& modelIn, const std::string& headerIn,
- size_t label, size_t maxLabel, std::vector<std::string> labelNamesIn = std::vector<std::string>());
+ /**
+ * @brief Constructs a EisSpectra
+ *
+ * @param data vector of the data points of the spectra
+ * @param model model descritpion string for this spectra
+ * @param header a freform text that will be inclded in any save of this spectra
+ * @param labels an optional vector of giving the values of the inputs of the model to get this spectra
+ * @param labelNames an optional vector of names describing every input of the model
+ */
+ EisSpectra(const std::vector<DataPoint>& data, const std::string& model, const std::string& header,
+ std::vector<double> labels = std::vector<double>(),
+ std::vector<std::string> labelNames = std::vector<std::string>());
+
+ /**
+ * @brief Constructs a EisSpectra
+ * this function differes from the above only in the datatype of the label
+ *
+ * @param data vector of the data points of the spectra
+ * @param model model descritpion string for this spectra
+ * @param header a freform text that will be inclded in any save of this spectra
+ * @param labels an optional vector of giving the values of the inputs of the model to get this spectra
+ * @param labelNames an optional vector of names describing every input of the model
+ */
+ EisSpectra(const std::vector<DataPoint>& data, const std::string& model, const std::string& header,
+ std::vector<float> labels, std::vector<std::string> labelNames = std::vector<std::string>());
+
+ /**
+ * @brief Constructs a EisSpectra
+ * this function differes from the above only in the datatype of the label
+ *
+ * @param data vector of the data points of the spectra
+ * @param model model descritpion string for this spectra
+ * @param header a freform text that will be inclded in any save of this spectra
+ * @param labels an optional vector of giving the values of the inputs of the model to get this spectra
+ * @param labelNames an optional vector of names describing every input of the model
+ */
+ EisSpectra(const std::vector<DataPoint>& data, const std::string& model, const std::string& header,
+ std::vector<size_t> labels, std::vector<std::string> labelNames = std::vector<std::string>());
+
+ /**
+ * @brief Constructs a EisSpectra
+ * this function differes from the above only in the datatype of the label
+ *
+ * @param data vector of the data points of the spectra
+ * @param model model descritpion string for this spectra
+ * @param header a freeform text that will be inclded in any save of this spectra
+ * @param label a value corrisponding to all inputs of the model
+ * @param maxLabel the number of inputs of the model
+ */
+ EisSpectra(const std::vector<DataPoint>& data, const std::string& model, const std::string& header,
+ size_t label, size_t maxLabel, std::vector<std::string> labelNames = std::vector<std::string>());
+
+ /**
+ * @brief Constructs a EisSpectra by loading a EIS file from disk
+ *
+ * @throw eis::file_error if there is an error loading the file
+ * @param path the path to the file
+ */
EisSpectra(const std::filesystem::path& path){*this = loadFromDisk(path);}
+
EisSpectra(){}
- [[nodiscard]] static EisSpectra loadFromDisk(const std::filesystem::path& path);
- [[nodiscard]] static EisSpectra loadFromStream(std::istream& path);
+
+ /**
+ * @brief Constructs a EisSpectra by loading a EIS file from disk
+ *
+ * @throw eis::file_error if there is an error loading the file
+ * @param path the path to the file
+ * @return the EisSpectra
+ */
+ [[nodiscard]] static EisSpectra loadFromDisk(const std::filesystem::path& path);
+
+ /**
+ * @brief Constructs a EisSpectra by loading a EIS file from a stream
+ *
+ * @throw eis::file_error if there is an error loading the file
+ * @param stream the stream that contains the EIS file
+ * @return the EisSpectra
+ */
+ [[nodiscard]] static EisSpectra loadFromStream(std::istream& stream);
+
+ /**
+ * @brief Constructs a EisSpectra by loading a EIS file from a stream
+ *
+ * @param stream the stream that contains the EIS file
+ * @return the EisSpectra
+ */
void setLabel(size_t label, size_t maxLabel);
+
+ /**
+ * @brief Gets the input value of this model, where it is a single value
+ *
+ * @return the input value
+ */
size_t getLabel();
+
+ /**
+ * @brief Sets the input values of this model
+ *
+ * @param label the input values
+ */
void setSzLabels(std::vector<size_t> label);
+
+ /**
+ * @brief Sets the input values of this model
+ *
+ * @param label the input values
+ */
void setLabels(const std::vector<double>& labelsIn);
+
+ /**
+ * @brief Sets the input values of this model
+ *
+ * @param label the input values
+ */
void setLabels(const std::vector<float>& labelsIn);
+
+ /**
+ * @brief Sets the input values of this model
+ *
+ * @param label the input values
+ */
std::vector<size_t> getSzLabels() const;
+
+ /**
+ * @brief Returns true if there are multiple inputs, false otherwise
+ *
+ * @return true if there are multiple inputs, false otherwise
+ */
bool isMulticlass();
+
+ /**
+ * @brief Returns the inputs as a vector
+ *
+ * @return the inputs as a vector
+ */
std::vector<fvalue> getFvalueLabels();
+
+ /**
+ * @brief Saves the spectra to disk
+ *
+ * @param path a path to the file on disk where the spectra shal be saved
+ * @return true on sucess, false on failure
+ */
bool saveToDisk(const std::filesystem::path& path) const;
+
+ /**
+ * @brief Saves the spectra in the given stream
+ *
+ * @param stream a std::ostream into which the specta will be saved
+ */
void saveToStream(std::ostream& stream) const;
};
-bool saveToDisk(const EisSpectra& data, const std::filesystem::path& path);
+/**
+ * @brief deprecated function use eis::EisSpectra::saveToDisk instead
+ */
+[[deprecated]] bool saveToDisk(const EisSpectra& data, const std::filesystem::path& path);
-EisSpectra loadFromDisk(const std::filesystem::path& path);
+/**
+ * @brief deprecated function use eis::EisSpectra::loadFromDisk instead
+ */
+[[deprecated]] [[nodiscard]] EisSpectra loadFromDisk(const std::filesystem::path& path);
+/**
+* @brief Returns the a vector of DataPoints as a pair of valarrays
+*
+* @return a pair of valarrays first the real part and second the imaginary part
+*/
std::pair<std::valarray<fvalue>, std::valarray<fvalue>> eisToValarrays(const std::vector<eis::DataPoint>& b);
+/**
+* @brief Returns the mean l2 element wise distance of he given spectra
+*
+* @param a the first set of points
+* @param b the second set of points, must be the same length as a
+* @return the mean l2 distance
+*/
fvalue eisDistance(const std::vector<eis::DataPoint>& a, const std::vector<eis::DataPoint>& b);
+
+/**
+* @brief Returns the mean distance of the points in a to the linearly interporlated nyquist curve of b
+*
+* This implementation is quite slow
+*
+* @param a the first set of points
+* @param b the second set of points
+* @return the mean nyquist distance
+*/
fvalue eisNyquistDistance(const std::vector<eis::DataPoint>& a, const std::vector<eis::DataPoint>& b);
+/** @} */
+
}
+
+std::ostream &operator<<(std::ostream &s, eis::DataPoint const& dp);
+
+std::ostream &operator<<(std::ostream &s, eis::Range const& range);
+
+std::ostream &operator<<(std::ostream &s, eis::EisSpectra const& spectra);
+
diff --git a/eisgenerator/model.h b/eisgenerator/model.h
index 2fd622b94a9ee49122e73f13ea5e8007dd26635d..c2f590f6512327b8439eac89f5ae64e9c0654262 100644
--- a/eisgenerator/model.h
+++ b/eisgenerator/model.h
@@ -14,6 +14,15 @@ namespace eis
struct CompiledObject;
+/**
+* Eis modeling
+* @defgroup MODELING Modeling
+* @{
+*/
+
+/**
+* @brief The main class of eisgenerator reprisenting a equivalent circuit model
+*/
class Model
{
private:
@@ -36,33 +45,224 @@ private:
CompiledObject* _compiledModel = nullptr;
public:
+
+ /**
+ * @brief Constructor
+ *
+ * @throws parse_errror
+ * @param str the model string to create a model object for
+ * @param paramSweepCount optionally the number of sweep point to use for parameter sweeps
+ * @param defaultToRange optionally a bool that if true, circut elements not given in str are defaulted to a range instead of a fixed value
+ */
Model(const std::string& str, size_t paramSweepCount = 100, bool defaultToRange = true);
Model(const Model& in);
Model& operator=(const Model& in);
~Model();
+
+ /**
+ * @brief Ajusts the sweep count so that the total of spectra that need to be generated in the parameter sweep is close to the given value
+ *
+ * @param totalCount the total number of spectra to target
+ * @return the number of spectra that will be generated by a parameter sweep after calling this function, should be close to, but may not be exactly totalCount
+ */
size_t setParamSweepCountClosestTotal(size_t totalCount);
+
+ /**
+ * @brief Gets the impedance at the given frequency
+ * this method calls resolveSteps
+ *
+ * @param omega the frequency in rad/s to calculate the impedance at
+ * @param index an optional intex to the parameter sweep step at which to calculate the impedance
+ * @return a DataPoint struct containing the result
+ */
DataPoint execute(fvalue omaga, size_t index = 0);
+
+ /**
+ * @brief Executes a frequency sweep along the given range
+ * this method calls resolveSteps
+ *
+ * @param omega the range along which to execute a frequency sweep
+ * @param index an optional intex to the parameter sweep step at which to calculate the impedance
+ * @return a vector of DataPoint structs containing the impedance at every frequency in the sweep
+ */
std::vector<DataPoint> executeSweep(const Range& omega, size_t index = 0);
+
+ /**
+ * @brief Executes a frequency sweep with the given omega values
+ *
+ * @param omega a vector of frequencyies in rad/s to calculate the impedance at
+ * @param index an optional intex to the parameter sweep step at which to calculate the impedance
+ * @return a vector of DataPoint structs containing the impedance at every frequency in the sweep
+ */
std::vector<DataPoint> executeSweep(const std::vector<fvalue>& omega, size_t index = 0);
+
+ /**
+ * @brief Executes a frequency sweep with the given omega values for eatch parameter combination in the applied parameter sweep
+ * this method calls resolveSteps
+ *
+ * @param omega the range along which to execute a frequency sweep
+ * @return a vector of vectors of DataPoint structs containing the impedance at every frequency in the sweep with every parameter combination
+ */
std::vector<std::vector<DataPoint>> executeAllSweeps(const Range& omega);
+
+ /**
+ * @brief Returns the model string corrisponding to this model object, without embeded parameters
+ *
+ * @return the model string corrisponding to this model object, without embeded parameters
+ */
std::string getModelStr() const;
+
+ /**
+ * @brief Returns the model string corrisponding to this model object, with embeded parameters
+ * this method calls resolveSteps
+ *
+ * @param index the parameter sweep index for which to embed the parameters
+ * @return the model string corrisponding to this model object, with embeded parameters
+ */
std::string getModelStrWithParam(size_t index);
+
+ /**
+ * @brief Returns the model string corrisponding to this model object, with embeded parameters
+ * the parameter sweep index of the last call to resolveSteps or 0 is used
+ *
+ * @return the model string corrisponding to this model object, with embeded parameters
+ */
std::string getModelStrWithParam() const;
+
+ /**
+ * @brief Returns a uinique id that is unique for this circut, but not for this object specifically
+
+ * @return the uid
+ */
size_t getUuid();
+
+ /**
+ * @brief Returns a vector of pointers to the circuit elements in this model
+ * the pointers can only be assumbed to be valid until the next member call to this model object
+ *
+ * @param model for internal use only
+ * @return a vector of the circuit elements in the model
+ */
std::vector<Componant*> getFlatComponants(Componant *model = nullptr);
+
+ /**
+ * @brief gets the values of the parameters of the circuit elements at the current parameter sweep step
+ *
+ * @return the values of the parameters of the circuit elements at the current parameter sweep step
+ */
std::vector<fvalue> getFlatParameters();
+
+ /**
+ * @brief gets the ranges of the parameters of the circuit elements
+ *
+ * @return the ranges of the parameters of the circuit elements
+ */
std::vector<Range> getFlatParameterRanges();
+
+ /**
+ * @brief gets the default ranges of the parameters of eatch type of circuit elemen used in the model
+ *
+ * @return the default ranges of the parameters of eatch type of circuit elemen used in the model
+ */
std::vector<Range> getDefaultParameters();
+
+ /**
+ * @brief gets the total number of parameters used by all the circuit elements in this model
+ *
+ * @return the total number of parameters
+ */
size_t getParameterCount();
+
+ /**
+ * @brief this function compiles the model into native vectorized code for faster execution
+ *
+ * This function compiles a shared-object for this model that is then loaded by eisgenerator to
+ * speed up execution of this model by a factor of 10 or more by employing vectorization and avoiding
+ * function calls.
+ *
+ * This function is slow, but results are cached for the lifetime of process linked to libeisgenerator
+ * so that a circuit has to be compiled only once and can then be used by any number of Model objects.
+ *
+ * This function is only implemented on UNIX, on other platforms this function will allways return false.
+ * This function also requires that gcc be availble in PATH.
+ *
+ * @return true if compile was sucessfull, false otherwise
+ */
bool compile();
+
+ /**
+ * @brief this member determines if the model is in a state ready to execute
+ *
+ * @return true if the model is ready for the execute* family of methods
+ */
bool isReady();
+
+ /**
+ * @brief this member resolves the parameters of all circuit elements at the given parameter sweep step
+ *
+ * @param index the index to the sweep step to resolve to
+ */
void resolveSteps(int64_t index);
+
+ /**
+ * @brief gets the total number of parameter sweep steps for the applied sweep
+ *
+ * @return the total number of parameter sweep steps for the applied sweep
+ */
size_t getRequiredStepsForSweeps();
+
+ /**
+ * @brief checks if the model is a sweep (ie has at least one paramter with a range)
+ *
+ * @return true if the model contains a parameter sweep, false otherwise
+ */
bool isParamSweep();
+
+ /**
+ * @brief compiles this model into efficant c++ code corrisponding to the circuit of this model
+ *
+ * @return the code or an empty string if compilation was unsucessfull
+ */
std::string getCode();
+
+ /**
+ * @brief compiles this model into TorchScript
+ * to be compiled by torch::jit::compile
+ *
+ * @return the TorchScript code or an empty string if compilation was unsucessfull
+ */
std::string getTorchScript();
+
+ /**
+ * @brief Gets the function name in the code for this model
+ *
+ * @return the function name in the code for this model
+ */
std::string getCompiledFunctionName();
+
+ /**
+ * @brief Gets the function name in the code returned by getTorchScript and getCode for this model
+ *
+ * @return the function name in the code for this model
+ */
std::vector<size_t> getRecommendedParamIndices(eis::Range omegaRange, double distance, bool threaded = false);
};
+/**
+ * @example simple.cpp
+ * A simple example in how to use eisgenerator
+ */
+
+/**
+ * @example compileing.cpp
+ * An example on how to use the eisgenerator compiled execution model
+ */
+
+/**
+ * @example torchscript.cpp
+ * An example on how to use the eisgenerator torch execution model
+ */
+
+/** @} */
+
}
diff --git a/eisgenerator/normalize.h b/eisgenerator/normalize.h
index bfaf1a1794393bd81154c05a16fb63dbe5b5993d..74d4d1df18c98d260e0525090c389aaf851f9b4c 100644
--- a/eisgenerator/normalize.h
+++ b/eisgenerator/normalize.h
@@ -5,11 +5,44 @@
#include "eistype.h"
#include "model.h"
+
namespace eis
{
+/**
+Functions for normalization of spectra data
+* @defgroup NORM Normalization
+* @{
+*/
+
+/**
+* @brief Normalizes the data to [0,1]
+*
+* @param data the data to normalize
+*/
void normalize(std::vector<eis::DataPoint>& data);
+
+/**
+* @brief Reduces the data by removing "uninteresting" regions
+* Uninteresting regions are detemined by takeing the first and second derivative and removeing the areas where these change very little
+*
+* @param data the data to reduce
+* @return the reduced data
+*/
std::vector<eis::DataPoint> reduceRegion(const std::vector<eis::DataPoint>& data, fvalue gradThreshFactor = 0.01, bool useSecondDeiv = false);
+
+/**
+* @brief Removes INF and NAN from the dataset by interpolateing from neighboring points
+*
+* This function is not availbe when this libary is compiled with fast math enabled
+*
+* As a side effect, this function caps spikes to +-INF to +-10 maximally
+*
+* @param data the data to remove INF and NAN from
+*/
void eraseSingularites(std::vector<eis::DataPoint>& data);
+/** @} */
+
}
+
diff --git a/eisgenerator/translators.h b/eisgenerator/translators.h
index 2d32b27cd9632540e0b1f0536eb14fb9015a12fd..17f9d53b442f65ef983cd269bb70021f444a38c8 100644
--- a/eisgenerator/translators.h
+++ b/eisgenerator/translators.h
@@ -3,20 +3,87 @@
#include <exception>
#include <vector>
+
namespace eis
{
-//Used by RHD Relaxis3
+/**
+* Eis model string translators to translate between different description strings used by various 3rd parties
+* @defgroup TRANS Translators
+* @{
+*/
+
+/**
+* @brief Translates a model string for RHD instruments RelaxIS to the format used by eisgenerator
+*
+* @throws parse_errror
+* @param in the RelaxIS model string
+* @param params an optional vector of the parameters of the circuit elements
+* @return the eisgenerator model string
+*/
std::string relaxisToEis(const std::string& in, const std::vector<double>& params = std::vector<double>());
+
+/**
+* @brief Translates a string for this library to the format used by RHD instruments RelaxIS
+*
+* Note that any parameters embedded into the eisgenerator model string will be striped and
+* not included in the RelaxIS model.
+*
+* @throws parse_errror
+* @param in the eisgenerator model string
+* @return the RelaxIS model string
+*/
std::string eisToRelaxis(const std::string& in);
-//Circuit Description Code also known as Boukamp Codeing
+/**
+* @brief Translates a Boukamp Circut Description Code (CDC) string into the format used by this library
+*
+* @throws parse_errror
+* @param in the CDC string
+* @return the eisgenerator model string
+*/
std::string cdcToEis(std::string in);
+
+/**
+* @brief Translates a string for this library a Boukamp Circut Description Code (CDC)
+*
+* Note that any parameters embedded into the eisgenerator model string will be striped and
+* not included in the CDC.
+*
+* @throws parse_errror
+* @param in the eisgenerator model string
+* @return the CDC string
+*/
std::string eisToCdc(const std::string& in);
-//MADAP string
+/**
+* @brief Translates a model description string as used by the MADAP library into the format used by this library
+
+* @param in a model description string as used by the MADAP library
+* @param parameters optinally a string containing the parameters of the model in MADAP parameter format
+* @return the eisgenerator model string optinally including embedded parameters
+*/
std::string madapToEis(const std::string& in, const std::string& parameters = "");
+
+/**
+* @brief Translates a string for this library a into the format used by the MADAP library
+*
+* Note that any parameters embedded into the eisgenerator model string will be striped and
+* not included in the MADAP string.
+*
+* @throws parse_errror
+* @param in the eisgenerator model string
+* @return the MADAP string
+*/
std::string eisToMadap(std::string in);
+/**
+* @brief Given a eisgenerator model description string, this function will purge all the embedded parameters
+*
+* @param in an eisgenerator model string
+*/
void purgeEisParamBrackets(std::string& in);
+
+/** @} */
+
}
diff --git a/examples/CMakeLists.txt b/examples/CMakeLists.txt
new file mode 100644
index 0000000000000000000000000000000000000000..9015511ed4a0eff45824451d2cbeb9768b4d1276
--- /dev/null
+++ b/examples/CMakeLists.txt
@@ -0,0 +1,26 @@
+cmake_minimum_required(VERSION 3.23)
+
+project(eigenerator_examples CXX)
+set (CMAKE_CXX_STANDARD 20)
+
+find_package(PkgConfig REQUIRED)
+find_package(Torch)
+pkg_search_module(EIS REQUIRED libeisgenerator)
+
+add_executable(${PROJECT_NAME}_simple simple.cpp)
+target_link_libraries(${PROJECT_NAME}_simple ${EIS_LIBRARIES})
+target_include_directories(${PROJECT_NAME}_simple PRIVATE ${EIS_INCLUDE_DIRS})
+target_compile_options(${PROJECT_NAME}_simple PRIVATE "-Wall" "-g")
+
+add_executable(${PROJECT_NAME}_compile compileing.cpp)
+target_link_libraries(${PROJECT_NAME}_compile ${EIS_LIBRARIES})
+target_include_directories(${PROJECT_NAME}_compile PRIVATE ${EIS_INCLUDE_DIRS})
+target_compile_options(${PROJECT_NAME}_compile PRIVATE "-Wall" "-g")
+
+if(Torch_FOUND)
+ message("Found torch will compile torch example")
+ add_executable(${PROJECT_NAME}_torch torchscript.cpp)
+ target_link_libraries(${PROJECT_NAME}_torch ${EIS_LIBRARIES} ${TORCH_LIBRARIES})
+ target_include_directories(${PROJECT_NAME}_torch PRIVATE ${EIS_INCLUDE_DIRS} ${TORCH_INCLUDE_DIRS})
+ target_compile_options(${PROJECT_NAME}_torch PRIVATE "-Wall" "-g")
+endif()
diff --git a/examples/compileing.cpp b/examples/compileing.cpp
new file mode 100644
index 0000000000000000000000000000000000000000..09dfbefc6599fd444a56835bf139ea5f3018774c
--- /dev/null
+++ b/examples/compileing.cpp
@@ -0,0 +1,42 @@
+#include <iostream>
+#include <eisgenerator/model.h>
+#include <eisgenerator/log.h>
+
+int main(int argc, char** argv)
+{
+ // Set the verbosity of libeisgenerator
+ eis::Log::level = eis::Log::WARN;
+
+ // Create a model object from a circuit
+ eis::Model model("r{100}-r{1000}p{1e-3, 0.5}");
+
+ // Print the corrisponding code for this model
+ std::cout<<"C++ code for "<<model.getModelStr()<<":\n"<<model.getCode()<<'\n';
+
+ // Compile the model
+ model.compile();
+
+ // Create a model object from a circuit string this time its a parameter sweep
+ // This is simply to demonstate that caching is employed
+ eis::Model modelSweep("r{10~100}-r{50~1000}p{1e-3, 0.5~0.8}", 50);
+ // This now goes quickly
+ modelSweep.compile();
+
+ // Create an omega range for a sweep
+ // from 1 to 1e4 rad/s, with 100 points
+ // and spaced logarithmically
+ eis::Range omegaRange(1, 1e4, 10, true);
+
+ // Do a sweep along omegaRange for eatch
+ // combination of parameters in the model
+ std::vector<std::vector<eis::DataPoint>> data = modelSweep.executeAllSweeps(omegaRange);
+
+ std::cout<<"Got "<<data.size()<<" sweeps with "<<data.size()*data[0].size()<<" total datapoints\n";
+
+ // Print a couple of random ones
+ eis::EisSpectra spectraSix(data[6], modelSweep.getModelStrWithParam(6), "Sweep at 6");
+ std::cout<<spectraSix<<'\n';
+
+ eis::EisSpectra spectraTen(data[10000], modelSweep.getModelStrWithParam(10000), "Sweep at 10000");
+ std::cout<<spectraTen<<'\n';
+}
diff --git a/examples/simple.cpp b/examples/simple.cpp
new file mode 100644
index 0000000000000000000000000000000000000000..48b7444d37d79682cbd3b7ef910974315abe976d
--- /dev/null
+++ b/examples/simple.cpp
@@ -0,0 +1,40 @@
+#include <iostream>
+#include <eisgenerator/model.h>
+#include <eisgenerator/log.h>
+
+int main(int argc, char** argv)
+{
+ // Set the verbosity of libeisgenerator
+ eis::Log::level = eis::Log::WARN;
+
+ // Create a model object from a circuit string
+ eis::Model model("r{100}-r{50}p{1e-3, 0.8}");
+
+ // Generate a signle impedance at omega = 10 rad/s
+ eis::DataPoint point = model.execute(10);
+ std::cout<<"A calculated data point: "<<point<<'\n';
+
+ // Create an omega range for a sweep
+ // from 1 to 1e4 rad/s, with 100 points
+ // and spaced logarithmically
+ eis::Range omegaRange(1, 1e4, 25, true);
+
+ // Print the values in this range
+ std::vector<fvalue> omegaVector = omegaRange.getRangeVector();
+ std::cout<<"A Range:\n";
+ for(fvalue omega : omegaVector)
+ std::cout<<omega<<'\n';
+ std::cout<<'\n';
+
+ // Get a spectra from the model and the omega range
+ std::vector<eis::DataPoint> data = model.executeSweep(omegaRange);
+
+ // Construct a EisSpectra object for output
+ eis::EisSpectra spectra(data, model.getModelStrWithParam(), "My first spectra");
+
+ // Print the spectra
+ std::cout<<"Spectra:\n"<<spectra<<'\n';
+
+ // Save it to disk
+ spectra.saveToDisk("./spectra.csv");
+}
diff --git a/examples/torchscript.cpp b/examples/torchscript.cpp
new file mode 100644
index 0000000000000000000000000000000000000000..1c3776337c58f179782d9a58b3e6ea0e9145ddcd
--- /dev/null
+++ b/examples/torchscript.cpp
@@ -0,0 +1,88 @@
+#include <iostream>
+#include <eisgenerator/model.h>
+#include <eisgenerator/log.h>
+#include <torch/torch.h>
+
+template <typename V>
+inline torch::TensorOptions tensorOptCpu(bool grad = true)
+{
+ static_assert(std::is_same<V, float>::value || std::is_same<V, double>::value,
+ "This function can only be passed double or float types");
+ torch::TensorOptions options;
+ if constexpr(std::is_same<V, float>::value)
+ options = options.dtype(torch::kFloat32);
+ else
+ options = options.dtype(torch::kFloat64);
+ options = options.layout(torch::kStrided);
+ options = options.device(torch::kCPU);
+ options = options.requires_grad(grad);
+ return options;
+}
+
+torch::Tensor fvalueVectorToTensor(std::vector<fvalue>& vect)
+{
+ return torch::from_blob(vect.data(), {static_cast<int64_t>(vect.size())}, tensorOptCpu<fvalue>());
+}
+
+std::shared_ptr<torch::CompilationUnit> compileModel(eis::Model &model)
+{
+ std::string torchScript = model.getTorchScript();
+ std::shared_ptr<torch::CompilationUnit> compiledModule = torch::jit::compile(torchScript);
+ return compiledModule;
+}
+
+std::shared_ptr<torch::CompilationUnit> compileModel(std::string modelstr)
+{
+ eis::Model model(modelstr);
+ return compileModel(model);
+}
+
+torch::Tensor runScriptModel(eis::Model& model, std::shared_ptr<torch::CompilationUnit> compiledScript,
+ torch::Tensor parameters, torch::Tensor omegas)
+{
+ torch::Tensor result = compiledScript->run_method(model.getCompiledFunctionName(), parameters, omegas).toTensor();
+ assert(result.scalar_type() == torch::kComplexFloat || result.scalar_type() == torch::kComplexDouble);
+ assert(result.size(0) == omegas.numel());
+ assert(result.sizes().size() == 1 || result.size(1) == 1);
+ if(result.sizes().size() == 2)
+ result = result.reshape({result.numel()});
+ return result;
+}
+
+torch::Tensor runScriptModel(eis::Model& model, size_t step,
+ std::shared_ptr<torch::CompilationUnit> compiledScript,
+ torch::Tensor omegas, torch::Device device)
+{
+ model.resolveSteps(step);
+ std::vector<fvalue> parameterVec = model.getFlatParameters();
+ torch::Tensor parameters = fvalueVectorToTensor(parameterVec).to(device);
+ return runScriptModel(model, compiledScript, parameters, omegas);
+}
+
+int main(int argc, char** argv)
+{
+ // Set the verbosity of libeisgenerator
+ eis::Log::level = eis::Log::WARN;
+
+ std::string deviceString = torch::cuda::is_available() ? "cuda:0" : "cpu";
+ std::cout<<"Using "<<deviceString<<" as compute device\n";
+ torch::Device device(deviceString);
+
+ // Create a model object from a circuit string
+ eis::Model model("r{10~100}-r{10-1000}p{1e-5, 0.7}");
+
+ // Print the TorchScript code
+ std::cout<<"TorchScript:\n"<<model.getTorchScript()<<'\n';
+
+ // Compile the TorchScript
+ std::shared_ptr<torch::CompilationUnit> compiledModel = compileModel(model);
+
+ // Create a range of omega values
+ torch::Tensor omegas = torch::logspace(1, 4, 10, 10, torch::TensorOptions().device(device));
+ std::cout<<"Omegas:\n"<<omegas<<"\n\n";
+
+ // Run the 100th step in the parameter sweep of this model
+ torch::Tensor spectra = runScriptModel(model, 0, compiledModel, omegas, device).cpu();
+
+ std::cout<<"Spectra:\n"<<torch::view_as_real(spectra)<<'\n';
+}