Module faiss::index

Index interface and native implementations.

This module hosts the vital Index trait, through which index building and searching is made. It also contains index_factory, a generic function through which the user can retrieve most of the available index implementations. A very typical usage scenario of this crate is to create the index through this function, but some statically verified index types are available as well.

Modules

• autotune
• flat
  Interface and implementation to Flat index type.
• gpu
  GPU Index implementation
• id_map
  Module for the ID map wrapper.
• io
  Index I/O functions
• io_flags
  Module containing the I/O flags.
• ivf_flat
  Interface and implementation to IVFFlat index type.
• lsh
  Interface and implementation to Locality-Sensitive Hashing (LSH) index type.
• pretransform
  Implementation to PreTransform index type.
• refine_flat
  Interface and implementation to RefineFlat index type.
• scalar_quantizer
  Interface and implementation to ScalarQuantizer index type.

Structs

• AssignSearchResult
  The outcome of an index assign operation.
• Idx
  Primitive data type for identifying a vector in an index (or lack thereof).
• IndexImpl
  Native implementation of a Faiss Index running on the CPU.
• RangeSearchResult
  The outcome of an index range search operation.
• SearchResult
  The outcome of an index search operation.

Traits

• ConcurrentIndex
  Trait for a Faiss index that can be safely searched over multiple threads. Operations which do not modify the index are given a method taking an immutable reference. This is not the default for every index type because some implementations (such as the ones running on the GPU) do not allow concurrent searches.
• CpuIndex
  Trait for Faiss index types known to be running on the CPU.
• FromInnerPtr
  Trait for Faiss index types which can be built from a pointer to a native implementation.
• Index
  Interface for a Faiss index. Most methods in this trait match the ones in the native library, whereas some others serve as getters to the index’ parameters.
• NativeIndex
  Sub-trait for native implementations of a Faiss index.
• TryClone
  A trait which provides a Clone implementation to native index types.
• TryFromInnerPtr
  Trait for Faiss index types which can be built from a pointer to a native implementation.
• UpcastIndex
  Index upcast trait.

Functions

• index_factory
  Use the index factory to create a native instance of a Faiss index, for d-dimensional vectors. description should follow the exact guidelines as the native Faiss interface (see the Faiss wiki for examples).
• try_clone_from_inner_ptr