File hamming-inl.h¶

Defines

SPECIALIZED_HC(CODE_SIZE)¶

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.

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. Defines a few objects that apply transformations to a set of vectors Often these are pre-processing steps.

Functions

template<size_t nbits, typename T> inline T hamming(const uint8_t *bs1, const uint8_t *bs2)¶

template<size_t nbits> inline hamdis_t hamming(const uint64_t *bs1, const uint64_t *bs2)¶

template<> inline hamdis_t hamming<64>(const uint64_t *pa, const uint64_t *pb)¶

template<> inline hamdis_t hamming<128>(const uint64_t *pa, const uint64_t *pb)¶

template<> inline hamdis_t hamming<256>(const uint64_t *pa, const uint64_t *pb)¶

inline hamdis_t hamming(const uint64_t *bs1, const uint64_t *bs2, size_t nwords)¶

SPECIALIZED_HC (4)

SPECIALIZED_HC (8)

SPECIALIZED_HC (16)

SPECIALIZED_HC (20)

SPECIALIZED_HC (32)

SPECIALIZED_HC (64)

inline int generalized_hamming_64(uint64_t a)¶

void generalized_hammings_knn_hc(int_maxheap_array_t *ha, const uint8_t *a, const uint8_t *b, size_t nb, size_t code_size, int ordered = true)¶: generalized Hamming distances (= count number of code bytes that are the same)

Variables

const uint8_t hamdis_tab_ham_bytes[256]¶

struct HammingComputer4¶

Public Functions

inline HammingComputer4()¶

inline HammingComputer4(const uint8_t *a, int code_size)¶

inline void set(const uint8_t *a, int code_size)¶

inline int hamming(const uint8_t *b) const¶

Public Members

uint32_t a0¶

struct HammingComputer8¶

Public Functions

inline HammingComputer8()¶

inline HammingComputer8(const uint8_t *a, int code_size)¶

inline void set(const uint8_t *a, int code_size)¶

inline int hamming(const uint8_t *b) const¶

Public Members

uint64_t a0¶

struct HammingComputer16¶

Public Functions

inline HammingComputer16()¶

inline HammingComputer16(const uint8_t *a8, int code_size)¶

inline void set(const uint8_t *a8, int code_size)¶

inline int hamming(const uint8_t *b8) const¶

Public Members

uint64_t a0¶

uint64_t a1¶

struct HammingComputer20¶

Public Functions

inline HammingComputer20()¶

inline HammingComputer20(const uint8_t *a8, int code_size)¶

inline void set(const uint8_t *a8, int code_size)¶

inline int hamming(const uint8_t *b8) const¶

Public Members

uint64_t a0¶

uint64_t a1¶

uint32_t a2¶

struct HammingComputer32¶

Public Functions

inline HammingComputer32()¶

inline HammingComputer32(const uint8_t *a8, int code_size)¶

inline void set(const uint8_t *a8, int code_size)¶

inline int hamming(const uint8_t *b8) const¶

Public Members

uint64_t a0¶

uint64_t a1¶

uint64_t a2¶

uint64_t a3¶

struct HammingComputer64¶

Public Functions

inline HammingComputer64()¶

inline HammingComputer64(const uint8_t *a8, int code_size)¶

inline void set(const uint8_t *a8, int code_size)¶

inline int hamming(const uint8_t *b8) const¶

Public Members

uint64_t a0¶

uint64_t a1¶

uint64_t a2¶

uint64_t a3¶

uint64_t a4¶

uint64_t a5¶

uint64_t a6¶

uint64_t a7¶

struct HammingComputerDefault¶

Subclassed by faiss::HammingComputer< CODE_SIZE >

Public Functions

inline HammingComputerDefault()¶

inline HammingComputerDefault(const uint8_t *a8, int code_size)¶

inline void set(const uint8_t *a8, int code_size)¶

inline int hamming(const uint8_t *b8) const¶

Public Members

const uint8_t *a8¶

int quotient8¶

int remainder8¶

struct HammingComputerM8¶

Public Functions

inline HammingComputerM8()¶

inline HammingComputerM8(const uint8_t *a8, int code_size)¶

inline void set(const uint8_t *a8, int code_size)¶

inline int hamming(const uint8_t *b8) const¶

Public Members

const uint64_t *a¶

int n¶

struct HammingComputerM4¶

Public Functions

inline HammingComputerM4()¶

inline HammingComputerM4(const uint8_t *a4, int code_size)¶

inline void set(const uint8_t *a4, int code_size)¶

inline int hamming(const uint8_t *b8) const¶

Public Members

const uint32_t *a¶

int n¶

template<int CODE_SIZE> struct HammingComputer : public faiss::HammingComputerDefault ¶

Public Functions

inline HammingComputer(const uint8_t *a, int code_size)¶

inline void set(const uint8_t *a8, int code_size)¶

inline int hamming(const uint8_t *b8) const¶

Public Members

const uint8_t *a8¶

int quotient8¶

int remainder8¶

struct GenHammingComputer8¶

Public Functions

inline GenHammingComputer8(const uint8_t *a, int code_size)¶

inline int hamming(const uint8_t *b) const¶

Public Members

uint64_t a0¶

struct GenHammingComputer16¶

Public Functions

inline GenHammingComputer16(const uint8_t *a8, int code_size)¶

inline int hamming(const uint8_t *b8) const¶

Public Members

uint64_t a0¶

uint64_t a1¶

struct GenHammingComputer32¶

Public Functions

inline GenHammingComputer32(const uint8_t *a8, int code_size)¶

inline int hamming(const uint8_t *b8) const¶

Public Members

uint64_t a0¶

uint64_t a1¶

uint64_t a2¶

uint64_t a3¶

struct GenHammingComputerM8¶

Public Functions

inline GenHammingComputerM8(const uint8_t *a8, int code_size)¶

inline int hamming(const uint8_t *b8) const¶

Public Members

const uint64_t *a¶

int n¶

template<class HammingComputer> struct HCounterState¶

#include <hamming-inl.h>

This class maintains a list of best distances seen so far.

Since the distances are in a limited range (0 to nbit), the object maintains one list per possible distance, and fills in only the n-first lists, such that the sum of sizes of the n lists is below k.

Public Functions

inline HCounterState(int *counters, int64_t *ids_per_dis, const uint8_t *x, int d, int k)¶

inline void update_counter(const uint8_t *y, size_t j)¶

Public Members

int *counters¶

int64_t *ids_per_dis¶

HammingComputer hc¶

int thres¶

int count_lt¶

int count_eq¶

int k¶