Skip to main content

Module faiss_native_integration

Module faiss_native_integration 

Source
Expand description

Native FAISS Integration — UNAVAILABLE under the Pure Rust policy

This module’s types describe what a native FAISS integration (via FFI bindings to Facebook’s C++ FAISS library) would look like, but no such integration is actually wired up: the COOLJAPAN Pure Rust Policy forbids adding new C/C++ FFI dependencies to this crate’s default build, and no oxirs-vec-adapter-faiss quarantine crate exists (unlike, e.g., oxirs-vec-adapter-cuda for CUDA).

NativeFaissIndex::new therefore always returns an explicit error instead of fabricating a working index behind fake numeric handles. Use this crate’s Pure Rust indexes instead (HnswIndex, IvfIndex, PQIndex, …), or the byte-compatible (import/export only, no live FFI) crate::faiss_compatibility module.

The struct/field definitions below are kept only so that a future real oxirs-vec-adapter-faiss crate has a documented shape to implement against; none of the “simulated” logic they describe (GPU context, memory pool, benchmark numbers) executes in production.

Structs§

AllocationStats
Memory allocation statistics
BenchmarkDataset
Benchmark dataset
BenchmarkResult
Individual benchmark result
ComparisonData
Performance comparison data
ComparisonResult
Comparison result
DatasetCharacteristics
Dataset characteristics for benchmarking
FaissPerformanceComparison
Performance comparison framework
GpuContext
GPU context for FAISS GPU operations
GpuMetrics
GPU performance metrics
GpuResource
GPU resource handle
MemoryBlock
Memory block in the pool
MemoryMetrics
Memory efficiency metrics
MemoryPool
Memory pool for efficient memory management
NativeFaissConfig
Native FAISS integration configuration
NativeFaissIndex
Native FAISS index wrapper
NativeFaissStatistics
Native FAISS statistics with detailed metrics
NativeMetrics
Native FAISS specific metrics
NativePerformanceTuning
Native performance tuning configuration
PerformanceMetrics
Performance metrics for comparison
PerformanceRatios
Performance ratios
StatisticalSignificance
Statistical significance test results