Struct SparseVector 

pub struct SparseVector {
    pub indices: Vec<u32>,
    pub values: Vec<f32>,
    pub tokens: Option<Vec<String>>,
}

Represents a sparse vector using parallel arrays for indices and values.

On deserialization: accepts both old format {"indices": [...], "values": [...]} and new format {"#type": "sparse_vector", "indices": [...], "values": [...]}.

On serialization: always includes #type field with value "sparse_vector".

Fields

indices: Vec<u32>

Dimension indices

values: Vec<f32>

Values corresponding to each index

tokens: Option<Vec<String>>

Tokens corresponding to each index

Implementations

impl SparseVector

pub fn new( indices: Vec<u32>, values: Vec<f32>, ) -> Result<Self, SparseVectorLengthMismatch>

Create a new sparse vector from parallel arrays.

pub fn new_with_tokens( indices: Vec<u32>, values: Vec<f32>, tokens: Vec<String>, ) -> Result<Self, SparseVectorLengthMismatch>

Create a new sparse vector from parallel arrays.

pub fn from_pairs(pairs: impl IntoIterator<Item = (u32, f32)>) -> Self

Create a sparse vector from an iterator of (index, value) pairs.

pub fn from_triples( triples: impl IntoIterator<Item = (String, u32, f32)>, ) -> Self

Create a sparse vector from an iterator of (string, index, value) pairs.

pub fn iter(&self) -> impl Iterator<Item = (u32, f32)> + '_

Iterate over (index, value) pairs.

pub fn validate(&self) -> Result<(), MetadataValueConversionError>

Validate the sparse vector

Trait Implementations

impl Clone for SparseVector

fn clone(&self) -> SparseVector

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SparseVector

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SparseVector

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&SparseVector> for CsVec<f32>

Convert SparseVector to sprs::CsVec for efficient sparse operations

fn from(sparse: &SparseVector) -> Self

Converts to this type from the input type.

impl From<SparseVector> for CsVec<f32>

fn from(sparse: SparseVector) -> Self

Converts to this type from the input type.

impl From<SparseVector> for MetadataValue

fn from(v: SparseVector) -> Self

Converts to this type from the input type.

impl From<SparseVector> for QueryVector

fn from(sparse: SparseVector) -> Self

Converts to this type from the input type.

impl From<SparseVector> for SparseVector

fn from(sparse: SparseVector) -> Self

Converts to this type from the input type.

impl From<SparseVector> for UpdateMetadataValue

fn from(v: SparseVector) -> Self

Converts to this type from the input type.

impl Ord for SparseVector

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SparseVector

fn eq(&self, other: &SparseVector) -> 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 PartialOrd for SparseVector

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for SparseVector

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<SparseVector> for SparseVector

type Error = SparseVectorLengthMismatch

The type returned in the event of a conversion error.

fn try_from(proto: SparseVector) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for SparseVector

impl StructuralPartialEq for SparseVector