Skip to main content

Embedding

Struct Embedding 

Source
pub struct Embedding(/* private fields */);
Expand description

A vector with two explicit construction policies.

Embedding::from_raw truncates and L2-normalises model output; Embedding::from_preserved validates nonempty, finite input and preserves every component’s bits without truncation or normalization. A zero vector remains zero and reports normalized() == false. Derived deserialization retains its existing, unvalidated behavior.

Implementations§

Source§

impl Embedding

Source

pub fn from_raw(raw: Vec<f32>, dim: Dimension) -> Result<Embedding, Error>

Truncate a raw model output to dim leading components, then L2-normalise.

Normalising after truncation matters: a slice of a unit vector is not unit length, and skipping this silently degrades ranking.

Source

pub fn from_preserved(values: Vec<f32>) -> Result<Embedding, Error>

Restore a nonempty, finite vector without truncating or normalizing it. Every component’s bits are preserved, including signed zero and subnormals.

Source

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

Source

pub fn dim(&self) -> usize

Source

pub fn dimension(&self) -> usize

Width derived from the vector, never duplicated mutable metadata.

Source

pub fn normalized(&self) -> bool

Whether this vector has unit L2 norm (within 1e-5).

Source

pub fn into_vec(self) -> Vec<f32>

Source

pub fn cosine(&self, other: &Embedding) -> f32

Raw dot product, equal to cosine similarity only when both embeddings are L2-normalised. This method does not normalise either operand; deserialised, unnormalised vectors therefore give non-cosine values.

Trait Implementations§

Source§

impl Clone for Embedding

Source§

fn clone(&self) -> Embedding

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Embedding

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Embedding

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<Embedding, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for Embedding

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for Embedding

Source§

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Embedding

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

Source§

fn into_sample(self) -> T

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(value: T, _simd: S) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.