pub struct QuerySet<DataType: Clone> { /* private fields */ }
Expand description
A set of query points (dense, sparse, or both) and their exact nearest neighbors for various metrics.
Implementations§
Source§impl<DataType: Clone> QuerySet<DataType>
impl<DataType: Clone> QuerySet<DataType>
Sourcepub fn new(points: PointSet<DataType>) -> QuerySet<DataType>
pub fn new(points: PointSet<DataType>) -> QuerySet<DataType>
Creates a new QuerySet from a set of query points.
Sourcepub fn get_points(&self) -> &PointSet<DataType>
pub fn get_points(&self) -> &PointSet<DataType>
Returns the set of query points.
Sourcepub fn add_ground_truth(
&mut self,
metric: Metric,
neighbors: Array2<usize>,
) -> Result<()>
pub fn add_ground_truth( &mut self, metric: Metric, neighbors: Array2<usize>, ) -> Result<()>
Adds a set of exact nearest neighbors to the query set, as solutions to ANN with the given metric.
Returns an error if the number of rows in neighbors
does not match the number of query
points.
Sourcepub fn get_ground_truth(&self, metric: &Metric) -> Result<&GroundTruth>
pub fn get_ground_truth(&self, metric: &Metric) -> Result<&GroundTruth>
Returns the set of exact nearest neighbors for ANN search with the given metric; or an error if the query set does not have the solution.
Trait Implementations§
Source§impl<'de, DataType> Deserialize<'de> for QuerySet<DataType>where
DataType: Deserialize<'de> + Clone,
impl<'de, DataType> Deserialize<'de> for QuerySet<DataType>where
DataType: Deserialize<'de> + Clone,
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
impl<DataType: Eq + Clone> Eq for QuerySet<DataType>
impl<DataType: Clone> StructuralPartialEq for QuerySet<DataType>
Auto Trait Implementations§
impl<DataType> Freeze for QuerySet<DataType>
impl<DataType> RefUnwindSafe for QuerySet<DataType>where
DataType: RefUnwindSafe,
impl<DataType> Send for QuerySet<DataType>where
DataType: Send,
impl<DataType> Sync for QuerySet<DataType>where
DataType: Sync,
impl<DataType> Unpin for QuerySet<DataType>where
DataType: Unpin,
impl<DataType> UnwindSafe for QuerySet<DataType>where
DataType: RefUnwindSafe + UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self
from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self
is actually part of its subset T
(and can be converted to it).Source§unsafe fn to_subset_unchecked(&self) -> SS
unsafe fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset
but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self
to the equivalent element of its superset.