burn_dataset::transform

Struct WindowsDataset

Source 
pub struct WindowsDataset<D, I> {
    pub size: NonZeroUsize,
    /* private fields */
}
Expand description

Dataset designed to work with overlapping windows of data.

Fields§

§size: NonZeroUsize

The size of the windows.

Implementations§

Source§

impl<D, I> WindowsDataset<D, I>
where D: Dataset<I>,

Source

pub fn new(dataset: D, size: usize) -> Self
where D:,

Creates a new WindowsDataset instance. The windows overlap. Is empty if the input Dataset is shorter than size.

§Parameters
  • dataset: The dataset over which windows will be created.
  • size: The size of the windows.

Trait Implementations§

Source§

impl<D, I> Dataset<Vec<I>> for WindowsDataset<D, I>
where D: Dataset<I>, I: Clone + Send + Sync,

Source§

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

Retrieves a window of items from the dataset.

§Parameters
  • index: The index of the window.
§Returns

A vector representing the window.

Source§

fn len(&self) -> usize

Retrieves the number of windows in the dataset.

§Returns

A size representing the number of windows.

Source§

fn is_empty(&self) -> bool

Checks if the dataset is empty.
Source§

fn iter(&self) -> DatasetIterator<'_, I> ⓘ
where Self: Sized,

Returns an iterator over the dataset.

Auto Trait Implementations§

§

impl<D, I> Freeze for WindowsDataset<D, I>
where D: Freeze,

§

impl<D, I> RefUnwindSafe for WindowsDataset<D, I>
where D: RefUnwindSafe, I: RefUnwindSafe,

§

impl<D, I> Send for WindowsDataset<D, I>
where D: Send, I: Send,

§

impl<D, I> Sync for WindowsDataset<D, I>
where D: Sync, I: Sync,

§

impl<D, I> Unpin for WindowsDataset<D, I>
where D: Unpin, I: Unpin,

§

impl<D, I> UnwindSafe for WindowsDataset<D, I>
where D: UnwindSafe, I: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<I, T> Window<I> for T
where T: Dataset<I> + ?Sized,

Source§

fn window(&self, current: usize, size: NonZero<usize>) -> Option<Vec<I>>

Creates a window of a collection. Read more
Source§

impl<I, T> Windows<I> for T
where T: Dataset<I>,

Source§

fn windows(&self, size: usize) -> WindowsIterator<'_, I> ⓘ

Is empty if the Dataset is shorter than size.

§Panics

Panics if size is 0.

§Examples
use crate::burn_dataset::{
   transform::{Windows, WindowsDataset},
   Dataset, InMemDataset,
};

let items = [1, 2, 3, 4].to_vec();
let dataset = InMemDataset::new(items.clone());

for window in dataset.windows(2) {
 // do sth with window
}