echelon  0.8.0
Public Member Functions | Friends | List of all members
echelon::hdf5::slice Class Reference

A slice (rectangular portion) of an HDF5 dataset. More...

#include <slice.hpp>

Public Member Functions

template<typename T >
void operator<<= (const T &source)
 Writes the content of a data source into the slice. More...
 
template<typename T >
void operator<<= (const array_slice< T > &source)
 Writes the content of an array slice into the slice. More...
 
const std::vector< hsize_t > & shape () const
 The shape of the slice.
 

Friends

template<typename T >
void operator<<= (T &sink, const slice &source)
 Reads the content of the slice into a data sink. More...
 
template<typename T >
void operator<<= (const array_slice< T > &sink, const slice &source)
 Reads the content of the slice into an array slice. More...
 

Detailed Description

A slice (rectangular portion) of an HDF5 dataset.

Member Function Documentation

template<typename T >
void echelon::hdf5::slice::operator<<= ( const T &  source)
inline

Writes the content of a data source into the slice.

The shape of the data source must match the shape of the slice.

Template Parameters
Ttype of the container; T must satisfy the data source requirements.
Parameters
sourcethe data source
template<typename T >
void echelon::hdf5::slice::operator<<= ( const array_slice< T > &  source)
inline

Writes the content of an array slice into the slice.

The shape of the array must match the shape of the slice.

Template Parameters
Tvalue type of the array slice
Parameters
sourcethe array slice

Friends And Related Function Documentation

template<typename T >
void operator<<= ( T &  sink,
const slice source 
)
friend

Reads the content of the slice into a data sink.

Template Parameters
Ttype of the container; T must satisfy the data sink requirements.
Parameters
sinkthe data sink
sourcethe slice, which is used as a source
template<typename T >
void operator<<= ( const array_slice< T > &  sink,
const slice source 
)
friend

Reads the content of the slice into an array slice.

Template Parameters
Ttype of the container; T must satisfy the data sink requirements.
Parameters
sinkthe data sink
sourcethe slice, which is used as a source

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