# File simdlib_avx512.h

namespace faiss

Copyright (c) Facebook, Inc. and its affiliates.

This source code is licensed under the MIT license found in the LICENSE file in the root directory of this source tree.

Copyright (c) Facebook, Inc. and its affiliates.

This source code is licensed under the MIT license found in the LICENSE file in the root directory of this source tree. Implementation of k-means clustering with many variants.

Copyright (c) Facebook, Inc. and its affiliates.

This source code is licensed under the MIT license found in the LICENSE file in the root directory of this source tree. IDSelector is intended to define a subset of vectors to handle (for removal or as subset to search)

Copyright (c) Facebook, Inc. and its affiliates.

This source code is licensed under the MIT license found in the LICENSE file in the root directory of this source tree. PQ4 SIMD packing and accumulation functions

The basic kernel accumulates nq query vectors with bbs = nb * 2 * 16 vectors and produces an output matrix for that. It is interesting for nq * nb <= 4, otherwise register spilling becomes too large.

The implementation of these functions is spread over 3 cpp files to reduce parallel compile times. Templates are instantiated explicitly.

Copyright (c) Facebook, Inc. and its affiliates.

This source code is licensed under the MIT license found in the LICENSE file in the root directory of this source tree. This file contains callbacks for kernels that compute distances.

Throughout the library, vectors are provided as float * pointers. Most algorithms can be optimized when several vectors are processed (added/searched) together in a batch. In this case, they are passed in as a matrix. When n vectors of size d are provided as float * x, component j of vector i is

x[ i * d + j ]

where 0 <= i < n and 0 <= j < d. In other words, matrices are always compact. When specifying the size of the matrix, we call it an n*d matrix, which implies a row-major storage.

Copyright (c) Facebook, Inc. and its affiliates.

This source code is licensed under the MIT license found in the LICENSE file in the root directory of this source tree. I/O functions can read/write to a filename, a file handle or to an object that abstracts the medium.

The read functions return objects that should be deallocated with delete. All references within these objectes are owned by the object.

Copyright (c) Facebook, Inc. and its affiliates.

This source code is licensed under the MIT license found in the LICENSE file in the root directory of this source tree. Definition of inverted lists + a few common classes that implement the interface.

Copyright (c) Facebook, Inc. and its affiliates.

This source code is licensed under the MIT license found in the LICENSE file in the root directory of this source tree. Since IVF (inverted file) indexes are of so much use for large-scale use cases, we group a few functions related to them in this small library. Most functions work both on IndexIVFs and IndexIVFs embedded within an IndexPreTransform.

Copyright (c) Facebook, Inc. and its affiliates.

This source code is licensed under the MIT license found in the LICENSE file in the root directory of this source tree. In this file are the implementations of extra metrics beyond L2 and inner product

Copyright (c) Facebook, Inc. and its affiliates.

This source code is licensed under the MIT license found in the LICENSE file in the root directory of this source tree. Implements a few neural net layers, mainly to support QINCo

Copyright (c) Facebook, Inc. and its affiliates.

This source code is licensed under the MIT license found in the LICENSE file in the root directory of this source tree. Defines a few objects that apply transformations to a set of vectors Often these are pre-processing steps.

Functions

inline simd16uint16 combine4x2(simd32uint16 a, simd32uint16 b)
struct simd512bit
#include <simdlib_avx512.h>

512-bit representation without interpretation as a vector

Simple wrapper around the AVX 512-bit registers

The objective is to separate the different interpretations of the same registers (as a vector of uint8, uint16 or uint32), to provide printing functions, and to give more readable names to the AVX intrinsics. It does not pretend to be exhausitve, functions are added as needed.

Subclassed by faiss::simd32uint16, faiss::simd64uint8

Public Functions

inline simd512bit()
inline explicit simd512bit(__m512i i)
inline explicit simd512bit(__m512 f)
inline explicit simd512bit(const void *x)
inline explicit simd512bit(simd256bit lo)
inline explicit simd512bit(simd256bit lo, simd256bit hi)
inline void clear()
inline void storeu(void *ptr) const
inline void loadu(const void *ptr)
inline void store(void *ptr) const
inline void bin(char bits[513]) const
inline std::string bin() const

Public Members

__m512i i
__m512 f
union faiss::simd512bit::[anonymous] [anonymous]
struct simd32uint16 : public faiss::simd512bit
#include <simdlib_avx512.h>

vector of 32 elements in uint16

Public Functions

inline simd32uint16()
inline explicit simd32uint16(__m512i i)
inline explicit simd32uint16(int x)
inline explicit simd32uint16(uint16_t x)
inline explicit simd32uint16(simd512bit x)
inline explicit simd32uint16(const uint16_t *x)
inline explicit simd32uint16(simd256bit lo)
inline explicit simd32uint16(simd256bit lo, simd256bit hi)
inline std::string elements_to_string(const char *fmt) const
inline std::string hex() const
inline std::string dec() const
inline void set1(uint16_t x)
inline simd32uint16 operator*(const simd32uint16 &other) const
inline simd32uint16 operator>>(const int shift) const
inline simd32uint16 operator<<(const int shift) const
inline simd32uint16 operator+=(simd32uint16 other)
inline simd32uint16 operator-=(simd32uint16 other)
inline simd32uint16 operator+(simd32uint16 other) const
inline simd32uint16 operator-(simd32uint16 other) const
inline simd32uint16 operator&(simd512bit other) const
inline simd32uint16 operator|(simd512bit other) const
inline simd32uint16 operator^(simd512bit other) const
inline simd32uint16 operator~() const
inline simd16uint16 low() const
inline simd16uint16 high() const
inline uint16_t operator[](int i) const
inline void accu_min(simd32uint16 incoming)
inline void accu_max(simd32uint16 incoming)
inline void clear()
inline void storeu(void *ptr) const
inline void loadu(const void *ptr)
inline void store(void *ptr) const
inline void bin(char bits[513]) const
inline std::string bin() const

Public Members

__m512i i
__m512 f
union faiss::simd512bit::[anonymous] [anonymous]
struct simd64uint8 : public faiss::simd512bit

Public Functions

inline simd64uint8()
inline explicit simd64uint8(__m512i i)
inline explicit simd64uint8(int x)
inline explicit simd64uint8(uint8_t x)
inline explicit simd64uint8(simd256bit lo)
inline explicit simd64uint8(simd256bit lo, simd256bit hi)
inline explicit simd64uint8(simd512bit x)
inline explicit simd64uint8(const uint8_t *x)
inline std::string elements_to_string(const char *fmt) const
inline std::string hex() const
inline std::string dec() const
inline void set1(uint8_t x)
inline simd64uint8 operator&(simd512bit other) const
inline simd64uint8 operator+(simd64uint8 other) const
inline simd64uint8 lookup_4_lanes(simd64uint8 idx) const
inline simd32uint16 lane0_as_uint16() const
inline simd32uint16 lane1_as_uint16() const
inline simd64uint8 operator+=(simd64uint8 other)
inline uint8_t operator[](int i) const
inline void clear()
inline void storeu(void *ptr) const
inline void loadu(const void *ptr)
inline void store(void *ptr) const
inline void bin(char bits[513]) const
inline std::string bin() const

Public Members

__m512i i
__m512 f
union faiss::simd512bit::[anonymous] [anonymous]