mirror of
https://github.com/facebookresearch/faiss.git
synced 2025-06-03 21:54:02 +08:00
2bfbead8f1
* [c_api] Update impl and interface for v1.5
- move IndexShards to dedicated module IndexShards_c.{h|cpp}
- remove getter/setters to unreachable fields
- reimplement faiss_IndexIVF_imbalance_factor (to use invlists)
- minor IndexIVF documentation tweaks
- Remove QueryResult, provide RangeQueryResult
* [c_api] Document FaissErrorCode
* [c_api] Update GPU impl and interface for v1.5
- Remove unavailable method setTempMemoryFraction
* [c_api] Relicense to MIT
In accordance to the rest of the project
50 lines
1.4 KiB
C
50 lines
1.4 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.
|
|
*/
|
|
|
|
// Copyright 2004-present Facebook. All Rights Reserved.
|
|
// -*- c++ -*-
|
|
|
|
#ifndef METAINDEXES_C_H
|
|
#define METAINDEXES_C_H
|
|
|
|
#include "faiss_c.h"
|
|
#include "Index_c.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/** Index that translates search results to ids */
|
|
FAISS_DECLARE_CLASS_INHERITED(IndexIDMap, Index)
|
|
|
|
FAISS_DECLARE_GETTER_SETTER(IndexIDMap, int, own_fields)
|
|
|
|
int faiss_IndexIDMap_new(FaissIndexIDMap** p_index, FaissIndex* index);
|
|
|
|
/** get a pointer to the index map's internal ID vector (the `id_map` field). The
|
|
* outputs of this function become invalid after any operation that can modify the index.
|
|
*
|
|
* @param index opaque pointer to index object
|
|
* @param p_id_map output, the pointer to the beginning of `id_map`.
|
|
* @param p_size output, the current length of `id_map`.
|
|
*/
|
|
void faiss_IndexIDMap_id_map(FaissIndexIDMap* index, long** p_id_map, size_t* p_size);
|
|
|
|
/** same as IndexIDMap but also provides an efficient reconstruction
|
|
implementation via a 2-way index */
|
|
FAISS_DECLARE_CLASS_INHERITED(IndexIDMap2, IndexIDMap)
|
|
|
|
int faiss_IndexIDMap2_new(FaissIndexIDMap2** p_index, FaissIndex* index);
|
|
|
|
/// make the rev_map from scratch
|
|
int faiss_IndexIDMap2_construct_rev_map(FaissIndexIDMap2* index);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
#endif
|