Struct InMemoryAnnDataset

pub struct InMemoryAnnDataset<DataType: Clone> { /* private fields */ }

An ANN dataset.

Implementations

impl<DataType: Clone> InMemoryAnnDataset<DataType>

pub fn create(data_points: PointSet<DataType>) -> InMemoryAnnDataset<DataType>

Creates an AnnDataset object.

Here is a simple example:

use ndarray::Array2;
use sprs::{CsMat, TriMat};
use ann_dataset::{InMemoryAnnDataset, PointSet};

let dense = Array2::<f32>::eye(10);
let mut sparse = TriMat::new((10, 4));
sparse.add_triplet(0, 0, 3.0_f32);
sparse.add_triplet(1, 2, 2.0);
sparse.add_triplet(3, 0, -2.0);
sparse.add_triplet(9, 2, 3.4);
let sparse: CsMat<_> = sparse.to_csr();

let data_points = PointSet::new(Some(dense.clone()), Some(sparse.clone()))
    .expect("Failed to create PointSet.");

let dataset = InMemoryAnnDataset::create(data_points);

Trait Implementations

impl<DataType: Clone> AnnDataset<DataType> for InMemoryAnnDataset<DataType>

fn add_query_set(&mut self, label: &str, query_set: QuerySet<DataType>)

Adds a new query set to the dataset with the given label or replaces one if it already exists.

Consider the following example:

use ndarray::Array2;
use ann_dataset::{AnnDataset, InMemoryAnnDataset, PointSet, QuerySet};

let dense = Array2::<f32>::eye(10);
let data_points = PointSet::new(Some(dense.clone()), None)
    .expect("Failed to create PointSet.");
let query_points = data_points.clone();

let mut dataset = InMemoryAnnDataset::create(data_points);

let query_set = QuerySet::new(query_points);
dataset.add_query_set("train", query_set);

fn get_data_points(&self) -> &PointSet<DataType>

Returns all data points.

fn get_data_points_mut(&mut self) -> &mut PointSet<DataType>

Returns a mutable view of all data points.

fn select(&self, ids: &[usize]) -> PointSet<DataType>

Selects a subset of data points.

fn get_query_set(&self, label: &str) -> Result<&QuerySet<DataType>>

fn add_train_query_set(&mut self, query_set: QuerySet<DataType>)

Convenience method to add a “train” query set.

fn add_validation_query_set(&mut self, query_set: QuerySet<DataType>)

Convenience method to add a “validation” query set.

fn add_test_query_set(&mut self, query_set: QuerySet<DataType>)

Convenience method to add a “test” query set.

fn get_train_query_set(&self) -> Result<&QuerySet<DataType>>

Convenience method that returns the “train” QuerySet.

fn get_validation_query_set(&self) -> Result<&QuerySet<DataType>>

Convenience method that returns the “validation” QuerySet.

fn get_test_query_set(&self) -> Result<&QuerySet<DataType>>

Convenience method that returns the “test” QuerySet.

impl<DataType: Clone + Clone> Clone for InMemoryAnnDataset<DataType>

fn clone(&self) -> InMemoryAnnDataset<DataType>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<DataType: Debug + Clone> Debug for InMemoryAnnDataset<DataType>

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

Formats the value using the given formatter.

impl<'de, DataType> Deserialize<'de> for InMemoryAnnDataset<DataType>

where DataType: Deserialize<'de> + Clone,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<DataType: Clone> Display for InMemoryAnnDataset<DataType>

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

Formats the value using the given formatter.

impl<DataType: Clone + H5Type> Hdf5File for InMemoryAnnDataset<DataType>

type Object = InMemoryAnnDataset<DataType>

fn write(&self, path: &str) -> Result<()>

Stores Object as an HDF5 file at path.

fn read(path: &str) -> Result<Self::Object>

Reads Object from HDF5 file at path.

impl<DataType: Clone + H5Type> Hdf5Serialization for InMemoryAnnDataset<DataType>

type Object = InMemoryAnnDataset<DataType>

fn add_to(&self, group: &mut Group) -> Result<()>

Adds Object to the given HDF5 group.

fn read_from(group: &Group) -> Result<Self::Object>

Deserializes group into the Object.

fn label() -> String

Returns the label of Object in the HDF5 file.

impl<DataType: PartialEq + Clone> PartialEq for InMemoryAnnDataset<DataType>

fn eq(&self, other: &InMemoryAnnDataset<DataType>) -> 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<DataType> Serialize for InMemoryAnnDataset<DataType>

where DataType: Serialize + Clone,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<DataType: Eq + Clone> Eq for InMemoryAnnDataset<DataType>

impl<DataType: Clone> StructuralPartialEq for InMemoryAnnDataset<DataType>