Struct faiss::index::Idx

#[repr(transparent)]
pub struct Idx(_);

Primitive data type for identifying a vector in an index (or lack thereof).

Depending on the kind of index, it may be possible for vectors to share the same ID.

Implementations

impl Idx

pub fn new(idx: u64) -> Self

Create a vector identifier.

Panic

Panics if the ID is too large (>= 2^63)

pub fn none() -> Self

Create an identifier referring to no vector.

pub fn is_none(self) -> bool

Check whether the vector identifier does not point to anything.

pub fn is_some(self) -> bool

Check whether the vector identifier is not “none”.

pub fn get(self) -> Option<u64>

Retrieve the vector identifier as a primitive unsigned integer.

pub fn to_native(self) -> idx_t

Convert the vector identifier into a native idx_t value.

Trait Implementations

impl Clone for Idx

fn clone(&self) -> Idx

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Idx

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

Formats the value using the given formatter.

impl Display for Idx

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

Formats the value using the given formatter.

impl From<i64> for Idx

fn from(x: idx_t) -> Self

Converts to this type from the input type.

impl PartialEq<Idx> for Idx

This comparison is not entirely reflexive: it returns always false if at least one of the values is a none.

fn eq(&self, idx: &Idx) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<Idx> for Idx

This comparison is not entirely reflexive: it returns always None if at least one of the values is a none.

fn partial_cmp(&self, idx: &Idx) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Idx