ZippedBatchRange

#include <sbio/core/iteration.hh>

template<class DS, class... Groups>
class ZippedBatchRange

Defined in src/lib/sbio/core/iteration.hh:589

Iterate contiguous step batches of a DataSource with fetches over a set of BrokerGroups.

Equivalent to the [ZippedGroupRange](api-sbio-ZippedGroupRange.md#zippedgrouprange) but for the batched API calls.

Each parallel executing unit (e.g. a thread or rank, etc.) iterating will setup its own range-based for loop (for (auto batch : zip_batches(ds, bg1, bg2)) {}).

Template Parameters

DS The DataSource type (const or non-const).
Groups The BrokerGroup types, all created from the DataSource.

Public Methods

Return	Name	Description
`SBIO_HD`	`ZippedBatchRange` `inline`
	`ZippedBatchRange`	Deleted constructor.
`ZippedBatchRange` &	`operator=`	Deleted assignment operator.
`SBIO_HDConstIterator`	`begin` `const` `inline`	Return an iterator at the first batch for this unit, with its data fetched.
`SBIO_HDConstIterator`	`end` `const` `inline`
`SBIO_HDConstIterator`	`cbegin` `const` `inline`
`SBIO_HDConstIterator`	`cend` `const` `inline`
`SBIO_HD` hd_std::size_t	`num_fetches` `const` `inline`	The number of distinct fetches performed per batch.

ZippedBatchRange

inline

inline SBIO_HD ZippedBatchRange(DS & ds, const Groups &... groups)

Defined in src/lib/sbio/core/iteration.hh:598

ZippedBatchRange

ZippedBatchRange(const ZippedBatchRange &) = delete

Defined in src/lib/sbio/core/iteration.hh:603

Deleted constructor.

operator=

ZippedBatchRange & operator=(const ZippedBatchRange &) = delete

Defined in src/lib/sbio/core/iteration.hh:604

Deleted assignment operator.

begin

const inline

inline SBIO_HDConstIterator begin() const

Defined in src/lib/sbio/core/iteration.hh:661

Return an iterator at the first batch for this unit, with its data fetched.

end

const inline

inline SBIO_HDConstIterator end() const

Defined in src/lib/sbio/core/iteration.hh:664

cbegin

const inline

inline SBIO_HDConstIterator cbegin() const

Defined in src/lib/sbio/core/iteration.hh:668

cend

const inline

inline SBIO_HDConstIterator cend() const

Defined in src/lib/sbio/core/iteration.hh:669

num_fetches

const inline

inline SBIO_HD hd_std::size_t num_fetches() const

Defined in src/lib/sbio/core/iteration.hh:674

The number of distinct fetches performed per batch.

Public Types

Name	Description
`StepIdxType`
`FTraits`
`ExecutionPolicy`
`BatchRange`
`BatchIt`
`FetchPlan`
`Iterator`
`ConstIterator`

StepIdxType

using StepIdxType = typename hd_std::remove_const_t< DS >::StepIdxType

Defined in src/lib/sbio/core/iteration.hh:591

FTraits

using FTraits = typename hd_std::remove_const_t< DS >::DataFormat

Defined in src/lib/sbio/core/iteration.hh:592

ExecutionPolicy

using ExecutionPolicy = typename hd_std::remove_const_t< DS >::ExecutionPolicy

Defined in src/lib/sbio/core/iteration.hh:593

BatchRange

using BatchRange = decltype(hd_std::declval< DS & >().batches())

Defined in src/lib/sbio/core/iteration.hh:594

BatchIt

using BatchIt = decltype(hd_std::declval< const BatchRange & >().begin())

Type: decltype(hd_std::declval< const BatchRange & >().begin())

Defined in src/lib/sbio/core/iteration.hh:595

FetchPlan

using FetchPlan = impl::ZipFetchPlan< ExecutionPolicy, FTraits, Groups... >

Type: impl::ZipFetchPlan< ExecutionPolicy, FTraits, Groups… >

Defined in src/lib/sbio/core/iteration.hh:596

Iterator

using Iterator = IteratorImpl< FetchPlan >

Type: IteratorImpl< FetchPlan >

Defined in src/lib/sbio/core/iteration.hh:653

ConstIterator

using ConstIterator = IteratorImpl< const FetchPlan >

Type: IteratorImpl< const FetchPlan >

Defined in src/lib/sbio/core/iteration.hh:654

Private Attributes

Return	Name	Description
`BatchRange`	`m_batches`
`FetchPlan`	`m_plan`

m_batches

BatchRange m_batches

Type: BatchRange

Defined in src/lib/sbio/core/iteration.hh:677

m_plan

FetchPlan m_plan

Type: FetchPlan

Defined in src/lib/sbio/core/iteration.hh:678