Faiss
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends
Public Member Functions | Protected Attributes | List of all members
faiss::gpu::GpuIndex Class Referenceabstract
Inheritance diagram for faiss::gpu::GpuIndex:
faiss::Index faiss::gpu::GpuIndexFlat faiss::gpu::GpuIndexIVF faiss::gpu::GpuIndexFlatIP faiss::gpu::GpuIndexFlatL2 faiss::gpu::GpuIndexIVFFlat faiss::gpu::GpuIndexIVFPQ

Public Member Functions

 GpuIndex (GpuResources *resources, int device, int dims, faiss::MetricType metric)
 
int getDevice () const
 
GpuResourcesgetResources ()
 
virtual void add (faiss::Index::idx_t, float const *)=0
 
- Public Member Functions inherited from faiss::Index
 Index (idx_t d=0, MetricType metric=METRIC_INNER_PRODUCT)
 
virtual void train (idx_t n, const float *x)
 
virtual void add_with_ids (idx_t n, const float *x, const long *xids)
 
virtual void search (idx_t n, const float *x, idx_t k, float *distances, idx_t *labels) const =0
 
virtual void range_search (idx_t n, const float *x, float radius, RangeSearchResult *result) const
 
void assign (idx_t n, const float *x, idx_t *labels, idx_t k=1)
 
virtual void reset ()=0
 removes all elements from the database.
 
virtual long remove_ids (const IDSelector &sel)
 
virtual void reconstruct (idx_t key, float *recons) const
 
virtual void reconstruct_n (idx_t i0, idx_t ni, float *recons) const
 
void compute_residual (const float *x, float *residual, idx_t key) const
 
void display () const
 
virtual std::string get_typename () const
 
virtual void set_typename ()=0
 

Protected Attributes

GpuResourcesresources_
 Manages streans, cuBLAS handles and scratch memory for devices.
 
int device_
 The GPU device we are resident on.
 

Additional Inherited Members

- Public Types inherited from faiss::Index
typedef long idx_t
 all indices are this type
 
- Public Attributes inherited from faiss::Index
std::string index_typename
 
int d
 vector dimension
 
idx_t ntotal
 total nb of indexed vectors
 
bool verbose
 verbosity level
 
bool is_trained
 set if the Index does not require training, or if training is done already
 
MetricType metric_type
 type of metric this index uses for search
 

Detailed Description

Definition at line 20 of file GpuIndex.h.

Member Function Documentation

virtual void faiss::gpu::GpuIndex::add ( faiss::Index::idx_t  n,
float const *  x 
)
pure virtual

Add n vectors of dimension d to the index.

Vectors are implicitly assigned labels ntotal .. ntotal + n - 1 This function slices the input vectors in chuncks smaller than blocksize_add and calls add_core.

Parameters
xinput matrix, size n * d

Implements faiss::Index.

Implemented in faiss::gpu::GpuIndexFlat, and faiss::gpu::GpuIndexIVF.


The documentation for this class was generated from the following files: