Struct VectorRef 

pub struct VectorRef<'a>(/* private fields */);

A borrowed dense vector of f32 components.

A zero-copy view over a &[f32], for passing query vectors without taking ownership. It is Copy. With the serde feature it derives Serialize only — a borrowed view cannot be deserialized into, since there is nowhere to own the decoded data.

Examples

use iqdb_types::VectorRef;

let data = [1.0, 0.0, 0.0];
let v = VectorRef::from(&data[..]);
assert_eq!(v.dim(), 3);
assert_eq!(v.as_slice(), &[1.0, 0.0, 0.0]);

Implementations

impl<'a> VectorRef<'a>

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

Borrows the components as a slice.

Examples

use iqdb_types::VectorRef;

let data = [0.5, 0.5];
assert_eq!(VectorRef::from(&data[..]).as_slice(), &[0.5, 0.5]);

pub fn len(&self) -> usize

Returns the number of components.

Examples

use iqdb_types::VectorRef;

let data = [1.0, 2.0];
assert_eq!(VectorRef::from(&data[..]).len(), 2);

pub fn is_empty(&self) -> bool

Returns true if the view has no components.

Examples

use iqdb_types::VectorRef;

let empty: [f32; 0] = [];
assert!(VectorRef::from(&empty[..]).is_empty());

pub fn dim(&self) -> usize

Returns the dimensionality of the view (its component count).

Examples

use iqdb_types::VectorRef;

let data = [1.0, 2.0, 3.0];
assert_eq!(VectorRef::from(&data[..]).dim(), 3);

pub fn into_inner(self) -> &'a [f32]

Returns the borrowed slice with its original lifetime.

Examples

use iqdb_types::VectorRef;

let data = [1.0, 2.0];
let v = VectorRef::from(&data[..]);
let slice: &[f32] = v.into_inner();
assert_eq!(slice, &[1.0, 2.0]);

Trait Implementations

impl<'a> Clone for VectorRef<'a>

fn clone(&self) -> VectorRef<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for VectorRef<'a>

impl<'a> Debug for VectorRef<'a>

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

Formats the value using the given formatter.

impl<'a> From<&'a [f32]> for VectorRef<'a>

fn from(data: &'a [f32]) -> Self

Converts to this type from the input type.

impl<'a> PartialEq for VectorRef<'a>

fn eq(&self, other: &VectorRef<'a>) -> 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<'a> Serialize for VectorRef<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> StructuralPartialEq for VectorRef<'a>