diff --git a/.clang-format b/.clang-format new file mode 100644 index 0000000..61d09bd --- /dev/null +++ b/.clang-format @@ -0,0 +1,42 @@ +BasedOnStyle: LLVM +IndentWidth: 2 +BreakBeforeBraces: Attach +BreakArrays: true + +UseTab: AlignWithSpaces +TabWidth: 2 + +# array +SpacesInSquareBrackets: false + +AllowShortIfStatementsOnASingleLine: false +IndentCaseLabels: true +IndentPPDirectives: BeforeHash + +ColumnLimit: 0 + +PointerAlignment: Left +ReferenceAlignment: Right + +AlignConsecutiveAssignments: + Enabled: true + AcrossComments: true + AcrossEmptyLines: true + +AlignConsecutiveMacros: + Enabled: true + AcrossComments: true + AcrossEmptyLines: true + +AlignConsecutiveBitFields: + Enabled: true + AcrossComments: true + AcrossEmptyLines: true + +AlignEscapedNewlines: Left +AlignAfterOpenBracket: Align + +AlignConsecutiveDeclarations: + Enabled: true + +SortIncludes: false diff --git a/.clang-tidy b/.clang-tidy new file mode 100644 index 0000000..49f84e7 --- /dev/null +++ b/.clang-tidy @@ -0,0 +1,8 @@ +Checks: "-*,readability-magic-numbers,readability-identifier-naming" + +WarningsAsErrors: "*" + +CheckOptions: + - { key: readability-identifier-naming.NamespaceCase, value: lower_case } + - { key: readability-identifier-naming.StructCase, value: CamelCase } + - { key: readability-identifier-naming.FunctionCase, value: camelBack } diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..dbeb11c --- /dev/null +++ b/.gitignore @@ -0,0 +1,194 @@ +tests-stderr-logs +compile_commands.json + +**DS_Store +.vscode** + +**/libpascal.a + +main +.python-version + +**.dat** + +**/libs/** +**/build/** +**/results/** +**/data/** +**/plots** + +**.o +**.a +tests/**/*.o +include/test.h + +tests/**/test.o +tests/**/data.dat +tests/**/test +tests/test_baseline/data.dat +tests/test_baseline/results.csv +tests/valgrind/results/* + +**/*.log +scratch/** + +# Byte-compiled / optimized / DLL files +**__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/#use-with-ide +.pdm.toml + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/ diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..02bc17a --- /dev/null +++ b/.gitmodules @@ -0,0 +1,6 @@ +[submodule "arbiter"] + path = arbiter + url = https://github.com/janithpet/arbiter.git +[submodule "docs/doxygen-awesome-css"] + path = docs/doxygen-awesome-css + url = https://github.com/jothepro/doxygen-awesome-css.git diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..a83615f --- /dev/null +++ b/Makefile @@ -0,0 +1,160 @@ +BUILD_SOURCES=build-sources.inc + +# backend flags +TENSOR_BACKEND_GSL=0 +TENSOR_BACKEND_BLAS=1 +TENSOR_BACKEND_CLAPACK=2 + +# set backend +TENSOR_BACKEND=$(TENSOR_BACKEND_CLAPACK) + +# general pascal flags +TENSOR_USE_UXHW=0 +TENSOR_USE_SIMD=0 +TENSOR_PRINT_VERBOSE=0 +TENSOR_USE_ASSERT=0 + + +# arbiter flags +ARBITER_VERBOSE=0 +ARBITER_STDERR_LOG_DIR= + +ENTRYPOINT=main + +# source directories +SRC_DIR=src +PYTHON_SRC=python-src + +# other directories +BUILD_DIR=build +INCLUDE_DIR=include +LIBS_DIR=libs +TESTS_DIR=tests +CONFIGS_DIR=configs +EXAMPLES_DIR=examples +BENCHMARKS_DIR=benchmarks +DOCS_DIR=docs + +# get platform name. Should be darwin (macOs) or linx (Linux) +PLATFORM=$(shell uname -s | awk '{print tolower($$0)}') + +LIB=$(LIBS_DIR)/libpascal.a + +# default initial compile flags +INCLUDE_FLAGS= -I$(INCLUDE_DIR) -Iarbiter/include +LDFLAGS=-L$(LIBS_DIR) -lpascal + +# default optimisation level and debug flags +OPTFLAGS=-O3 +DEBUG_FLAGS= + + +CONFIGURATION=default +include $(CONFIGS_DIR)/$(CONFIGURATION).conf + +CFLAGS+=-D'TENSOR_PRINT_VERBOSE=$(TENSOR_PRINT_VERBOSE)' -D'TESTS_VERBOSE=$(TESTS_VERBOSE)' -D'TESTS_STDERR_LOG_DIR="$(TESTS_STDERR_LOG_DIR)"' -D'TENSOR_USE_SIMD=$(TENSOR_USE_SIMD)' -D'TENSOR_USE_ASSERT=$(TENSOR_USE_ASSERT)' -D'TENSOR_USE_UXHW=$(TENSOR_USE_UXHW)' -D'TENSOR_BACKEND_GSL=$(TENSOR_BACKEND_GSL)' -D'TENSOR_BACKEND_BLAS=$(TENSOR_BACKEND_BLAS)' -D'TENSOR_BACKEND_CLAPACK=$(TENSOR_BACKEND_CLAPACK)' + + +include $(BUILD_SOURCES) + +SOURCES_FLAT:= $(SOURCES:$(SRC_DIR)/%=%) +OBJECTS := $(SOURCES_FLAT:%=$(BUILD_DIR)/%.o) + + +TESTS := \ + $(TESTS_DIR)/load_data \ + $(TESTS_DIR)/tensor_integration \ + $(TESTS_DIR)/tensor \ + $(TESTS_DIR)/tensor_random_sample \ + $(TESTS_DIR)/tensor_utils \ + $(TESTS_DIR)/autodiff \ + $(TESTS_DIR)/autodiff_primitives \ + $(TESTS_DIR)/tensor_broadcast \ + $(TESTS_DIR)/tensor_iterate \ + +EXAMPLES := \ + bnn-simple \ + gp-simple \ + nn-simple \ + bnn-inference + +EXPERIMENTS := \ + +BENCHMARKS := \ + tensor-single \ + +.PHONY := \ + default \ + lib \ + run \ + test \ + examples \ + benchmarks \ + clean \ + docs \ + +default: lib +lib: $(LIB) + +$(LIB): Makefile $(OBJECTS) + mkdir -p $(dir $@) + ar r $@ $(filter-out $<,$^) + +$(BUILD_DIR)/$(ENTRYPOINT).o: Makefile $(ENTRYPOINT).c + mkdir -p $(dir $@) + $(CC) $(CFLAGS) $(OPTFLAGS) $(DEBUG_FLAGS) $(INCLUDE_FLAGS) -c $(filter-out $<,$^) -o $@ + +$(BUILD_DIR)/%.o: Makefile $(SRC_DIR)/%.c + mkdir -p $(dir $@) + $(CC) $(CFLAGS) $(OPTFLAGS) $(DEBUG_FLAGS) $(INCLUDE_FLAGS) -c $(filter-out $<,$^) -o $@ + + +$(BUILD_DIR)/$(ENTRYPOINT): Makefile $(BUILD_DIR)/$(ENTRYPOINT).o $(LIB) + $(LD) $(MAP) $(LD_SCRIPT_FLAGS) $(FRAMEWORK_FLAGS) $(filter-out $<,$^) -o $@ $(LDFLAGS) + +run: $(BUILD_DIR)/$(ENTRYPOINT) + ./$(BUILD_DIR)/$(ENTRYPOINT) + + +$(BUILD_DIR)/arbiter/src/arbiter.o: Makefile arbiter/src/arbiter.c arbiter/include/arbiter.h + mkdir -p $(dir $@) + $(CC) $(CFLAGS) $(OPTFLAGS) $(DEBUG_FLAGS) $(INCLUDE_FLAGS) -D'ARBITER_STDERR_LOG_DIR="$(ARBITER_STDERR_LOG_DIR)"' -D'ARBITER_VERBOSE=$(ARBITER_VERBOSE)' -c arbiter/src/arbiter.c -o $@ + +$(TESTS_DIR)/%/test: $(TESTS_DIR)/%/test.o $(BUILD_DIR)/arbiter/src/arbiter.o $(LIB) + $(LD) $< $(BUILD_DIR)/arbiter/src/arbiter.o $(FRAMEWORK_FLAGS) -o $@ $(LDFLAGS) + +$(TESTS_DIR)/%/test.o: $(TESTS_DIR)/%/test.c + $(CC) $(OPTFLAGS) $(CFLAGS) -c $< $(INCLUDE_FLAGS) -o $@ + +test: $(TESTS:%=%/test) + $(foreach executable,$^,$(executable);) + + +.SECONDEXPANSION: +$(addprefix eg-,$(EXAMPLES)): $(EXAMPLES_DIR)/$$(patsubst eg-%,%,$$@)/Makefile $(LIB) + @cd $(EXAMPLES_DIR)/$(patsubst eg-%,%,$@); make run; echo + +.SECONDEXPANSION: +$(addprefix bm-,$(BENCHMARKS)): $(BENCHMARKS_DIR)/$$(patsubst bm-%,%,$$@)/Makefile $(LIB) + cd $(BENCHMARKS_DIR)/$(patsubst bm-%,%,$@); make run + + +examples: $(EXAMPLES:%=eg-%) +benchmarks: $(BENCHMARKS:%=bm-%) + + +clean: + rm -rfv $(BUILD_DIR)/* + rm -fv $(ENTRYPOINT) \ + $(LIB) \ + $(OBJECTS) \ + $(TESTS:%=%/test) \ + $(TESTS:%=%/test.o) \ + $(TESTS:%=$(TESTS_DIR)/%/test) \ + $(TESTS:%=$(TESTS_DIR)/%/test) \ + + $(if $(EXAMPLES), cd $(EXAMPLES:%=$(EXAMPLES_DIR)/%); make clean, ) + $(if $(BENCHMARKS), cd $(BENCHMARKS:%=$(BENCHMARKS_DIR)/%); make clean, ) + +docs : $(DOCS_DIR)/config + doxygen $(DOCS_DIR)/config diff --git a/README.md b/README.md new file mode 100644 index 0000000..de31514 --- /dev/null +++ b/README.md @@ -0,0 +1,107 @@ +# Pascal + +Pascal is a software framework written in C that enables hardware-enhanced Bayesian Learning. It contains modules that can carry out operations on tensors, similar to [NumPy Arrays](https://numpy.org/doc/stable/reference/generated/numpy.array.html), [PyTorch Tensors](https://pytorch.org/docs/stable/tensors.html), and other popular tools. Pascal can also carry out reverse-mode automatic differentiation using the `pascal-autodiff` module. + + +## Requirements +Pascal can run using several backends. By default, Pascal uses `clapack`, which is included in this repository. Therefore you do not have to + +Pascal uses either a `cblas` or a `libgsl` backend to carry out some operations. Thus, these should be installed. The [`Makefile`](Makefile) includes flags that should point to standard locations. If these don't work, please updated the `INCLUDE_FLAGS`, `LDFLAGS` and `FRAMEWORK_FLAGS` variables in the [`configs/default.conf`](configs/default.conf) as needed. Alternatively, you can create a new configuration file (`.conf`) in the `configs` folder and update the `CONFIGURATION` variable in the [`Makefile`](Makefile) (note that if your new configuration is `configs/new-config.conf`, `CONFIGURATION` should be set to `new-config`). + +### CBLAS and GSL on MacOS +On MacOS, these are included in the [Accelerate framework](https://developer.apple.com/documentation/accelerate). This is installed with the XCode command-line tools, by running: +``` +xcode-select --install +``` + +Currently, `default.conf` assumes that [`libgsl`](https://www.gnu.org/software/gsl/doc/html/index.html) is installed using [`homebrew`](https://brew.sh) by running: +``` +brew install gsl +``` + +If you install it using other means, please update the `INCLUDE_FLAGS` and `LDFLAGS` in the correct if-else block. + +### CBLAS and GSL on Linux +To be written + +## Build +To use this package, simply clone this repository. This can be done as: +``` +git clone --recursive https://github.com/physical-computation/pascal.git +``` + +> [!NOTE] +> The `--recursive` is important since this repository uses submodules. + + + + Then you can build it using +``` +make +``` + +This creates a library file in `libs/` + +To test, run: +``` +make test +``` + +If everything worked well, this will print: +```bash +tests/load_data/test; tests/tensor_integration/test; tests/tensor/test; tests/tensor_random_sample/test; tests/tensor_utils/test; tests/autodiff/test; tests/autodiff_primitives/test; tests/tensor_broadcast/test; tests/tensor_iterate/test; +Running tests in load_data: +Completed: 3/3 passed in 596µs +Running tests in pascal_tensor_integrations: +Completed: 15/15 passed in 192µs +Running tests in tensor: +Completed: 48/48 passed in 372µs +Running tests in pascal_tensor_random_sample: +Completed: 2/2 passed in 3µs +Running tests in pascal_tensor_utils: +Completed: 8/8 passed in 10µs +Running tests in autodiff: +Completed: 15/15 passed in 273µs +Running tests in autodiff_primitives: +Completed: 19/19 passed in 106µs +Running tests in pascal_tensor_broadcast: +Completed: 3/3 passed in 12µs +Running tests in pascal_tensor_iterate: +Completed: 6/6 passed in 8µs +``` + +## Examples and Benchmarks +> [!NOTE] +> Currently, the Makefiles in [`examples/`](examples/) and [`benchmarks/`](benchmarks/) are written to work with `macOS` only. + +A basic implementation of a tensor operation using `Pascal` is + + +The examples and benchmarks use Python to run some analyses and baselines. It is recommended that you use a virtual environment. Install the required packages using +``` +pip install -r requirements.txt +``` +Please see the `examples/` folder. It includes a few simple examples of using the functionality that Pascal offers. The `Makefile`s in these folders currently only support `macOS`. However, they should be a useful guide for other platforms: you can think of them as compiling your application while including `libpascal.a` (which gets created when you run `make`). + +### Running examples +All examples can be executed by running the following from the root directory of this project: +``` +make examples +``` + +Individual examples can be executed using the following syntax: +``` +make eg- +``` +`` can be replaced by the names of the folders inside of [`examples/`](examples/), such as `nn-simple` and `bnn-simple`. + +### Running benchmarks +We currently compare some of our tensor operations against [`NumPy`](www.numpy.org). To run these benchmarks, run +``` +make benchmarks +``` + +## Documentation +There is a set of incomplete documentation in [`docs/`](docs/). If you load [`docs/html/index.html`](docs/html/index.html) locally, you can navigate this documentation on your browser. + +Furthermore, documentation comments can be found on some of the function in [`include/pascal.h`](include/pascal.h). diff --git a/benchmarks/tensor-single/Makefile b/benchmarks/tensor-single/Makefile new file mode 100644 index 0000000..75427f2 --- /dev/null +++ b/benchmarks/tensor-single/Makefile @@ -0,0 +1,61 @@ +CC=clang + +OPTIMISATION_LEVEL=-O3 + +SRC_DIR=src +PYTHON_SRC=python-src +BUILD_DIR=build +INCLUDE_DIR=include +RESULTS_DIR=results + +INCLUDE_FLAGS=-I../../include -I$(INCLUDE_DIR) +CFLAGS+=$(OPTIMISATION_LEVEL) +LDFLAGS=-L../../libs/ -lpascal +FRAMEWORK_FLAGS= +DEBUG_FLAGS=-g + +SOURCES := \ + +ENTRYPOINTS := \ + add \ + add_broadcast \ + multiply \ + multiply_broadcast \ + reciprocal \ + square \ + matmul \ + dot \ + linalg_inv \ + linalg_solve \ + sum \ + sum_all \ + + +OBJECTS := $(SOURCES:%=$(BUILD_DIR)/%.o) +LIB := $(OBJECTS:%=%) +ENTRYPOINTS_FLAT := $(ENTRYPOINTS:%=$(BUILD_DIR)/%) + +.PHONY := \ + run \ + clean \ + +$(BUILD_DIR)/%.c.o: $(SRC_DIR)/%.c + mkdir -p $(dir $@) + $(CC) $(CFLAGS) $(DEBUG_FLAGS) $(INCLUDE_FLAGS) -c $< -o $@ + +.SECONDEXPANSION: +$(addsuffix .c.o,$(ENTRYPOINTS_FLAT)): $$(patsubst $(BUILD_DIR)/%.c.o,$(SRC_DIR)/%.c,$$@) + mkdir -p $(dir $@) + $(CC) $(CFLAGS) -c $< $(DEBUG_FLAGS) $(INCLUDE_FLAGS) -o $@ + +.SECONDEXPANSION: +$(ENTRYPOINTS_FLAT): $$@.c.o $(LIB) + $(CC) -o $@ $^ $(LDFLAGS) $(DEBUG_FLAGS) $(FRAMEWORK_FLAGS) + +.SECONDEXPANSION: +run: $(ENTRYPOINTS_FLAT) + mkdir -p $(RESULTS_DIR) + $(foreach ep, $(ENTRYPOINTS), $(BUILD_DIR)/$(ep); python $(PYTHON_SRC)/$(ep).py; echo;) + +clean: + rm -fv $(BUILD_DIR)/* diff --git a/benchmarks/tensor-single/python-src/add.py b/benchmarks/tensor-single/python-src/add.py new file mode 100644 index 0000000..c17a5fc --- /dev/null +++ b/benchmarks/tensor-single/python-src/add.py @@ -0,0 +1,22 @@ +import numpy as np + +import time + +N = 1000 +dim = 3 +ndim = 10 + +if __name__ == '__main__': + shape = [dim for i in range(ndim)] + + completion_time = 0 + for i in range(N): + a = np.random.uniform(-1, 1, shape) + b = np.random.uniform(-1, 1, shape) + + start_time = time.time() + c = a + b + completion_time += time.time() - start_time + + completion_time /= N + print(f"python\t{completion_time*1000000:.0f}\xB5s\tadd") diff --git a/benchmarks/tensor-single/python-src/add_broadcast.py b/benchmarks/tensor-single/python-src/add_broadcast.py new file mode 100644 index 0000000..de522b4 --- /dev/null +++ b/benchmarks/tensor-single/python-src/add_broadcast.py @@ -0,0 +1,22 @@ +import numpy as np + +import time + +N = 1000 +dim = 3 +ndim = 10 + +if __name__ == "__main__": + shape = [dim for i in range(ndim)] + + completion_time = 0 + for i in range(N): + a = np.random.uniform(-1, 1, shape) + b = np.random.uniform(-1, 1, [1]) + + start_time = time.time() + c = a + b + completion_time += time.time() - start_time + + completion_time /= N + print(f"python\t{completion_time*1000000:.0f}\xB5s\tadd_broadcast") diff --git a/benchmarks/tensor-single/python-src/dot.py b/benchmarks/tensor-single/python-src/dot.py new file mode 100644 index 0000000..84032d1 --- /dev/null +++ b/benchmarks/tensor-single/python-src/dot.py @@ -0,0 +1,19 @@ +import numpy as np + +import time + +N = 1000 +dim = 100000 + +if __name__ == '__main__': + a = np.random.uniform(-1, 1, [dim]) + b = np.random.uniform(-1, 1, [dim]) + + completion_time = 0 + for i in range(N): + start_time = time.time() + c = np.dot(a, b) + completion_time += time.time() - start_time + + completion_time /= N + print(f"python\t{completion_time*1000000:.0f}\xB5s\tdot") diff --git a/benchmarks/tensor-single/python-src/linalg_inv.py b/benchmarks/tensor-single/python-src/linalg_inv.py new file mode 100644 index 0000000..d690283 --- /dev/null +++ b/benchmarks/tensor-single/python-src/linalg_inv.py @@ -0,0 +1,18 @@ +import numpy as np + +import time + +N = 1000 +dim = 50 + +if __name__ == '__main__': + a = np.random.uniform(-1, 1, [dim, dim]) + + completion_time = 0 + for i in range(N): + start_time = time.time() + b = np.linalg.inv(a) + completion_time += time.time() - start_time + + completion_time /= N + print(f"python\t{completion_time*1000000:.0f}\xB5s\tlinalg_inv") diff --git a/benchmarks/tensor-single/python-src/linalg_solve.py b/benchmarks/tensor-single/python-src/linalg_solve.py new file mode 100644 index 0000000..6d6f256 --- /dev/null +++ b/benchmarks/tensor-single/python-src/linalg_solve.py @@ -0,0 +1,19 @@ +import numpy as np + +import time + +N = 1000 +dim = 100 + +if __name__ == '__main__': + completion_time = 0 + for i in range(N): + a = np.random.uniform(-1, 1, [dim, dim]) + b = np.random.uniform(-1, 1, [dim, dim]) + + start_time = time.time() + c = np.linalg.solve(a, b) + completion_time += time.time() - start_time + + completion_time /= N + print(f"python\t{completion_time*1000000:.0f}\xB5s\tlinalg_solve") diff --git a/benchmarks/tensor-single/python-src/matmul.py b/benchmarks/tensor-single/python-src/matmul.py new file mode 100644 index 0000000..2f6c515 --- /dev/null +++ b/benchmarks/tensor-single/python-src/matmul.py @@ -0,0 +1,19 @@ +import numpy as np + +import time + +N = 1000 +dim = 100 + +if __name__ == '__main__': + completion_time = 0 + for i in range(N): + a = np.random.uniform(-1, 1, [dim, dim]) + b = np.random.uniform(-1, 1, [dim, dim]) + + start_time = time.time() + c = a @ b + completion_time += time.time() - start_time + + completion_time /= N + print(f"python\t{completion_time*1000000:.0f}\xB5s\tmatmul") diff --git a/benchmarks/tensor-single/python-src/multiply.py b/benchmarks/tensor-single/python-src/multiply.py new file mode 100644 index 0000000..1a01fc7 --- /dev/null +++ b/benchmarks/tensor-single/python-src/multiply.py @@ -0,0 +1,22 @@ +import numpy as np + +import time + +N = 1000 +dim = 3 +ndim = 10 + +if __name__ == '__main__': + shape = [dim for i in range(ndim)] + + completion_time = 0 + for i in range(N): + a = np.random.uniform(-1, 1, shape) + b = np.random.uniform(-1, 1, shape) + + start_time = time.time() + c = a * b + completion_time += time.time() - start_time + + completion_time /= N + print(f"python\t{completion_time*1000000:.0f}\xB5s\tmultiply") diff --git a/benchmarks/tensor-single/python-src/multiply_broadcast.py b/benchmarks/tensor-single/python-src/multiply_broadcast.py new file mode 100644 index 0000000..30abe83 --- /dev/null +++ b/benchmarks/tensor-single/python-src/multiply_broadcast.py @@ -0,0 +1,22 @@ +import numpy as np + +import time + +N = 1000 +dim = 3 +ndim = 10 + +if __name__ == '__main__': + shape = [dim for i in range(ndim)] + + a = np.random.uniform(-1, 1, shape) + b = np.random.uniform(-1, 1, [1]) + + completion_time = 0 + for i in range(N): + start_time = time.time() + c = a * b + completion_time += time.time() - start_time + + completion_time /= N + print(f"python\t{completion_time*1000000:.0f}\xB5s\tmultiply_broadcast") diff --git a/benchmarks/tensor-single/python-src/reciprocal.py b/benchmarks/tensor-single/python-src/reciprocal.py new file mode 100644 index 0000000..16815a2 --- /dev/null +++ b/benchmarks/tensor-single/python-src/reciprocal.py @@ -0,0 +1,18 @@ +import numpy as np + +import time + +N = 1000 +dim = 300 + +if __name__ == "__main__": + + completion_time = 0 + for i in range(N): + a = np.random.uniform(-1, 1, [dim, dim]) + + start_time = time.time() + b = np.reciprocal(a) + completion_time += time.time() - start_time + completion_time /= N + print(f"python\t{completion_time*1000000:.0f}\xB5s\treciprocal") diff --git a/benchmarks/tensor-single/python-src/square.py b/benchmarks/tensor-single/python-src/square.py new file mode 100644 index 0000000..d0c5d79 --- /dev/null +++ b/benchmarks/tensor-single/python-src/square.py @@ -0,0 +1,19 @@ +import numpy as np + +import time + +N = 10000 +dim = 200 + +if __name__ == '__main__': + + completion_time = 0 + for i in range(N): + a = np.random.uniform(-1, 1, [dim, dim]) + + start_time = time.time() + b = np.square(a) + completion_time += time.time() - start_time + + completion_time /= N + print(f"python\t{completion_time*1000000:.0f}\xB5s\tsquare") diff --git a/benchmarks/tensor-single/python-src/sum.py b/benchmarks/tensor-single/python-src/sum.py new file mode 100644 index 0000000..e410a30 --- /dev/null +++ b/benchmarks/tensor-single/python-src/sum.py @@ -0,0 +1,21 @@ +import numpy as np + +import time + +N = 1000 +dim = 5 +ndim = 7 + +if __name__ == '__main__': + shape = [dim for i in range(ndim)] + + completion_time = 0 + for i in range(N): + a = np.random.uniform(-1, 1, shape) + + start_time = time.time() + b = np.sum(a, (0, 2, 3, 4)) + completion_time += time.time() - start_time + + completion_time /= N + print(f"python\t{completion_time*1000000:.0f}\xB5s\tsum") diff --git a/benchmarks/tensor-single/python-src/sum_all.py b/benchmarks/tensor-single/python-src/sum_all.py new file mode 100644 index 0000000..6cb34ba --- /dev/null +++ b/benchmarks/tensor-single/python-src/sum_all.py @@ -0,0 +1,19 @@ +import numpy as np + +import time + +N = 1000 +dim = 500 + +if __name__ == '__main__': + + completion_time = 0 + for i in range(N): + a = np.random.uniform(-1, 1, [dim, dim]) + + start_time = time.time() + b = np.sum(a) + completion_time += time.time() - start_time + + completion_time /= N + print(f"python\t{completion_time*1000000:.0f}\xB5s\tsum_all") diff --git a/benchmarks/tensor-single/src/add.c b/benchmarks/tensor-single/src/add.c new file mode 100644 index 0000000..b47b066 --- /dev/null +++ b/benchmarks/tensor-single/src/add.c @@ -0,0 +1,41 @@ +#include +#include +#include + +#include "pascal.h" +#include + +int main() { + srand(time(NULL)); + + index_t N = 1000; + index_t dim = 3; + index_t ndim = 10; + + index_t* shape = malloc(sizeof(index_t) * ndim); + for (int i = 0; i < ndim; i++) { + shape[i] = dim; + } + + struct timeval stop, start; + long int completion_time = 0; + for (int i = 0; i < N; i++) { + Tensor a = pascal_tensor_random_uniform(-1, 1, shape, ndim); + Tensor b = pascal_tensor_random_uniform(-1, 1, shape, ndim); + + Tensor c; + + gettimeofday(&start, NULL); + c = pascal_tensor_add(a, b); + gettimeofday(&stop, NULL); + + completion_time += ((stop.tv_sec - start.tv_sec) * 1000000 + (stop.tv_usec - start.tv_usec)); + + pascal_tensor_free(a); + pascal_tensor_free(b); + pascal_tensor_free(c); + } + + completion_time = completion_time / N; + printf("pascal\t%ld\xC2\xB5s\tadd\n", completion_time); +} diff --git a/benchmarks/tensor-single/src/add_broadcast.c b/benchmarks/tensor-single/src/add_broadcast.c new file mode 100644 index 0000000..7af588c --- /dev/null +++ b/benchmarks/tensor-single/src/add_broadcast.c @@ -0,0 +1,42 @@ +#include +#include +#include + +#include "pascal.h" +#include + +int main() { + srand(time(NULL)); + + index_t N = 1000; + index_t dim = 3; + index_t ndim = 10; + + index_t* shape = malloc(sizeof(index_t) * ndim); + for (int i = 0; i < ndim; i++) { + shape[i] = dim; + } + + struct timeval stop, start; + long int completion_time = 0; + for (int i = 0; i < N; i++) { + Tensor a = pascal_tensor_random_uniform(-1, 1, shape, ndim); + Tensor b = pascal_tensor_random_uniform(-1, 1, (index_t[]){dim}, 1); + + Tensor c; + gettimeofday(&start, NULL); + + c = pascal_tensor_add(a, b); + + gettimeofday(&stop, NULL); + completion_time += ((stop.tv_sec - start.tv_sec) * 1000000 + (stop.tv_usec - start.tv_usec)); + + pascal_tensor_free(a); + pascal_tensor_free(b); + pascal_tensor_free(c); + } + + free(shape); + completion_time = completion_time / N; + printf("pascal\t%ld\xC2\xB5s\tadd_broadcast\n", completion_time); +} diff --git a/benchmarks/tensor-single/src/dot.c b/benchmarks/tensor-single/src/dot.c new file mode 100644 index 0000000..95038d0 --- /dev/null +++ b/benchmarks/tensor-single/src/dot.c @@ -0,0 +1,37 @@ +#include +#include +#include + +#include "pascal.h" +#include + +int main() { + srand(time(NULL)); + + index_t N = 1000; + + index_t ndim = 2; + index_t dim = 100000; + index_t shape[2] = {dim, 1}; + + Tensor a = pascal_tensor_random_uniform(-1, 1, shape, ndim); + Tensor b = pascal_tensor_random_uniform(-1, 1, shape, ndim); + + Tensor c; + struct timeval stop, start; + long int completion_time = 0; + for (int i = 0; i < N; i++) { + gettimeofday(&start, NULL); + c = pascal_tensor_dot(a, b); + gettimeofday(&stop, NULL); + + completion_time += ((stop.tv_sec - start.tv_sec) * 1000000 + (stop.tv_usec - start.tv_usec)); + } + + completion_time = completion_time / N; + printf("pascal\t%ld\xC2\xB5s\tdot\n", completion_time); + + pascal_tensor_free(a); + pascal_tensor_free(b); + pascal_tensor_free(c); +} diff --git a/benchmarks/tensor-single/src/linalg_inv.c b/benchmarks/tensor-single/src/linalg_inv.c new file mode 100644 index 0000000..4bfab12 --- /dev/null +++ b/benchmarks/tensor-single/src/linalg_inv.c @@ -0,0 +1,35 @@ +#include +#include +#include + +#include "pascal.h" +#include + +int main() { + srand(time(NULL)); + + index_t N = 1000; + + index_t ndim = 2; + index_t dim = 50; + index_t shape[2] = {dim, dim}; + + Tensor a = pascal_tensor_random_uniform(-1, 1, shape, ndim); + + Tensor b; + struct timeval stop, start; + long int completion_time = 0; + for (int i = 0; i < N; i++) { + gettimeofday(&start, NULL); + b = pascal_tensor_linalg_inv(a); + gettimeofday(&stop, NULL); + + completion_time += ((stop.tv_sec - start.tv_sec) * 1000000 + (stop.tv_usec - start.tv_usec)); + } + + completion_time = completion_time / N; + printf("pascal\t%ld\xC2\xB5s\tlinalg_inv\n", completion_time); + + pascal_tensor_free(a); + pascal_tensor_free(b); +} diff --git a/benchmarks/tensor-single/src/linalg_solve.c b/benchmarks/tensor-single/src/linalg_solve.c new file mode 100644 index 0000000..3db3db9 --- /dev/null +++ b/benchmarks/tensor-single/src/linalg_solve.c @@ -0,0 +1,36 @@ +#include +#include +#include + +#include "pascal.h" +#include + +int main() { + srand(time(NULL)); + + index_t N = 1000; + + index_t ndim = 2; + index_t dim = 100; + index_t shape[2] = {dim, dim}; + + struct timeval stop, start; + long int completion_time = 0; + for (int i = 0; i < N; i++) { + Tensor a = pascal_tensor_random_uniform(-1, 1, shape, ndim); + Tensor b = pascal_tensor_random_uniform(-1, 1, shape, ndim); + + gettimeofday(&start, NULL); + Tensor c = pascal_tensor_linalg_solve(a, b); + gettimeofday(&stop, NULL); + + completion_time += ((stop.tv_sec - start.tv_sec) * 1000000 + (stop.tv_usec - start.tv_usec)); + + pascal_tensor_free(a); + pascal_tensor_free(b); + pascal_tensor_free(c); + } + + completion_time = completion_time / N; + printf("pascal\t%ld\xC2\xB5s\tlinalg_solve\n", completion_time); +} diff --git a/benchmarks/tensor-single/src/matmul.c b/benchmarks/tensor-single/src/matmul.c new file mode 100644 index 0000000..8fa03fa --- /dev/null +++ b/benchmarks/tensor-single/src/matmul.c @@ -0,0 +1,37 @@ +#include +#include +#include + +#include "pascal.h" +#include + +int main() { + srand(time(NULL)); + + index_t N = 1000; + + index_t ndim = 2; + index_t dim = 100; + + index_t shape[2] = {dim, dim}; + + struct timeval stop, start; + long int completion_time = 0; + for (int i = 0; i < N; i++) { + Tensor a = pascal_tensor_random_uniform(-1, 1, shape, ndim); + Tensor b = pascal_tensor_random_uniform(-1, 1, shape, ndim); + + gettimeofday(&start, NULL); + Tensor c = pascal_tensor_matmul(a, b); + gettimeofday(&stop, NULL); + + completion_time += ((stop.tv_sec - start.tv_sec) * 1000000 + (stop.tv_usec - start.tv_usec)); + + pascal_tensor_free(a); + pascal_tensor_free(b); + pascal_tensor_free(c); + } + + completion_time = completion_time / N; + printf("pascal\t%ld\xC2\xB5s\tmatmul\n", completion_time); +} diff --git a/benchmarks/tensor-single/src/multiply.c b/benchmarks/tensor-single/src/multiply.c new file mode 100644 index 0000000..1d759ef --- /dev/null +++ b/benchmarks/tensor-single/src/multiply.c @@ -0,0 +1,41 @@ +#include +#include +#include + +#include "pascal.h" +#include + +int main() { + srand(time(NULL)); + + index_t N = 1000; + index_t dim = 3; + index_t ndim = 10; + + index_t* shape = malloc(sizeof(index_t) * ndim); + for (int i = 0; i < ndim; i++) { + shape[i] = dim; + }; + + struct timeval stop, start; + long int completion_time = 0; + for (int i = 0; i < N; i++) { + Tensor a = pascal_tensor_random_uniform(-1, 1, shape, ndim); + Tensor b = pascal_tensor_random_uniform(-1, 1, shape, ndim); + + Tensor c; + + gettimeofday(&start, NULL); + c = pascal_tensor_multiply(a, b); + gettimeofday(&stop, NULL); + + completion_time += ((stop.tv_sec - start.tv_sec) * 1000000 + (stop.tv_usec - start.tv_usec)); + + pascal_tensor_free(a); + pascal_tensor_free(b); + pascal_tensor_free(c); + } + + completion_time = completion_time / N; + printf("pascal\t%ld\xC2\xB5s\tmultiply\n", completion_time); +} diff --git a/benchmarks/tensor-single/src/multiply_broadcast.c b/benchmarks/tensor-single/src/multiply_broadcast.c new file mode 100644 index 0000000..dd30190 --- /dev/null +++ b/benchmarks/tensor-single/src/multiply_broadcast.c @@ -0,0 +1,39 @@ +#include +#include +#include + +#include "pascal.h" +#include + +int main() { + srand(time(NULL)); + + index_t N = 100; + index_t dim = 3; + index_t ndim = 10; + + index_t* shape = malloc(sizeof(index_t) * ndim); + for (int i = 0; i < ndim; i++) { + shape[i] = dim; + } + + struct timeval stop, start; + long int completion_time = 0; + for (int i = 0; i < N; i++) { + Tensor a = pascal_tensor_random_uniform(-1, 1, shape, ndim); + Tensor b = pascal_tensor_random_uniform(-1, 1, (index_t[]){1}, 1); + + gettimeofday(&start, NULL); + Tensor c = pascal_tensor_multiply(a, b); + gettimeofday(&stop, NULL); + + completion_time += ((stop.tv_sec - start.tv_sec) * 1000000 + (stop.tv_usec - start.tv_usec)); + + pascal_tensor_free(a); + pascal_tensor_free(b); + pascal_tensor_free(c); + } + free(shape); + completion_time = completion_time / N; + printf("pascal\t%ld\xC2\xB5s\tmultiply_broadcast\n", completion_time); +} diff --git a/benchmarks/tensor-single/src/reciprocal.c b/benchmarks/tensor-single/src/reciprocal.c new file mode 100644 index 0000000..fa76ca7 --- /dev/null +++ b/benchmarks/tensor-single/src/reciprocal.c @@ -0,0 +1,36 @@ +#include +#include +#include + +#include "pascal.h" +#include + +int main() { + srand(time(NULL)); + + index_t N = 1000; + + index_t ndim = 2; + index_t dim = 300; + index_t shape[2] = {dim, dim}; + + struct timeval stop, start; + long int completion_time = 0; + for (int i = 0; i < N; i++) { + Tensor a = pascal_tensor_random_uniform(-1, 1, shape, ndim); + + Tensor b; + + gettimeofday(&start, NULL); + b = pascal_tensor_reciprocal(a); + gettimeofday(&stop, NULL); + + completion_time += ((stop.tv_sec - start.tv_sec) * 1000000 + (stop.tv_usec - start.tv_usec)); + + pascal_tensor_free(a); + pascal_tensor_free(b); + } + + completion_time = completion_time / N; + printf("pascal\t%ld\xC2\xB5s\treciprocal\n", completion_time); +} diff --git a/benchmarks/tensor-single/src/square.c b/benchmarks/tensor-single/src/square.c new file mode 100644 index 0000000..453b35c --- /dev/null +++ b/benchmarks/tensor-single/src/square.c @@ -0,0 +1,36 @@ +#include +#include +#include + +#include "pascal.h" +#include + +int main() { + srand(time(NULL)); + + index_t N = 10000; + + index_t ndim = 2; + index_t dim = 200; + index_t shape[2] = {dim, dim}; + + struct timeval stop, start; + long int completion_time = 0; + for (int i = 0; i < N; i++) { + Tensor a = pascal_tensor_random_uniform(-1, 1, shape, ndim); + + Tensor b; + + gettimeofday(&start, NULL); + b = pascal_tensor_square(a); + gettimeofday(&stop, NULL); + + completion_time += ((stop.tv_sec - start.tv_sec) * 1000000 + (stop.tv_usec - start.tv_usec)); + + pascal_tensor_free(a); + pascal_tensor_free(b); + } + + completion_time = completion_time / N; + printf("pascal\t%ld\xC2\xB5s\tsquare\n", completion_time); +} diff --git a/benchmarks/tensor-single/src/sum.c b/benchmarks/tensor-single/src/sum.c new file mode 100644 index 0000000..ab00f9e --- /dev/null +++ b/benchmarks/tensor-single/src/sum.c @@ -0,0 +1,39 @@ +#include +#include +#include + +#include "pascal.h" +#include + +int main() { + srand(time(NULL)); + + index_t N = 1000; + index_t dim = 5; + index_t ndim = 7; + + index_t* shape = malloc(sizeof(index_t) * ndim); + for (int i = 0; i < ndim; i++) { + shape[i] = dim; + } + + struct timeval stop, start; + long int completion_time = 0; + for (int i = 0; i < N; i++) { + Tensor a = pascal_tensor_random_uniform(-1, 1, shape, ndim); + + Tensor b; + + gettimeofday(&start, NULL); + b = pascal_tensor_sum(a, (index_t[]){0, 2, 3, 4}, 4); + gettimeofday(&stop, NULL); + + completion_time += ((stop.tv_sec - start.tv_sec) * 1000000 + (stop.tv_usec - start.tv_usec)); + + pascal_tensor_free(a); + pascal_tensor_free(b); + } + + completion_time = completion_time / N; + printf("pascal\t%ld\xC2\xB5s\tsum\n", completion_time); +} diff --git a/benchmarks/tensor-single/src/sum_all.c b/benchmarks/tensor-single/src/sum_all.c new file mode 100644 index 0000000..aff5ba0 --- /dev/null +++ b/benchmarks/tensor-single/src/sum_all.c @@ -0,0 +1,36 @@ +#include +#include +#include + +#include "pascal.h" +#include + +int main() { + srand(time(NULL)); + + index_t N = 1000; + + index_t ndim = 2; + index_t dim = 500; + index_t shape[2] = {dim, dim}; + + struct timeval stop, start; + long int completion_time = 0; + for (int i = 0; i < N; i++) { + Tensor a = pascal_tensor_random_uniform(-1, 1, shape, ndim); + + Tensor b; + + gettimeofday(&start, NULL); + b = pascal_tensor_sum_all(a); + gettimeofday(&stop, NULL); + + completion_time += ((stop.tv_sec - start.tv_sec) * 1000000 + (stop.tv_usec - start.tv_usec)); + + pascal_tensor_free(a); + pascal_tensor_free(b); + } + + completion_time = completion_time / N; + printf("pascal\t%ld\xC2\xB5s\tsum_all\n", completion_time); +} diff --git a/build-sources.inc b/build-sources.inc new file mode 100644 index 0000000..07aeb3f --- /dev/null +++ b/build-sources.inc @@ -0,0 +1,327 @@ +SOURCES := \ + $(SRC_DIR)/tensor/add \ + $(SRC_DIR)/tensor/append \ + $(SRC_DIR)/tensor/clamp \ + $(SRC_DIR)/tensor/conv2d \ + $(SRC_DIR)/tensor/convolution \ + $(SRC_DIR)/tensor/copy \ + $(SRC_DIR)/tensor/diag \ + $(SRC_DIR)/tensor/divide \ + $(SRC_DIR)/tensor/dot \ + $(SRC_DIR)/tensor/expand_dims \ + $(SRC_DIR)/tensor/eye \ + $(SRC_DIR)/tensor/flatten \ + $(SRC_DIR)/tensor/free \ + $(SRC_DIR)/tensor/get \ + $(SRC_DIR)/tensor/init \ + $(SRC_DIR)/tensor/linspace \ + $(SRC_DIR)/tensor/linalg_inv \ + $(SRC_DIR)/tensor/linalg_solve \ + $(SRC_DIR)/tensor/linalg_cholesky \ + $(SRC_DIR)/tensor/linalg_triangular_solve \ + $(SRC_DIR)/tensor/map \ + $(SRC_DIR)/tensor/matmul \ + $(SRC_DIR)/tensor/max_pool \ + $(SRC_DIR)/tensor/mean_all \ + $(SRC_DIR)/tensor/multiply \ + $(SRC_DIR)/tensor/new \ + $(SRC_DIR)/tensor/new_no_malloc \ + $(SRC_DIR)/tensor/new_repeat \ + $(SRC_DIR)/tensor/ones \ + $(SRC_DIR)/tensor/print \ + $(SRC_DIR)/tensor/prod_all \ + $(SRC_DIR)/tensor/random_normal \ + $(SRC_DIR)/tensor/random_uniform \ + $(SRC_DIR)/tensor/reciprocal \ + $(SRC_DIR)/tensor/reshape \ + $(SRC_DIR)/tensor/scalar_multiply \ + $(SRC_DIR)/tensor/square \ + $(SRC_DIR)/tensor/subtract \ + $(SRC_DIR)/tensor/sum \ + $(SRC_DIR)/tensor/sum_all \ + $(SRC_DIR)/tensor/tile \ + $(SRC_DIR)/tensor/transpose \ + $(SRC_DIR)/tensor/uncertain_normal \ + $(SRC_DIR)/tensor/zeros \ +\ + $(SRC_DIR)/tensor_random_sample/normal \ + $(SRC_DIR)/tensor_random_sample/uniform \ +\ + $(SRC_DIR)/tensor_utils/tensor_binary_operate \ + $(SRC_DIR)/tensor_utils/tensor_print_shape\ + $(SRC_DIR)/tensor_utils/tensor_print_values \ + $(SRC_DIR)/tensor_utils/tensor_utils_apply_transpose_map \ + $(SRC_DIR)/tensor_utils/tensor_utils_default_stride \ + $(SRC_DIR)/tensor_utils/tensor_utils_get_convolution_array \ + $(SRC_DIR)/tensor_utils/tensor_utils_get_convolution_start_index \ + $(SRC_DIR)/tensor_utils/tensor_utils_get_masked_index \ + $(SRC_DIR)/tensor_utils/tensor_utils_get_masked_offset \ + $(SRC_DIR)/tensor_utils/tensor_utils_get_pointer \ + $(SRC_DIR)/tensor_utils/tensor_utils_index_from_linear_index \ + $(SRC_DIR)/tensor_utils/tensor_utils_index_from_linear_index_transpose_safe \ + $(SRC_DIR)/tensor_utils/tensor_utils_linalg_get_array_col_maj \ + $(SRC_DIR)/tensor_utils/tensor_utils_shapes_equal \ + $(SRC_DIR)/tensor_utils/tensor_utils_size_from_shape \ + $(SRC_DIR)/tensor_utils/tensor_utils_unary_chain_rule \ + $(SRC_DIR)/tensor_utils/tensor_utils_unravel \ + $(SRC_DIR)/tensor_utils/tensor_utils_unravel_and_replace \ +\ + $(SRC_DIR)/tensor_broadcast/broadcast_output_free \ + $(SRC_DIR)/tensor_broadcast/broadcast_output_init \ + $(SRC_DIR)/tensor_broadcast/tensor_broadcast \ + $(SRC_DIR)/tensor_broadcast/tensor_broadcast_and_operate \ + $(SRC_DIR)/tensor_broadcast/tensor_broadcast_is_needed \ + $(SRC_DIR)/tensor_broadcast/tensor_broadcast_is_needed_linalg \ + $(SRC_DIR)/tensor_broadcast/tensor_broadcast_linalg \ + $(SRC_DIR)/tensor_broadcast/tensor_linear_index_from_index \ +\ + $(SRC_DIR)/tensor_iterate/tensor_iterator_copy \ + $(SRC_DIR)/tensor_iterate/tensor_iterator_free \ + $(SRC_DIR)/tensor_iterate/tensor_iterator_new \ + $(SRC_DIR)/tensor_iterate/tensor_iterate \ + $(SRC_DIR)/tensor_iterate/tensor_iterate_current \ + $(SRC_DIR)/tensor_iterate/tensor_iterate_indexes_next \ + $(SRC_DIR)/tensor_iterate/tensor_iterate_next \ +\ + $(SRC_DIR)/autodiff_primitives/add \ + $(SRC_DIR)/autodiff_primitives/copy \ + $(SRC_DIR)/autodiff_primitives/exp \ + $(SRC_DIR)/autodiff_primitives/linalg_inv \ + $(SRC_DIR)/autodiff_primitives/matmul \ + $(SRC_DIR)/autodiff_primitives/log \ + $(SRC_DIR)/autodiff_primitives/mean_all \ + $(SRC_DIR)/autodiff_primitives/multiply \ + $(SRC_DIR)/autodiff_primitives/prod_all \ + $(SRC_DIR)/autodiff_primitives/reciprocal \ + $(SRC_DIR)/autodiff_primitives/relu \ + $(SRC_DIR)/autodiff_primitives/sigmoid \ + $(SRC_DIR)/autodiff_primitives/sin \ + $(SRC_DIR)/autodiff_primitives/square \ + $(SRC_DIR)/autodiff_primitives/subtract \ + $(SRC_DIR)/autodiff_primitives/sum_all \ + $(SRC_DIR)/autodiff_primitives/tanh \ +\ + $(SRC_DIR)/autodiff/compute_backward \ + $(SRC_DIR)/autodiff/compute_forward \ + $(SRC_DIR)/autodiff/add \ + $(SRC_DIR)/autodiff/clamp \ + $(SRC_DIR)/autodiff/constant_scalar \ + $(SRC_DIR)/autodiff/copy \ + $(SRC_DIR)/autodiff/exp \ + $(SRC_DIR)/autodiff/free \ + $(SRC_DIR)/autodiff/init \ + $(SRC_DIR)/autodiff/matmul \ + $(SRC_DIR)/autodiff/log \ + $(SRC_DIR)/autodiff/map \ + $(SRC_DIR)/autodiff/mean_all \ + $(SRC_DIR)/autodiff/multiply \ + $(SRC_DIR)/autodiff/new \ + $(SRC_DIR)/autodiff/operate \ + $(SRC_DIR)/autodiff/parameter \ + $(SRC_DIR)/autodiff/print \ + $(SRC_DIR)/autodiff/prod_all \ + $(SRC_DIR)/autodiff/random_normal \ + $(SRC_DIR)/autodiff/random_normal_parameter \ + $(SRC_DIR)/autodiff/random_uniform \ + $(SRC_DIR)/autodiff/random_uniform_parameter \ + $(SRC_DIR)/autodiff/reciprocal \ + $(SRC_DIR)/autodiff/relu \ + $(SRC_DIR)/autodiff/sigmoid \ + $(SRC_DIR)/autodiff/sin \ + $(SRC_DIR)/autodiff/square \ + $(SRC_DIR)/autodiff/subtract \ + $(SRC_DIR)/autodiff/sum_all \ + $(SRC_DIR)/autodiff/tanh \ + $(SRC_DIR)/autodiff/tensor_self_derivative \ + $(SRC_DIR)/autodiff/tensor_self_derivative_with_operation \ +\ + $(SRC_DIR)/benchmark \ + $(SRC_DIR)/load_data + +ifeq ($(TENSOR_BACKEND), $(TENSOR_BACKEND_CLAPACK)) + SOURCES += \ + $(SRC_DIR)/clapack/ddot \ + $(SRC_DIR)/clapack/dgemm \ + $(SRC_DIR)/clapack/dgemv \ + $(SRC_DIR)/clapack/dger \ + $(SRC_DIR)/clapack/dgesv \ + $(SRC_DIR)/clapack/dgetf2 \ + $(SRC_DIR)/clapack/dgetrf \ + $(SRC_DIR)/clapack/dgetri \ + $(SRC_DIR)/clapack/dgetrs \ + $(SRC_DIR)/clapack/dlamch \ + $(SRC_DIR)/clapack/dlaswp\ + $(SRC_DIR)/clapack/dscal \ + $(SRC_DIR)/clapack/dswap \ + $(SRC_DIR)/clapack/dtrmm \ + $(SRC_DIR)/clapack/dtrmv \ + $(SRC_DIR)/clapack/dtrsm \ + $(SRC_DIR)/clapack/dtrti2 \ + $(SRC_DIR)/clapack/dtrtri \ + $(SRC_DIR)/clapack/idamax \ + $(SRC_DIR)/clapack/ieeeck \ + $(SRC_DIR)/clapack/ilaenv \ + $(SRC_DIR)/clapack/iparmq \ + $(SRC_DIR)/clapack/lsame \ + $(SRC_DIR)/clapack/lsamen \ + $(SRC_DIR)/clapack/maxloc \ + $(SRC_DIR)/clapack/xerbla \ + $(SRC_DIR)/clapack/xerbla_array \ +\ + $(SRC_DIR)/clapack/f2c/abort_ \ + $(SRC_DIR)/clapack/f2c/backspac \ + $(SRC_DIR)/clapack/f2c/c_abs \ + $(SRC_DIR)/clapack/f2c/c_cos \ + $(SRC_DIR)/clapack/f2c/c_div \ + $(SRC_DIR)/clapack/f2c/c_exp \ + $(SRC_DIR)/clapack/f2c/c_log \ + $(SRC_DIR)/clapack/f2c/c_sin \ + $(SRC_DIR)/clapack/f2c/c_sqrt \ + $(SRC_DIR)/clapack/f2c/cabs \ + $(SRC_DIR)/clapack/f2c/close \ + $(SRC_DIR)/clapack/f2c/ctype \ + $(SRC_DIR)/clapack/f2c/d_abs \ + $(SRC_DIR)/clapack/f2c/d_acos \ + $(SRC_DIR)/clapack/f2c/d_asin \ + $(SRC_DIR)/clapack/f2c/d_atan \ + $(SRC_DIR)/clapack/f2c/d_atn2 \ + $(SRC_DIR)/clapack/f2c/d_cnjg \ + $(SRC_DIR)/clapack/f2c/d_cos \ + $(SRC_DIR)/clapack/f2c/d_cosh \ + $(SRC_DIR)/clapack/f2c/d_dim \ + $(SRC_DIR)/clapack/f2c/d_exp \ + $(SRC_DIR)/clapack/f2c/d_imag \ + $(SRC_DIR)/clapack/f2c/d_int \ + $(SRC_DIR)/clapack/f2c/d_lg10 \ + $(SRC_DIR)/clapack/f2c/d_log \ + $(SRC_DIR)/clapack/f2c/d_mod \ + $(SRC_DIR)/clapack/f2c/d_nint \ + $(SRC_DIR)/clapack/f2c/d_prod \ + $(SRC_DIR)/clapack/f2c/d_sign \ + $(SRC_DIR)/clapack/f2c/d_sin \ + $(SRC_DIR)/clapack/f2c/d_sinh \ + $(SRC_DIR)/clapack/f2c/d_sqrt \ + $(SRC_DIR)/clapack/f2c/d_tan \ + $(SRC_DIR)/clapack/f2c/d_tanh \ + $(SRC_DIR)/clapack/f2c/derf_ \ + $(SRC_DIR)/clapack/f2c/derfc_ \ + $(SRC_DIR)/clapack/f2c/dfe \ + $(SRC_DIR)/clapack/f2c/dolio \ + $(SRC_DIR)/clapack/f2c/dtime_ \ + $(SRC_DIR)/clapack/f2c/due \ + $(SRC_DIR)/clapack/f2c/ef1asc_ \ + $(SRC_DIR)/clapack/f2c/ef1cmc_ \ + $(SRC_DIR)/clapack/f2c/endfile \ + $(SRC_DIR)/clapack/f2c/erf_ \ + $(SRC_DIR)/clapack/f2c/erfc_ \ + $(SRC_DIR)/clapack/f2c/err \ + $(SRC_DIR)/clapack/f2c/etime_ \ + $(SRC_DIR)/clapack/f2c/exit_ \ + $(SRC_DIR)/clapack/f2c/f77_aloc \ + $(SRC_DIR)/clapack/f2c/f77vers \ + $(SRC_DIR)/clapack/f2c/fmt \ + $(SRC_DIR)/clapack/f2c/fmtlib \ + $(SRC_DIR)/clapack/f2c/ftell_ \ + $(SRC_DIR)/clapack/f2c/getarg_ \ + $(SRC_DIR)/clapack/f2c/getenv_ \ + $(SRC_DIR)/clapack/f2c/h_abs \ + $(SRC_DIR)/clapack/f2c/h_dim \ + $(SRC_DIR)/clapack/f2c/h_dnnt \ + $(SRC_DIR)/clapack/f2c/h_indx \ + $(SRC_DIR)/clapack/f2c/h_len \ + $(SRC_DIR)/clapack/f2c/h_mod \ + $(SRC_DIR)/clapack/f2c/h_nint \ + $(SRC_DIR)/clapack/f2c/h_sign \ + $(SRC_DIR)/clapack/f2c/hl_ge \ + $(SRC_DIR)/clapack/f2c/hl_gt \ + $(SRC_DIR)/clapack/f2c/hl_le \ + $(SRC_DIR)/clapack/f2c/hl_lt \ + $(SRC_DIR)/clapack/f2c/i77vers \ + $(SRC_DIR)/clapack/f2c/i_abs \ + $(SRC_DIR)/clapack/f2c/i_ceiling \ + $(SRC_DIR)/clapack/f2c/i_dim \ + $(SRC_DIR)/clapack/f2c/i_dnnt \ + $(SRC_DIR)/clapack/f2c/i_indx \ + $(SRC_DIR)/clapack/f2c/i_len \ + $(SRC_DIR)/clapack/f2c/i_len_trim \ + $(SRC_DIR)/clapack/f2c/i_mod \ + $(SRC_DIR)/clapack/f2c/i_nint \ + $(SRC_DIR)/clapack/f2c/i_sign \ + $(SRC_DIR)/clapack/f2c/iargc_ \ + $(SRC_DIR)/clapack/f2c/iio \ + $(SRC_DIR)/clapack/f2c/ilnw \ + $(SRC_DIR)/clapack/f2c/inquire \ + $(SRC_DIR)/clapack/f2c/l_ge \ + $(SRC_DIR)/clapack/f2c/l_gt \ + $(SRC_DIR)/clapack/f2c/l_le \ + $(SRC_DIR)/clapack/f2c/l_lt \ + $(SRC_DIR)/clapack/f2c/lbitbits \ + $(SRC_DIR)/clapack/f2c/lbitshft \ + $(SRC_DIR)/clapack/f2c/lread \ + $(SRC_DIR)/clapack/f2c/lwrite \ + $(SRC_DIR)/clapack/f2c/main \ + $(SRC_DIR)/clapack/f2c/open \ + $(SRC_DIR)/clapack/f2c/pow_ci \ + $(SRC_DIR)/clapack/f2c/pow_dd \ + $(SRC_DIR)/clapack/f2c/pow_di \ + $(SRC_DIR)/clapack/f2c/pow_hh \ + $(SRC_DIR)/clapack/f2c/pow_ii \ + $(SRC_DIR)/clapack/f2c/pow_ri \ + $(SRC_DIR)/clapack/f2c/pow_zi \ + $(SRC_DIR)/clapack/f2c/pow_zz \ + $(SRC_DIR)/clapack/f2c/r_abs \ + $(SRC_DIR)/clapack/f2c/r_acos \ + $(SRC_DIR)/clapack/f2c/r_asin \ + $(SRC_DIR)/clapack/f2c/r_atan \ + $(SRC_DIR)/clapack/f2c/r_atn2 \ + $(SRC_DIR)/clapack/f2c/r_cnjg \ + $(SRC_DIR)/clapack/f2c/r_cos \ + $(SRC_DIR)/clapack/f2c/r_cosh \ + $(SRC_DIR)/clapack/f2c/r_dim \ + $(SRC_DIR)/clapack/f2c/r_exp \ + $(SRC_DIR)/clapack/f2c/r_imag \ + $(SRC_DIR)/clapack/f2c/r_int \ + $(SRC_DIR)/clapack/f2c/r_lg10 \ + $(SRC_DIR)/clapack/f2c/r_log \ + $(SRC_DIR)/clapack/f2c/r_mod \ + $(SRC_DIR)/clapack/f2c/r_nint \ + $(SRC_DIR)/clapack/f2c/r_sign \ + $(SRC_DIR)/clapack/f2c/r_sin \ + $(SRC_DIR)/clapack/f2c/r_sinh \ + $(SRC_DIR)/clapack/f2c/r_sqrt \ + $(SRC_DIR)/clapack/f2c/r_tan \ + $(SRC_DIR)/clapack/f2c/r_tanh \ + $(SRC_DIR)/clapack/f2c/rdfmt \ + $(SRC_DIR)/clapack/f2c/rewind \ + $(SRC_DIR)/clapack/f2c/rsfe \ + $(SRC_DIR)/clapack/f2c/rsli \ + $(SRC_DIR)/clapack/f2c/rsne \ + $(SRC_DIR)/clapack/f2c/s_cat \ + $(SRC_DIR)/clapack/f2c/s_cmp \ + $(SRC_DIR)/clapack/f2c/s_copy \ + $(SRC_DIR)/clapack/f2c/s_paus \ + $(SRC_DIR)/clapack/f2c/s_rnge \ + $(SRC_DIR)/clapack/f2c/s_stop \ + $(SRC_DIR)/clapack/f2c/sfe \ + $(SRC_DIR)/clapack/f2c/sig_die \ + $(SRC_DIR)/clapack/f2c/signal_ \ + $(SRC_DIR)/clapack/f2c/sue \ + $(SRC_DIR)/clapack/f2c/system_ \ + $(SRC_DIR)/clapack/f2c/typesize \ + $(SRC_DIR)/clapack/f2c/uio \ + $(SRC_DIR)/clapack/f2c/uninit \ + $(SRC_DIR)/clapack/f2c/util \ + $(SRC_DIR)/clapack/f2c/wref \ + $(SRC_DIR)/clapack/f2c/wrtfmt \ + $(SRC_DIR)/clapack/f2c/wsfe \ + $(SRC_DIR)/clapack/f2c/wsle \ + $(SRC_DIR)/clapack/f2c/wsne \ + $(SRC_DIR)/clapack/f2c/xwsne \ + $(SRC_DIR)/clapack/f2c/z_abs \ + $(SRC_DIR)/clapack/f2c/z_cos \ + $(SRC_DIR)/clapack/f2c/z_div \ + $(SRC_DIR)/clapack/f2c/z_exp \ + $(SRC_DIR)/clapack/f2c/z_log \ + $(SRC_DIR)/clapack/f2c/z_sin \ + $(SRC_DIR)/clapack/f2c/z_sqrt +endif diff --git a/configs/default.conf b/configs/default.conf new file mode 100644 index 0000000..ec9618e --- /dev/null +++ b/configs/default.conf @@ -0,0 +1,42 @@ +ifeq ($(CONFIGURATION), default) +CC=gcc +CXX=g++ +LD=ld + +# macOS default configuration +ifeq ($(PLATFORM), darwin) +MAP=-map $(BUILD_DIR)/$(ENTRYPOINT).map + +ifeq ($(TENSOR_BACKEND), $(TENSOR_BACKEND_GSL)) +INCLUDE_FLAGS+= -I/opt/homebrew/include/ +LDFLAGS+=-L/opt/homebrew/lib -L/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/usr/lib -lgsl -lgslcblas -macos_version_min 22.4 -lSystem +CFLAGS=-DDARWIN -D'TENSOR_BACKEND=$(TENSOR_BACKEND)' + +else ifeq ($(TENSOR_BACKEND), $(TENSOR_BACKEND_BLAS)) + +INCLUDE_FLAGS+=-I/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/System/Library/Frameworks/Accelerate.framework/Versions/A/Frameworks/vecLib.framework/Headers/ +LDFLAGS+=-L/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/usr/lib -macos_version_min 22.4 -lSystem +FRAMEWORK_FLAGS=-F/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/System/Library/Frameworks/ -framework accelerate +CFLAGS=-DDARWIN -D'TENSOR_BACKEND=$(TENSOR_BACKEND)' + +else ifeq ($(TENSOR_BACKEND), $(TENSOR_BACKEND_CLAPACK)) +LDFLAGS+=-L/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/usr/lib -macos_version_min 22.4 -lSystem +CFLAGS=-DDARWIN -D'TENSOR_BACKEND=$(TENSOR_BACKEND)' +endif + +# linux default configuration +else +LD=gcc +ifeq ($(TENSOR_BACKEND), $(TENSOR_BACKEND_GSL)) +FRAMEWORK_FLAGS= +CFLAGS=-DLINUX -D'TENSOR_BACKEND=$(TENSOR_BACKEND)' +LDFLAGS+=-lm -lcblas -llapack + +else ifeq ($(TENSOR_BACKEND), $(TENSOR_BACKEND_CLAPACK)) +INCLUDE_FLAGS+=-I$(INCLUDE_DIR) +FRAMEWORK_FLAGS= +CFLAGS=-DLINUX -D'TENSOR_BACKEND=$(TENSOR_BACKEND)' +LDFLAGS+=-lgsl -lm +endif +endif +endif diff --git a/docs/config b/docs/config new file mode 100644 index 0000000..5d96622 --- /dev/null +++ b/docs/config @@ -0,0 +1,2660 @@ +# Doxyfile 1.9.3 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the configuration +# file that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "Pascal" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = docs/ + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by doxygen. +# The default value is: NO. + +JAVADOC_BANNER = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# By default Python docstrings are displayed as preformatted text and doxygen's +# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the +# doxygen's special commands can be used and the contents of the docstring +# documentation blocks is shown as doxygen documentation. +# The default value is: YES. + +PYTHON_DOCSTRING = YES + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:^^" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". Note that you cannot put \n's in the value part of an alias +# to insert newlines (in the resulting output). You can put ^^ in the value part +# of an alias to insert a newline as if a physical newline was in the original +# file. When you need a literal { or } or , in the value part of an alias you +# have to escape them by means of a backslash (\), this can lead to conflicts +# with the commands \{ and \} for these it is advised to use the version @{ and +# @} or use a double escape (\\{ and \\}) + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, +# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, +# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser +# tries to guess whether the code is fixed or free formatted code, this is the +# default for Fortran type files). For instance to make doxygen treat .inc files +# as Fortran files (default is PHP), and .f files as C (default is Fortran), +# use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. When specifying no_extension you should add +# * to the FILE_PATTERNS. +# +# Note see also the list of default file extension mappings. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See https://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 5. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 5 + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use +# during processing. When set to 0 doxygen will based this on the number of +# cores available in the system. You can set it explicitly to a value larger +# than 0 to get more control over the balance between CPU load and processing +# speed. At this moment only the input processing can be done using multiple +# threads. Since this is still an experimental feature the default is set to 1, +# which effectively disables parallel processing. Please report any issues you +# encounter. Generating dot graphs in parallel is controlled by the +# DOT_NUM_THREADS setting. +# Minimum value: 0, maximum value: 32, default value: 1. + +NUM_PROC_THREADS = 1 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If this flag is set to YES, the name of an unnamed parameter in a declaration +# will be determined by the corresponding definition. By default unnamed +# parameters remain unnamed in the output. +# The default value is: YES. + +RESOLVE_UNNAMED_PARAMS = YES + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# declarations. If set to NO, these declarations will be included in the +# documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# With the correct setting of option CASE_SENSE_NAMES doxygen will better be +# able to match the capabilities of the underlying filesystem. In case the +# filesystem is case sensitive (i.e. it supports files in the same directory +# whose names only differ in casing), the option must be set to YES to properly +# deal with such files in case they appear in the input. For filesystems that +# are not case sensitive the option should be be set to NO to properly deal with +# output files written for symbols that only differ in casing, such as for two +# classes, one named CLASS and the other named Class, and to also support +# references to files without having to specify the exact matching casing. On +# Windows (including Cygwin) and MacOS, users should typically set this option +# to NO, whereas on Linux or other Unix flavors it should typically be set to +# YES. +# The default value is: system dependent. + +CASE_SENSE_NAMES = NO + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class +# will show which file needs to be included to use the class. +# The default value is: YES. + +SHOW_HEADERFILE = YES + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \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. See also section "Changing the +# layout of pages" for information. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as documenting some parameters in +# a documented function twice, or documenting parameters that don't exist or +# using markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete +# function parameter documentation. If set to NO, doxygen will accept that some +# parameters have no documentation without warning. +# The default value is: YES. + +WARN_IF_INCOMPLETE_DOC = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong parameter +# documentation, but not about the absence of documentation. If EXTRACT_ALL is +# set to YES then this flag will automatically be disabled. See also +# WARN_IF_INCOMPLETE_DOC +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS +# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but +# at the end of the doxygen process doxygen will return with a non-zero status. +# Possible values are: NO, YES and FAIL_ON_WARNINGS. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). In case the file specified cannot be opened for writing the +# warning and error messages are written to standard error. When as file - is +# specified the warning and error messages are written to standard output +# (stdout). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = src/ +INPUT += include/ +INPUT += README.md + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: +# https://www.gnu.org/software/libiconv/) for the list of possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# Note the list of default checked file patterns might differ from the list of +# default file extension mappings. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, +# *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C +# comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, +# *.vhdl, *.ucf, *.qsf and *.ice. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.idl \ + *.ddl \ + *.odl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.l \ + *.cs \ + *.d \ + *.php \ + *.php4 \ + *.php5 \ + *.phtml \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.pyw \ + *.f90 \ + *.f95 \ + *.f03 \ + *.f08 \ + *.f18 \ + *.f \ + *.for \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf \ + *.ice + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# ANamespace::AClass, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = 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 = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# entity all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see https://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = docs/doxygen-awesome-css/doxygen-awesome.css + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a color-wheel, see +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use gray-scales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via JavaScript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have JavaScript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: +# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To +# create a documentation set, doxygen will generate a Makefile in the HTML +# output directory. Running make will produce the docset in that directory and +# running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.html for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag determines the URL of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDURL = + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# on Windows. In the beginning of 2021 Microsoft took the original page, with +# a.o. the download links, offline the HTML help workshop was already many years +# in maintenance mode). You can download the HTML help workshop from the web +# archives at Installation executable (see: +# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo +# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the main .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location (absolute path +# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to +# run qhelpgenerator on the generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine tune the look of the index (see "Fine-tuning the output"). As an +# example, the default style sheet generated by doxygen has an example that +# shows how to put an image at the root of the tree instead of the PROJECT_NAME. +# Since the tree basically has the same information as the tab index, you could +# consider setting DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = YES + +# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the +# FULL_SIDEBAR option determines if the side bar is limited to only the treeview +# area (value NO) or if it should extend to the full height of the window (value +# YES). Setting this to YES gives a layout similar to +# https://docs.readthedocs.io with more room for contents, but less room for the +# project logo, title, and description. If either GENERATE_TREEVIEW or +# DISABLE_INDEX is set to NO, this option has no effect. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FULL_SIDEBAR = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email +# addresses. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +OBFUSCATE_EMAILS = YES + +# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg +# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see +# https://inkscape.org) to generate formulas as SVG images instead of PNGs for +# the HTML output. These images will generally look nicer at scaled resolutions. +# Possible values are: png (the default) and svg (looks nicer but requires the +# pdf2svg or inkscape tool). +# The default value is: png. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FORMULA_FORMAT = png + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANSPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. + +FORMULA_MACROFILE = + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://www.mathjax.org) which uses client side JavaScript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# With MATHJAX_VERSION it is possible to specify the MathJax version to be used. +# Note that the different versions of MathJax have different requirements with +# regards to the different settings, so it is possible that also other MathJax +# settings have to be changed when switching between the different MathJax +# versions. +# Possible values are: MathJax_2 and MathJax_3. +# The default value is: MathJax_2. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_VERSION = MathJax_2 + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. For more details about the output format see MathJax +# version 2 (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3 +# (see: +# http://docs.mathjax.org/en/latest/web/components/output.html). +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility. This is the name for Mathjax version 2, for MathJax version 3 +# this will be translated into chtml), NativeMML (i.e. MathML. Only supported +# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This +# is the name for Mathjax version 3, for MathJax version 2 this will be +# translated into HTML-CSS) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from https://www.mathjax.org before deployment. The default value is: +# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 +# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# for MathJax version 2 (see +# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions): +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# For example for MathJax version 3 (see +# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html): +# MATHJAX_EXTENSIONS = ams +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /