Trait AnnDataset

pub trait AnnDataset<DataType: Clone> {
    // Required methods
    fn get_data_points(&self) -> &PointSet<DataType>;
    fn get_data_points_mut(&mut self) -> &mut PointSet<DataType>;
    fn select(&self, ids: &[usize]) -> PointSet<DataType>;
    fn add_query_set(&mut self, label: &str, query_set: QuerySet<DataType>);
    fn get_query_set(&self, label: &str) -> Result<&QuerySet<DataType>>;

    // Provided methods
    fn add_train_query_set(&mut self, query_set: QuerySet<DataType>) { ... }
    fn add_validation_query_set(&mut self, query_set: QuerySet<DataType>) { ... }
    fn add_test_query_set(&mut self, query_set: QuerySet<DataType>) { ... }
    fn get_train_query_set(&self) -> Result<&QuerySet<DataType>> { ... }
    fn get_validation_query_set(&self) -> Result<&QuerySet<DataType>> { ... }
    fn get_test_query_set(&self) -> Result<&QuerySet<DataType>> { ... }
}

Required Methods

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 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.

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

Provided Methods

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.

Implementors

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