Struct EmbeddingVector 

pub struct EmbeddingVector { /* private fields */ }

Wrapper type around an immutable floating-point embedding.

Implementations

impl EmbeddingVector

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

Creates a new embedding from owned values.

Errors

Returns MemoryError::InvalidRecord when the supplied vector is empty or contains non-finite values.

pub fn from_slice(values: &[f32]) -> MemoryResult<Self>

Creates an embedding by copying the provided slice.

Errors

Returns MemoryError::InvalidRecord if the slice is empty or contains non-finite values.

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

Returns an immutable view of the embedding data.

pub fn len(&self) -> usize

Returns the dimensionality of the embedding.

pub fn is_empty(&self) -> bool

Returns whether the embedding is empty. This should never be the case because EmbeddingVector::new rejects empty inputs, but the helper is provided for completeness.

Trait Implementations

impl Clone for EmbeddingVector

fn clone(&self) -> EmbeddingVector

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EmbeddingVector

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EmbeddingVector

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for EmbeddingVector

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

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 EmbeddingVector