mirror of
https://github.com/facebookresearch/faiss.git
synced 2025-06-03 21:54:02 +08:00
a4401c13d8
Summary: ### Description - Create custom readers and writers for index IO, which take function pointers as input - Also expose these from the C_API This is helpful for FFI use, where calling processes would pass upcall stubs for streamlined IO Pull Request resolved: https://github.com/facebookresearch/faiss/pull/4180 Reviewed By: gtwang01 Differential Revision: D71208266 Pulled By: mnorris11 fbshipit-source-id: ab82397d4780a2a07c7bfdc52329968377f42af4
114 lines
2.9 KiB
C
114 lines
2.9 KiB
C
/*
|
|
* Copyright (c) Meta Platforms, Inc. and 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_C_H
|
|
#define FAISS_INDEX_IO_C_H
|
|
|
|
#include <stdio.h>
|
|
#include "IndexBinary_c.h"
|
|
#include "Index_c.h"
|
|
#include "VectorTransform_c.h"
|
|
#include "faiss_c.h"
|
|
#include "impl/io_c.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/** Write index to a file.
|
|
* This is equivalent to `faiss::write_index` when a file descriptor is
|
|
* provided.
|
|
*/
|
|
int faiss_write_index(const FaissIndex* idx, FILE* f);
|
|
|
|
/** Write index to a file.
|
|
* This is equivalent to `faiss::write_index` when a file path is provided.
|
|
*/
|
|
int faiss_write_index_fname(const FaissIndex* idx, const char* fname);
|
|
|
|
/** Write index to a custom writer.
|
|
*/
|
|
int faiss_write_index_custom(
|
|
const FaissIndex* idx,
|
|
FaissIOWriter* io_writer,
|
|
int io_flags);
|
|
|
|
#define FAISS_IO_FLAG_MMAP 1
|
|
#define FAISS_IO_FLAG_READ_ONLY 2
|
|
|
|
/** Read index from a file.
|
|
* This is equivalent to `faiss:read_index` when a file descriptor is given.
|
|
*/
|
|
int faiss_read_index(FILE* f, int io_flags, FaissIndex** p_out);
|
|
|
|
/** Read index from a file.
|
|
* This is equivalent to `faiss:read_index` when a file path is given.
|
|
*/
|
|
int faiss_read_index_fname(const char* fname, int io_flags, FaissIndex** p_out);
|
|
|
|
/** Read index from a custom reader.
|
|
*/
|
|
int faiss_read_index_custom(
|
|
FaissIOReader* io_reader,
|
|
int io_flags,
|
|
FaissIndex** p_out);
|
|
|
|
/** Write index to a file.
|
|
* This is equivalent to `faiss::write_index_binary` when a file descriptor is
|
|
* provided.
|
|
*/
|
|
int faiss_write_index_binary(const FaissIndexBinary* idx, FILE* f);
|
|
|
|
/** Write index to a file.
|
|
* This is equivalent to `faiss::write_index_binary` when a file path is
|
|
* provided.
|
|
*/
|
|
int faiss_write_index_binary_fname(
|
|
const FaissIndexBinary* idx,
|
|
const char* fname);
|
|
|
|
/** Write binary index to a custom writer.
|
|
*/
|
|
int faiss_write_index_binary_custom(
|
|
const FaissIndexBinary* idx,
|
|
FaissIOWriter* io_writer);
|
|
|
|
/** Read index from a file.
|
|
* This is equivalent to `faiss:read_index_binary` when a file descriptor is
|
|
* given.
|
|
*/
|
|
int faiss_read_index_binary(FILE* f, int io_flags, FaissIndexBinary** p_out);
|
|
|
|
/** Read index from a file.
|
|
* This is equivalent to `faiss:read_index_binary` when a file path is given.
|
|
*/
|
|
int faiss_read_index_binary_fname(
|
|
const char* fname,
|
|
int io_flags,
|
|
FaissIndexBinary** p_out);
|
|
|
|
/** Read binary index from a custom reader.
|
|
*/
|
|
int faiss_read_index_binary_custom(
|
|
FaissIOReader* io_reader,
|
|
int io_flags,
|
|
FaissIndexBinary** p_out);
|
|
|
|
/** Read vector transform from a file.
|
|
* This is equivalent to `faiss:read_VectorTransform` when a file path is given.
|
|
*/
|
|
int faiss_read_VectorTransform_fname(
|
|
const char* fname,
|
|
FaissVectorTransform** p_out);
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
#endif
|