Struct KnnOptions 

pub struct KnnOptions {
    pub max_distance: Option<f32>,
    pub exclude_self: bool,
}

Options for a batch nearest-neighbour query.

Fields

max_distance: Option<f32>

Largest Euclidean distance reported; farther targets leave the slot empty.

exclude_self: bool

Skip the query atom itself (and, when periodic, its own images).

Implementations

impl KnnOptions

pub fn for_queries( max_distance: Option<f32>, exclude_self: Option<bool>, separate_queries: bool, ) -> Self

Options for a table query: exclude_self defaults to true when the points query themselves and to false when separate queries are given.

Trait Implementations

impl Clone for KnnOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for KnnOptions

impl Debug for KnnOptions

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

Formats the value using the given formatter.

impl Default for KnnOptions

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for KnnOptions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for KnnOptions