Struct Vector

pub struct Vector<const N: usize>(/* private fields */);

Implementations

impl<const N: usize> Vector<N>

pub fn try_from(values: Vec<f32>) -> Result<Self, Vec<f32>>

Try to create a Vector from a Vec<f32>.

Arguments

• values - The vector to create the Vector from, must be of size N.

Returns

• Ok(Vector<N>) - The Vector created from the Vec<f32>.
• Err(Vec<f32>) - The Vec<f32> is not the correct size.

Examples

use vector_lite::Vector;
let vec = vec![1.0, 2.0, 3.0];
let vector: Vector<3> = Vector::try_from(vec).unwrap();
assert_eq!(vector.into_inner(), vec![1.0, 2.0, 3.0]);

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

Get the inner vector.

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

pub fn sq_euc_dist(&self, vector: &Vector<N>) -> f32

pub fn cosine_similarity(&self, vector: &Vector<N>) -> f32

Trait Implementations

impl<'__de, const N: usize, __Context> BorrowDecode<'__de, __Context> for Vector<N>

fn borrow_decode<__D: BorrowDecoder<'__de, Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given BorrowDecode.

impl<const N: usize> Clone for Vector<N>

fn clone(&self) -> Vector<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const N: usize> Debug for Vector<N>

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

Formats the value using the given formatter.

impl<const N: usize, __Context> Decode<__Context> for Vector<N>

fn decode<__D: Decoder<Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given Decode.

impl<const N: usize> Encode for Vector<N>

fn encode<__E: Encoder>(&self, encoder: &mut __E) -> Result<(), EncodeError>

Encode a given type.

impl<const N: usize> From<[f32; N]> for Vector<N>

fn from(values: [f32; N]) -> Self

Converts to this type from the input type.

impl<const N: usize> Hash for Vector<N>

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<const N: usize> PartialEq for Vector<N>

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

Tests for self and other values to be equal, and is used by ==.

const 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<const N: usize> Eq for Vector<N>