Struct SparseVector 

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

Sparse vector structure

Fields

indices: Vec<u32>

Indices must be unique

values: Vec<f32>

Values and indices must be the same length

Implementations

impl SparseVector

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

pub fn sort_by_indices(&mut self)

Sort this vector by indices.

Sorting is required for scoring and overlap checks.

pub fn is_sorted(&self) -> bool

Check if this vector is sorted by indices.

pub fn is_empty(&self) -> bool

Check if this vector is empty.

pub fn len(&self) -> usize

Returns the number of elements in the vector.

pub fn score(&self, other: &SparseVector) -> Option<f32>

Score this vector against another vector using dot product. Warning: Expects both vectors to be sorted by indices.

Return None if the vectors do not overlap.

pub fn combine_aggregate( &self, other: &SparseVector, op: impl Fn(f32, f32) -> f32, ) -> Self

Construct a new vector that is the result of performing all indices-wise operations. Automatically sort input vectors if necessary.

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 Default for SparseVector

fn default() -> SparseVector

Returns the “default value” for a type.

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 Vector

fn from(v: SparseVector) -> Self

Converts to this type from the input type.

impl From<SparseVector> for VectorInternal

fn from(val: SparseVector) -> Self

Converts to this type from the input type.

impl Hash for SparseVector

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl JsonSchema for SparseVector

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

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 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<Vec<(u32, f32)>> for SparseVector

type Error = ValidationErrors

The type returned in the event of a conversion error.

fn try_from(tuples: Vec<(u32, f32)>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<VectorInternal> for SparseVector

type Error = OperationError

The type returned in the event of a conversion error.

fn try_from(value: VectorInternal) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryInto<&'a SparseVector> for &'a VectorInternal

type Error = OperationError

The type returned in the event of a conversion error.

fn try_into(self) -> Result<&'a SparseVector, Self::Error>

Performs the conversion.

impl Validate for SparseVector

fn validate(&self) -> Result<(), ValidationErrors>

impl StructuralPartialEq for SparseVector