A structure storing details about the matrix. More...

#include <MatrixRecord.h>

Collaboration diagram for MatrixRecord:

[legend]

Public Types
enum	MatrixType { MatrixType::kReal, MatrixType::kComplex, MatrixType::kIndex, MatrixType::kFftw }
	All possible types of the matrix. More...

Public Member Functions
	MatrixRecord ()
	Default constructor. More...

	MatrixRecord (const MatrixRecord &src)
	Copy constructor. More...

MatrixRecord &	operator= (const MatrixRecord &src)
	operator = More...

void	set (const MatrixType matrixType, const DimensionSizes dimensionSizes, const bool loadData, const bool checkpoint, MatrixName &matrixName)
	Set all values for the record. More...

Public Attributes
BaseMatrix *	matrixPtr
	Pointer to the matrix object.

MatrixType	matrixType
	Matrix data type.

DimensionSizes	dimensionSizes
	Matrix dimension sizes.

bool	loadData
	Is the matrix content loaded from the HDF5 file?

bool	checkpoint
	Is the matrix necessary to be preserver when checkpoint is enabled?

std::string	matrixName
	Matrix name in the HDF5 file.

Detailed Description

A structure storing details about the matrix. The matrix container stores the list of these records - metadata and pointer to the matrix.

Definition at line 47 of file MatrixRecord.h.

Member Enumeration Documentation

◆ MatrixType

enum MatrixRecord::MatrixType

strong

Enumerator
kReal	Matrix for real values.
kComplex	Matrix for complex values.
kIndex	Matrix for index values.
kFftw	Matrix for FFTW.

Definition at line 53 of file MatrixRecord.h.

Constructor & Destructor Documentation

◆ MatrixRecord() [1/2]

MatrixRecord::MatrixRecord ( )

Default constructor.

Definition at line 48 of file MatrixRecord.cpp.

◆ MatrixRecord() [2/2]

MatrixRecord::MatrixRecord ( const MatrixRecord & src )

Copy constructor of TMatrixRecord.

Definition at line 63 of file MatrixRecord.cpp.

Member Function Documentation

◆ operator=()

MatrixRecord & MatrixRecord::operator= ( const MatrixRecord & src )

operator =

Definition at line 78 of file MatrixRecord.cpp.

◆ set()

void MatrixRecord::set	(	const MatrixType	matrixType,
		const DimensionSizes	dimensionSizes,
		const bool	loadData,
		const bool	checkpoint,
		MatrixName &	matrixName
	)

Parameters

[in]	matrixType	- Matrix data type.
[in]	dimensionSizes	- Dimension sizes.
[in]	loadData	- Load data from file?
[in]	checkpoint	- Checkpoint this matrix?
[in]	matrixName	- HDF5 matrix name.

Set all values for the record.

Definition at line 97 of file MatrixRecord.cpp.

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

Containers/MatrixRecord.h
Containers/MatrixRecord.cpp

Public Types

Public Member Functions

Public Attributes