ultra::src::multi_dataset< D > Class Template Reference

#include <multi_dataset.h>

Public Member Functions
	multi_dataset ()=default
const D &	selected () const noexcept
D &	selected () noexcept
const D &	operator[] (dataset_t) const noexcept
D &	operator[] (dataset_t) noexcept
void	select (dataset_t) noexcept

Detailed Description

template<DataSet D>
class ultra::src::multi_dataset< D >

Container for multiple datasets with a selectable active one.

Template Parameters

D	a dataset type satisfying the DataSet concept

This class groups together a fixed set of datasets (training, validation, and test) of the same type and provides convenient access to the currently selected dataset.

Constructor & Destructor Documentation

multi_dataset()

template<DataSet D>

ultra::src::multi_dataset< D >::multi_dataset ( )

default

Constructs an empty multi-dataset.

Each contained dataset is default-constructed. For typical container types, this results in empty datasets.

Member Function Documentation

operator[]() [1/2]

template<DataSet D>

const D & multi_dataset::operator[] ( dataset_t d ) const

nodiscardnoexcept

Accesses a dataset by role (const overload).

Parameters

[in]

d

the dataset role to access

Returns

a const reference to the requested dataset

Precondition

d must be a valid dataset_t value

operator[]() [2/2]

template<DataSet D>

D & multi_dataset::operator[] ( dataset_t d )

nodiscardnoexcept

Accesses a dataset by role.

Parameters

[in]

d

the dataset role to access

Returns

a reference to the requested dataset

Precondition

d must be a valid dataset_t value

select()

template<DataSet D>

void multi_dataset::select ( dataset_t d )

noexcept

Selects the active dataset.

Parameters

[in]

d

the dataset to select

Precondition

d must be a valid dataset_t value

Subsequent calls to selected() will refer to the dataset identified by d.

selected() [1/2]

template<DataSet D>

const D & multi_dataset::selected ( ) const

nodiscardnoexcept

Returns the currently selected dataset (const overload).

Returns

a const reference to the active dataset

selected() [2/2]

template<DataSet D>

D & multi_dataset::selected ( )

nodiscardnoexcept

Returns the currently selected dataset.

Returns

a reference to the active dataset

---

The documentation for this class was generated from the following files:

• multi_dataset.h
• multi_dataset.tcc