Struct SparseEmbedding 

pub struct SparseEmbedding { /* private fields */ }

A sparse vector embedding for use with pgvector’s sparsevec type.

Sparse vectors are efficient for high-dimensional data where most values are zero, common in text embeddings, bag-of-words representations, and learned sparse retrievers.

Examples

use prax_pgvector::SparseEmbedding;

// From a dense vector (zeros are stripped)
let sparse = SparseEmbedding::from_dense(vec![1.0, 0.0, 2.0, 0.0, 3.0]);

// From indices and values
let sparse = SparseEmbedding::from_parts(&[0, 2, 4], &[1.0, 2.0, 3.0], 5).unwrap();

Implementations

impl SparseEmbedding

pub fn from_dense(values: Vec<f32>) -> Self

Create a sparse embedding from a dense vector.

Zero values are automatically removed.

pub fn from_parts( indices: &[i32], values: &[f32], dimensions: usize, ) -> VectorResult<Self>

Create a sparse embedding from indices, values, and total dimensions.

Errors

Returns an error if indices and values have different lengths, or if any index is out of bounds.

pub fn dimensions(&self) -> i32

Get the total number of dimensions.

pub fn indices(&self) -> &[i32]

Get the indices of non-zero elements.

pub fn values(&self) -> &[f32]

Get the values of non-zero elements.

pub fn nnz(&self) -> usize

Get the number of non-zero elements.

pub fn to_dense(&self) -> Vec<f32>

Convert to a dense vector.

pub fn into_inner(self) -> SparseVector

Get the inner pgvector type.

pub fn inner(&self) -> &SparseVector

Get a reference to the inner pgvector type.

Trait Implementations

impl Clone for SparseEmbedding

fn clone(&self) -> SparseEmbedding

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SparseEmbedding

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SparseEmbedding

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SparseEmbedding

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<SparseEmbedding> for SparseVector

fn from(e: SparseEmbedding) -> Self

Converts to this type from the input type.

impl From<SparseVector> for SparseEmbedding

fn from(v: SparseVector) -> Self

Converts to this type from the input type.

impl PartialEq for SparseEmbedding

fn eq(&self, other: &SparseEmbedding) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SparseEmbedding

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SparseEmbedding