BioCMAMC-ST
Core::DataExporter::MultiMatrixDescription Struct Reference

Describes the properties of a multi-dimensional matrix for export operations. More...

#include <data_exporter.hpp>

Public Attributes

std::string name
 Dataset name.
 
std::vector< size_t > dims
 Dataset dimensions.
 
std::vector< size_t > max_dims
 Expected dataset max dimensions.
 
std::optional< std::vector< unsigned long long > > chunk_dims
 Data chunk along each dimension.
 
bool compression
 Matrix data has to be compressed or not.
 
bool is_integer
 Matrix data is integer type or floating point.
 

Detailed Description

Describes the properties of a multi-dimensional matrix for export operations.

This structure holds the necessary metadata required to define and manage a matrix, including its dimensions, maximum dimensions, chunking options, and data type characteristics. It is used when preparing or working with matrices within the DataExporter class.

Member Data Documentation

◆ chunk_dims

std::optional<std::vector<unsigned long long> > Core::DataExporter::MultiMatrixDescription::chunk_dims

Data chunk along each dimension.

◆ compression

bool Core::DataExporter::MultiMatrixDescription::compression

Matrix data has to be compressed or not.

◆ dims

std::vector<size_t> Core::DataExporter::MultiMatrixDescription::dims

Dataset dimensions.

◆ is_integer

bool Core::DataExporter::MultiMatrixDescription::is_integer

Matrix data is integer type or floating point.

◆ max_dims

std::vector<size_t> Core::DataExporter::MultiMatrixDescription::max_dims

Expected dataset max dimensions.

◆ name

std::string Core::DataExporter::MultiMatrixDescription::name

Dataset name.


The documentation for this struct was generated from the following file: