diff --git a/CMakeLists.txt b/CMakeLists.txt index 675f9d8e..d79ffee1 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -278,6 +278,12 @@ target_link_libraries(grpc_network_impl_test PUBLIC ${Protobuf_LIBRARY} ) +add_subdirectory(faiss) +add_executable(faisslib_test + src/faiss_tests.cc +) +target_link_libraries(faisslib_test PUBLIC faiss) + # eraft-ctl add_executable(eraftkv-ctl src/eraftkv_ctl.cc diff --git a/Dockerfile b/Dockerfile index 706cf657..6598f6a7 100644 --- a/Dockerfile +++ b/Dockerfile @@ -56,3 +56,7 @@ FROM eraft/eraftkv:v0.0.4 # RUN ldconfig RUN apt-get install -y redis-tools telnet + +# install faiss + +RUN apt-get install libatlas-base-dev libatlas3-base -y && apt-get install swig -y diff --git a/doc/eraft-vdb.md b/doc/eraft-vdb.md index 96f4c0d5..caf180f9 100644 --- a/doc/eraft-vdb.md +++ b/doc/eraft-vdb.md @@ -18,10 +18,10 @@ Vec stores a single vector, include vector id, vector data and additional commen - vid: A unique identifier of your vector. -- vdata: +- vdata (vextra): Vectorized representation of information in the physical world such as sound, video, and pictures. -- vextra: +- vlabel: The description information of the vector datam which is a json structure. ### Storage Cluster diff --git a/doc/vdb-server.md b/doc/vdb-server.md index e69de29b..d4206a72 100644 --- a/doc/vdb-server.md +++ b/doc/vdb-server.md @@ -0,0 +1,53 @@ +## vdb-server RESP protocol for vector design + +### 1.Create a Vecset + +- Syntax +``` +VECSET ADD vecset_name vecset_size +``` +- Return +vecset id + +### 2.Get a Vecset + +- Syntax +``` +VECSET GET vecset_name +``` +- Return + +Bulk string reply: + +``` +vecset_size +vec_count +vecdata_disk_size +vecdata_mem_size +c_time +``` + +### 3.Add Vecs to Vecset + +- Syntax +``` +VEC ADD vecset_name vector_data vector_label [vector_data vector_label ...] +``` + +- Return +The status of the add operation. + +### 4.Search from a vecset + +-Syntax +``` +VEC SEARCH vecset_name vector_data DESC count +``` +- Return + +search result vector data similar with +vector_data. + +``` +vec_id score vec_label [vec_id score vec_label ...] +``` diff --git a/doc/vector-similarity-search-in-eraftvdb.md b/doc/vector-similarity-search-in-eraftvdb.md new file mode 100644 index 00000000..f61424cc --- /dev/null +++ b/doc/vector-similarity-search-in-eraftvdb.md @@ -0,0 +1,5 @@ + +https://colab.research.google.com/drive/1OLdDYk-TzVNhpyL3pAONtkHnKGI-GUsU?usp=sharing#scrollTo=420dPmKH8sTi + +https://medium.com/swlh/fine-grained-image-similarity-detection-using-facebook-ai-similarity-search-faiss-b357da4f1644 + diff --git a/faiss/.circleci/Dockerfile.cpu b/faiss/.circleci/Dockerfile.cpu new file mode 100644 index 00000000..a39edad1 --- /dev/null +++ b/faiss/.circleci/Dockerfile.cpu @@ -0,0 +1,11 @@ +FROM cimg/base:stable-20.04 + +# Install python3, swig, and MKL. +RUN sudo apt-get update && \ +sudo apt-get install -y python3-dev python3-pip swig libmkl-dev + +# Install recent CMake. +RUN wget -nv -O - https://github.com/Kitware/CMake/releases/download/v3.17.1/cmake-3.17.1-Linux-x86_64.tar.gz | sudo tar xzf - --strip-components=1 -C /usr + +# Install numpy/scipy/pytorch for python tests. +RUN pip3 install numpy scipy torch diff --git a/faiss/.circleci/Dockerfile.faiss_gpu b/faiss/.circleci/Dockerfile.faiss_gpu new file mode 100644 index 00000000..a82960ff --- /dev/null +++ b/faiss/.circleci/Dockerfile.faiss_gpu @@ -0,0 +1,28 @@ +FROM nvidia/cuda:10.2-devel-ubuntu18.04 + +# Install python3, wget, and openblas. +RUN apt-get update && \ + apt-get install -y python3-dev python3-pip libopenblas-dev wget libpcre3-dev + +# Install swig 4.0.2. +RUN wget -nv -O - https://sourceforge.net/projects/swig/files/swig/swig-4.0.2/swig-4.0.2.tar.gz/download | tar zxf - && cd swig-4.0.2 && ./configure && make -j && make install + +# Install recent CMake. +RUN wget -nv -O - https://github.com/Kitware/CMake/releases/download/v3.17.1/cmake-3.17.1-Linux-x86_64.tar.gz | tar xzf - --strip-components=1 -C /usr + +# Install numpy/scipy/pytorch for python tests. +RUN pip3 install numpy scipy torch + +COPY . /faiss + +WORKDIR /faiss + +RUN cmake -B build \ + -DFAISS_ENABLE_GPU=ON \ + -DFAISS_ENABLE_C_API=ON \ + -DFAISS_ENABLE_PYTHON=ON \ + -DBUILD_TESTING=ON \ + -DCMAKE_CUDA_FLAGS="-gencode arch=compute_75,code=sm_75" \ + . + +RUN make -C build -j8 diff --git a/faiss/.circleci/config.yml b/faiss/.circleci/config.yml new file mode 100644 index 00000000..9421be4b --- /dev/null +++ b/faiss/.circleci/config.yml @@ -0,0 +1,438 @@ +version: 2.1 + +orbs: + win: circleci/windows@2.4.0 + +jobs: + format: + docker: + - image: ubuntu:20.04 + steps: + - checkout + - run: + name: Install clang-format + command: | + apt-get update + apt-get install -y git-core clang-format-11 + - run: + name: Verify clang-format + command: | + git ls-files | grep -E '\.(cpp|h|cu|cuh)$' | xargs clang-format-11 -i + if git diff --quiet; then + echo "Formatting OK!" + else + echo "Formatting not OK!" + echo "------------------" + git --no-pager diff --color + exit 1 + fi + + build_linux: + parameters: + opt_level: + type: string + default: generic + resource_class: + type: string + default: medium + docker: + - image: beauby/faiss-circleci:cpu + resource_class: << parameters.resource_class >> + environment: + OMP_NUM_THREADS: 10 + MKL_THREADING_LAYER: GNU + steps: + - checkout + - run: + name: Build faiss library + command: | + cmake -B build -DBUILD_TESTING=ON -DFAISS_ENABLE_GPU=OFF \ + -DFAISS_OPT_LEVEL=<< parameters.opt_level >> \ + -DFAISS_ENABLE_C_API=ON \ + -DCMAKE_BUILD_TYPE=Release -DBLA_VENDOR=Intel10_64_dyn . + make -k -C build -j3 faiss + - when: + condition: + equal: [ "avx2", << parameters.opt_level >> ] + steps: + - run: + name: Build faiss_avx2 library + command: make -k -C build -j3 faiss_avx2 swigfaiss_avx2 + - run: + name: Test faiss library + command: | + make -C build -j3 faiss_test + export GTEST_OUTPUT="xml:$(realpath .)/test-results/googletest/" + make -C build test + - run: + name: Build python extension + command: | + make -C build -j3 swigfaiss + cd build/faiss/python + python3 setup.py build + - run: + name: Test python extension + command: | + pip3 install pytest + export PYTHONPATH="$(ls -d ./build/faiss/python/build/lib*/)" + pytest --junitxml=test-results/pytest/results.xml tests/test_*.py + pytest --junitxml=test-results/pytest/results-torch.xml tests/torch_*.py + - store_test_results: + path: test-results + - run: + name: Build C API + command: | + make -k -C build -j faiss_c + + build_linux_conda: + docker: + - image: continuumio/miniconda3 + steps: + - checkout + - run: + name: Conda build + command: | + conda install -y -q conda-build + cd conda + conda build faiss --python 3.7 -c pytorch + + build_osx: + macos: + xcode: 12.4.0 + environment: + OMP_NUM_THREADS: 10 + steps: + - checkout + - run: + name: Install Homebrew packages + command: | + brew install cmake swig libomp + - run: + name: Install numpy/scipy + command: | + pip3 install numpy scipy + - run: + name: Generate Makefiles + command: | + cmake -B build -DBUILD_TESTING=ON -DFAISS_ENABLE_GPU=OFF \ + -DCMAKE_BUILD_TYPE=Release -DFAISS_ENABLE_C_API=ON \ + -DPython_EXECUTABLE=/usr/local/bin/python3 . + - run: + name: Build faiss library + command: | + make -k -C build -j faiss + - run: + name: Test faiss library + command: | + make -C build -j faiss_test + export GTEST_OUTPUT="xml:$PWD/test-results/googletest/" + make -C build test + - run: + name: Build python extension + command: | + make -C build -j swigfaiss + cd build/faiss/python + python3 setup.py build + - run: + name: Test python extension + command: | + pip3 install pytest torch + export PYTHONPATH="$(ls -d ./build/faiss/python/build/lib*/)" + pytest --junitxml=test-results/pytest/results.xml tests/test_*.py + pytest --junitxml=test-results/pytest/results-torch.xml tests/torch_*.py + - store_test_results: + path: test-results + - run: + name: Build C API + command: | + make -k -C build -j faiss_c + + build_windows: + executor: + name: win/default + shell: bash.exe + steps: + - checkout + - run: + name: Build/test + command: | + conda install conda-build + cd conda + conda build faiss --python 3.7 -c pytorch + + build_arm: + machine: + image: ubuntu-2004:202101-01 + resource_class: arm.medium + parameters: + opt_level: + type: string + default: generic + environment: + OMP_NUM_THREADS: 10 + CONDA_HOME: /home/circleci/miniconda3 + PYTHON: /home/circleci/miniconda3/bin/python + steps: + - checkout + - run: + name: Install dependencies + command: | + sudo apt-get update && sudo apt-get install -y swig + wget https://repo.anaconda.com/miniconda/Miniconda3-py39_4.9.2-Linux-aarch64.sh + bash Miniconda3-py39_4.9.2-Linux-aarch64.sh -b -p $CONDA_HOME + pip3 install cmake + $CONDA_HOME/bin/conda install -y numpy scipy + $CONDA_HOME/bin/conda install -y pytorch cpuonly -c pytorch + $CONDA_HOME/bin/pip install pytest + - run: + name: Build faiss library + command: | + cmake -B build -DBUILD_TESTING=ON -DFAISS_ENABLE_GPU=OFF \ + -DFAISS_OPT_LEVEL=<< parameters.opt_level >> \ + -DFAISS_ENABLE_C_API=ON \ + -DCMAKE_BUILD_TYPE=Release \ + -DPython_EXECUTABLE=$PYTHON . + make -k -C build -j3 faiss + - run: + name: Test faiss library + command: | + make -C build -j3 faiss_test + export GTEST_OUTPUT="xml:$(realpath .)/test-results/googletest/" + make -C build test + - run: + name: Build python extension + command: | + make -C build -j3 swigfaiss + cd build/faiss/python + $PYTHON setup.py build + - run: + name: Test python extension + command: | + export PYTHONPATH="$(ls -d ./build/faiss/python/build/lib*/)" + $PYTHON -c "import faiss; assert 'NEON' in faiss.get_compile_options()" + $PYTHON -m pytest --junitxml=test-results/pytest/results.xml tests/test_*.py + $PYTHON -m pytest --junitxml=test-results/pytest/results-torch.xml tests/torch_*.py + - store_test_results: + path: test-results + - run: + name: Build C API + command: | + make -k -C build -j faiss_c + + build_linux_gpu: + machine: + resource_class: gpu.nvidia.medium + image: ubuntu-2004-cuda-11.4:202110-01 + docker_layer_caching: true + steps: + - checkout + - run: + name: Build/test + command: | + docker build -t faiss -f .circleci/Dockerfile.faiss_gpu . + docker run --gpus all faiss make -C build test + docker run --gpus all faiss sh -c '(pwd; find)' + docker run --gpus all faiss sh -c '(cd build/faiss/python; python3 setup.py install) && cp tests/common_faiss_tests.py faiss/gpu/test && python3 -m unittest discover -s faiss/gpu/test -p "test_*"' + docker run --gpus all faiss sh -c '(cd build/faiss/python; python3 setup.py install) && cp tests/common_faiss_tests.py faiss/gpu/test && python3 -m unittest discover -s faiss/gpu/test -p "torch_*.py"' + no_output_timeout: 60m + + deploy_linux: + parameters: + label: + type: string + default: main + docker: + - image: continuumio/miniconda3 + steps: + - checkout + - run: + name: Install conda-build/anaconda-client + command: | + conda install -y -q conda-build anaconda-client + conda config --set anaconda_upload yes + - run: + name: Build packages + environment: + PACKAGE_TYPE: <> + command: | + cd conda + conda build faiss --user pytorch --label <> + + deploy_linux_gpu: + parameters: + label: + type: string + default: main + cuda: + type: string + cuda_archs: + type: string + compiler_version: + type: string + machine: + resource_class: gpu.nvidia.medium + image: ubuntu-2004-cuda-11.4:202110-01 + docker_layer_caching: true + steps: + - checkout + - run: + name: Build packages + command: | + docker build -t faiss -f conda/Dockerfile.cuda<> . + docker run --gpus all \ + -e PACKAGE_TYPE="<>" \ + -e CUDA_ARCHS="<>" \ + -e ANACONDA_API_TOKEN=$ANACONDA_API_TOKEN \ + faiss \ + conda build faiss-gpu --variants '{ "cudatoolkit": "<>", "c_compiler_version": "<>", "cxx_compiler_version": "<>" }' \ + --user pytorch --label <> + no_output_timeout: 60m + + deploy_osx: + parameters: + label: + type: string + default: main + macos: + xcode: 12.4.0 + steps: + - checkout + - run: + name: Install conda + command: | + curl https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-x86_64.sh --output miniconda.sh + bash miniconda.sh -b -p $HOME/miniconda + $HOME/miniconda/bin/conda install -y -q conda-build anaconda-client + $HOME/miniconda/bin/conda config --set anaconda_upload yes + - run: + name: Install MacOSX10.9 SDK + command: | + curl -L -o - https://github.com/phracker/MacOSX-SDKs/releases/download/10.15/MacOSX10.9.sdk.tar.xz | sudo tar xJf - -C /opt + - run: + name: Build packages + environment: + PACKAGE_TYPE: <> + command: | + export PATH=~/miniconda/bin:$PATH + cd conda + conda build faiss --user pytorch --label <> + + deploy_windows: + parameters: + label: + type: string + default: main + executor: + name: win/default + shell: bash.exe + steps: + - checkout + - run: + name: Install conda-build/anaconda-client + command: | + conda install -y -q conda-build anaconda-client + conda config --set anaconda_upload yes + - run: + name: Build packages + environment: + PACKAGE_TYPE: <> + command: | + cd conda + conda build faiss --user pytorch --label <> + +workflows: + version: 2 + build: + jobs: + - format: + name: Format + - build_linux: + name: Linux + - build_linux: + name: Linux (AVX2) + opt_level: "avx2" + resource_class: "medium+" + - build_linux_conda: + name: Linux (conda) + - build_linux_gpu: + name: Linux GPU + requires: + - Linux + - build_osx: + name: OSX + - build_windows: + name: Windows + - build_arm: + name: ARM64 + - deploy_linux: + name: Linux packages + filters: + tags: + only: /^v.*/ + branches: + ignore: /.*/ + - deploy_linux_gpu: + name: Linux GPU packages (CUDA 10.2) + cuda: "10.2" + cuda_archs: "35;52;60;61;70;72;75" + compiler_version: "8.4" + filters: + tags: + only: /^v.*/ + branches: + ignore: /.*/ + - deploy_linux_gpu: + name: Linux GPU packages (CUDA 11.3) + cuda: "11.3" + cuda_archs: "60;61;70;72;75;80;86" + compiler_version: "9.3" + filters: + tags: + only: /^v.*/ + branches: + ignore: /.*/ + - deploy_windows: + name: Windows packages + filters: + tags: + only: /^v.*/ + branches: + ignore: /.*/ + - deploy_osx: + name: OSX packages + filters: + tags: + only: /^v.*/ + branches: + ignore: /.*/ + + nightly: + triggers: + - schedule: + cron: "0 0 * * *" + filters: + branches: + only: + - main + jobs: + - deploy_linux: + name: Linux nightlies + label: nightly + - deploy_linux_gpu: + name: Linux GPU nightlies (CUDA 10.2) + cuda: "10.2" + cuda_archs: "35;52;60;61;70;72;75" + compiler_version: "8.4" + label: nightly + - deploy_linux_gpu: + name: Linux GPU nightlies (CUDA 11.3) + cuda: "11.3" + cuda_archs: "60;61;70;72;75;80;86" + compiler_version: "9.3" + label: nightly + - deploy_windows: + name: Windows nightlies + label: nightly + - deploy_osx: + name: OSX nightlies + label: nightly diff --git a/faiss/.clang-format b/faiss/.clang-format new file mode 100644 index 00000000..1fe6508f --- /dev/null +++ b/faiss/.clang-format @@ -0,0 +1,88 @@ +--- +AccessModifierOffset: -1 +AlignAfterOpenBracket: AlwaysBreak +AlignConsecutiveAssignments: false +AlignConsecutiveDeclarations: false +AlignEscapedNewlinesLeft: true +AlignOperands: false +AlignTrailingComments: true +AllowAllParametersOfDeclarationOnNextLine: false +AllowShortBlocksOnASingleLine: false +AllowShortCaseLabelsOnASingleLine: false +AllowShortFunctionsOnASingleLine: Empty +AllowShortIfStatementsOnASingleLine: false +AllowShortLoopsOnASingleLine: false +AlwaysBreakAfterReturnType: None +AlwaysBreakBeforeMultilineStrings: true +AlwaysBreakTemplateDeclarations: true +BinPackArguments: false # at some point, set this to true +BinPackParameters: false # at some point, set this to true +BraceWrapping: + AfterClass: false + AfterControlStatement: false + AfterEnum: false + AfterFunction: false + AfterNamespace: false + AfterObjCDeclaration: false + AfterStruct: false + AfterUnion: false + BeforeCatch: false + BeforeElse: false + IndentBraces: false +BreakBeforeBinaryOperators: None +BreakBeforeBraces: Attach +BreakBeforeTernaryOperators: true +BreakConstructorInitializersBeforeComma: false +BreakAfterJavaFieldAnnotations: false +BreakStringLiterals: false +ColumnLimit: 80 +CommentPragmas: '^ IWYU pragma:' +CompactNamespaces: false +ConstructorInitializerAllOnOneLineOrOnePerLine: true +ConstructorInitializerIndentWidth: 8 +ContinuationIndentWidth: 8 +Cpp11BracedListStyle: true +DerivePointerAlignment: false +DisableFormat: false +ForEachMacros: [ FOR_EACH_RANGE, FOR_EACH, ] +IncludeCategories: + - Regex: '^<.*\.h(pp)?>' + Priority: 1 + - Regex: '^<.*' + Priority: 2 + - Regex: '.*' + Priority: 3 +IndentCaseLabels: true +IndentWidth: 4 +IndentWrappedFunctionNames: false +KeepEmptyLinesAtTheStartOfBlocks: false +MacroBlockBegin: '' +MacroBlockEnd: '' +MaxEmptyLinesToKeep: 1 +NamespaceIndentation: None +ObjCBlockIndentWidth: 4 +ObjCSpaceAfterProperty: false +ObjCSpaceBeforeProtocolList: false +PenaltyBreakBeforeFirstCallParameter: 1 +PenaltyBreakComment: 300 +PenaltyBreakFirstLessLess: 120 +PenaltyBreakString: 1000 +PenaltyExcessCharacter: 1000000 +PenaltyReturnTypeOnItsOwnLine: 2000000 +PointerAlignment: Left +ReflowComments: true +SortIncludes: true +SpaceAfterCStyleCast: false +SpaceBeforeAssignmentOperators: true +SpaceBeforeParens: ControlStatements +SpaceInEmptyParentheses: false +SpacesBeforeTrailingComments: 1 +SpacesInAngles: false +SpacesInContainerLiterals: true +SpacesInCStyleCastParentheses: false +SpacesInParentheses: false +SpacesInSquareBrackets: false +Standard: Cpp11 +TabWidth: 8 +UseTab: Never +... diff --git a/faiss/.dockerignore b/faiss/.dockerignore new file mode 100644 index 00000000..7763a51d --- /dev/null +++ b/faiss/.dockerignore @@ -0,0 +1 @@ +sift1M \ No newline at end of file diff --git a/faiss/.github/ISSUE_TEMPLATE.md b/faiss/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..132be64a --- /dev/null +++ b/faiss/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,33 @@ +# Summary + + + +# Platform + + + +OS: + +Faiss version: + +Installed from: + +Faiss compilation options: + +Running on: +- [ ] CPU +- [ ] GPU + +Interface: +- [ ] C++ +- [ ] Python + +# Reproduction instructions + + + + diff --git a/faiss/.github/workflows/publish-docs.yml b/faiss/.github/workflows/publish-docs.yml new file mode 100644 index 00000000..3578d010 --- /dev/null +++ b/faiss/.github/workflows/publish-docs.yml @@ -0,0 +1,44 @@ +name: publish-docs +on: + page_build: + branches: + - gh-pages + paths-ignore: + - 'docs/**' + workflow_run: + workflows: [update-doxygen] + types: + - completed +jobs: + build_and_publish: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: Set up Python + uses: actions/setup-python@v2 + with: + python-version: 3.8 + - name: Checkout gh-pages + run: | + git fetch origin gh-pages + git checkout gh-pages + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -r requirements.txt + - name: Generate html + run: | + make html + git rm -rf docs + mv _build/html docs + touch docs/.nojekyll + - name: Push changes + run: | + git config --global user.email "$GITHUB_ACTOR@users.noreply.github.com" + git config --global user.name "$GITHUB_ACTOR" + git add docs + if [ -n "$(git status --porcelain)" ] + then + git commit docs -m "Sphinx rebuild ($(git rev-parse --short gh-pages))." + git push origin gh-pages + fi diff --git a/faiss/.github/workflows/update-doxygen.yml b/faiss/.github/workflows/update-doxygen.yml new file mode 100644 index 00000000..17e543a2 --- /dev/null +++ b/faiss/.github/workflows/update-doxygen.yml @@ -0,0 +1,40 @@ +name: update-doxygen +on: + push: + branches: + - main + paths: + - 'faiss/**' +jobs: + doxygen: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: Set up Python + uses: actions/setup-python@v2 + with: + python-version: 3.8 + - name: Install dependencies + run: | + sudo apt-get install -y doxygen + python -m pip install --upgrade pip + pip install breathe + - name: Generate doxygen xml + run: doxygen + - name: Push changes + run: | + git config --global user.email "$GITHUB_ACTOR@users.noreply.github.com" + git config --global user.name "$GITHUB_ACTOR" + mkdir ./tmp + mv xml ./tmp/xml + git fetch origin gh-pages + git checkout gh-pages + git rm -rf xml cpp_api + mv ./tmp/xml ./xml + breathe-apidoc -o cpp_api xml + git add xml cpp_api + if [ -n "$(git status --porcelain)" ] + then + git commit -m "Update API docs ($(git rev-parse --short main))." + git push origin gh-pages + fi diff --git a/faiss/.gitignore b/faiss/.gitignore new file mode 100644 index 00000000..183e2066 --- /dev/null +++ b/faiss/.gitignore @@ -0,0 +1,19 @@ +*.swp +*.swo +*.o +*.a +*.dSYM +*.so +*.dylib +*.pyc +*~ +/config.* +/aclocal.m4 +/autom4te.cache/ +/makefile.inc +/bin/ +/c_api/bin/ +/c_api/gpu/bin/ +/tests/test +/tests/gtest/ +faiss/python/swigfaiss_avx2.swig diff --git a/faiss/CHANGELOG.md b/faiss/CHANGELOG.md new file mode 100644 index 00000000..4a697abc --- /dev/null +++ b/faiss/CHANGELOG.md @@ -0,0 +1,230 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project DOES NOT adhere to [Semantic Versioning](https://semver.org/spec/v2.0.0.html) +at the moment. + +We try to indicate most contributions here with the contributor names who are not part of +the Facebook Faiss team. Feel free to add entries here if you submit a PR. + +## [Unreleased] + +- Added sparse k-means routines and moved the generic kmeans to contrib +- Added FlatDistanceComputer for all FlatCodes indexes +- Support for fast accumulation of 4-bit LSQ and RQ +- Added product additive quantization + +## [1.7.2] - 2021-12-15 +### Added +- Support LSQ on GPU (by @KinglittleQ) +- Support for exact 1D kmeans (by @KinglittleQ) + +## [1.7.1] - 2021-05-27 +### Added +- Support for building C bindings through the `FAISS_ENABLE_C_API` CMake option. +- Serializing the indexes with the python pickle module +- Support for the NNDescent k-NN graph building method (by @KinglittleQ) +- Support for the NSG graph indexing method (by @KinglittleQ) +- Residual quantizers: support as codec and unoptimized search +- Support for 4-bit PQ implementation for ARM (by @vorj, @n-miyamoto-fixstars, @LWisteria, and @matsui528) +- Implementation of Local Search Quantization (by @KinglittleQ) + +### Changed +- The order of xb an xq was different between `faiss.knn` and `faiss.knn_gpu`. +Also the metric argument was called distance_type. +- The typed vectors (LongVector, LongLongVector, etc.) of the SWIG interface have +been deprecated. They have been replaced with Int32Vector, Int64Vector, etc. (by h-vetinari) + +### Fixed +- Fixed a bug causing kNN search functions for IndexBinaryHash and +IndexBinaryMultiHash to return results in a random order. +- Copy constructor of AlignedTable had a bug leading to crashes when cloning +IVFPQ indices. + +## [1.7.0] - 2021-01-27 + +## [1.6.5] - 2020-11-22 + +## [1.6.4] - 2020-10-12 +### Added +- Arbitrary dimensions per sub-quantizer now allowed for `GpuIndexIVFPQ`. +- Brute-force kNN on GPU (`bfKnn`) now accepts `int32` indices. +- Nightly conda builds now available (for CPU). +- Faiss is now supported on Windows. + +## [1.6.3] - 2020-03-24 +### Added +- Support alternative distances on GPU for GpuIndexFlat, including L1, Linf and +Lp metrics. +- Support METRIC_INNER_PRODUCT for GpuIndexIVFPQ. +- Support float16 coarse quantizer for GpuIndexIVFFlat and GpuIndexIVFPQ. GPU +Tensor Core operations (mixed-precision arithmetic) are enabled on supported +hardware when operating with float16 data. +- Support k-means clustering with encoded vectors. This makes it possible to +train on larger datasets without decompressing them in RAM, and is especially +useful for binary datasets (see https://github.com/facebookresearch/faiss/blob/main/tests/test_build_blocks.py#L92). +- Support weighted k-means. Weights can be associated to each training point +(see https://github.com/facebookresearch/faiss/blob/main/tests/test_build_blocks.py). +- Serialize callback in python, to write to pipes or sockets (see +https://github.com/facebookresearch/faiss/wiki/Index-IO,-cloning-and-hyper-parameter-tuning). +- Reconstruct arbitrary ids from IndexIVF + efficient remove of a small number +of ids. This avoids 2 inefficiencies: O(ntotal) removal of vectors and +IndexIDMap2 on top of indexIVF. Documentation here: +https://github.com/facebookresearch/faiss/wiki/Special-operations-on-indexes. +- Support inner product as a metric in IndexHNSW (see +https://github.com/facebookresearch/faiss/blob/main/tests/test_index.py#L490). +- Support PQ of sizes other than 8 bit in IndexIVFPQ. +- Demo on how to perform searches sequentially on an IVF index. This is useful +for an OnDisk index with a very large batch of queries. In that case, it is +worthwhile to scan the index sequentially (see +https://github.com/facebookresearch/faiss/blob/main/tests/test_ivflib.py#L62). +- Range search support for most binary indexes. +- Support for hashing-based binary indexes (see +https://github.com/facebookresearch/faiss/wiki/Binary-indexes). + +### Changed +- Replaced obj table in Clustering object: now it is a ClusteringIterationStats +structure that contains additional statistics. + +### Removed +- Removed support for useFloat16Accumulator for accumulators on GPU (all +accumulations are now done in float32, regardless of whether float16 or float32 +input data is used). + +### Fixed +- Some python3 fixes in benchmarks. +- Fixed GpuCloner (some fields were not copied, default to no precomputed tables +with IndexIVFPQ). +- Fixed support for new pytorch versions. +- Serialization bug with alternative distances. +- Removed test on multiple-of-4 dimensions when switching between blas and AVX +implementations. + +## [1.6.2] - 2020-03-10 + +## [1.6.1] - 2019-12-04 + +## [1.6.0] - 2019-09-24 +### Added +- Faiss as a codec: We introduce a new API within Faiss to encode fixed-size +vectors into fixed-size codes. The encoding is lossy and the tradeoff between +compression and reconstruction accuracy can be adjusted. +- ScalarQuantizer support for GPU, see gpu/GpuIndexIVFScalarQuantizer.h. This is +particularly useful as GPU memory is often less abundant than CPU. +- Added easy-to-use serialization functions for indexes to byte arrays in Python +(faiss.serialize_index, faiss.deserialize_index). +- The Python KMeans object can be used to use the GPU directly, just add +gpu=True to the constuctor see gpu/test/test_gpu_index.py test TestGPUKmeans. + +### Changed +- Change in the code layout: many C++ sources are now in subdirectories impl/ +and utils/. + +## [1.5.3] - 2019-06-24 +### Added +- Basic support for 6 new metrics in CPU IndexFlat and IndexHNSW (https://github.com/facebookresearch/faiss/issues/848). +- Support for IndexIDMap/IndexIDMap2 with binary indexes (https://github.com/facebookresearch/faiss/issues/780). + +### Changed +- Throw python exception for OOM (https://github.com/facebookresearch/faiss/issues/758). +- Make DistanceComputer available for all random access indexes. +- Gradually moving from long to uint64_t for portability. + +### Fixed +- Slow scanning of inverted lists (https://github.com/facebookresearch/faiss/issues/836). + +## [1.5.2] - 2019-05-28 +### Added +- Support for searching several inverted lists in parallel (parallel_mode != 0). +- Better support for PQ codes where nbit != 8 or 16. +- IVFSpectralHash implementation: spectral hash codes inside an IVF. +- 6-bit per component scalar quantizer (4 and 8 bit were already supported). +- Combinations of inverted lists: HStackInvertedLists and VStackInvertedLists. +- Configurable number of threads for OnDiskInvertedLists prefetching (including +0=no prefetch). +- More test and demo code compatible with Python 3 (print with parentheses). + +### Changed +- License was changed from BSD+Patents to MIT. +- Exceptions raised in sub-indexes of IndexShards and IndexReplicas are now +propagated. +- Refactored benchmark code: data loading is now in a single file. + +## [1.5.1] - 2019-04-05 +### Added +- MatrixStats object, which reports useful statistics about a dataset. +- Option to round coordinates during k-means optimization. +- An alternative option for search in HNSW. +- Support for range search in IVFScalarQuantizer. +- Support for direct uint_8 codec in ScalarQuantizer. +- Better support for PQ code assignment with external index. +- Support for IMI2x16 (4B virtual centroids). +- Support for k = 2048 search on GPU (instead of 1024). +- Support for renaming an ondisk invertedlists. +- Support for nterrupting computations with interrupt signal (ctrl-C) in python. +- Simplified build system (with --with-cuda/--with-cuda-arch options). + +### Changed +- Moved stats() and imbalance_factor() from IndexIVF to InvertedLists object. +- Renamed IndexProxy to IndexReplicas. +- Most CUDA mem alloc failures now throw exceptions instead of terminating on an +assertion. +- Updated example Dockerfile. +- Conda packages now depend on the cudatoolkit packages, which fixes some +interferences with pytorch. Consequentially, faiss-gpu should now be installed +by conda install -c pytorch faiss-gpu cudatoolkit=10.0. + +## [1.5.0] - 2018-12-19 +### Added +- New GpuIndexBinaryFlat index. +- New IndexBinaryHNSW index. + +## [1.4.0] - 2018-08-30 +### Added +- Automatic tracking of C++ references in Python. +- Support for non-intel platforms, some functions optimized for ARM. +- Support for overriding nprobe for concurrent searches. +- Support for floating-point quantizers in binary indices. + +### Fixed +- No more segfaults due to Python's GC. +- GpuIndexIVFFlat issues for float32 with 64 / 128 dims. +- Sharding of flat indexes on GPU with index_cpu_to_gpu_multiple. + +## [1.3.0] - 2018-07-10 +### Added +- Support for binary indexes (IndexBinaryFlat, IndexBinaryIVF). +- Support fp16 encoding in scalar quantizer. +- Support for deduplication in IndexIVFFlat. +- Support for index serialization. + +### Fixed +- MMAP bug for normal indices. +- Propagation of io_flags in read func. +- k-selection for CUDA 9. +- Race condition in OnDiskInvertedLists. + +## [1.2.1] - 2018-02-28 +### Added +- Support for on-disk storage of IndexIVF data. +- C bindings. +- Extended tutorial to GPU indices. + +[Unreleased]: https://github.com/facebookresearch/faiss/compare/v1.7.2...HEAD +[1.7.2]: https://github.com/facebookresearch/faiss/compare/v1.7.1...v1.7.2 +[1.7.1]: https://github.com/facebookresearch/faiss/compare/v1.7.0...v1.7.1 +[1.7.0]: https://github.com/facebookresearch/faiss/compare/v1.6.5...v1.7.0 +[1.6.5]: https://github.com/facebookresearch/faiss/compare/v1.6.4...v1.6.5 +[1.6.4]: https://github.com/facebookresearch/faiss/compare/v1.6.3...v1.6.4 +[1.6.3]: https://github.com/facebookresearch/faiss/compare/v1.6.2...v1.6.3 +[1.6.2]: https://github.com/facebookresearch/faiss/compare/v1.6.1...v1.6.2 +[1.6.1]: https://github.com/facebookresearch/faiss/compare/v1.6.0...v1.6.1 +[1.6.0]: https://github.com/facebookresearch/faiss/compare/v1.5.3...v1.6.0 +[1.5.3]: https://github.com/facebookresearch/faiss/compare/v1.5.2...v1.5.3 +[1.5.2]: https://github.com/facebookresearch/faiss/compare/v1.5.1...v1.5.2 +[1.5.1]: https://github.com/facebookresearch/faiss/compare/v1.5.0...v1.5.1 +[1.5.0]: https://github.com/facebookresearch/faiss/compare/v1.4.0...v1.5.0 +[1.4.0]: https://github.com/facebookresearch/faiss/compare/v1.3.0...v1.4.0 +[1.3.0]: https://github.com/facebookresearch/faiss/compare/v1.2.1...v1.3.0 +[1.2.1]: https://github.com/facebookresearch/faiss/releases/tag/v1.2.1 diff --git a/faiss/CMakeLists.txt b/faiss/CMakeLists.txt new file mode 100644 index 00000000..0db3bcfd --- /dev/null +++ b/faiss/CMakeLists.txt @@ -0,0 +1,56 @@ +# Copyright (c) Facebook, Inc. and its affiliates. +# All rights reserved. +# +# This source code is licensed under the BSD-style license found in the +# LICENSE file in the root directory of this source tree. + +cmake_minimum_required(VERSION 3.17 FATAL_ERROR) + +project(faiss + VERSION 1.7.2 + DESCRIPTION "A library for efficient similarity search and clustering of dense vectors." + HOMEPAGE_URL "https://github.com/facebookresearch/faiss" + LANGUAGES CXX) +include(GNUInstallDirs) + +set(CMAKE_CXX_STANDARD 11) + +list(APPEND CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/cmake") + +# Valid values are "generic", "avx2". +option(FAISS_OPT_LEVEL "" "generic") +option(FAISS_ENABLE_GPU "Enable support for GPU indexes." ON) +option(FAISS_ENABLE_PYTHON "Build Python extension." ON) +option(FAISS_ENABLE_C_API "Build C API." OFF) + +if(FAISS_ENABLE_GPU) + set(CMAKE_CUDA_HOST_COMPILER ${CMAKE_CXX_COMPILER}) + enable_language(CUDA) +endif() + +add_subdirectory(faiss) + +if(FAISS_ENABLE_GPU) + add_subdirectory(faiss/gpu) +endif() + +if(FAISS_ENABLE_PYTHON) + add_subdirectory(faiss/python) +endif() + +if(FAISS_ENABLE_C_API) + add_subdirectory(c_api) +endif() + +add_subdirectory(demos) +add_subdirectory(tutorial/cpp) + +# CTest must be included in the top level to enable `make test` target. +include(CTest) +if(BUILD_TESTING) + add_subdirectory(tests) + + if(FAISS_ENABLE_GPU) + add_subdirectory(faiss/gpu/test) + endif() +endif() diff --git a/faiss/CODE_OF_CONDUCT.md b/faiss/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..ac27d8a5 --- /dev/null +++ b/faiss/CODE_OF_CONDUCT.md @@ -0,0 +1,2 @@ +# Code of Conduct +Facebook has adopted a Code of Conduct that we expect project participants to adhere to. Please [read the full text](https://code.fb.com/codeofconduct) so that you can understand what actions will and will not be tolerated. \ No newline at end of file diff --git a/faiss/CONTRIBUTING.md b/faiss/CONTRIBUTING.md new file mode 100644 index 00000000..8577a55c --- /dev/null +++ b/faiss/CONTRIBUTING.md @@ -0,0 +1,52 @@ +# Contributing to Faiss + +We want to make contributing to this project as easy and transparent as +possible. + +## Our Development Process + +We mainly develop Faiss within Facebook. Sometimes, we will sync the +github version of Faiss with the internal state. + +## Pull Requests + +We welcome pull requests that add significant value to Faiss. If you plan to do +a major development and contribute it back to Faiss, please contact us first before +putting too much effort into it. + +1. Fork the repo and create your branch from `main`. +2. If you've added code that should be tested, add tests. +3. If you've changed APIs, update the documentation. +4. Ensure the test suite passes. +5. Make sure your code lints. +6. If you haven't already, complete the Contributor License Agreement ("CLA"). + +There is a Facebook internal test suite for Faiss, and we need to run +all changes to Faiss through it. + +## Contributor License Agreement ("CLA") + +In order to accept your pull request, we need you to submit a CLA. You only need +to do this once to work on any of Facebook's open source projects. + +Complete your CLA here: + +## Issues + +We use GitHub issues to track public bugs. Please ensure your description is +clear and has sufficient instructions to be able to reproduce the issue. + +Facebook has a [bounty program](https://www.facebook.com/whitehat/) for the safe +disclosure of security bugs. In those cases, please go through the process +outlined on that page and do not file a public issue. + +## Coding Style + +* 4 or 2 spaces for indentation in C++ (no tabs) +* 80 character line length (both for C++ and Python) +* C++ language level: C++11 + +## License + +By contributing to Faiss, you agree that your contributions will be licensed +under the LICENSE file in the root directory of this source tree. diff --git a/faiss/Dockerfile b/faiss/Dockerfile new file mode 100644 index 00000000..418fb292 --- /dev/null +++ b/faiss/Dockerfile @@ -0,0 +1,29 @@ +FROM nvidia/cuda:8.0-devel-centos7 + +# Install MKL +RUN yum-config-manager --add-repo https://yum.repos.intel.com/mkl/setup/intel-mkl.repo +RUN rpm --import https://yum.repos.intel.com/intel-gpg-keys/GPG-PUB-KEY-INTEL-SW-PRODUCTS-2019.PUB +RUN yum install -y intel-mkl-2019.3-062 +ENV LD_LIBRARY_PATH /opt/intel/mkl/lib/intel64:$LD_LIBRARY_PATH +ENV LIBRARY_PATH /opt/intel/mkl/lib/intel64:$LIBRARY_PATH +ENV LD_PRELOAD /usr/lib64/libgomp.so.1:/opt/intel/mkl/lib/intel64/libmkl_def.so:\ +/opt/intel/mkl/lib/intel64/libmkl_avx2.so:/opt/intel/mkl/lib/intel64/libmkl_core.so:\ +/opt/intel/mkl/lib/intel64/libmkl_intel_lp64.so:/opt/intel/mkl/lib/intel64/libmkl_gnu_thread.so + +# Install necessary build tools +RUN yum install -y gcc-c++ make swig3 + +# Install necesary headers/libs +RUN yum install -y python-devel numpy + +COPY . /opt/faiss + +WORKDIR /opt/faiss + +# --with-cuda=/usr/local/cuda-8.0 +RUN ./configure --prefix=/usr --libdir=/usr/lib64 --without-cuda +RUN make -j $(nproc) +RUN make -C python +RUN make test +RUN make install +RUN make -C demos demo_ivfpq_indexing && ./demos/demo_ivfpq_indexing diff --git a/faiss/Doxyfile b/faiss/Doxyfile new file mode 100644 index 00000000..25227b73 --- /dev/null +++ b/faiss/Doxyfile @@ -0,0 +1,2282 @@ + + +# Doxyfile 1.8.5 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "Faiss" + +# 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 an logo or icon that is included in +# the documentation. The maximum height of the logo should not exceed 55 pixels +# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo +# to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# 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, Brazilian, Catalan, Chinese, Chinese- +# Traditional, Croatian, Czech, Danish, Dutch, English, Esperanto, Farsi, +# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en, +# Korean, Korean-en, Latvian, Norwegian, Macedonian, Persian, Polish, +# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, +# Turkish, Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = YES + +# 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 QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a +# new page for each member. If set to NO, the documentation of a member will be +# part of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make +# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C +# (default is Fortran), use: inc=Fortran f=C. +# +# Note For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by 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: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = 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 = NO + +# This flag is only useful for Objective-C code. When set to YES local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO these classes will be included in the various overviews. This option has +# no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the 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 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. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the +# todo list. This list is created by putting \todo commands in the +# documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the +# test list. This list is created by putting \test commands in the +# documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES the list +# will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. Do not use file names with spaces, bibtex cannot handle them. See +# also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO doxygen will only warn about wrong or incomplete parameter +# documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. +# Note: If this tag is empty the current directory is searched. + +INPUT = ./faiss + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank the +# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, +# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, +# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, +# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, +# *.qsf, *.as and *.js. + +FILE_PATTERNS = *.h *.cuh + +# 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 = gpu/test + +# 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 = */impl/* + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER ) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = YES + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = NO + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES, then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = NO + +# 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 an additional user- +# defined cascading style sheet that is 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 therefor more robust against future updates. +# Doxygen will copy the style sheet file to the output directory. For an example +# see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the stylesheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to NO can help when comparing the output of multiple runs. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler ( hhc.exe). If non-empty +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated ( +# YES) or that it should be included in the master .chm file ( NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated ( +# YES) or a normal table of contents ( NO) in the .chm file. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = 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 stylesheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = 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 + +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using prerendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/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 +# , /