Struct SelectionDataset

pub struct SelectionDataset<D, I>
where
    D: Dataset<I>,
    I: Clone + Send + Sync,
{
    pub wrapped: Arc<D>,
    pub indices: Vec<usize>,
    /* private fields */
}

A dataset that selects a subset of indices from an existing dataset.

Indices may appear multiple times, but they must be within the bounds of the original dataset.

Fields

wrapped: Arc<D>

The wrapped dataset from which to select indices.

indices: Vec<usize>

The indices to select from the wrapped dataset.

Implementations

impl<D, I> SelectionDataset<D, I>

where D: Dataset<I>, I: Clone + Send + Sync,

pub fn from_indices_checked<S>( dataset: S, indices: Vec<usize>, ) -> SelectionDataset<D, I>

where S: Into<Arc<D>>,

Creates a new selection dataset with the given dataset and indices.

Checks that all indices are within the bounds of the dataset.

Arguments

• dataset - The original dataset to select from.
• indices - A slice of indices to select from the dataset. These indices must be within the bounds of the dataset.

Panics

Panics if any index is out of bounds for the dataset.

pub fn from_indices_unchecked<S>( dataset: S, indices: Vec<usize>, ) -> SelectionDataset<D, I>

where S: Into<Arc<D>>,

Creates a new selection dataset with the given dataset and indices without checking bounds.

Arguments

• dataset - The original dataset to select from.
• indices - A vector of indices to select from the dataset.

Safety

This function does not check if the indices are within the bounds of the dataset.

pub fn new_select_all<S>(dataset: S) -> SelectionDataset<D, I>

where S: Into<Arc<D>>,

Creates a new selection dataset that selects all indices from the dataset.

This allocates a 1-to-1 mapping of indices to the dataset size, essentially functioning as a no-op selection. This is only useful when the dataset will later be shuffled or transformed in place.

Arguments

• dataset - The original dataset to select from.

Returns

A new SelectionDataset that selects all indices from the dataset.

pub fn new_shuffled<S, R>(dataset: S, rng_source: R) -> SelectionDataset<D, I>

where S: Into<Arc<D>>, R: Into<RngSource>,

Creates a new selection dataset with shuffled indices.

Selects every index of the dataset and shuffles them with randomness from the provided random number generator.

Arguments

• dataset - The original dataset to select from.
• rng - A mutable reference to a random number generator.

Returns

A new SelectionDataset with shuffled indices.

pub fn shuffle<R>(&mut self, rng_source: R)

where R: Into<RngSource>,

Shuffles the indices of the dataset using a mutable random number generator.

This method modifies the dataset in place, shuffling the indices.

Arguments

• rng - A mutable reference to a random number generator.

pub fn slice(&self, start: usize, end: usize) -> SelectionDataset<D, I>

Creates a new dataset that is a slice of the current selection dataset.

Slices the selection indices from [start..end].

Independent of future shuffles on the parent, but shares the same wrapped dataset.

Arguments

• start - The start of the range.
• end - The end of the range (exclusive).

pub fn split(&self, num: usize) -> Vec<SelectionDataset<D, I>>

Split into num datasets by slicing the selection indices evenly.

Split is done via slice, so the datasets share the same wrapped dataset.

Independent of future shuffles on the parent, but shares the same wrapped dataset.

Arguments

• num - The number of datasets to split into.

Returns

A vector of SelectionDataset instances, each containing a subset of the indices.

Trait Implementations

impl<D, I> Clone for SelectionDataset<D, I>

where D: Clone + Dataset<I>, I: Clone + Send + Sync,

fn clone(&self) -> SelectionDataset<D, I>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<D, I> Dataset<I> for SelectionDataset<D, I>

where D: Dataset<I>, I: Clone + Send + Sync,

fn get(&self, index: usize) -> Option<I>

Gets the item at the given index.

fn len(&self) -> usize

Gets the number of items in the dataset.

fn is_empty(&self) -> bool

Checks if the dataset is empty.

fn iter(&self) -> DatasetIterator<'_, I>

where Self: Sized,

Returns an iterator over the dataset.