pax_global_header00006660000000000000000000000064150026131550014510gustar00rootroot0000000000000052 comment=ea1cdf0fb28f31ab36ea95d8d65abfcc184d1b8f faiss-1.11.0/000077500000000000000000000000001500261315500126755ustar00rootroot00000000000000faiss-1.11.0/.clang-format000066400000000000000000000051151500261315500152520ustar00rootroot00000000000000--- 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 ... faiss-1.11.0/.dockerignore000066400000000000000000000000061500261315500153450ustar00rootroot00000000000000sift1Mfaiss-1.11.0/.github/000077500000000000000000000000001500261315500142355ustar00rootroot00000000000000faiss-1.11.0/.github/ISSUE_TEMPLATE.md000066400000000000000000000015521500261315500167450ustar00rootroot00000000000000# Summary # Platform OS: Faiss version: Installed from: Faiss compilation options: Running on: - [ ] CPU - [ ] GPU Interface: - [ ] C++ - [ ] Python # Reproduction instructions faiss-1.11.0/.github/actions/000077500000000000000000000000001500261315500156755ustar00rootroot00000000000000faiss-1.11.0/.github/actions/build_cmake/000077500000000000000000000000001500261315500201345ustar00rootroot00000000000000faiss-1.11.0/.github/actions/build_cmake/action.yml000066400000000000000000000174611500261315500221450ustar00rootroot00000000000000name: Build cmake inputs: opt_level: description: 'Compile options / optimization level.' required: false default: generic gpu: description: 'Enable GPU support.' required: false default: OFF cuvs: description: 'Enable cuVS support.' required: false default: OFF rocm: description: 'Enable ROCm support.' required: false default: OFF runs: using: composite steps: - name: Setup miniconda uses: conda-incubator/setup-miniconda@v3 with: python-version: '3.11' miniforge-version: latest # ensures conda-forge channel is used. channels: conda-forge conda-remove-defaults: 'true' # Set to aarch64 if we're on arm64 because there's no miniforge ARM64 package, just aarch64. # They are the same thing, just named differently. architecture: ${{ runner.arch == 'ARM64' && 'aarch64' || runner.arch }} - name: Configure build environment shell: bash run: | # initialize Conda conda config --set solver libmamba # Ensure starting packages are from conda-forge. conda list --show-channel-urls conda update -y -q conda echo "$CONDA/bin" >> $GITHUB_PATH conda install -y -q python=3.11 cmake=3.30.4 make=4.2 swig=4.0 "numpy<2" scipy=1.14 pytest=7.4 gflags=2.2 # install base packages for ARM64 if [ "${{ runner.arch }}" = "ARM64" ]; then conda install -y -q -c conda-forge openblas=0.3.29 gxx_linux-aarch64=14.2 sysroot_linux-aarch64=2.17 fi # install base packages for X86_64 if [ "${{ runner.arch }}" = "X64" ]; then # TODO: merge this with ARM64 conda install -y -q -c conda-forge gxx_linux-64=14.2 sysroot_linux-64=2.17 conda install -y -q mkl=2022.2.1 mkl-devel=2022.2.1 fi # no CUDA needed for ROCm so skip this if [ "${{ inputs.rocm }}" = "ON" ]; then : # regular CUDA for GPU builds elif [ "${{ inputs.gpu }}" = "ON" ] && [ "${{ inputs.cuvs }}" = "OFF" ]; then conda install -y -q cuda-toolkit=12.4 -c "nvidia/label/cuda-12.4.0" # and CUDA from cuVS channel for cuVS builds elif [ "${{ inputs.cuvs }}" = "ON" ]; then conda install -y -q libcuvs=25.04 'cuda-version>=12.0,<=12.5' cuda-toolkit=12.4.1 gxx_linux-64=12.4 -c rapidsai -c rapidsai-nightly -c conda-forge fi # install test packages if [ "${{ inputs.rocm }}" = "ON" ]; then : # skip torch install via conda, we need to install via pip to get # ROCm-enabled version until it's supported in conda by PyTorch elif [ "${{ inputs.gpu }}" = "ON" ]; then conda install -y -q "pytorch<2.5" pytorch-cuda=12.4 -c pytorch -c "nvidia/label/cuda-12.4.0" else conda install -y -q "pytorch<2.5" -c pytorch fi - name: ROCm - Install dependencies if: inputs.rocm == 'ON' shell: bash run: | # Update repos and install kmod, wget, gpg sudo apt-get -qq update >/dev/null sudo apt-get -qq install -y kmod wget gpg >/dev/null # Get UBUNTU version name UBUNTU_VERSION_NAME=`cat /etc/os-release | grep UBUNTU_CODENAME | awk -F= '{print $2}'` # Set ROCm version ROCM_VERSION="6.2" # Download, prepare, and install the package signing key mkdir --parents --mode=0755 /etc/apt/keyrings wget https://repo.radeon.com/rocm/rocm.gpg.key -O - | gpg --dearmor | sudo tee /etc/apt/keyrings/rocm.gpg > /dev/null # Add rocm repository wget -qO - http://repo.radeon.com/rocm/rocm.gpg.key | sudo apt-key add - rocm_baseurl="http://repo.radeon.com/rocm/apt/${ROCM_VERSION}" echo "deb [arch=amd64] ${rocm_baseurl} ${UBUNTU_VERSION_NAME} main" | sudo tee /etc/apt/sources.list.d/rocm.list sudo apt-get -qq update --allow-insecure-repositories >/dev/null sudo apt-get -qq install -y --allow-unauthenticated \ "rocm-dev${ROCM_VERSION}" "rocm-utils${ROCM_VERSION}" \ "rocm-libs${ROCM_VERSION}" >/dev/null # Fake presence of MI200-class accelerators echo "gfx90a" | sudo tee /opt/rocm/bin/target.lst # Cleanup sudo apt-get -qq autoclean >/dev/null sudo apt-get -qq clean >/dev/null sudo rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/* - name: Symblink system dependencies if: inputs.rocm == 'ON' shell: bash run: | # symblink system libraries for HIP compiler sudo ln -s /lib/x86_64-linux-gnu/libc.so.6 /lib64/libc.so.6 sudo ln -s /lib/x86_64-linux-gnu/libc_nonshared.a /usr/lib64/libc_nonshared.a sudo ln -s /usr/lib/x86_64-linux-gnu/libpthread.so.0 /lib64/libpthread.so.0 sudo ln -s $HOME/miniconda3/x86_64-conda-linux-gnu/sysroot/usr/lib64/libpthread_nonshared.a /usr/lib64/libpthread_nonshared.a - name: Build all targets shell: bash run: | eval "$(conda shell.bash hook)" conda activate cmake -B build \ -DBUILD_TESTING=ON \ -DBUILD_SHARED_LIBS=ON \ -DFAISS_ENABLE_GPU=${{ inputs.gpu }} \ -DFAISS_ENABLE_CUVS=${{ inputs.cuvs }} \ -DFAISS_ENABLE_ROCM=${{ inputs.rocm }} \ -DFAISS_OPT_LEVEL=${{ inputs.opt_level }} \ -DFAISS_ENABLE_C_API=ON \ -DPYTHON_EXECUTABLE=$CONDA/bin/python \ -DCMAKE_BUILD_TYPE=Release \ -DBLA_VENDOR=${{ runner.arch == 'X64' && 'Intel10_64_dyn' || '' }} \ -DCMAKE_CUDA_FLAGS=${{ runner.arch == 'X64' && '"-gencode arch=compute_75,code=sm_75"' || '' }} \ . make -k -C build -j$(nproc) - name: C++ tests shell: bash run: | export GTEST_OUTPUT="xml:$(realpath .)/test-results/googletest/" make -C build test - name: C++ perf benchmarks shell: bash if: inputs.rocm == 'OFF' run: | find ./build/perf_tests/ -executable -type f -name "bench*" -exec '{}' -v \; - name: Install Python extension shell: bash working-directory: build/faiss/python run: | $CONDA/bin/python setup.py install - name: ROCm - install ROCm-enabled torch via pip if: inputs.rocm == 'ON' shell: bash run: | pip3 install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/rocm6.1 - name: Python tests (CPU only) if: inputs.gpu == 'OFF' shell: bash run: | pytest --junitxml=test-results/pytest/results.xml tests/test_*.py pytest --junitxml=test-results/pytest/results-torch.xml tests/torch_*.py - name: Python tests (CPU + GPU) if: inputs.gpu == 'ON' shell: bash run: | pytest --junitxml=test-results/pytest/results.xml tests/test_*.py pytest --junitxml=test-results/pytest/results-torch.xml tests/torch_*.py cp tests/common_faiss_tests.py faiss/gpu/test pytest --junitxml=test-results/pytest/results-gpu.xml faiss/gpu/test/test_*.py pytest --junitxml=test-results/pytest/results-gpu-torch.xml faiss/gpu/test/torch_*.py - name: Test avx2 loading if: inputs.opt_level == 'avx2' shell: bash run: | FAISS_DISABLE_CPU_FEATURES=AVX2 LD_DEBUG=libs $CONDA/bin/python -c "import faiss" 2>&1 | grep faiss.so LD_DEBUG=libs $CONDA/bin/python -c "import faiss" 2>&1 | grep faiss_avx2.so - name: Upload test results if: always() uses: actions/upload-artifact@v4 with: name: test-results-arch=${{ runner.arch }}-opt=${{ inputs.opt_level }}-gpu=${{ inputs.gpu }}-cuvs=${{ inputs.cuvs }}-rocm=${{ inputs.rocm }} path: test-results - name: Check installed packages channel shell: bash run: | # Shows that all installed packages are from conda-forge. conda list --show-channel-urls faiss-1.11.0/.github/actions/build_conda/000077500000000000000000000000001500261315500201405ustar00rootroot00000000000000faiss-1.11.0/.github/actions/build_conda/action.yml000066400000000000000000000105451500261315500221450ustar00rootroot00000000000000name: Conda build description: Builds Faiss inside a Conda environment and uploads to repository when label is provided. inputs: label: description: "The label to be used for uploads to Conda." default: "" required: false cuda: description: "CUDA toolkit version to use." default: "" required: false cuvs: description: "Enable cuVS support." default: "" required: false runs: using: composite steps: - name: Choose shell shell: bash id: choose_shell run: | # Use pwsh on Windows; bash everywhere else if [ "${{ runner.os }}" != "Windows" ]; then echo "shell=bash" >> "$GITHUB_OUTPUT" else echo "shell=pwsh" >> "$GITHUB_OUTPUT" fi - name: Setup miniconda uses: conda-incubator/setup-miniconda@v3 with: python-version: '3.11' miniforge-version: latest # ensures conda-forge channel is used. channels: conda-forge conda-remove-defaults: 'true' # Set to runner.arch=aarch64 if we're on arm64 because # there's no miniforge ARM64 package, just aarch64. # They are the same thing, just named differently. # However there is an ARM64 for macOS, so exclude that. architecture: ${{ (runner.arch == 'ARM64' && runner.os != 'macOS') && 'aarch64' || runner.arch }} - name: Install conda build tools shell: ${{ steps.choose_shell.outputs.shell }} run: | # Ensure starting packages are from conda-forge. conda list --show-channel-urls conda install -y -q "conda!=24.11.0" conda install -y -q "conda-build=25.3.1" "liblief=0.14.1" conda list --show-channel-urls - name: Enable anaconda uploads if: inputs.label != '' shell: ${{ steps.choose_shell.outputs.shell }} env: PACKAGE_TYPE: ${{ inputs.label }} run: | conda install -y -q anaconda-client conda config --set anaconda_upload yes - name: Conda build (CPU) if: inputs.label == '' && inputs.cuda == '' shell: ${{ steps.choose_shell.outputs.shell }} working-directory: conda run: | conda build faiss --python 3.11 -c pytorch - name: Conda build (CPU) w/ anaconda upload if: inputs.label != '' && inputs.cuda == '' shell: ${{ steps.choose_shell.outputs.shell }} working-directory: conda env: PACKAGE_TYPE: ${{ inputs.label }} run: | conda build faiss --user pytorch --label ${{ inputs.label }} -c pytorch - name: Conda build (GPU) if: inputs.label == '' && inputs.cuda != '' && inputs.cuvs == '' shell: ${{ steps.choose_shell.outputs.shell }} working-directory: conda run: | conda build faiss-gpu --variants '{ "cudatoolkit": "${{ inputs.cuda }}" }' \ -c pytorch -c nvidia/label/cuda-${{ inputs.cuda }} -c nvidia - name: Conda build (GPU) w/ anaconda upload if: inputs.label != '' && inputs.cuda != '' && inputs.cuvs == '' shell: ${{ steps.choose_shell.outputs.shell }} working-directory: conda env: PACKAGE_TYPE: ${{ inputs.label }} run: | conda build faiss-gpu --variants '{ "cudatoolkit": "${{ inputs.cuda }}" }' \ --user pytorch --label ${{ inputs.label }} -c pytorch -c nvidia/label/cuda-${{ inputs.cuda }} -c nvidia - name: Conda build (GPU w/ cuVS) if: inputs.label == '' && inputs.cuda != '' && inputs.cuvs != '' shell: ${{ steps.choose_shell.outputs.shell }} working-directory: conda run: | conda build faiss-gpu-cuvs --variants '{ "cudatoolkit": "${{ inputs.cuda }}" }' \ -c pytorch -c rapidsai -c rapidsai-nightly -c conda-forge -c nvidia - name: Conda build (GPU w/ cuVS) w/ anaconda upload if: inputs.label != '' && inputs.cuda != '' && inputs.cuvs != '' shell: ${{ steps.choose_shell.outputs.shell }} working-directory: conda env: PACKAGE_TYPE: ${{ inputs.label }} run: | conda build faiss-gpu-cuvs --variants '{ "cudatoolkit": "${{ inputs.cuda }}" }' \ --user pytorch --label ${{ inputs.label }} -c pytorch -c rapidsai -c rapidsai-nightly -c conda-forge -c nvidia - name: Check installed packages channel shell: ${{ steps.choose_shell.outputs.shell }} run: | # Shows that all installed packages are from conda-forge. conda list --show-channel-urls faiss-1.11.0/.github/workflows/000077500000000000000000000000001500261315500162725ustar00rootroot00000000000000faiss-1.11.0/.github/workflows/autoclose.yml000066400000000000000000000013361500261315500210160ustar00rootroot00000000000000name: Close Inactive Issues on: schedule: - cron: "30 1 * * *" jobs: close-issues: runs-on: ubuntu-latest permissions: issues: write pull-requests: write steps: - uses: actions/stale@v5 with: only-labels: autoclose days-before-issue-stale: 7 days-before-issue-close: 7 stale-issue-label: "stale" stale-issue-message: "This issue is stale because it has been open for 7 days with no activity." close-issue-message: "This issue was closed because it has been inactive for 7 days since being marked as stale." days-before-pr-stale: -1 days-before-pr-close: -1 repo-token: ${{ secrets.GITHUB_TOKEN }} faiss-1.11.0/.github/workflows/build-pull-request.yml000066400000000000000000000120101500261315500225460ustar00rootroot00000000000000on: workflow_call: env: OMP_NUM_THREADS: '10' MKL_THREADING_LAYER: GNU jobs: format: name: Format runs-on: ubuntu-latest steps: - name: Checkout uses: actions/checkout@v4 - name: Install clang-format run: | sudo apt-get update -y sudo apt-get install -y wget sudo apt install -y lsb-release wget software-properties-common gnupg wget https://apt.llvm.org/llvm.sh chmod u+x llvm.sh sudo ./llvm.sh 18 sudo apt-get install -y git-core clang-format-18 - name: Verify clang-format run: | git ls-files | grep -E '\.(cpp|h|cu|cuh)$' | xargs clang-format-18 -i if git diff --quiet; then echo "Formatting OK!" else echo "Formatting not OK!" echo "------------------" git --no-pager diff --color exit 1 fi linux-x86_64-cmake: name: Linux x86_64 (cmake) runs-on: ubuntu-latest steps: - name: Checkout uses: actions/checkout@v4 - name: Build and Test (cmake) uses: ./.github/actions/build_cmake linux-x86_64-AVX2-cmake: name: Linux x86_64 AVX2 (cmake) needs: linux-x86_64-cmake runs-on: ubuntu-latest steps: - name: Checkout uses: actions/checkout@v4 - name: Build and Test (cmake) uses: ./.github/actions/build_cmake with: opt_level: avx2 linux-x86_64-AVX512-cmake: name: Linux x86_64 AVX512 (cmake) needs: linux-x86_64-cmake runs-on: faiss-aws-m7i.large steps: - name: Checkout uses: actions/checkout@v4 - name: Build and Test (cmake) uses: ./.github/actions/build_cmake with: opt_level: avx512 linux-x86_64-AVX512_SPR-cmake: name: Linux x86_64 AVX512_SPR (cmake) needs: linux-x86_64-cmake runs-on: faiss-aws-m7i.large steps: - name: Checkout uses: actions/checkout@v4 - name: Build and Test (cmake) uses: ./.github/actions/build_cmake with: opt_level: avx512_spr linux-x86_64-GPU-cmake: name: Linux x86_64 GPU (cmake) needs: linux-x86_64-cmake runs-on: 4-core-ubuntu-gpu-t4 steps: - name: Checkout uses: actions/checkout@v4 - name: Build and Test (cmake) uses: ./.github/actions/build_cmake with: gpu: ON linux-x86_64-GPU-w-CUVS-cmake: name: Linux x86_64 GPU w/ cuVS (cmake) needs: linux-x86_64-cmake runs-on: 4-core-ubuntu-gpu-t4 steps: - name: Checkout uses: actions/checkout@v4 - name: Build and Test (cmake) uses: ./.github/actions/build_cmake with: gpu: ON cuvs: ON linux-x86_64-GPU-w-ROCm-cmake: name: Linux x86_64 GPU w/ ROCm (cmake) needs: linux-x86_64-cmake runs-on: faiss-amd-MI200 container: image: ubuntu:22.04 options: --device=/dev/kfd --device=/dev/dri --ipc=host --shm-size 16G --group-add video --cap-add=SYS_PTRACE --cap-add=SYS_ADMIN steps: - name: Container setup run: | if [ -f /.dockerenv ]; then apt-get update && apt-get install -y sudo && apt-get install -y git git config --global --add safe.directory '*' else echo 'Skipping. Current job is not running inside a container.' fi - name: Checkout uses: actions/checkout@v4 - name: Build and Test (cmake) uses: ./.github/actions/build_cmake with: gpu: ON rocm: ON linux-arm64-SVE-cmake: name: Linux arm64 SVE (cmake) needs: linux-x86_64-cmake runs-on: faiss-aws-r8g.large steps: - name: Checkout uses: actions/checkout@v4 - name: Build and Test (cmake) uses: ./.github/actions/build_cmake with: opt_level: sve env: # Context: https://github.com/facebookresearch/faiss/wiki/Troubleshooting#surprising-faiss-openmp-and-openblas-interaction OPENBLAS_NUM_THREADS: '1' linux-x86_64-conda: name: Linux x86_64 (conda) needs: linux-x86_64-cmake runs-on: ubuntu-latest steps: - name: Checkout uses: actions/checkout@v4 with: fetch-depth: 0 fetch-tags: true - name: Build and Package (conda) uses: ./.github/actions/build_conda windows-x86_64-conda: name: Windows x86_64 (conda) needs: linux-x86_64-cmake runs-on: windows-2019 steps: - name: Checkout uses: actions/checkout@v4 with: fetch-depth: 0 fetch-tags: true - name: Build and Package (conda) uses: ./.github/actions/build_conda linux-arm64-conda: name: Linux arm64 (conda) needs: linux-x86_64-cmake runs-on: 2-core-ubuntu-arm steps: - name: Checkout uses: actions/checkout@v4 with: fetch-depth: 0 fetch-tags: true - name: Build and Package (conda) uses: ./.github/actions/build_conda faiss-1.11.0/.github/workflows/build-release.yml000066400000000000000000000100151500261315500215270ustar00rootroot00000000000000on: workflow_call: secrets: ANACONDA_API_TOKEN: required: true env: OMP_NUM_THREADS: '10' MKL_THREADING_LAYER: GNU jobs: linux-x86_64-packages: name: Linux x86_64 packages runs-on: ubuntu-latest steps: - name: Checkout uses: actions/checkout@v4 with: fetch-depth: 0 fetch-tags: true - name: Build and Package (conda) uses: ./.github/actions/build_conda env: ANACONDA_API_TOKEN: ${{ secrets.ANACONDA_API_TOKEN }} with: label: main linux-x86_64-GPU-packages-CUDA-11-4-4: name: Linux x86_64 GPU packages (CUDA 11.4.4) runs-on: 4-core-ubuntu-gpu-t4 env: CUDA_ARCHS: "60-real;61-real;62-real;70-real;72-real;75-real;80;86-real" FAISS_FLATTEN_CONDA_INCLUDES: "1" steps: - name: Checkout uses: actions/checkout@v4 with: fetch-depth: 0 fetch-tags: true - name: Build and Package (conda) uses: ./.github/actions/build_conda env: ANACONDA_API_TOKEN: ${{ secrets.ANACONDA_API_TOKEN }} with: label: main cuda: "11.4.4" linux-x86_64-GPU-CUVS-packages-CUDA11-8-0: name: Linux x86_64 GPU w/ cuVS packages (CUDA 11.8.0) runs-on: 4-core-ubuntu-gpu-t4 env: CUDA_ARCHS: "70-real;72-real;75-real;80;86-real" steps: - name: Checkout uses: actions/checkout@v4 with: fetch-depth: 0 fetch-tags: true - name: Build and Package (conda) uses: ./.github/actions/build_conda env: ANACONDA_API_TOKEN: ${{ secrets.ANACONDA_API_TOKEN }} with: label: main cuvs: "ON" cuda: "11.8.0" linux-x86_64-GPU-packages-CUDA-12-1-1: name: Linux x86_64 GPU packages (CUDA 12.1.1) runs-on: 4-core-ubuntu-gpu-t4 env: CUDA_ARCHS: "70-real;72-real;75-real;80;86-real" steps: - name: Checkout uses: actions/checkout@v4 with: fetch-depth: 0 fetch-tags: true - name: Build and Package (conda) uses: ./.github/actions/build_conda env: ANACONDA_API_TOKEN: ${{ secrets.ANACONDA_API_TOKEN }} with: label: main cuda: "12.1.1" linux-x86_64-GPU-CUVS-packages-CUDA12-4-0: name: Linux x86_64 GPU w/ cuVS packages (CUDA 12.4.0) runs-on: 4-core-ubuntu-gpu-t4 env: CUDA_ARCHS: "70-real;72-real;75-real;80;86-real" steps: - name: Checkout uses: actions/checkout@v4 with: fetch-depth: 0 fetch-tags: true - name: Build and Package (conda) uses: ./.github/actions/build_conda env: ANACONDA_API_TOKEN: ${{ secrets.ANACONDA_API_TOKEN }} with: label: main cuvs: "ON" cuda: "12.4.0" windows-x86_64-packages: name: Windows x86_64 packages runs-on: windows-2019 steps: - name: Checkout uses: actions/checkout@v4 with: fetch-depth: 0 fetch-tags: true - name: Build and Package (conda) uses: ./.github/actions/build_conda env: ANACONDA_API_TOKEN: ${{ secrets.ANACONDA_API_TOKEN }} with: label: main osx-arm64-packages: name: OSX arm64 packages runs-on: macos-14 steps: - name: Checkout uses: actions/checkout@v4 with: fetch-depth: 0 fetch-tags: true - name: Build and Package (conda) uses: ./.github/actions/build_conda env: ANACONDA_API_TOKEN: ${{ secrets.ANACONDA_API_TOKEN }} with: label: main linux-arm64-packages: name: Linux arm64 packages runs-on: 2-core-ubuntu-arm steps: - name: Checkout uses: actions/checkout@v4 with: fetch-depth: 0 fetch-tags: true - name: Build and Package (conda) uses: ./.github/actions/build_conda env: ANACONDA_API_TOKEN: ${{ secrets.ANACONDA_API_TOKEN }} with: label: main faiss-1.11.0/.github/workflows/build.yml000066400000000000000000000006271500261315500201210ustar00rootroot00000000000000name: Build on: workflow_dispatch: pull_request: branches: - main push: tags: - 'v*' jobs: build-pull-request: uses: ./.github/workflows/build-pull-request.yml build-release: uses: ./.github/workflows/build-release.yml secrets: ANACONDA_API_TOKEN: ${{ secrets.ANACONDA_API_TOKEN }} if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v') faiss-1.11.0/.github/workflows/nightly.yml000066400000000000000000000101111500261315500204650ustar00rootroot00000000000000name: Nightly on: schedule: - cron: '10 6 * * *' env: OMP_NUM_THREADS: '10' MKL_THREADING_LAYER: GNU jobs: linux-x86_64-nightly: name: Linux x86_64 nightlies runs-on: 4-core-ubuntu steps: - name: Checkout uses: actions/checkout@v4 with: fetch-depth: 0 fetch-tags: true - uses: ./.github/actions/build_conda env: ANACONDA_API_TOKEN: ${{ secrets.ANACONDA_API_TOKEN }} with: label: nightly linux-x86_64-GPU-CUDA-11-4-4-nightly: name: Linux x86_64 GPU nightlies (CUDA 11.4.4) runs-on: 4-core-ubuntu-gpu-t4 env: CUDA_ARCHS: "60-real;61-real;62-real;70-real;72-real;75-real;80;86-real" FAISS_FLATTEN_CONDA_INCLUDES: "1" steps: - name: Checkout uses: actions/checkout@v4 with: fetch-depth: 0 fetch-tags: true - uses: ./.github/actions/build_conda env: ANACONDA_API_TOKEN: ${{ secrets.ANACONDA_API_TOKEN }} with: label: nightly cuda: "11.4.4" linux-x86_64-GPU-CUVS-CUDA11-8-0-nightly: name: Linux x86_64 GPU w/ cuVS nightlies (CUDA 11.8.0) runs-on: 4-core-ubuntu-gpu-t4 env: CUDA_ARCHS: "70-real;72-real;75-real;80;86-real" steps: - name: Checkout uses: actions/checkout@v4 with: fetch-depth: 0 fetch-tags: true - uses: ./.github/actions/build_conda env: ANACONDA_API_TOKEN: ${{ secrets.ANACONDA_API_TOKEN }} with: label: nightly cuvs: "ON" cuda: "11.8.0" linux-x86_64-GPU-CUDA-12-1-1-nightly: name: Linux x86_64 GPU nightlies (CUDA 12.1.1) runs-on: 4-core-ubuntu-gpu-t4 env: CUDA_ARCHS: "70-real;72-real;75-real;80;86-real" steps: - name: Checkout uses: actions/checkout@v4 with: fetch-depth: 0 fetch-tags: true - uses: ./.github/actions/build_conda env: ANACONDA_API_TOKEN: ${{ secrets.ANACONDA_API_TOKEN }} with: label: nightly cuda: "12.1.1" linux-x86_64-GPU-CUVS-CUDA12-4-0-nightly: name: Linux x86_64 GPU w/ cuVS nightlies (CUDA 12.4.0) runs-on: 4-core-ubuntu-gpu-t4 env: CUDA_ARCHS: "70-real;72-real;75-real;80;86-real" steps: - name: Checkout uses: actions/checkout@v4 with: fetch-depth: 0 fetch-tags: true - uses: ./.github/actions/build_conda env: ANACONDA_API_TOKEN: ${{ secrets.ANACONDA_API_TOKEN }} with: label: nightly cuvs: "ON" cuda: "12.4.0" windows-x86_64-nightly: name: Windows x86_64 nightlies runs-on: windows-2019 steps: - name: Checkout uses: actions/checkout@v4 with: fetch-depth: 0 fetch-tags: true - uses: ./.github/actions/build_conda env: ANACONDA_API_TOKEN: ${{ secrets.ANACONDA_API_TOKEN }} with: label: nightly osx-arm64-nightly: name: OSX arm64 nightlies runs-on: macos-14 steps: - name: Checkout uses: actions/checkout@v4 with: fetch-depth: 0 fetch-tags: true - uses: ./.github/actions/build_conda env: ANACONDA_API_TOKEN: ${{ secrets.ANACONDA_API_TOKEN }} with: label: nightly linux-arm64-nightly: name: Linux arm64 nightlies runs-on: 2-core-ubuntu-arm steps: - name: Checkout uses: actions/checkout@v4 with: fetch-depth: 0 fetch-tags: true - uses: ./.github/actions/build_conda env: ANACONDA_API_TOKEN: ${{ secrets.ANACONDA_API_TOKEN }} with: label: nightly auto-retry: name: Auto retry on failure if: fromJSON(github.run_attempt) < 2 runs-on: ubuntu-latest steps: - name: Start rerun workflow env: GH_REPO: ${{ github.repository }} GH_TOKEN: ${{ github.token }} GH_DEBUG: api run: | gh workflow run retry_build.yml \ -F run_id=${{ github.run_id }} faiss-1.11.0/.github/workflows/publish-docs.yml000066400000000000000000000022521500261315500214120ustar00rootroot00000000000000name: 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 faiss-1.11.0/.github/workflows/retry_build.yml000066400000000000000000000021151500261315500213400ustar00rootroot00000000000000name: Retry Build on: workflow_dispatch: inputs: run_id: required: true jobs: rerun-on-failure: permissions: write-all runs-on: ubuntu-latest steps: - name: rerun ${{ inputs.run_id }} env: GH_REPO: ${{ github.repository }} GH_TOKEN: ${{ github.token }} GH_DEBUG: api run: | # status can be one of "queued", "in_progress", "completed", "waiting", "requested", "pending" # https://docs.github.com/en/rest/checks/runs # while not completed, sleep for 10 minutes while gh run view ${{ inputs.run_id }} --json status | grep -v completed do echo Workflow in progress - sleeping for 10 minutes then checking again sleep 10m done # Only retry if there are failed jobs if gh run view ${{ inputs.run_id }} --exit-status; then echo Workflow succeeded - no retry necessary. else echo Workflow failed - initiating retry. gh run rerun ${{ inputs.run_id }} --failed fi faiss-1.11.0/.github/workflows/update-doxygen.yml000066400000000000000000000021541500261315500217540ustar00rootroot00000000000000name: 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 faiss-1.11.0/.gitignore000066400000000000000000000004651500261315500146720ustar00rootroot00000000000000*.swp *.swo *.o *.a *.dSYM *.so *.dylib *.pyc *~ /build/ /config.* /aclocal.m4 /autom4te.cache/ /makefile.inc /bin/ /c_api/bin/ /c_api/gpu/bin/ /tests/test /tests/gtest/ faiss/python/swigfaiss_avx2.swig faiss/python/swigfaiss_avx512.swig faiss/python/swigfaiss_avx512_spr.swig faiss/python/swigfaiss_sve.swig faiss-1.11.0/CHANGELOG.md000066400000000000000000000646461500261315500145260ustar00rootroot00000000000000# Changelog All notable changes to this project will be documented in this file. ## [Unreleased] ## [1.11.0] - 2025-04-24 Added - RaBitQ implementation (#4235) - Add RaBitQ to the swigfaiss so we can access its properties correctly in python (#4304) - Add date and time to the codec file path so that the file doesn't get overridden with each run (#4303) - Add missing header in faiss/CMakeLists.txt (#4285) - Implement is_spherical and normalize_L2 booleans as part of the training APIs (#4279) - Add normalize_l2 boolean to distributed training API - re-land mmap diff (#4250) - SearchParameters support for IndexBinaryFlat (#4055) - Support non-partition col and map in the embedding reader (#4229) - Support cosine distance for training vectors (#4227) - Add missing #include in code_distance-sve.h (#4219) - Add the support for IndexIDMap with Cagra index (#4188) - Add bounds checking to hnsw nb_neighbors (#4185) - Add sharding convenience function for IVF indexes (#4150) - Added support for building for MinGW, in addition to MSVC (#4145) Changed - Skip mmap test case in AIX. (#4275) - Handle insufficient driver gracefully (#4271) - relax input params for IndexIVFRaBitQ::get_InvertedListScanner() (#4270) - Allow using custom index readers and writers (#4180) - Upgrade to libcuvs=25.04 (#4164) - ignore regex (#4264) - Publish the C API to Conda (#4186) - Pass row filters to Hive Reader to filter rows (#4256) - Back out "test merge with internal repo" (#4244) - test merge with internal repo (#4242) - Revert D69972250: Memory-mapping and Zero-copy deserializers - Revert D69984379: mem mapping and zero-copy python fixes - mem mapping and zero-copy python fixes (#4212) - Memory-mapping and Zero-copy deserializers (#4199) - Use `nullptr` in faiss/gpu/StandardGpuResources.cpp (#4232) - Make static method in header inline (#4214) - Upgrade openblas to 0.3.29 for ARM architectures (#4203) - Pass `store_dataset` argument along to cuVS CAGRA (#4173) - Handle plain SearchParameters in HNSW searches (#4167) - Update INSTALL.md to remove some raft references, add missing dependency (#4176) - Update README.md (#4169) - Update CAGRA docs (#4152) - Expose IDSelectorBitmap in the C_API (#4158) Fixed - fix: algorithm of spreading vectors over shards (#4299) - Fix overflow of int32 in IndexNSG (#4297) - Fix Type Error in Conditional Logic (#4294) - faiss/gpu/GpuAutoTune.cpp: fix llvm-19-exposed -Wunused-but-set-variable warnings - Fix nightly by pinning conda-build to prevent regression in 25.3.2 (#4287) - Fix CQS signal. Id] 88153895 -- readability-redundant-string-init in fbcode/faiss (#4283) - Fix a placeholder for 'unimplemented' in mapped_io.cpp (#4268) - fix bug: IVFPQ of raft/cuvs does not require redundant check (#4241) - fix a serialization problem in RaBitQ (#4261) - Grammar fix in FlatIndexHNSW (#4253) - Fix CUDA kernel index data type in faiss/gpu/impl/DistanceUtils.cuh +10 (#4246) - fix `IVFPQFastScan::RangeSearch()` on the `ARM` architecture (#4247) - fix integer overflow issue when calculating imbalance_factor (#4245) - Fix bug with metric_arg in IndexHNSW (#4239) - Address compile errors and warnings (#4238) - faiss: fix non-templated hammings function (#4195) - Fix LLVM-19 compilation issue in faiss/AutoTune.cpp (#4220) - Fix cloning and reverse index factory for NSG indices (#4151) - Remove python_abi to fix nightly (#4217) - Fix IVF quantizer centroid sharding so IDs are generated (#4197) - Pin lief to fix nightly (#4211) - Fix Sapphire Rapids never loading in Python bindings (#4209) - Attempt to nightly fix (#4204) - Fix nightly by installing earlier version of lief (#4198) - Check for not completed - Fix install error when building avx512_spr variant (#4170) - fix: gpu tests link failure with static lib (#4137) - Fix the order of parameters in bench_scalar_quantizer_distance. (#4159) Deprecated - Remove unused exception parameter from faiss/impl/ResultHandler.h (#4243) - Remove unused variable (#4205) ## [1.10.0] - 2025-01-30 Added - Add desc_name to dataset descriptor (#3935) - implement ST_norm_from_LUT for the ResidualQuantizer (#3917) - Add example of how to build, link, and test an external SWIG module (#3922) - add copyright header (#3948) - Add some SVE implementations (#3933) - Enable linting: lint config changes plus arc lint command (#3966) - Re-add example of how to build, link, and test an external SWIG module (#3981) - demo: IndexPQ: separate codes from codebook (#3987) - add all wrapped indexes to the index_read (#3988) - add validity check AlignedTableTightAlloc clear method (#3997) - Add index binary to telemetry (#4001) - Add VectorTransform read from filename to the C API (#3970) - Added IndexLSH to the demo (#4009) - write distributed_kmeans centroids and assignments to hive tables (#4017) - introduce data splits in dataset descriptor (#4012) - Faiss GPU: bfloat16 brute-force kNN support (#4018) - ROCm support for bfloat16 (#4039) - Unit tests for distances_simd.cpp (#4058) - add cuda-toolkit for GPU (#4057) - Add more unit testing for IndexHNSW [1/n] (#4054) - Add more unit testing for IndexHNSW [2/n] (#4056) - Add more unit testing for HNSW [3/n] (#4059) - Add more unit testing for HNSW [4/n] (#4061) - Add more unit tests for index_read and index_write (#4068) - Add testing for utils/hamming.cpp (#4079) - Test sa_decode methd on IndexIVFFlat (#4098) - Conditionally compile extras like benchmarks and demos (#4094) - Add a new architecture mode: 'avx512_spr'. (#4025) - Use _mm512_popcnt_epi64 to speedup hamming distance evaluation. (#4020) - PQ with pytorch (#4116) - add range_search() to IndexRefine (#4022) - Expose accumulate_to_mem from faiss interface (#4099) - Windows Arm64 support (#4087) - add test to cover GPU (#4130) - Added support for building without MKL (#4147) Changed - Move train, build and search to their respective operators (#3934) - PQFS into Index trainer (#3941) - Place a useful cmake function 'link_to_faiss_lib' into a separate file (#3939) - Cache device major version value to avoid multiple calls of getCudaDeviceProperties (#3950) - Consolidate set_target_properties() calls in faiss/CMakeLists.txt (#3973) - Removing Manual Hipify Build Step (#3962) - Allow to replace graph structure for NSG graphs (#3975) - Adjust nightly build (#3978) - Update RAFT CI with pytorch 2.4.1 (#3980) - Moved add_sa_codes, sa_code_size to Index, IndexBinary base classes (#3989) - Update autoclose.yml (#4000) - Migrate from RAFT to CUVS (#3549) - Pin to numpy<2 (#4033) - (1/n) - Preload datasets in manifold so that subsequent stages of training, indexing and search can use those instead of each trainer or indexer downloading data. (#4034) - Constrain conda version for Windows build (#4040) - Updates to faiss-gpu-cuvs nightly pkg (#4032) - pin the dependecies version for x86_64 (#4046) - pin arm64 dependency (#4060) - Pin conda build (#4062) - Improve naming due to codemod (#4063) - Improve naming due to codemod (#4064) - Improve naming due to codemod (#4065) - separare the github build into two conditions (#4066) - Improve naming due to codemod (#4070) - improve naming due to codemod (#4067) - improve naming due to codemod (#4071) - improve naming due to codemod (#4072) - fix nightily build (#4080) - Change github action workflows name (#4083) - Resolve Packaging Issues (#4044) - Update __init__.py (#4086) - Exhaustive IVF probing in scalar quantizer tests (#4075) - Pin Nightlies with testing on PR (#4088) - Update benchmarking library code to work for IdMap index as well (#4093) - Update action.yml (#4100) - Upgrade CUVS to 24.12 (#4021) - Link cuVS Docs (#4084) - Set KnnDescriptor.desc_name in the Benchmarking core framework in FAISS like other descriptors (#4109) - enable quiet mode for conda install (#4112) - Disable retry build (#4124) - Add ngpu default argument to knn_ground_truth (#4123) - Update code comment to reflect the range of IF from [1, k] (#4139) - Reenable auto retry workflow (#4140) - Migration off defaults to conda-forge channel (#4126) - Benchmarking Scripts for cuVS Index, more docs updates (#4117) Fixed - Fix total_rows (#3942) - Fix INSTALL.md due to failure of conflict resolving (#3915) - Back out "Add example of how to build, link, and test an external SWIG module" (#3954) - Fix shadowed variable in faiss/IndexPQ.cpp (#3959) - Fix shadowed variable in faiss/IndexIVFAdditiveQuantizer.cpp (#3958) - Fix shadowed variable in faiss/impl/HNSW.cpp (#3961) - Fix shadowed variable in faiss/impl/simd_result_handlers.h (#3960) - Fix shadowed variable in faiss/utils/NeuralNet.cpp (#3952) - Resolve "incorrect-portions-license" errors: add no license lint to top of GPU files with both licenses (#3965) - Resolve "duplicate-license-header": Find and replace duplicate license headers (#3967) - fix some more nvidia licenses that get erased (#3977) - fix merge_flat_ondisk stress run failures (#3999) - Fix reverse_index_factory formatting of ScalarQuantizers (#4003) - Fix shadowed variable in faiss/IndexAdditiveQuantizer.cpp (#4011) - facebook-unused-include-check in fbcode/faiss (#4029) - fix linter (#4035) - Some chore fixes (#4010) - Fix unused variable compilation error (#4041) - stop dealloc of coarse quantizer when it is deleted (#4045) - Fix SCD Table test flakiness (#4069) - Fix IndexIVFFastScan reconstruct_from_offset method (#4095) - more fast-scan reconstruction (#4128) - Fix nightly cuVS 11.8.0 failure (#4149) - Correct capitalization of FAISS to Faiss (#4155) - Fix cuVS 12.4.0 nightly failure (#4153) Deprecated - Remove unused-variable in dumbo/backup/dumbo/service/tests/ChainReplicatorTests.cpp (#4024) - remove inconsistent oom exception test (#4052) - Remove unused(and wrong) io macro (#4122) ## [1.9.0] - 2024-10-04 ### Added - Add AVX-512 implementation for the distance and scalar quantizer functions. (#3853) - Allow k and M suffixes in IVF indexes (#3812) - add reconstruct support to additive quantizers (#3752) - introduce options for reducing the overhead for a clustering procedure (#3731) - Add hnsw search params for bounded queue option (#3748) - ROCm support (#3462) - Add sve targets (#2886) - add get_version() for c_api (#3688) - QINCo implementation in CPU Faiss (#3608) - Add search functionality to FlatCodes (#3611) - add dispatcher for VectorDistance and ResultHandlers (#3627) - Add SQ8bit signed quantization (#3501) - Add ABS_INNER_PRODUCT metric (#3524) - Interop between CAGRA and HNSW (#3252) - add skip_storage flag to HNSW (#3487) - QT_bf16 for scalar quantizer for bfloat16 (#3444) - Implement METRIC.NaNEuclidean (#3414) - TimeoutCallback C++ and Python (#3417) - support big-endian machines (#3361) - Support for Remove ids from IVFPQFastScan index (#3354) - Implement reconstruct_n for GPU IVFFlat indexes (#3338) - Support of skip_ids in merge_from_multiple function of OnDiskInvertedLists (#3327) - Add the ability to clone and read binary indexes to the C API. (#3318) - AVX512 for PQFastScan (#3276) ### Changed - faster hnsw CPU index training (#3822) - Some small improvements. (#3692) - First attempt at LSH matching with nbits (#3679) - Set verbosoe before train (#3619) - Remove duplicate NegativeDistanceComputer instances (#3450) - interrupt for NNDescent (#3432) - Get rid of redundant instructions in ScalarQuantizer (#3430) - PowerPC, improve code generation for function fvec_L2sqr (#3416) - Unroll loop in lookup_2_lanes (#3364) - Improve filtering & search parameters propagation (#3304) - Change index_cpu_to_gpu to throw for indices not implemented on GPU (#3336) - Throw when attempting to move IndexPQ to GPU (#3328) - Skip HNSWPQ sdc init with new io flag (#3250) ### Fixed - FIx a bug for a non-simdlib code of ResidualQuantizer (#3868) - assign_index should default to null (#3855) - Fix an incorrectly counted the number of computed distances for HNSW (#3840) - Add error for overflowing nbits during PQ construction (#3833) - Fix radius search with HSNW and IP (#3698) - fix algorithm of spreading vectors over shards (#3374) - Fix IndexBinary.assign Python method (#3384) - Few fixes in bench_fw to enable IndexFromCodec (#3383) - Fix the endianness issue in AIX while running the benchmark. (#3345) - Fix faiss swig build with version > 4.2.x (#3315) - Fix problems when using 64-bit integers. (#3322) - Fix IVFPQFastScan decode function (#3312) - Handling FaissException in few destructors of ResultHandler.h (#3311) - Fix HNSW stats (#3309) - AIX compilation fix for io classes (#3275) ## [1.8.0] - 2024-02-27 ### Added - Added a new conda package faiss-gpu-raft alongside faiss-cpu and faiss-gpu - Integrated IVF-Flat and IVF-PQ implementations in faiss-gpu-raft from RAFT by Nvidia [thanks Corey Nolet and Tarang Jain] - Added a context parameter to InvertedLists and InvertedListsIterator - Added Faiss on Rocksdb demo to showing how inverted lists can be persisted in a key-value store - Introduced Offline IVF framework powered by Faiss big batch search - Added SIMD NEON Optimization for QT_FP16 in Scalar Quantizer. [thanks Naveen Tatikonda] - Generalized ResultHandler and supported range search for HNSW and FastScan - Introduced avx512 optimization mode and FAISS_OPT_LEVEL env variable [thanks Alexandr Ghuzva] - Added search parameters for IndexRefine::search() and IndexRefineFlat::search() - Supported large two-level clustering - Added support for Python 3.11 and 3.12 - Added support for CUDA 12 ### Changed - Used the benchmark to find Pareto optimal indices. Intentionally limited to IVF(Flat|HNSW),PQ|SQ indices - Splitted off RQ encoding steps to another file - Supported better NaN handling - HNSW speedup + Distance 4 points [thanks Alexandr Ghuzva] ### Fixed - Fixed DeviceVector reallocations in Faiss GPU - Used efSearch from params if provided in HNSW search - Fixed warp synchronous behavior in Faiss GPU CUDA 12 ## [1.7.4] - 2023-04-12 ### Added - Added big batch IVF search for conducting efficient search with big batches of queries - Checkpointing in big batch search support - Precomputed centroids support - Support for iterable inverted lists for eg. key value stores - 64-bit indexing arithmetic support in FAISS GPU - IndexIVFShards now handle IVF indexes with a common quantizer - Jaccard distance support - CodePacker for non-contiguous code layouts - Approximate evaluation of top-k distances for ResidualQuantizer and IndexBinaryFlat - Added support for 12-bit PQ / IVFPQ fine quantizer decoders for standalone vector codecs (faiss/cppcontrib) - Conda packages for osx-arm64 (Apple M1) and linux-aarch64 (ARM64) architectures - Support for Python 3.10 ### Removed - CUDA 10 is no longer supported in precompiled packages - Removed Python 3.7 support for precompiled packages - Removed constraint for using fine quantizer with no greater than 8 bits for IVFPQ, for example, now it is possible to use IVF256,PQ10x12 for a CPU index ### Changed - Various performance optimizations for PQ / IVFPQ for AVX2 and ARM for training (fused distance+nearest kernel), search (faster kernels for distance_to_code() and scan_list_*()) and vector encoding - A magnitude faster CPU code for LSQ/PLSQ training and vector encoding (reworked code) - Performance improvements for Hamming Code computations for AVX2 and ARM (reworked code) - Improved auto-vectorization support for IP and L2 distance computations (better handling of pragmas) - Improved ResidualQuantizer vector encoding (pooling memory allocations, avoid r/w to a temporary buffer) ### Fixed - HSNW bug fixed which improves the recall rate! Special thanks to zh Wang @hhy3 for this. - Faiss GPU IVF large query batch fix - Faiss + Torch fixes, re-enable k = 2048 - Fix the number of distance computations to match max_codes parameter - Fix decoding of large fast_scan blocks ## [1.7.3] - 2022-11-3 ### Added - 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 - Support per-query search parameters for many indexes + filtering by ids - write_VectorTransform and read_vectorTransform were added to the public API (by @AbdelrahmanElmeniawy) - Support for IDMap2 in index_factory by adding "IDMap2" to prefix or suffix of the input String (by @AbdelrahmanElmeniawy) - Support for merging all IndexFlatCodes descendants (by @AbdelrahmanElmeniawy) - Remove and merge features for IndexFastScan (by @AbdelrahmanElmeniawy) - Performance improvements: 1) specialized the AVX2 pieces of code speeding up certain hotspots, 2) specialized kernels for vector codecs (this can be found in faiss/cppcontrib) ### Fixed - Fixed memory leak in OnDiskInvertedLists::do_mmap when the file is not closed (by @AbdelrahmanElmeniawy) - LSH correctly throws error for metric types other than METRIC_L2 (by @AbdelrahmanElmeniawy) ## [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.11.0...HEAD [1.11.0]: https://github.com/facebookresearch/faiss/compare/v1.10.0...v1.11.0 [1.10.0]: https://github.com/facebookresearch/faiss/compare/v1.9.0...v1.10.0 [1.9.0]: https://github.com/facebookresearch/faiss/compare/v1.8.0...v1.9.0 [1.8.0]: https://github.com/facebookresearch/faiss/compare/v1.7.4...v1.8.0 [1.7.4]: https://github.com/facebookresearch/faiss/compare/v1.7.3...v1.7.4 [1.7.3]: https://github.com/facebookresearch/faiss/compare/v1.7.2...v1.7.3 [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 faiss-1.11.0/CMakeLists.txt000066400000000000000000000073031500261315500154400ustar00rootroot00000000000000# @lint-ignore-every LICENSELINT # 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. # ============================================================================= # Copyright (c) 2023-2024, NVIDIA CORPORATION. # # Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except # in compliance with the License. You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software distributed under the License # is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express # or implied. See the License for the specific language governing permissions and limitations under # the License. # ============================================================================= cmake_minimum_required(VERSION 3.24.0 FATAL_ERROR) set(FAISS_LANGUAGES CXX) if(FAISS_ENABLE_GPU) if (FAISS_ENABLE_ROCM) list(APPEND FAISS_LANGUAGES HIP) list(PREPEND CMAKE_MODULE_PATH "/opt/rocm/lib/cmake") list(PREPEND CMAKE_PREFIX_PATH "/opt/rocm") else() list(APPEND FAISS_LANGUAGES CUDA) endif() endif() if(FAISS_ENABLE_CUVS) include(cmake/thirdparty/fetch_rapids.cmake) include(rapids-cmake) include(rapids-cpm) include(rapids-cuda) include(rapids-export) include(rapids-find) rapids_cuda_init_architectures(faiss) rapids_cuda_init_architectures(pyfaiss) rapids_cuda_init_architectures(faiss_c_library) endif() project(faiss VERSION 1.11.0 DESCRIPTION "A library for efficient similarity search and clustering of dense vectors." HOMEPAGE_URL "https://github.com/facebookresearch/faiss" LANGUAGES ${FAISS_LANGUAGES}) include(GNUInstallDirs) set(CMAKE_CXX_STANDARD 17) list(APPEND CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/cmake") # Valid values are "generic", "avx2", "avx512", "avx512_spr", "sve". option(FAISS_OPT_LEVEL "" "generic") option(FAISS_ENABLE_GPU "Enable support for GPU indexes." ON) option(FAISS_ENABLE_CUVS "Enable cuVS for GPU indexes." OFF) option(FAISS_ENABLE_ROCM "Enable ROCm for GPU indexes." OFF) option(FAISS_ENABLE_MKL "Enable MKL." ON) option(FAISS_ENABLE_PYTHON "Build Python extension." ON) option(FAISS_ENABLE_C_API "Build C API." OFF) option(FAISS_ENABLE_EXTRAS "Build extras like benchmarks and demos" ON) option(FAISS_USE_LTO "Enable Link-Time optimization" OFF) if(FAISS_ENABLE_GPU) if(FAISS_ENABLE_ROCM) enable_language(HIP) add_definitions(-DUSE_AMD_ROCM) find_package(HIP REQUIRED) find_package(hipBLAS REQUIRED) set(GPU_EXT_PREFIX "hip") execute_process(COMMAND ${PROJECT_SOURCE_DIR}/faiss/gpu/hipify.sh) else () set(CMAKE_CUDA_HOST_COMPILER ${CMAKE_CXX_COMPILER}) enable_language(CUDA) set(GPU_EXT_PREFIX "cu") endif() endif() if(FAISS_ENABLE_CUVS AND NOT TARGET cuvs::cuvs) find_package(cuvs) endif() add_subdirectory(faiss) if(FAISS_ENABLE_GPU) if(FAISS_ENABLE_ROCM) add_subdirectory(faiss/gpu-rocm) else() add_subdirectory(faiss/gpu) endif() endif() if(FAISS_ENABLE_PYTHON) add_subdirectory(faiss/python) endif() if(FAISS_ENABLE_C_API) add_subdirectory(c_api) endif() if(FAISS_ENABLE_EXTRAS) add_subdirectory(demos) add_subdirectory(benchs) add_subdirectory(tutorial/cpp) endif() # CTest must be included in the top level to enable `make test` target. include(CTest) if(BUILD_TESTING) add_subdirectory(tests) add_subdirectory(perf_tests) if(FAISS_ENABLE_GPU) if(FAISS_ENABLE_ROCM) add_subdirectory(faiss/gpu-rocm/test) else() add_subdirectory(faiss/gpu/test) endif() endif() endif() faiss-1.11.0/CODE_OF_CONDUCT.md000066400000000000000000000003611500261315500154740ustar00rootroot00000000000000# 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.faiss-1.11.0/CONTRIBUTING.md000066400000000000000000000034111500261315500151250ustar00rootroot00000000000000# 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 spaces for indentation in C++ (no tabs) * 80 character line length (both for C++ and Python) * C++ language level: C++17 ## 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. faiss-1.11.0/Doxyfile000066400000000000000000003016211500261315500144060ustar00rootroot00000000000000 # 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 = # 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 # , /