ValueMapLoader Class Reference

#include <ValueMapLoader.h>

Inheritance diagram for ValueMapLoader:

Public Member Functions
	ValueMapLoader (const ValueMap &value_map, Size batch_dim)
std::size_t	total () const override
	Total (fixed) number of batches that will be generated.
Public Member Functions inherited from FixedSizeWorkGenerator< ValueMap >
bool	has_more () const override
	Whether the generator has more work to generate.
Public Member Functions inherited from WorkGenerator< ValueMap >
	WorkGenerator ()=default
	WorkGenerator (WorkGenerator &&) noexcept=default
	WorkGenerator (const WorkGenerator &)=default
WorkGenerator &	operator= (WorkGenerator &&) noexcept=default
WorkGenerator &	operator= (const WorkGenerator &)=default
virtual	~WorkGenerator ()=default
std::pair< std::size_t, ValueMap >	next (std::size_t n)
	Generate the next n batches of work.
std::size_t	offset () const
	Return the current offset, i.e., the number of batches that have been generated.

Protected Member Functions
std::pair< std::size_t, ValueMap >	generate (std::size_t n) override
	Generate the next n batches of work.

Constructor & Destructor Documentation

ValueMapLoader()

ValueMapLoader	(	const ValueMap &	value_map,
		Size	batch_dim )

Member Function Documentation

generate()

std::pair< std::size_t, ValueMap > generate ( std::size_t n )

overrideprotectedvirtual

Generate the next n batches of work.

Note that in the case of insufficient remaining work, it is possible that the number of batches generated is less than n.

Parameters

n	Number of batches to generate

Returns

std::pair<std::size_t, T> Number of batches generated (m) and the next m batches of work

Implements WorkGenerator< ValueMap >.

total()

std::size_t total ( ) const

overridevirtual

Total (fixed) number of batches that will be generated.

Implements FixedSizeWorkGenerator< ValueMap >.