faiss/c_api/index_io_c.h
Michael Kosten 2c961cc308 Add VectorTransform read from filename to the C API (#3970)
Summary:
This adds read_VectorTransform to the C API. This is helpful for independently loading a vector transform rather than as an IndexPreTransform.

Pull Request resolved: https://github.com/facebookresearch/faiss/pull/3970

Reviewed By: asadoughi

Differential Revision: D65192203

Pulled By: junjieqi

fbshipit-source-id: 949ae875924b9f3558d7a9f43c4f2aa8ae705f02
2024-10-30 12:01:15 -07:00

86 lines
2.3 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"
#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);
#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);
/** 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);
/** 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 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