mirror of
https://github.com/facebookresearch/faiss.git
synced 2025-06-03 21:54:02 +08:00
a8118acbc5
Changelog: - changed license: BSD+Patents -> MIT - propagates exceptions raised in sub-indexes of IndexShards and IndexReplicas - 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) - refactored benchmark code: data loading is now in a single file
91 lines
2.7 KiB
C++
91 lines
2.7 KiB
C++
/**
|
|
* 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.
|
|
*/
|
|
|
|
// -*- c++ -*-
|
|
|
|
// I/O code for indexes
|
|
|
|
#ifndef FAISS_INDEX_IO_H
|
|
#define FAISS_INDEX_IO_H
|
|
|
|
|
|
#include <cstdio>
|
|
|
|
/** 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.
|
|
*/
|
|
|
|
namespace faiss {
|
|
|
|
struct Index;
|
|
struct IndexBinary;
|
|
struct VectorTransform;
|
|
struct IndexIVF;
|
|
struct ProductQuantizer;
|
|
struct IOReader;
|
|
struct IOWriter;
|
|
struct InvertedLists;
|
|
|
|
void write_index (const Index *idx, const char *fname);
|
|
void write_index (const Index *idx, FILE *f);
|
|
void write_index (const Index *idx, IOWriter *writer);
|
|
|
|
void write_index_binary (const IndexBinary *idx, const char *fname);
|
|
void write_index_binary (const IndexBinary *idx, FILE *f);
|
|
void write_index_binary (const IndexBinary *idx, IOWriter *writer);
|
|
|
|
// The read_index flags are implemented only for a subset of index types.
|
|
const int IO_FLAG_MMAP = 1; // try to memmap if possible
|
|
const int IO_FLAG_READ_ONLY = 2;
|
|
// strip directory component from ondisk filename, and assume it's in
|
|
// the same directory as the index file
|
|
const int IO_FLAG_ONDISK_SAME_DIR = 4;
|
|
|
|
Index *read_index (const char *fname, int io_flags = 0);
|
|
Index *read_index (FILE * f, int io_flags = 0);
|
|
Index *read_index (IOReader *reader, int io_flags = 0);
|
|
|
|
IndexBinary *read_index_binary (const char *fname, int io_flags = 0);
|
|
IndexBinary *read_index_binary (FILE * f, int io_flags = 0);
|
|
IndexBinary *read_index_binary (IOReader *reader, int io_flags = 0);
|
|
|
|
void write_VectorTransform (const VectorTransform *vt, const char *fname);
|
|
VectorTransform *read_VectorTransform (const char *fname);
|
|
|
|
ProductQuantizer * read_ProductQuantizer (const char*fname);
|
|
ProductQuantizer * read_ProductQuantizer (IOReader *reader);
|
|
|
|
void write_ProductQuantizer (const ProductQuantizer*pq, const char *fname);
|
|
void write_ProductQuantizer (const ProductQuantizer*pq, IOWriter *f);
|
|
|
|
void write_InvertedLists (const InvertedLists *ils, IOWriter *f);
|
|
InvertedLists *read_InvertedLists (IOReader *reader, int io_flags = 0);
|
|
|
|
/* cloning functions */
|
|
Index *clone_index (const Index *);
|
|
|
|
/** Cloner class, useful to override classes with other cloning
|
|
* functions. The cloning function above just calls
|
|
* Cloner::clone_Index. */
|
|
struct Cloner {
|
|
virtual VectorTransform *clone_VectorTransform (const VectorTransform *);
|
|
virtual Index *clone_Index (const Index *);
|
|
virtual IndexIVF *clone_IndexIVF (const IndexIVF *);
|
|
virtual ~Cloner() {}
|
|
};
|
|
|
|
|
|
|
|
} // namespace faiss
|
|
|
|
|
|
#endif
|