API Reference¶
Complete API documentation for VSAX v1.0.0.
Core Components¶
- Base Classes - Abstract interfaces (AbstractHypervector, AbstractOpSet)
- VSAModel - Immutable model container
Representations¶
- ComplexHypervector - Complex-valued phase-based representation
- RealHypervector - Real-valued continuous representation
- BinaryHypervector - Binary/bipolar discrete representation
Operations¶
- FHRROperations - FFT-based circular convolution
- MAPOperations - Element-wise multiply and mean
- BinaryOperations - XOR and majority voting
Sampling¶
- Sampling Functions - Random vector generation
Memory & Utilities¶
- VSAMemory - Symbol table and basis management
- Factory Functions - Easy model creation
Encoders¶
- ScalarEncoder - Encode numeric values
- SequenceEncoder - Encode ordered sequences
- SetEncoder - Encode unordered collections
- DictEncoder - Encode key-value pairs
- GraphEncoder - Encode graph structures
- AbstractEncoder - Base class for custom encoders
Similarity¶
- Similarity Functions - Cosine, dot, Hamming similarity
Resonator Networks¶
- CleanupMemory & Resonator - Codebook projection and iterative factorization
I/O & Persistence¶
- Save/Load Functions - JSON serialization for basis vectors
Utilities¶
- Batch Operations - vmap_bind, vmap_bundle, vmap_similarity
- Visualization - pretty_repr, format_similarity_results