diff --git a/.gitignore b/.gitignore index 8ec6a6ed7..9a1578e81 100644 --- a/.gitignore +++ b/.gitignore @@ -76,8 +76,11 @@ Makefile.in # Visual Studio user options files **/*.vcxproj.user +.vscode/ src/frontend/parse-bison.c src/frontend/parse-bison.h src/spicelib/parser/inpptree-parser.c src/spicelib/parser/inpptree-parser.h +# Visual Studio Code user options files +.vscode/ diff --git a/configure.ac b/configure.ac index fcfb372c6..1692d1ccd 100644 --- a/configure.ac +++ b/configure.ac @@ -35,6 +35,7 @@ m4_ifdef([AM_SILENT_RULES], [AM_SILENT_RULES([yes])]) ext_CFLAGS="${CFLAGS+yes}" AC_PROG_CC +AC_PROG_CXX AX_PROG_CC_FOR_BUILD m4_ifdef([AM_PROG_AR], [AM_PROG_AR]) @@ -43,6 +44,8 @@ AC_SUBST([AM_CPPFLAGS], ['-I. -I$(srcdir) -I$(top_builddir)/src/include']) AC_CONFIG_MACRO_DIR([m4]) + + # Package Options # --------------- @@ -683,6 +686,7 @@ AC_ARG_ENABLE([rpath], ] ) + if test "x$_use_rpath" = xyes ; then # Try to figure out if we need -Rpath for finding X11 libs # at runtime. Why autoconf doesn't already do this, I don't @@ -767,6 +771,11 @@ esac AM_CONDITIONAL([NO_X], [test "x$has_no_x" = xtrue]) AM_CONDITIONAL([NO_HELP], [test "x$has_no_help" = xtrue]) +# Additional libs of hicum group +AC_CHECK_LIB(stdc++, main, XTRALIBS="$XTRALIBS -lstdc++",,) +AC_SUBST(XTRALIBS, $XTRALIBS) + +LIBS="$LIBS $XTRALIBS" # enabling making of the old and outdated applications # ngsconvert ngproc2mod ngmultidec ngmakeidx nghelp @@ -1239,6 +1248,7 @@ AC_CONFIG_FILES([Makefile src/spicelib/devices/isrc/Makefile src/spicelib/devices/hfet1/Makefile src/spicelib/devices/hfet2/Makefile + src/spicelib/devices/hicum2/Makefile src/spicelib/devices/hisim2/Makefile src/spicelib/devices/hisimhv1/Makefile src/spicelib/devices/hisimhv2/Makefile @@ -1315,6 +1325,7 @@ AC_CONFIG_FILES([Makefile tests/filters/Makefile tests/general/Makefile tests/hfet/Makefile + tests/hicum2/Makefile tests/hisim/Makefile tests/hisimhv1/Makefile tests/hisimhv2/Makefile diff --git a/examples/hicum2/hic2_ft.sp b/examples/hicum2/hic2_ft.sp new file mode 100644 index 000000000..330826955 --- /dev/null +++ b/examples/hicum2/hic2_ft.sp @@ -0,0 +1,42 @@ +HICUM2v2.40 Test ft=f(Ic) Vce=1V + +vce 1 0 dc 1.0 +vgain 1 c dc 0.0 +f 0 2 vgain -2 +l 2 b 1g +c 2 0 1g +ib 0 b dc 0.0 ac 1.0 +ic 0 c 0.001 +Q1 C B 0 hicumL2V2p40 + +.control +let run = 0 +let ft_runs = 9 +set curplot=new $ create a new plot +set curplotname=ft_plot +set curplottitle="HICUM2v2.40 ft = f(Ic)" +set scratch=$curplot $ store its name to 'scratch' +setplot $scratch $ make 'scratch' the active plot +let ft=unitvec(ft_runs) $ create a vector in plot 'scratch' to store ft data +let ic=unitvec(ft_runs) $ create a vector in plot 'scratch' to store ic data +foreach myic 1e-03 3e-03 6e-03 9e-03 14e-03 21e-03 27e-03 33e-3 40e-03 + alter ic = $myic + op + print all + ac dec 100 1Meg 800g + meas ac freq_at when vdb(vgain#branch)=0 + set run ="$&run" $ create a variable from the vector + set dt = $curplot $ store the current plot to dt + setplot $scratch $ make 'scratch' the active plot + let ic[run] = $myic $ store ic to vector ft in plot 'scratch' + let ft[run] = {$dt}.freq_at $ store ft to vector ft in plot 'scratch' + setplot $dt $ go back to the previous plot + let run = run + 1 +end +setplot unknown1 +plot ft vs ic xlog +.endc + +.include model-card-examples.lib + +.end diff --git a/examples/hicum2/hic2_gain.sp b/examples/hicum2/hic2_gain.sp new file mode 100644 index 000000000..1ef2a87e9 --- /dev/null +++ b/examples/hicum2/hic2_gain.sp @@ -0,0 +1,24 @@ +HICUM2v2.40 AC gain Test h21 = f(Ic) Vce=1V + +vce 1 0 dc 1.0 +vgain 1 c dc 0.0 +f 0 2 vgain -2 +l 2 b 1g +c 2 0 1g +ib 0 b dc 0.0 ac 1.0 +ic 0 c 0.001 +Q1 C B 0 hicumL2V2p40 + +.control +foreach myic 2e-03 4e-03 7e-03 9e-03 18e-03 33e-3 + alter ic = $myic + op + print all + ac dec 10 1Meg 800g +end +plot abs(ac1.vgain#branch) abs(ac2.vgain#branch) abs(ac3.vgain#branch) abs(ac4.vgain#branch) abs(ac5.vgain#branch) abs(ac6.vgain#branch) ylimit 0.1 300 loglog +.endc + +.include model-card-examples.lib + +.end diff --git a/examples/hicum2/hic2_gum.sp b/examples/hicum2/hic2_gum.sp new file mode 100644 index 000000000..8204ba079 --- /dev/null +++ b/examples/hicum2/hic2_gum.sp @@ -0,0 +1,20 @@ +HICUM2v2.40 Gummel Test Ic,b,s=f(Vc,Ib) Vce=1V + +VB B 0 1.2 +VC C 0 1.0 +VS S 0 0.0 + +Q1 C B 0 S hicumL2V2p40 + +.control +option gmin=1e-14 +dc vb 0.2 1.2 0.01 +*plot i(vc) i(vb) i(vs) +*gnuplot fgum i(vc) i(vb) i(vs) xlimit 0.2 1.2 ylog ylimit 1e-12 0.1 +plot abs(i(vc)) abs(i(vb)) abs(i(vs)) xlimit 0.2 1.2 ylog ylimit 1e-14 0.1 +plot abs(i(vc))/abs(i(vb)) vs abs(i(vc)) xlog xlimit 1e-09 100e-3; ylimit 0 500 +.endc + +.include model-card-examples.lib + +.end diff --git a/examples/hicum2/hic2_gum_inv.sp b/examples/hicum2/hic2_gum_inv.sp new file mode 100644 index 000000000..bcad18db9 --- /dev/null +++ b/examples/hicum2/hic2_gum_inv.sp @@ -0,0 +1,18 @@ +HICUM2v2.40 Gummel Test invers Ie,b,s=f(Ve,Ib) Vec=1V + +VB B 0 1.2 +VE E 0 1.0 +VS S 0 0.0 + +Q1 0 B E S hicumL2V2p40 + +.control +dc vb 0.2 1.2 0.01 +*plot i(ve) i(vb) i(vs) +plot abs(i(ve)) abs(i(vb)) abs(i(vs)) xlimit 0.2 1.2 ylog ylimit 1e-12 0.1 +plot abs(i(ve))/abs(i(vb)) vs abs(i(ve)) xlog xlimit 1e-06 100e-3 ylimit 0 50 +.endc + +.include model-card-examples.lib + +.end diff --git a/examples/hicum2/hic2_noise.sp b/examples/hicum2/hic2_noise.sp new file mode 100644 index 000000000..d1891c89e --- /dev/null +++ b/examples/hicum2/hic2_noise.sp @@ -0,0 +1,31 @@ +HICUM2v2.40 Noise Test + +vcc 4 0 26 +vin 1 0 ac 1 + +ccouple 1 b 1 + +ibias 0 b 100uA + +rload 4 c 1k noisy=0 + +q1 c b 0 0 hicumL2V2p40 + +.include model-card-examples.lib + +.control +op +print all +echo +noise v(c) vin dec 10 10 10G 1 +setplot +setplot noise1 +plot ally +plot inoise_spectrum onoise_spectrum loglog +setplot noise2 +print all +echo +print inoise_total onoise_total +.endc + +.end diff --git a/examples/hicum2/hic2_noise_I.sp b/examples/hicum2/hic2_noise_I.sp new file mode 100644 index 000000000..acd068aad --- /dev/null +++ b/examples/hicum2/hic2_noise_I.sp @@ -0,0 +1,65 @@ +HICUM2v2.40 Noise Current Test + +* _______ +* _|_ _|_ +* /// / _ \ +* \/ \/ I1 +* /\_/\ +* R1 \___/ +* _/\ __| +* | \/ _| +* |____|' +* B |`-> +* _|_ E +* /VIN\ +* \___/ +* _|_ +* /// +* +* + +vin E 0 DC 0.0 ac 1.0u +I1 0 C 1uA +R1 C B 1000k noisy=0 +q1 C B E hicumL2V2p40 + +.include model-card-examples.lib + +.control +setplot new + +let V1u = 0*vector(81) +let V10u = 0*vector(81) +let V100u = 0*vector(81) +let V1000u = 0*vector(81) + +op +noise v(C) vin dec 10 1 100Meg 1 +destroy +let unknown1.V1u = sqrt(v(onoise_spectrum))*1u + +alter I1 dc = 10u +op +noise v(C) vin dec 10 1 100Meg 1 +destroy +let unknown1.V10u = sqrt(v(onoise_spectrum))*1u + +alter I1 dc = 100u +op +noise v(C) vin dec 10 1 100Meg 1 +destroy +let unknown1.V100u = sqrt(v(onoise_spectrum))*1u + +alter I1 dc = 1000u +op +noise v(C) vin dec 10 1 100Meg 1 +destroy +let unknown1.V1000u = sqrt(v(onoise_spectrum))*1u + + +set pensize = 2 +plot unknown1.V1u unknown1.V10u unknown1.V100u unknown1.V1000u vs frequency loglog title LM394NoiseCurrent + +echo " ... done." +.endcontrol +.end diff --git a/examples/hicum2/hic2_noise_V.sp b/examples/hicum2/hic2_noise_V.sp new file mode 100644 index 000000000..92bbb7bb6 --- /dev/null +++ b/examples/hicum2/hic2_noise_V.sp @@ -0,0 +1,65 @@ +HICUM2v2.40 Noise Voltage Test + +* _______ +* _|_ _|_ +* /// / _ \ +* \/ \/ I1 +* /\_/\ +* \___/ +* _______| +* | _| +* |____|' +* B |`-> +* _|_ E +* /VIN\ +* \___/ +* _|_ +* /// +* +* + +vin E 0 DC 0.0 ac 1.0u +I1 0 B 1uA +q1 B B E hicumL2V2p40 + + +.include model-card-examples.lib + +.control +setplot new + +let V1u = 0*vector(81) +let V10u = 0*vector(81) +let V100u = 0*vector(81) +let V1000u = 0*vector(81) + +op +noise v(B) vin dec 10 1 100Meg 1 +destroy +let unknown1.V1u = sqrt(v(onoise_spectrum)) + +alter I1 dc = 10u +op +noise v(B) vin dec 10 1 100Meg 1 +destroy +let unknown1.V10u = sqrt(v(onoise_spectrum)) + +alter I1 dc = 100u +op +noise v(B) vin dec 10 1 100Meg 1 +destroy +let unknown1.V100u = sqrt(v(onoise_spectrum)) + +alter I1 dc = 1000u +op +noise v(B) vin dec 10 1 100Meg 1 +destroy +let unknown1.V1000u = sqrt(v(onoise_spectrum)) + + +set pensize = 2 +plot unknown1.V1u unknown1.V10u unknown1.V100u unknown1.V1000u vs frequency loglog title HICUM_NoiseVoltage + +echo " ... done." +.endcontrol +.end diff --git a/examples/hicum2/hic2_noise_ver.sp b/examples/hicum2/hic2_noise_ver.sp new file mode 100644 index 000000000..1f57363e2 --- /dev/null +++ b/examples/hicum2/hic2_noise_ver.sp @@ -0,0 +1,44 @@ +HICUM2v2.40 Noise Voltage Test + +* _______ +* _|_ _|_ +* /// / _ \ +* \/ \/ I1 +* /\_/\ +* \___/ +* _______| +* | _| +* |____|' +* B |`-> +* _|_ E +* /VIN\ +* \___/ +* _|_ +* /// +* +* + +vin E 0 DC 0.0 ac 1.0u +I1 0 B 25mA +q1 B B E hicumL2V2p40 + + +.include model-card-examples.lib + +.control +setplot new + +let V1u = 0*vector(81) + +op +noise v(B) vin dec 10 1 100Meg 1 +destroy +*let unknown1.V1u = sqrt(v(onoise_spectrum)) +let unknown1.V1u = v(onoise_spectrum) + +set pensize = 2 +plot unknown1.V1u vs frequency loglog title HICUM_NoiseVoltage + +echo " ... done." +.endcontrol +.end diff --git a/examples/hicum2/hic2_out.sp b/examples/hicum2/hic2_out.sp new file mode 100644 index 000000000..db5cbbc00 --- /dev/null +++ b/examples/hicum2/hic2_out.sp @@ -0,0 +1,21 @@ +HICUM2v2.40 Output Test Ic=f(Vc,Ib) + +IB 0 B 1u +VC C 0 1.8 +VS S 0 0.0 + +Q1 C B 0 S tj hicumL2V2p40 + +.control +dc vc 0.0 1.8 0.01 ib 10u 100u 10u +plot -i(vc) +reset +altermod @hicumL2V2p40[flsh]=1 +dc vc 0.0 1.8 0.01 ib 1u 10u 1u +plot -i(vc) +plot v(tj) +.endc + +.include model-card-examples.lib + +.end diff --git a/examples/hicum2/hic2_tran.sp b/examples/hicum2/hic2_tran.sp new file mode 100644 index 000000000..823570571 --- /dev/null +++ b/examples/hicum2/hic2_tran.sp @@ -0,0 +1,27 @@ +HICUM2v2.40 Amplifier in Time Domain + +vcc 2 0 2.5 +*vin 1 0 ac 1 dc 0 sin 0 25m 1G +vin 1 0 ac 1 dc 0 pulse 0 50m 0 5p 5p 4n 8n +rs 1 in 50 +c1 in b 1n +r1 2 c 180 +r2 c b 5k +q1 c b 0 0 hicuml2v2p40 +c2 c out 100p +r3 out 0 1k + +.ic v(c)=0.9 +.control +option method=gear +op +print all +ac dec 10 1Meg 9.9g +plot vdb(out) +tran 2p 200n +plot v(in) v(out) +.endc + +.include model-card-examples.lib + +.end diff --git a/examples/hicum2/model-card-examples.lib b/examples/hicum2/model-card-examples.lib new file mode 100644 index 000000000..06a17b971 --- /dev/null +++ b/examples/hicum2/model-card-examples.lib @@ -0,0 +1,175 @@ +* Example parameter test set +.model hicumL2V2p40 npn level=8 +* +*Transfer current ++ c10 = 9.074e-030 ++ qp0 = 1.008e-013 ++ ich = 0 ++ hf0 = 40 ++ hfe = 10.01 ++ hfc = 20.04 ++ hjei = 3.382 ++ ahjei = 3 ++ rhjei = 2 ++ hjci = 0.2 +* +*Base-Emitter diode currents ++ ibeis = 1.328e-019 ++ mbei = 1.027 ++ ireis = 1.5e-015 ++ mrei = 2 ++ ibeps = 1.26e-019 ++ mbep = 1.042 ++ ireps = 1.8e-015 ++ mrep = 1.8 ++ mcf = 1 +* +*Transit time for excess recombination current at b-c barrier ++ tbhrec = 1e-010 +* +*Base-Collector diode currents ++ ibcis = 4.603e-017 ++ mbci = 1.15 ++ ibcxs = 0 ++ mbcx = 1 +* +*Base-Emitter tunneling current ++ ibets = 0.02035 ++ abet = 24 ++ tunode = 1 +* +*Base-Collector avalanche current ++ favl = 18.96 ++ qavl = 5.092e-014 ++ alfav = -0.0024 ++ alqav = -0.0006284 ++ kavl = 0.0 ++ alkav = 0.0 +* +*Series resistances ++ rbi0 = 4.444 ++ rbx = 2.568 ++ fgeo = 0.7409 ++ fdqr0 = 0 ++ fcrbi = 0 ++ fqi = 1 ++ re = 1.511 ++ rcx = 2.483 +* +*Substrate transistor ++ itss = 1.143e-017 ++ msf = 1.056 ++ iscs = 4.60106e-015 ++ msc = 1.018 ++ tsf = 0 +* +*Intra-device substrate coupling ++ rsu = 500 ++ csu = 6.4e-014 +* +*Depletion Capacitances ++ cjei0 = 8.869e-015 ++ vdei = 0.714 ++ zei = 0.2489 ++ ajei = 1.65 ++ cjep0 = 2.178e-015 ++ vdep = 0.8501 ++ zep = 0.2632 ++ ajep = 1.6 ++ cjci0 = 3.58e-015 ++ vdci = 0.8201 ++ zci = 0.2857 ++ vptci = 1.79 ++ cjcx0 = 6.299e-015 ++ vdcx = 0.8201 ++ zcx = 0.2863 ++ vptcx = 1.977 ++ fbcpar = 0.3 ++ fbepar = 1 ++ cjs0 = 2.6e-014 ++ vds = 0.9997 ++ zs = 0.4295 ++ vpts = 100 ++ cscp0 = 1.4e-014 ++ vdsp = 0 ++ zsp = 0.35 ++ vptsp = 4 +* +*Diffusion Capacitances ++ t0 = 2.089e-013 ++ dt0h = 8e-014 ++ tbvl = 8.25e-014 ++ tef0 = 3.271e-013 ++ gtfe = 3.548 ++ thcs = 5.001e-012 ++ ahc = 0.05 ++ fthc = 0.7 ++ rci0 = 9.523 ++ vlim = 0.6999 ++ vces = 0.01 ++ vpt = 2 ++ aick = 1e-3 ++ delck = 2 ++ tr = 0 ++ vcbar = 0.04 ++ icbar = 0.01 ++ acbar = 1.5 +* +*Isolation Capacitances ++ cbepar = 2.609e-014 ++ cbcpar = 1.64512e-014 +* +*Non-quasi-static Effect ++ flnqs = 0 ++ alqf = 0.166667 ++ alit = 0.333333 +* +*Noise ++ kf = .3e-16 ++ af = .75 ++ cfbe = -1 ++ flcono = 0 ++ kfre = 0.0 ++ afre = 2.0 +* +*Lateral Geometry Scaling (at high current densities) ++ latb = 0.0 ++ latl = 0.0 +* +*Temperature dependence ++ vgb = 0.91 ++ alt0 = 0.004 ++ kt0 = 6.588e-005 ++ zetaci = 0.58 ++ alvs = 0.001 ++ alces = -0.2286 ++ zetarbi = 0.3002 ++ zetarbx = 0.06011 ++ zetarcx = -0.02768 ++ zetare = -0.9605 ++ zetacx = 0 ++ vge = 1.17 ++ vgc = 1.17 ++ vgs = 1.049 ++ f1vg = -0.000102377 ++ f2vg = 0.00043215 ++ zetact = 5 ++ zetabet = 4.892 ++ alb = 0 ++ dvgbe = 0 ++ zetahjei = -0.5 ++ zetavgbe = 0.7 +* +*Self-Heating ++ flsh = 0 ++ rth = 1113.4 ++ cth = 6.841e-012 ++ zetarth = 0 ++ alrth = 0.002 +* +*Compatibility with V2.1 ++ flcomp = 2.3 +* +*Circuit simulator specific parameters ++ tnom = 26.85 +*+ dt = 0 diff --git a/src/Makefile.am b/src/Makefile.am index 22591e9a7..03ded012e 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -73,6 +73,7 @@ DYNAMIC_DEVICELIBS = \ spicelib/devices/isrc/libisrc.la \ spicelib/devices/hfet1/libhfet.la \ spicelib/devices/hfet2/libhfet2.la \ + spicelib/devices/hicum2/libhicum2.la \ spicelib/devices/hisim2/libhisim2.la \ spicelib/devices/hisimhv1/libhisimhv1.la \ spicelib/devices/hisimhv2/libhisimhv2.la \ @@ -581,6 +582,7 @@ libngspice_la_LIBADD += \ libngspice_la_CFLAGS = -shared libngspice_la_LDFLAGS = -shared +libngspice_la_LDFLAGS += -lstdc++ if SHWIN libngspice_la_LDFLAGS += -Wl,--output-def=ngspice.def -Wl,--out-implib=ngspice.dll.a diff --git a/src/include/cppduals/.appveyor.yml b/src/include/cppduals/.appveyor.yml new file mode 100644 index 000000000..1bc8991f3 --- /dev/null +++ b/src/include/cppduals/.appveyor.yml @@ -0,0 +1,41 @@ +version: 0.2.{build} +clone_folder: c:\projects\cppduals +clone_depth: 3 + +image: +#- Visual Studio 2013 +#- Visual Studio 2015 +- Visual Studio 2017 + +configuration: +- Release +#- Debug # someone with a debugger please investigate this :) + +# Do not build feature branch with open Pull Requests +skip_branch_with_pr: true + +# skip unsupported combinations +init: +- echo %APPVEYOR_BUILD_WORKER_IMAGE% +- if "%APPVEYOR_BUILD_WORKER_IMAGE%"=="Visual Studio 2013" ( set generator="Visual Studio 12 2013" ) +- if "%APPVEYOR_BUILD_WORKER_IMAGE%"=="Visual Studio 2015" ( set generator="Visual Studio 14 2015" ) +- if "%APPVEYOR_BUILD_WORKER_IMAGE%"=="Visual Studio 2017" ( set generator="Visual Studio 15 2017" ) +- echo %generator% + +before_build: +- cmd: |- + mkdir build + cd build + cmake --version + cmake .. -G %generator% -DCPPDUALS_TESTING=ON + pwd + ls + +build: + project: c:\projects\cppduals\build\cppduals.sln + verbosity: minimal +# parallel: true + +test_script: +- pwd +- ctest -C Debug -VV diff --git a/src/include/cppduals/.editorconfig b/src/include/cppduals/.editorconfig new file mode 100644 index 000000000..254b85a9a --- /dev/null +++ b/src/include/cppduals/.editorconfig @@ -0,0 +1,18 @@ +root = true + +[*] +end_of_line = lf +insert_final_newline = true +charset = utf-8 + +[*.{cpp,hpp,h}] +indent_style = space +indent_size = 2 + +[{duals/**,tests/**}] +trim_trailing_whitespace = true + +[CMakeLists.txt] +trim_trailing_whitespace = true +indent_style = space +indent_size = 2 diff --git a/src/include/cppduals/.gitlab-ci.yml b/src/include/cppduals/.gitlab-ci.yml new file mode 100644 index 000000000..9296366be --- /dev/null +++ b/src/include/cppduals/.gitlab-ci.yml @@ -0,0 +1,87 @@ +#image: ubuntu:19.04 +image: fedora:30 + +variables: + GIT_DEPTH: 3 + CTEST_OUTPUT_ON_FAILURE: y + +stages: +- build +- test +- cover +- publish + +before_script: +#- apt-get update --yes +#- apt-get install --yes cmake g++ git doxygen lcov graphviz +- dnf install -y gcc-c++ make cmake git doxygen lcov graphviz + +build: + stage: build +# variables: +# CC: clang +# CXX: clang++ + script: + - echo $CXX + - cmake -Bbuild -H. -DCPPDUALS_TESTING=ON + - cmake --build build + - cmake -Bbuild-latest -H. -DCPPDUALS_TESTING=ON -DCPPDUALS_EIGEN_LATEST=ON + - cmake --build build-latest + artifacts: + expire_in: 1 week + paths: + - build + - build-latest + +test: + stage: test + script: + - cmake --build build --target test + - cmake --build build-latest --target test + dependencies: + - build + +cover: + script: + - cmake -Bbuild-cov -H. -DCODE_COVERAGE=ON -DCPPDUALS_TESTING=ON + - cmake --build build-cov --target cov + - cmake --build build-cov --target cov-html + coverage: '/Total:|\w*\d+\.\d+/' + artifacts: + expire_in: 1 day + paths: + - build-cov + only: + - merge_requests + +pages: + script: + - cmake -Bbuild -H. -DCODE_COVERAGE=ON -DCPPDUALS_TESTING=ON + - cmake --build build --target cppduals_docs + - cmake --build build --target cov-html + - mv build/docs public/ + - mv build/coverage public/ + coverage: '/Total:|\w*\d+\.\d+/' + artifacts: + paths: + - public + only: + - master + +publish: + stage: publish + dependencies: + - build + environment: + name: publish + only: + - /^v\d+\.\d+\.\d+$/ + except: + - branches + before_script: + - dnf install -y python3-requests + script: +# - ln -s cppduals-h-${CI_BUILD_TAG#v} . +# - tar czvhf cppduals-h-${CI_BUILD_TAG#v}.tgz cppduals-h-${CI_BUILD_TAG#v}/duals cppduals-h-${CI_BUILD_TAG#v}/CMakeLists.txt + - tar czvf cppduals-h-${CI_BUILD_TAG#v}.tgz duals CMakeLists.txt + - ./doc/gitlab-release --message "Release ${CI_BUILD_TAG}" cppduals-h-${CI_BUILD_TAG#v}.tgz diff --git a/src/include/cppduals/CMakeLists.txt b/src/include/cppduals/CMakeLists.txt new file mode 100644 index 000000000..b002dfdc2 --- /dev/null +++ b/src/include/cppduals/CMakeLists.txt @@ -0,0 +1,223 @@ +# +# CMake for cppduals +# +cmake_minimum_required (VERSION 3.1) +project (cppduals + VERSION 0.3.1 + LANGUAGES C CXX + ) +include (GNUInstallDirs) + +set (CMAKE_CXX_STANDARD 11 CACHE STRING "Which C++ standard to test against.") +set (CMAKE_CXX_STANDARD_REQUIRED ON) +set (CMAKE_DISABLE_IN_SOURCE_BUILD ON) +if (CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR) + message (STATUS "Configuring cppduals for standalone build") + set (CPPDUALS_STANDALONE TRUE) +elseif () + message (STATUS "Configuring cppduals for subproject build") + set (CPPDUALS_STANDALONE FALSE) +endif () +if (CPPDUALS_STANDALONE AND + NOT CMAKE_CONFIGURATION_TYPES AND + NOT CMAKE_NO_BUILD_TYPE AND + NOT CMAKE_BUILD_TYPE + ) + message (STATUS "Setting build type to 'RelWithDebInfo' since none specified") + set_property (CACHE CMAKE_BUILD_TYPE PROPERTY VALUE RelWithDebInfo) + set_property (CACHE CMAKE_BUILD_TYPE PROPERTY + STRINGS "Debug" "Release" "MinSizeRel" "RelWithDebInfo" + ) +endif () +if (CPPDUALS_STANDALONE AND + CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT) + set (CMAKE_INSTALL_PREFIX "${CMAKE_BINARY_DIR}/install" + CACHE PATH "cppduals installation directory" + FORCE + ) + message (STATUS "No install prefix specified; using '${CMAKE_INSTALL_PREFIX}'") +endif () + +set_property (CACHE CMAKE_CXX_STANDARD PROPERTY STRINGS 11 14 17 20) + +option (CPPDUALS_TESTING "Enable testing" OFF) +option (CPPDUALS_BENCHMARK "Enable benchmarking" OFF) +option (CPPDUALS_EIGEN_LATEST "Eigen latest" OFF) +option (CPPDUALS_USE_LIBCXX "When testing use flags for libc++" OFF) +set (EIGEN3_INCLUDE_DIRS "" CACHE PATH "Path to Eigen includes" ) + +if ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU" OR + "${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang") + set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -g -Wall -Wpedantic") +endif () + +if (CPPDUALS_BENCHMARK) + set (CPPDUALS_TESTING ON) +endif (CPPDUALS_BENCHMARK) + +if (CPPDUALS_USE_LIBCXX) + if ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang") + add_compile_options ("-stdlib=libc++") + set (CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -stdlib=libc++ ") # -lc++abi + elseif ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU" OR + "${CMAKE_CXX_COMPILER_ID}" STREQUAL "Intel") + # this is unfinished... + set (CPPDUALS_CXX_FLAGS "${CMAKE_CXX_FLAGS} -nostdinc++") + message (WARNING "libc++ header path must be manually specified using CMAKE_CXX_FLAGS") + list (APPEND CPPDUALS_CXX_LINKER_FLAGS -nodefaultlibs) + list (APPEND CPPDUALS_CXX_LIBRARIES c++) + else () + message(FATAL_ERROR "-DCPPDUALS_USE_LIBCXX:BOOL=ON is not supported for this compiler") + endif () +endif (CPPDUALS_USE_LIBCXX) + +# +# Primary Library Target +# +add_library (cppduals_duals INTERFACE) +target_include_directories (cppduals_duals + INTERFACE + $ + $ + ) +set_target_properties (cppduals_duals + PROPERTIES + EXPORT_NAME duals + ) +add_library (cppduals::duals ALIAS cppduals_duals) + +# +# Build external dependencies for testing & benchmarking +# +if (CPPDUALS_TESTING) + + cmake_minimum_required (VERSION 3.10) # need gtest_discover_tests + file (MAKE_DIRECTORY "${PROJECT_BINARY_DIR}/thirdparty") + + # generator name + if (NOT "${CMAKE_EXTRA_GENERATOR}" STREQUAL "") + set (GENERATOR_STRING "${CMAKE_EXTRA_GENERATOR} - ${CMAKE_GENERATOR}") + else () + set (GENERATOR_STRING "${CMAKE_GENERATOR}") + endif () + + # configure the thirdparty build dir + execute_process ( + WORKING_DIRECTORY "${PROJECT_BINARY_DIR}/thirdparty" + COMMAND ${CMAKE_COMMAND} "-G${GENERATOR_STRING}" + "-DCMAKE_CONFIGURATION_TYPES=${CMAKE_CONFIGURATION_TYPES}" + "-DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE}" + "-DCMAKE_MAKE_PROGRAM=${CMAKE_MAKE_PROGRAM}" + "-DCPPDUALS_BENCHMARK=${CPPDUALS_BENCHMARK}" + "-DCPPDUALS_EIGEN_LATEST=${CPPDUALS_EIGEN_LATEST}" + "-DCPPDUALS_USE_LIBCXX=${CPPDUALS_USE_LIBCXX}" + "${PROJECT_SOURCE_DIR}/thirdparty" + RESULT_VARIABLE DEPS_CONFIG_RESULT + ) + if (DEPS_CONFIG_RESULT) + message (FATAL_ERROR "Configuring dependencies failed: ${DEPS_CONFIG_RESULT}") + endif () + + # build the thirdparty + message ("***************************************************************") + message ("** Building '${PROJECT_BINARY_DIR}/thirdparty'...") + message ("***************************************************************") + execute_process ( + WORKING_DIRECTORY "${PROJECT_BINARY_DIR}/thirdparty" + COMMAND "${CMAKE_COMMAND}" --build . + RESULT_VARIABLE DEPS_BUILD_RESULT + ) + message ("***************************************************************") + message ("*** Building thirdparty/ done.") + message ("***************************************************************") + if (DEPS_BUILD_RESULT) + message ("***************************************************************") + message (FATAL_ERROR "Building dependencies failed: ${DEPS_BUILD_RESULT}") + message ("***************************************************************") + endif () + + add_subdirectory (thirdparty) + +endif () + +# +# Code Coverage Configuration +# +add_library (cppduals_coverage_config INTERFACE) +option (CODE_COVERAGE "Enable coverage reporting" OFF) +if (CODE_COVERAGE AND CMAKE_CXX_COMPILER_ID MATCHES "GNU|Clang") + # Add required flags (GCC & LLVM/Clang) + target_compile_options (cppduals_coverage_config INTERFACE + -O0 # no optimization + -g # generate debug info + --coverage # sets all required flags + ) + if (CMAKE_VERSION VERSION_GREATER_EQUAL 3.13) + target_link_options (cppduals_coverage_config INTERFACE --coverage) + else () + target_link_libraries (cppduals_coverage_config INTERFACE --coverage) + endif () +endif () + +# +# Testing +# +if (CPPDUALS_TESTING) + enable_testing () + include (CTest) + add_subdirectory (tests) +endif (CPPDUALS_TESTING) + +# +# Documentation +# +find_program (DOXYGEN doxygen) +if (DOXYGEN) + configure_file (${PROJECT_SOURCE_DIR}/doc/Doxyfile.in ${PROJECT_BINARY_DIR}/doc/Doxyfile) + configure_file (${PROJECT_SOURCE_DIR}/doc/DoxygenLayout.xml ${PROJECT_BINARY_DIR}/doc/DoxygenLayout.xml COPYONLY) + configure_file (${PROJECT_SOURCE_DIR}/doc/header.html ${PROJECT_BINARY_DIR}/doc/header.html COPYONLY) + configure_file (${PROJECT_SOURCE_DIR}/doc/footer.html ${PROJECT_BINARY_DIR}/doc/footer.html COPYONLY) + configure_file (${PROJECT_SOURCE_DIR}/doc/favicon.ico ${PROJECT_BINARY_DIR}/doc/favicon.ico COPYONLY) + configure_file (${PROJECT_SOURCE_DIR}/doc/customdoxygen.css ${PROJECT_BINARY_DIR}/doc/customdoxygen.css) + add_custom_target (cppduals_docs + WORKING_DIRECTORY ${PROJECT_BINARY_DIR}/doc + COMMAND cmake -E remove_directory ${PROJECT_BINARY_DIR}/docs + COMMAND ${DOXYGEN} Doxyfile + ) +else () + add_custom_target (cppduals_docs + COMMAND echo "Please install doxygen and reconfigure to build the docs" + ) +endif () + +# +# Installation +# +install (TARGETS cppduals_duals EXPORT cppduals_export) +install (EXPORT cppduals_export + FILE cppduals-config.cmake + NAMESPACE cppduals:: + DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/cppduals + ) +install ( + DIRECTORY ${PROJECT_SOURCE_DIR}/duals + DESTINATION ${CMAKE_INSTALL_INCLUDEDIR} + PATTERN "*~" EXCLUDE + ) +install ( + DIRECTORY ${PROJECT_BINARY_DIR}/docs/ # Trailing slash triggers rename + DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/doc/cppduals + OPTIONAL + ) + +# +# etags +# +find_program (ETAGS etags) +if (ETAGS) + add_custom_target (cppduals_etags + COMMAND ${ETAGS} --language=c++ ${PROJECT_SOURCE_DIR}/duals/* + COMMAND ${ETAGS} --language=c++ --append ${PROJECT_SOURCE_DIR}/duals/arch/*/* + COMMAND ${ETAGS} --language=c++ --append `find ${PROJECT_BINARY_DIR}/thirdparty/eigenX/src/eigenX -type f` + ) +endif (ETAGS) diff --git a/src/include/cppduals/LICENSE.txt b/src/include/cppduals/LICENSE.txt new file mode 100644 index 000000000..14e2f777f --- /dev/null +++ b/src/include/cppduals/LICENSE.txt @@ -0,0 +1,373 @@ +Mozilla Public License Version 2.0 +================================== + +1. Definitions +-------------- + +1.1. "Contributor" + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +1.2. "Contributor Version" + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +1.8. "License" + means this document. + +1.9. "Licensable" + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +1.10. "Modifications" + means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +1.12. "Secondary License" + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +1.13. "Source Code Form" + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, "control" means (a) the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or (b) ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + +2. License Grants and Conditions +-------------------------------- + +2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +(a) under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; + or + +(b) for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, including, without limitation, warranties that the * +* Covered Software is free of defects, merchantable, fit for a * +* particular purpose or non-infringing. The entire risk as to the * +* quality and performance of the Covered Software is with You. * +* Should any Covered Software prove defective in any respect, You * +* (not any Contributor) assume the cost of any necessary servicing, * +* repair, or correction. This disclaimer of warranty constitutes an * +* essential part of this License. No use of any Covered Software is * +* authorized under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, indirect, * +* special, incidental, or consequential damages of any character * +* including, without limitation, damages for lost profits, loss of * +* goodwill, work stoppage, computer failure or malfunction, or any * +* and all other commercial damages or losses, even if such party * +* shall have been informed of the possibility of such damages. This * +* limitation of liability shall not apply to liability for death or * +* personal injury resulting from such party's negligence to the * +* extent applicable law prohibits such limitation. Some * +* jurisdictions do not allow the exclusion or limitation of * +* incidental or consequential damages, so this exclusion and * +* limitation may not apply to You. * +* * +************************************************************************ + +8. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice +--------------------------------------------------------- + + This Source Code Form is "Incompatible With Secondary Licenses", as + defined by the Mozilla Public License, v. 2.0. diff --git a/src/include/cppduals/README.md b/src/include/cppduals/README.md new file mode 100644 index 000000000..7aa1ef7f2 --- /dev/null +++ b/src/include/cppduals/README.md @@ -0,0 +1,354 @@ +cppduals +======== + +Header-only dual number library for C++11. The `dual<>` type can be +used for automatic (forward) differentiation. It can be used in +conjunction with Eigen to produced very fast vectorized computations +of real and complex matrix functions and their derivatives. + +There is a small paper on cppduals here: +[![DOI](https://joss.theoj.org/papers/10.21105/joss.01487/status.svg)](https://doi.org/10.21105/joss.01487) + +Documentation +============= + +[Full documentation is here](https://tesch1.gitlab.io/cppduals/). + +The dual number space is closely related to the complex number space, +and as such, the dual class `duals::dual<>` is similar to +`std::complex<>`. + +When compiling with Eigen it is possible to disable the vectorization +templates by `#define CPPDUALS_DONT_VECTORIZE`. This may be useful if +your compiler is particularly good at optimizing Eigen expressions, I +have had mixed results, sometimes there are differences between the +compiler's best (GCC and Clang) and the vectorized code of 30% or +more, in either direction. + +Examples +======== + +Here we calculate a function $`f(x)`$, with its derivative $`f'(x)`$, +calculated explicitly as `df()`, and calculated by using the dual +class (`1_e` returns the dual number $`0 + 1 \epsilon`$, it is +equivalent to `dual(0,1)`): + +```cpp +#include + +using namespace duals::literals; + +template T f(T x) { return pow(x,pow(x,x)); } +template T df(T x) { return pow(x,-1. + x + pow(x,x)) * (1. + x*log(x) + x*pow(log(x),2.)); } +template T ddf(T x) { return (pow(x,pow(x,x)) * pow(pow(x,x - 1.) + pow(x,x)*log(x)*(log(x) + 1.), 2.) + + pow(x,pow(x,x)) * (pow(x,x - 1.) * log(x) + + pow(x,x - 1.) * (log(x) + 1.) + + pow(x,x - 1.) * ((x - 1.)/x + log(x)) + + pow(x,x) * log(x) * pow(log(x) + 1., 2.) )); } + +int main() +{ + std::cout << " f(2.) = " << f(2.) << "\n"; + std::cout << " df(2.) = " << df(2.) << "\n"; + std::cout << "ddf(2.) = " << ddf(2.) << "\n"; + std::cout << " f(2+1_e) = " << f(2+1_e) << "\n"; + std::cout << " f(2+1_e).dpart() = " << f(2+1_e).dpart() << "\n"; + duals::hyperduald x(2+1_e,1+0_e); + std::cout << " f((2+1_e) + (1+0_e)_e).dpart().dpart() = " << f(x).dpart().dpart() << "\n"; +} +``` + +Produces: + +``` + f(2.) = 16 + df(2.) = 107.11 +ddf(2.) = 958.755 + f(2+1_e) = (16+107.11_e) + f(2+1_e).dpart() = 107.11 + f((2+1_e) + (1+0_e)_e).dpart().dpart() = 958.755 +``` + +Installation +============ + +Copy the [duals/](./duals/) directory (or just [dual](./duals/dual) ) +somewhere your `#include`s can find it. Then just `#include +` from your source. + +Alternatively, `cppduals` supports building with CMake. If using CMake v3.14+, +the ``FetchContent`` pattern is straightforward and enables using CMake targets +to specify library dependencies: + +```cmake + include(FetchContent) + + # Have CMake download the library + set (CPPDUALS_TAG v0.4.1) + set (CPPDUALS_MD5 7efe49496b8d0e3d3ffbcd3c68f542f3) + FetchContent_Declare (cppduals + URL https://gitlab.com/tesch1/cppduals/-/archive/${CPPDUALS_TAG}/cppduals-${CPPDUALS_TAG}.tar.bz2 + URL_HASH MD5=${CPPDUALS_MD5} + ) + FetchContent_MakeAvailable (cppduals) + + # Link to cppduals + target_link_libraries (your_target PRIVATE cppduals::duals) +``` + +Older versions of CMake can achieve a similar result using the ``ExternalProject`` +family of commands and modifying the global preprocessor search path: + +```cmake + include(ExternalProject) + + # Have CMake download the library headers only + set (CPPDUALS_TAG v0.4.1) + set (CPPDUALS_MD5 7efe49496b8d0e3d3ffbcd3c68f542f3) + ExternalProject_Add (cppduals + URL https://gitlab.com/tesch1/cppduals/-/archive/${CPPDUALS_TAG}/cppduals-${CPPDUALS_TAG}.tar.bz2 + URL_HASH MD5=${CPPDUALS_MD5} + CONFIGURE_COMMAND "" BUILD_COMMAND "" INSTALL_COMMAND "" ) + + # Make include directory globally visible + ExternalProject_Get_Property (cppduals source_dir) + include_directories (${source_dir}/) +``` + +Alternatively, `cppduals` supports installation and discovery via the +`find_package` utility. First, download and install the library to a +location of your choosing: + +```sh + CPPDUALS_PREFIX= + git clone https://gitlab.com/tesch1/cppduals.git && cd cppduals + mkdir build && cd build + cmake -DCMAKE_INSTALL_PREFIX="$CPPDUALS_PREFIX" .. + cmake --build . --target install +``` + +Then, in your project's `CMakeLists.txt`, find and link to the library in the +standard manner: + +```cmake + find_package(cppduals REQUIRED) + target_link_libraries(your_target PRIVATE cppduals::cppduals) +``` + +If you installed `cppduals` to a location that is not on `find_package`'s +default search path, you can specify the location by setting the `cppduals_DIR` +environment variable when configuring your project: + +```sh + cd your_build_dir + cppduals_DIR="${CPPDUALS_PREFIX}" cmake .. +``` + + +Benchmarks +========== + +The benchmark compares cppduals against a local BLAS implementation, +by default OpenBLAS (whose development package is required; +RedHat-flavor: `openblas-devel`, Debian-flavor: `openblas-dev`). If +you wish to build the benchmarks against a different installation of +BLAS, the following CMake variables can be set at configuration time: + +- [BLA_VENDOR](https://cmake.org/cmake/help/latest/module/FindBLAS.html) +- BLAS_DIR +- LAPACK_DIR + +For example, to build and run the tests shown below: + +```sh + cmake -Bbuild-bench -H. -DCPPDUALS_BENCHMARK=ON -DBLAS_DIR=/opt/local -DLAPACK_DIR=/opt/local + cmake --build build-bench --target bench_gemm + ./build-bench/tests/bench_gemm +``` + +The first performance goal of this project is to make the +`duals::dual<>` type at least as fast as `std::complex<>`. This is +considered to be an upper-bound for performance because complex math +operations are usually highly optimized for scientific computing and +have a similar algebraic structure. The second goal is to make the +compound type `std::complex>` as fast as possible for +use in calculation that require the derivative of complex functions +(ie comprising quantum-mechanical wave functions). + +The first goal is measured by comparing the speed of matrix-matrix +operations (nominally matrix multiplication) on `duals::dual<>`-valued +Eigen matrices with highly optimtimized BLAS implementations of +equivalent operations on complex-valued matrices. This can be done by +running the [./tests/bench_gemm](./tests/bench_gemm.cpp) program. In +the *ideal* case, the results of the `B_MatMat` type should +be nearly as fast, or faster than equivalently sized +`B_MatMat`, and double-sized +`B_MatMatBLAS<{float,double}>` operations. This is very difficult to +achieve in reality, as the BLAS libraries typically use hand-tuned +assembly, where the Eigen libraries must strive to express the +calculation in a general form that the compiler can turn into optimal +code. + +Comparing Eigen 3.3.7 and OpenBLAS 0.3.6 on an `Intel(R) Core(TM) +i7-7700 CPU @ 3.60GHz` is still sub-optimal, only achieving about half +the performance of the BLAS equivalent, and 90% of +`std::complex`: + + B_MatMat/32 5433 ns 5427 ns + B_MatMat/64 38478 ns 38433 ns + B_MatMat/128 299450 ns 298981 ns + B_MatMat/256 2365347 ns 2361566 ns + B_MatMat/512 18888220 ns 18857342 ns + B_MatMat/1024 151079955 ns 150856120 ns + + B_MatMat/32 4963 ns 4955 ns + B_MatMat/64 36716 ns 36671 ns + B_MatMat/128 280870 ns 280346 ns + B_MatMat/256 2173791 ns 2170886 ns + B_MatMat/512 17493222 ns 17459890 ns + B_MatMat/1024 138498432 ns 138286283 ns + + B_MatMatBLAS/32 4877 ns 4870 ns + B_MatMatBLAS/64 27722 ns 27691 ns + B_MatMatBLAS/128 177084 ns 176756 ns + B_MatMatBLAS/256 1268715 ns 1266445 ns + B_MatMatBLAS/512 9772184 ns 9726621 ns + B_MatMatBLAS/1024 75915016 ns 75432354 ns + + +The second benchmark of interest measures how well the nested +specializations `std::complex>` perform as matrix values +relative to using a BLAS library with an extended matrix to compute +the same value function. This comparison is also made with the +[./tests/bench_gemm](./tests/bench_gemm.cpp) program. The relevant +measures are `B_MatMat` and `B_MatMatBLAS` +of twice the size. + +On the same machine as above, using `std::complex>` +(`cdualf`) shows a speed advantage over the BLAS approach, while using +only half the memory. However, notice that the advantage decreases as +the matrices get larger, which ideally should not happen: + + B_MatMat/16 2810 ns 2808 ns + B_MatMat/32 19900 ns 19878 ns + B_MatMat/64 151837 ns 151646 ns + B_MatMat/128 1174699 ns 1172931 ns + B_MatMat/256 9122903 ns 9110123 ns + B_MatMat/512 72575352 ns 72467264 ns + + B_MatMatBLAS/32 4877 ns 4870 ns + B_MatMatBLAS/64 27722 ns 27691 ns + B_MatMatBLAS/128 177084 ns 176756 ns + B_MatMatBLAS/256 1268715 ns 1266445 ns + B_MatMatBLAS/512 9772184 ns 9726621 ns + B_MatMatBLAS/1024 75915016 ns 75432354 ns + + +Contributions +============= + +Questions, bug reports, bug fixes, and contributions are welcome. +Simply submit an [Issue](https://gitlab.com/tesch1/cppduals/issues) +or [Merge Request](https://gitlab.com/tesch1/cppduals/merge_requests). + +Contributors +------------ + +- [Nestor Demeure](https://gitlab.com/nestordemeure) +- [Jeff](https://github.com/flying-tiger) + +Compiler notes +============== + +XCode 11 (Apple Clang 11) is known to work. Also various version of +g++. Clang 8.0 appears to have some trouble with compiling the +optimized templates for Eigen, as evidenced by its propensity to +segfault when compiling the cppduals test programs. Please submit +issues if you experience similar problems, with specifics of your +compiler and compilation flags. + +License +======= + +The primary header file `duals/dual` and testing and benchmarking code +is licensed under the following: + +``` + Part of the cppduals project. + https://tesch1.gitlab.io/cppduals + + (c)2019 Michael Tesch. tesch1@gmail.com + + See https://gitlab.com/tesch1/cppduals/blob/master/LICENSE.txt for + license information. + + This Source Code Form is subject to the terms of the Mozilla + Public License v. 2.0. If a copy of the MPL was not distributed + with this file, You can obtain one at http://mozilla.org/MPL/2.0/. +``` + +Eigen-derived +------------- + +The support for Eigen vectorization, including `duals/dual_eigen` and +the architecture-specific vectorization files under `duals/arch` are +derived from the [Eigen +project](http://eigen.tuxfamily.org/index.php?title=Main_Page), and +thus licensed under [MPL-2](http://www.mozilla.org/MPL/2.0/FAQ.html) . + +ChangeLog +========= + +v0.4.1 +====== + +- changed constexpr to FMT_CONSTEXPR in the dual<> and complex<> + formatters to work with more compilers / lang standards. + +v0.4.0 +====== + +- cleaned-up release with fixes from v0.3.2. +- improved docs + +v0.3.3+ +======= + +- ignore these, will be, trying to cleanup release tarballs, next + stable will be v0.4.0 + +v0.3.2 +====== + +- not actually tagged release +- fixed a bug in the `{fmt}` support, added docs for the same. +- added benchmarking for `{fmt}` vs iostreams. + +v0.3.1 +====== + +- forgot to bump the CMakeLists package version number in 0.3.0. + +v0.3.0 +====== + +- vastly improved cmake support, thanks to + [Jeff](https://gitlab.com/flying-tiger). The improvements required + changing some CMake target names. +- Added basic optional [libfmt](https://github.com/fmtlib/fmt) support for + duals::dual<> and std::complex<>, enabled with `#define`\ s + +v0.2.0 +====== + +- fixed build on VS2017 +- save and restore signam and errno in {t,l}gamma +- fixes from Nestor D. for https://gitlab.com/tesch1/cppduals/issues/5 (spurious nan) + +Todo +==== + +- Add multi-variate differentiation capability. +- Non-x86_64 (CUDA/AltiVec/HIP/NEON/...) vectorization. +- Higher-order derivatives. + diff --git a/src/include/cppduals/doc/Doxyfile.in b/src/include/cppduals/doc/Doxyfile.in new file mode 100644 index 000000000..3f199eedf --- /dev/null +++ b/src/include/cppduals/doc/Doxyfile.in @@ -0,0 +1,2391 @@ +# Doxyfile 1.8.10 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "cppduals" + +# 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 = ${cppduals_VERSION} + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = "Dual numbers for C++" + +# 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 = ${PROJECT_SOURCE_DIR}/doc/Greek_Epsilon_archaic.svg + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = NO + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 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:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), VHDL. For +# instance to make doxygen treat .inc files as Fortran files (default is PHP), +# and .f files as C (default is Fortran), use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = no_extension=C++ + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = YES + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = YES + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO, these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES, upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = NO + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = 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 http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = ${PROJECT_SOURCE_DIR}/duals/dual \ + ${PROJECT_SOURCE_DIR}/duals/dual_eigen \ + ${PROJECT_SOURCE_DIR}/doc + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, +# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, +# *.vhdl, *.ucf, *.qsf, *.as and *.js. + +FILE_PATTERNS = *.cpp *.hpp *.h *.dox *.md + +# 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 = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = ${PROJECT_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: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. + +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. + +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 = ${PROJECT_SOURCE_DIR}/README.md + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = YES + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = ../docs + +# 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 = header.html + +# 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 = footer.html + +# 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 = customdoxygen.css + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = favicon.ico + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 80 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 10 + +# 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 = 240 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the master .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +#DISABLE_INDEX = YES +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +#GENERATE_TREEVIEW = YES +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = YES + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +#MATHJAX_FORMAT = HTML-CSS +MATHJAX_FORMAT = NativeMML + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5 +#MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /