Faiss

- Main Page
- Namespaces
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 1 2 3 4]

faiss |
gpu |
detail | Type of a subspace of a tensor
SubTensor | A `SubDim`-rank slice of a parent Tensor
SubTensor< TensorType, 0, PtrTraits > | Specialization for a view of a single value (0-dimensional)
traits |
RestrictPtrTraits |
DefaultPtrTraits |
ToCPUCloner |
ToGpuCloner |
ToGpuClonerMultiple |
GpuParameterSpace | Parameter space and setters for GPU indexes
GpuClonerOptions | Set some options on how to copy to GPU
GpuMultipleClonerOptions |
GpuIndexConfig |
GpuIndex |
GpuIndexBinaryFlatConfig |
GpuIndexBinaryFlat |
GpuIndexFlatConfig |
GpuIndexFlat |
GpuIndexFlatL2 |
GpuIndexFlatIP |
GpuIndexIVFConfig |
GpuIndexIVF |
GpuIndexIVFFlatConfig |
GpuIndexIVFFlat |
GpuIndexIVFPQConfig |
GpuIndexIVFPQ | IVFPQ index for the GPU
GpuResources |
BinaryFlatIndex | Holder of GPU resources for a particular flat index
FlatIndex | Holder of GPU resources for a particular flat index
IVFBase | Base inverted list functionality for IVFFlat and IVFPQ
IVFFlat |
IVFFlatScan | The class that we use to provide scan specializations
IVFFlatScan<-1, L2, T > |
IVFFlatScan< 0, L2, T > |
IVFPQ | Implementing class for IVFPQ on the GPU
Converter |
Converter< float > |
LoadCode32 |
LoadCode32< 1 > |
LoadCode32< 2 > |
LoadCode32< 3 > |
LoadCode32< 4 > |
LoadCode32< 8 > |
LoadCode32< 12 > |
LoadCode32< 16 > |
LoadCode32< 20 > |
LoadCode32< 24 > |
LoadCode32< 28 > |
LoadCode32< 32 > |
LoadCode32< 40 > |
LoadCode32< 48 > |
LoadCode32< 56 > |
LoadCode32< 64 > |
LoadCode32< 96 > |
LoadCodeDistances |
IndexWrapper |
StandardGpuResources |
Comparator |
IntToIdxType |
ConvertTo |
ConvertTo< float > |
ConvertTo< float2 > |
ConvertTo< float4 > |
DeviceMemoryReservation |
DeviceMemory | Manages temporary memory allocations on a GPU device
DeviceTensor |
DeviceScope |
CublasHandleScope | RAII object to manage a cublasHandle_t
CudaEvent |
DeviceVector |
HostTensor |
Limits |
Limits< float > |
Limits< int > |
Limits< Pair< K, V > > |
LoadStore |
Math |
Math< float2 > |
Math< float4 > |
CublasGemm |
CublasGemm< float > |
BlockMerge |
BlockMerge< NumThreads, K, V, N, L, Dir, Comp, true, FullMerge > | Merging lists smaller than a block
BlockMerge< NumThreads, K, V, N, L, Dir, Comp, false, FullMerge > | Merging lists larger than a block
BitonicMergeStep |
BitonicMergeStep< K, V, 1, Dir, Comp, Low, true > |
BitonicMergeStep< K, V, N, Dir, Comp, Low, true > |
BitonicMergeStep< K, V, N, Dir, Comp, true, false > |
BitonicMergeStep< K, V, N, Dir, Comp, false, false > |
BitonicSortStep |
BitonicSortStep< K, V, 1, Dir, Comp > |
NoTypeTensor |
Pair | A simple pair type for CUDA device usage
Sum |
Min |
Max |
SegmentedReduce |
FinalBlockMerge |
FinalBlockMerge< 1, NumThreads, K, V, NumWarpQ, Dir, Comp > |
FinalBlockMerge< 2, NumThreads, K, V, NumWarpQ, Dir, Comp > |
FinalBlockMerge< 4, NumThreads, K, V, NumWarpQ, Dir, Comp > |
FinalBlockMerge< 8, NumThreads, K, V, NumWarpQ, Dir, Comp > |
BlockSelect |
BlockSelect< K, V, Dir, Comp, 1, NumThreadQ, ThreadsPerBlock > | Specialization for k == 1 (NumWarpQ == 1)
WarpSelect |
WarpSelect< K, V, Dir, Comp, 1, NumThreadQ, ThreadsPerBlock > | Specialization for k == 1 (NumWarpQ == 1)
StackDeviceMemory |
Range |
Stack |
Tensor | Our tensor type
GpuResourcesThrustAllocator | Allocator for Thrust that comes out of a specified memory space
KernelTimer | Utility class for timing execution of a kernel
CpuTimer | CPU wallclock elapsed timer
TensorInfo |
TensorInfoOffset |
TensorInfoOffset< T, IndexT,-1 > |
ivflib |
SlidingIndexWindow |
AutoTuneCriterion |
OneRecallAtRCriterion |
IntersectionCriterion |
OperatingPoint |
OperatingPoints |
ParameterRange | Possible values of a parameter, sorted from least to most expensive/accurate
ParameterSpace |
MatrixStats |
Occurrence |
PerDimStats |
RangeSearchResult |
IDSelector |
IDSelectorRange |
IDSelectorBatch |
BufferList |
Buffer |
RangeQueryResult | Result structure for a single query
RangeSearchPartialResult | Entries in the buffers are split per query
IOReader |
IOWriter |
VectorIOReader |
VectorIOWriter |
DistanceComputer |
InterruptCallback |
ClusteringParameters |
Clustering |
FaissException | Base class for Faiss exceptions
ScopeDeleter |
ScopeDeleter1 |
HammingComputer4 |
HammingComputer8 |
HammingComputer16 |
HammingComputer20 |
HammingComputer32 |
HammingComputer64 |
HammingComputerDefault |
HammingComputerM8 |
HammingComputerM4 |
HammingComputer |
GenHammingComputer8 |
GenHammingComputer16 |
GenHammingComputer32 |
GenHammingComputerM8 |
HCounterState |
CMax |
CMin |
HeapArray |
HNSW |
MinimaxHeap |
NodeDistCloser | To sort pairs of (id, distance) from nearest to fathest or the reverse
NodeDistFarther |
VisitedTable | Set implementation optimized for fast access
HNSWStats |
Index |
ScopeFileCloser |
Cloner |
IndexBinary |
IndexBinaryFlat |
IndexBinaryFromFloat |
IndexBinaryHNSW |
IndexBinaryIVF |
BinaryInvertedListScanner |
IndexFlat |
IndexFlatIP |
IndexFlatL2 |
IndexFlatL2BaseShift |
IndexRefineFlat |
IndexFlat1D | Optimized version for 1D "vectors"
ReconstructFromNeighbors |
IndexHNSW |
IndexHNSWFlat |
IndexHNSWPQ |
IndexHNSWSQ |
IndexHNSW2Level |
Level1Quantizer |
IVFSearchParameters |
IndexIVF |
InvertedListScanner |
IndexIVFStats |
IndexIVFFlat |
IndexIVFFlatDedup |
CodeCmp |
IVFPQSearchParameters |
IndexIVFPQ |
IndexIVFPQStats |
IndexIVFPQR |
Index2Layer |
IndexIVFSpectralHash |
IndexLSH |
IndexPQ |
IndexPQStats |
MultiIndexQuantizer |
MultiIndexQuantizer2 |
IndexReplicasTemplate |
SQDistanceComputer |
ScalarQuantizer |
IndexScalarQuantizer |
IndexIVFScalarQuantizer |
IndexShardsTemplate |
InvertedLists |
ScopedCodes |
ScopedIds |
ArrayInvertedLists | Simple (default) implementation as an array of inverted lists
ReadOnlyInvertedLists |
HStackInvertedLists | Horizontal stack of inverted lists
SliceInvertedLists | Vertical slice of indexes in another InvertedLists
VStackInvertedLists |
MaskedInvertedLists |
IndexIDMap |
IndexIDMap2 |
IndexSplitVectors |
LockLevels |
OnDiskInvertedLists |
List |
OngoingPrefetch |
Thread |
Slot |
Score3Computer |
IndirectSort |
RankingScore2 |
SimulatedAnnealingParameters | Parameters used for the simulated annealing method
PermutationObjective | Abstract class for the loss function
ReproduceDistancesObjective |
SimulatedAnnealingOptimizer | Simulated annealing optimization algorithm for permutations
PolysemousTraining | Optimizes the order of indices in a ProductQuantizer
ProductQuantizer |
PQDecoder16 |
PQDecoder8 |
PQDecoderGeneric |
PQEncoder16 |
PQEncoder8 |
PQEncoderGeneric |
ThreadedIndex |
NopDistanceCorrection |
BaseShiftDistanceCorrection |
RandomGenerator | Random generator that can be used in multithreaded contexts
VectorTransform |
LinearTransform |
RandomRotationMatrix | Randomly rotate a set of vectors
PCAMatrix |
OPQMatrix |
RemapDimensionsTransform |
NormalizationTransform |
CenteringTransform |
IndexPreTransform |
WorkerThread |