CompositeDataResult

CompositeDataResult

#include <sbio/core/result.hh>

template<typename MemTag = ncarray::HostTag>
struct CompositeDataResult

Defined in src/lib/sbio/core/result.hh:87

An organized result returned from a BrokerGroup managing one or more brokers.

The BrokerGroup will return an organized data set that may contain data from multiple segment references, which may be managed by multiple StreamBrokers. If reading in batch, the final composite result may also have an access that corresponds to the number of steps in the batch.

Template Parameters

• MemTag Identifier for the location of the underlying memory (CPU or GPU).

List of all members

Name	Kind	Owner
data	variable	Declared here
num_segments	variable	Declared here
batch_count	variable	Declared here
segment_rank	variable	Declared here
segment_shape	variable	Declared here
dtype	variable	Declared here
to_array	function	Declared here

Public Attributes

Return	Name	Description
const void **	data	Pointer table of SegmentRef results.
hd_std::size_t	num_segments	The number of SegmentRef’s in the result.
hd_std::size_t	batch_count	The number of individaul steps/events.
hd_std::uint16_t	segment_rank	The rank of the DataResult returned by a StreamBroker.
hd_std::array< hd_std::uint32_t, SBIO_MAX_NDIM >	segment_shape	Shape of an individual result from a StreamBroker.
ncarray::DType	dtype

---

data

const void ** data { nullptr }

Defined in src/lib/sbio/core/result.hh:88

Pointer table of SegmentRef results.

---

num_segments

hd_std::size_t num_segments { 0 }

Defined in src/lib/sbio/core/result.hh:89

The number of SegmentRef’s in the result.

---

batch_count

hd_std::size_t batch_count { 1 }

Defined in src/lib/sbio/core/result.hh:90

The number of individaul steps/events.

---

segment_rank

hd_std::uint16_t segment_rank { 0 }

Defined in src/lib/sbio/core/result.hh:98

The rank of the DataResult returned by a StreamBroker.

When organizing the composite result into an array, the final rank will have 1 (or 2, if using batched reads) more dimensions.

---

segment_shape

hd_std::array< hd_std::uint32_t, SBIO_MAX_NDIM > segment_shape {}

Defined in src/lib/sbio/core/result.hh:102

Shape of an individual result from a StreamBroker.

---

dtype

ncarray::DType dtype { ncarray::DType::uint8 }

Defined in src/lib/sbio/core/result.hh:103

Public Methods

Return	Name	Description
SBIO_HD ncarray::SOViewFor< MemTag >	to_array const inline

---

to_array

const inline

inline SBIO_HD ncarray::SOViewFor< MemTag > to_array() const

Defined in src/lib/sbio/core/result.hh:105