Struct HnswParams

#[non_exhaustive]
pub struct HnswParams {
    pub dimension: u16,
    pub distance: Distance,
    pub vector_type: VectorType,
    pub m: u8,
    pub m0: u8,
    pub ef_construction: u16,
    pub extend_candidates: bool,
    pub keep_pruned_connections: bool,
    pub ml: Number,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

dimension: u16

distance: Distance

vector_type: VectorType

m: u8

m0: u8

ef_construction: u16

extend_candidates: bool

keep_pruned_connections: bool

ml: Number

Implementations

impl HnswParams

pub fn new( dimension: u16, distance: Distance, vector_type: VectorType, m: u8, m0: u8, ml: Number, ef_construction: u16, extend_candidates: bool, keep_pruned_connections: bool, ) -> Self

Trait Implementations

impl Clone for HnswParams

fn clone(&self) -> HnswParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HnswParams

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HnswParams

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for HnswParams

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 PartialEq for HnswParams

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

fn partial_cmp(&self, other: &HnswParams) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Revisioned for HnswParams

fn revision() -> u16

Returns the current revision of this type.

fn serialize_revisioned<W: Write>(&self, writer: &mut W) -> Result<(), Error>

Serializes the struct using the specficifed writer.

fn deserialize_revisioned<R: Read>(reader: &mut R) -> Result<Self, Error>

Deserializes a new instance of the struct from the specficifed reader.

fn type_id() -> TypeId

where Self: 'static,

Returns the type id of this type.

impl Serialize for HnswParams

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for HnswParams

impl StructuralPartialEq for HnswParams