All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends
/data/users/hoss/faiss/IndexReplicas.h
/**
* 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.
*/
#pragma once
#include "Index.h"
#include "IndexBinary.h"
#include "ThreadedIndex.h"
namespace faiss {
/// Takes individual faiss::Index instances, and splits queries for
/// sending to each Index instance, and joins the results together
/// when done.
/// Each index is managed by a separate CPU thread.
template <typename IndexT>
class IndexReplicasTemplate : public ThreadedIndex<IndexT> {
public:
using idx_t = typename IndexT::idx_t;
using component_t = typename IndexT::component_t;
using distance_t = typename IndexT::distance_t;
/// The dimension that all sub-indices must share will be the dimension of the
/// first sub-index added
/// @param threaded do we use one thread per sub-index or do queries
/// sequentially?
explicit IndexReplicasTemplate(bool threaded = true);
/// @param d the dimension that all sub-indices must share
/// @param threaded do we use one thread per sub index or do queries
/// sequentially?
explicit IndexReplicasTemplate(idx_t d, bool threaded = true);
/// int version due to the implicit bool conversion ambiguity of int as
/// dimension
explicit IndexReplicasTemplate(int d, bool threaded = true);
/// Alias for addIndex()
void add_replica(IndexT* index) { this->addIndex(index); }
/// Alias for removeIndex()
void remove_replica(IndexT* index) { this->removeIndex(index); }
/// faiss::Index API
/// All indices receive the same call
void train(idx_t n, const component_t* x) override;
/// faiss::Index API
/// All indices receive the same call
void add(idx_t n, const component_t* x) override;
/// faiss::Index API
/// Query is partitioned into a slice for each sub-index
/// split by ceil(n / #indices) for our sub-indices
void search(idx_t n,
const component_t* x,
idx_t k,
distance_t* distances,
idx_t* labels) const override;
/// reconstructs from the first index
void reconstruct(idx_t, component_t *v) const override;
protected:
/// Called just after an index is added
void onAfterAddIndex(IndexT* index) override;
};
using IndexReplicas = IndexReplicasTemplate<Index>;
using IndexBinaryReplicas = IndexReplicasTemplate<IndexBinary>;
} // namespace
faiss::ThreadedIndex::removeIndex
void removeIndex(IndexT *index)
Definition: ThreadedIndex-inl.h:88
faiss::IndexReplicasTemplate::train
void train(idx_t n, const component_t *x) override
Definition: IndexReplicas.cpp:57
faiss::IndexReplicasTemplate::IndexReplicasTemplate
IndexReplicasTemplate(bool threaded=true)
Definition: IndexReplicas.cpp:14
faiss::IndexReplicasTemplate::remove_replica
void remove_replica(IndexT *index)
Alias for removeIndex()
Definition: IndexReplicas.h:46
faiss::IndexReplicasTemplate::onAfterAddIndex
void onAfterAddIndex(IndexT *index) override
Called just after an index is added.
Definition: IndexReplicas.cpp:30
faiss::ThreadedIndex
Definition: ThreadedIndex.h:21
faiss::ThreadedIndex::addIndex
void addIndex(IndexT *index)
Definition: ThreadedIndex-inl.h:49
faiss::IndexReplicasTemplate::search
void search(idx_t n, const component_t *x, idx_t k, distance_t *distances, idx_t *labels) const override
Definition: IndexReplicas.cpp:79
faiss::IndexReplicasTemplate::reconstruct
void reconstruct(idx_t, component_t *v) const override
reconstructs from the first index
Definition: IndexReplicas.cpp:70
faiss::IndexReplicasTemplate::add
void add(idx_t n, const component_t *x) override
Definition: IndexReplicas.cpp:63
faiss::IndexReplicasTemplate::add_replica
void add_replica(IndexT *index)
Alias for addIndex()
Definition: IndexReplicas.h:43
faiss::IndexReplicasTemplate
Definition: IndexReplicas.h:21