faiss/MetaIndexes.h

/**
 * Copyright (c) 2015-present, Facebook, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the CC-by-NC license found in the
 * LICENSE file in the root directory of this source tree.
 */

// Copyright 2004-present Facebook. All Rights Reserved.
// -*- c++ -*-

#ifndef META_INDEXES_H
#define META_INDEXES_H


#include <vector>


#include "Index.h"


namespace faiss {

/** Index that translates search results to ids */
struct IndexIDMap : Index {
    Index * index;            ///! the sub-index
    bool own_fields;          ///! whether pointers are deleted in destructo
    std::vector<long> id_map;

    explicit IndexIDMap (Index *index);

    /// Same as add_core, but stores xids instead of sequential ids
    /// @param xids if non-null, ids to store for the vectors (size n)
    virtual void add_with_ids (idx_t n, const float * x, const long *xids)
        override;

    /// this will fail. Use add_with_ids
    virtual void add (idx_t n, const float *x) override;

    virtual void search (
           idx_t n, const float *x, idx_t k,
           float *distances, idx_t *labels) const override;

    virtual void train (idx_t n, const float *x) override;

    virtual void reset () override;

    virtual void set_typename () override;

    virtual ~IndexIDMap ();

};

/** Index that concatenates the results from several sub-indexes
 *
 */
struct IndexShards : Index {

    std::vector<Index*> shard_indexes;
    bool own_fields;      /// should the sub-indexes be deleted along with this?
    bool threaded;
    bool successive_ids;

    /**
     * @param threaded     do we use one thread per sub_index or do
     *                     queries sequentially?
     * @param successive_ids should we shift the returned ids by
     *                     the size of each sub-index or return them
     *                     as they are?
     */
    explicit IndexShards (idx_t d, bool threaded = false,
                         bool successive_ids = true);

    void add_shard (Index *);

    // update metric_type and ntotal. Call if you changes something in
    // the shard indexes.
    void sync_with_shard_indexes ();

    Index *at(int i) {return shard_indexes[i]; }

    /// supported only for sub-indices that implement add_with_ids
    virtual void add (idx_t n, const float *x) override;

    virtual void add_with_ids (idx_t n, const float * x, const long *xids)
        override;



    virtual void search (
           idx_t n, const float *x, idx_t k,
           float *distances, idx_t *labels) const override;

    virtual void train (idx_t n, const float *x) override;

    virtual void reset () override;

    virtual void set_typename () override;

    virtual ~IndexShards ();

};

/** splits input vectors in segments and assigns each segment to a sub-index
 * used to distribute a MultiIndexQuantizer
 */

struct IndexSplitVectors: Index {
    bool own_fields;
    bool threaded;
    std::vector<Index*> sub_indexes;
    idx_t sum_d;  /// sum of dimensions seen so far

    explicit IndexSplitVectors (idx_t d, bool threaded = false);

    void add_sub_index (Index *);
    void sync_with_sub_indexes ();

    virtual void add (idx_t n, const float *x) override;


    virtual void search (
           idx_t n, const float *x, idx_t k,
           float *distances, idx_t *labels) const override;

    virtual void train (idx_t n, const float *x) override;

    virtual void reset () override;

    virtual void set_typename () override;

    virtual ~IndexSplitVectors ();

};



}


#endif