File AlignedTable.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.

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<int A = 32>
inline bool is_aligned_pointer(const void *x)
template<class T, int A = 32>
struct AlignedTable

Public Functions

inline AlignedTable()
inline explicit AlignedTable(size_t n)
inline size_t itemsize() const
inline void resize(size_t n)
inline void clear()
inline size_t size() const
inline size_t nbytes() const
inline T *get()
inline const T *get() const
inline T *data()
inline const T *data() const
inline T &operator[](size_t i)
inline T operator[](size_t i) const

Public Members

AlignedTableTightAlloc<T, A> tab
size_t numel = 0

Public Static Functions

static inline size_t round_capacity(size_t n)
template<class T, int A = 32>
struct AlignedTableTightAlloc

Public Functions

inline AlignedTableTightAlloc()
inline explicit AlignedTableTightAlloc(size_t n)
inline size_t itemsize() const
inline void resize(size_t n)
inline void clear()
inline size_t size() const
inline size_t nbytes() const
inline T *get()
inline const T *get() const
inline T *data()
inline const T *data() const
inline T &operator[](size_t i)
inline T operator[](size_t i) const
inline ~AlignedTableTightAlloc()
inline AlignedTableTightAlloc<T, A> &operator=(const AlignedTableTightAlloc<T, A> &other)
inline AlignedTableTightAlloc(const AlignedTableTightAlloc<T, A> &other)

Public Members

T *ptr
size_t numel