faiss/c_api/index_io_c.h
Michael Norris 56a383f253 Resolve "duplicate-license-header": Find and replace duplicate license headers (#3967)
Summary:
Pull Request resolved: https://github.com/facebookresearch/faiss/pull/3967

This diff just finds and replaces duplicate license headers.

See the errors for "duplicate-license-header" in D64429711 under "linter-coverage-verification" signal.

Reviewed By: asadoughi

Differential Revision: D64484123

fbshipit-source-id: 906e8baa3a11a3bbee174a03dcc27681f9fd78c2
2024-10-21 08:26:22 -07:00

78 lines
2.0 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_C_H
#define FAISS_INDEX_IO_C_H
#include <stdio.h>
#include "IndexBinary_c.h"
#include "Index_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);
#ifdef __cplusplus
}
#endif
#endif