 |
ImFusion SDK 4.3
|
|
ImFusion SDK 4.3
|
#include <ImFusion/ML/DataLoaders/ShuffleDataLoader.h>
Shuffles the next specified items in the nested loader. More...
Inheritance diagram for ShuffleDataLoader:Shuffles the next specified items in the nested loader.
If the number of next items is not specified, it shuffles the entire nested loader
Public Member Functions | |
| ShuffleDataLoader (std::unique_ptr< DataLoader > loader, int shuffleBuffer=-1, int seed=-1, bool verbose=false) | |
| Constructs the shuffling by specifying how many next items to shuffle, and optionally seeding it. | |
| ShuffleDataLoader (DataLoaderList dataLoaders, const Properties &prop) | |
| std::optional< DataItem > | next () override |
| Advance the loader by one iteration. | |
| std::optional< size_t > | size () const override |
| Size of the loader, has value only for fixed cardinalities. | |
| void | reset () override |
| Reset the loader in order to restart the iteration. | |
| void | configure (const Properties *properties) override |
| Configure this object instance by de-serializing the given Properties. | |
| Public Member Functions inherited from DataLoader | |
| DataLoader (std::string name, bool verbose=false) | |
| Constructor to be used by DataReaders, as they are the first elements in the chain. | |
| DataLoader (std::string name, std::unique_ptr< DataLoader > loader, bool verbose=false) | |
| Constructor to be used by all other derived DataLoaders. | |
| DataLoader (std::string name, DataLoaderList &&dataLoaders, bool verbose=false) | |
| Constructor to be used by all other derived DataLoaders. | |
| const std::string & | name () const |
| Name of the loader. | |
| virtual void | reinit () |
| Reinitialize the loader state, cleaning it up if necessary Overload this method if your loader has state that must survive reset (i.e. | |
| virtual Cardinality | cardinality () const |
| Cardinality of this specific loader node. | |
| DataLoader * | singleUnderlyingLoader () const |
| Return a single underlying dataloader Expects there to be only one, returns a nullptr otherwise. | |
| std::unique_ptr< DataLoader > | extractDataloader () |
| Return a single underlying dataloader Expects there to be only one, throws an exception otherwise. | |
| DataLoaderList & | loaders () |
| DataLoaderList const & | loaders () const |
| bool | verbose () const |
| virtual void | setRandomSeed (unsigned int seed) |
| virtual Status | canBePrefetched () const |
| Indicates whether a loader is eligible for prefetching. | |
| const std::string & | logDomain () const |
| Log domain for AdvancedParameter. | |
| Public Member Functions inherited from Configurable | |
| virtual void | configuration (Properties *p) const |
| Serialize the current object configuration into the given Properties object. | |
| virtual void | configureDefaults () |
| Retrieve the properties of this object, replaces values with their defaults and sets it again. | |
| void | registerParameter (ParameterBase *param) |
| Register the given Parameter or SubProperty, so that it will be configured during configure()/configuration(). | |
| void | unregisterParameter (const ParameterBase *param) |
| Remove the given Parameter or SubProperty from the list of registered parameters. | |
| Configurable (const Configurable &rhs) | |
| Configurable (Configurable &&rhs) noexcept | |
| Configurable & | operator= (const Configurable &) |
| Configurable & | operator= (Configurable &&) noexcept |
Additional Inherited Members | |
| Public Attributes inherited from DataLoader | |
| LoaderParam< bool > | m_verbose = {"verbose", false, this, ParamRequired::No} |
| If enabled, print log messages with extra information like timings. | |
| Public Attributes inherited from Configurable | |
| Signal | signalParametersChanged |
Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted. | |
| Protected Member Functions inherited from NotCopyable | |
| NotCopyable (NotCopyable &&) noexcept=default | |
| NotCopyable & | operator= (NotCopyable &&) noexcept=default |
| NotCopyable (const NotCopyable &)=delete | |
| NotCopyable & | operator= (const NotCopyable &)=delete |
| Protected Attributes inherited from DataLoader | |
| std::string | m_name |
| Cardinality | m_cardinality = Cardinality::Fixed |
| Random::Generator | m_randGenerator |
| DataLoaderList | m_dataLoaders |
| Protected Attributes inherited from Configurable | |
| std::vector< Param > | m_params |
| List of all registered Parameter and SubProperty instances. | |
|
explicit |
Constructs the shuffling by specifying how many next items to shuffle, and optionally seeding it.
| loader | previous loader |
| shuffleBuffer | size of the buffer used to cache and shuffle |
| seed | seed for the random generator used to shuffle |
| DataLoaderException | if the nested loader is infinite and the number of items is not specified. |
|
overridevirtual |
Advance the loader by one iteration.
The function must pull an item from the underlying node, process it and return it. If the underlyng loader is exhausted, returns an empty optional.
Implements DataLoader.
|
overridevirtual |
Size of the loader, has value only for fixed cardinalities.
Implements DataLoader.
|
overridevirtual |
Reset the loader in order to restart the iteration.
Reimplemented from DataLoader.
|
overridevirtual |
Configure this object instance by de-serializing the given Properties.
The default implementation will do so automatically for all registered Parameter and SubProperty instances.
Reimplemented from DataLoader.
