Struct SparseVector 

pub struct SparseVector { /* private fields */ }

Data type for sparse vector.

Implementations

impl SparseVector

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

Creates a new value.

pub fn dimensions(&self) -> usize

Returns dimensions.

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

Returns indices.

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

Returns values.

pub fn nnz(&self) -> usize

Returns nnz.

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

Validates this value.

pub fn canonicalized(&self) -> Result<Self>

Returns canonicalized.

pub fn dot(&self, other: &Self) -> Result<f32>

Returns dot.

pub fn cosine_similarity(&self, other: &Self) -> Result<f32>

Returns cosine similarity.

pub fn l1_norm(&self) -> Result<f32>

Returns the L1 norm.

pub fn l2_norm(&self) -> Result<f32>

Returns the L2 norm.

pub fn scale(&self, factor: f32) -> Result<Self>

Scales all sparse values by a finite factor.

pub fn add(&self, other: &Self) -> Result<Self>

Adds two sparse vectors with matching dimensions.

pub fn hadamard(&self, other: &Self) -> Result<Self>

Returns the sparse Hadamard product, keeping only overlapping indices.

pub fn prune_abs_below(&self, threshold: f32) -> Result<Self>

Removes entries whose absolute value is below a finite non-negative threshold.

pub fn top_k_by_abs(&self, k: usize) -> Result<Vec<(usize, f32)>>

Returns the top k entries sorted by descending absolute value, then index.

pub fn normalize_l2(&self) -> Result<Self>

Returns normalize l2.

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

Converts this value to dense.

pub fn from_dense(values: &[f32]) -> Result<Self>

Builds this value from dense.

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

impl TryFrom<&DenseVector> for SparseVector

type Error = DetectError

The type returned in the event of a conversion error.

fn try_from(value: &DenseVector) -> Result<Self>

Performs the conversion.