BaseMatrix Class Reference

Abstract base class. The common ancestor defining the common interface and allowing derived classes to be allocated, freed and loaded from the file using the Matrix container. More...

#include <BaseMatrix.h>

Inheritance diagram for BaseMatrix:

Public Member Functions
	BaseMatrix ()
	Default constructor.
	BaseMatrix (const BaseMatrix &)=delete
	Copy constructor is not allowed.
virtual	~BaseMatrix ()
	Destructor.
BaseMatrix &	operator= (const BaseMatrix &)=delete
	Operator= is not allowed.
virtual const DimensionSizes &	getDimensionSizes () const =0
	Get dimension sizes of the matrix. More...
virtual size_t	size () const =0
	Size of the matrix. More...
virtual size_t	capacity () const =0
	The capacity of the matrix (this may differ from size due to padding, etc.). More...
virtual void	readData (Hdf5File &file, MatrixName &matrixName)=0
	Read matrix from HDF5 file. More...
virtual void	writeData (Hdf5File &file, MatrixName &matrixName, const size_t compressionLevel)=0
	Write data into HDF5 file. More...

Detailed Description

Abstract base class. The common ancestor defining the common interface and allowing derived classes to be allocated, freed and loaded from the file using the Matrix container. The I/O is done via HDF5 files.

Definition at line 48 of file BaseMatrix.h.

Member Function Documentation

capacity()

virtual size_t BaseMatrix::capacity ( ) const

pure virtual

Returns

Capacity of the currently allocated storage.

Implemented in BaseIndexMatrix, and BaseFloatMatrix.

getDimensionSizes()

virtual const DimensionSizes& BaseMatrix::getDimensionSizes ( ) const

pure virtual

Returns

Dimension sizes of the matrix.

Implemented in BaseIndexMatrix, and BaseFloatMatrix.

readData()

virtual void BaseMatrix::readData ( Hdf5File &  file, MatrixName &  matrixName  )

pure virtual

Read matrix from HDF5 file.

Parameters

[in]	file	- Handle to the HDF5 file.
[in]	matrixName	- HDF5 dataset name to read from.

Implemented in ComplexMatrix, IndexMatrix, and RealMatrix.

size()

virtual size_t BaseMatrix::size ( ) const

pure virtual

Returns

Number of elements.

Implemented in BaseIndexMatrix, and BaseFloatMatrix.

writeData()

virtual void BaseMatrix::writeData ( Hdf5File &  file, MatrixName &  matrixName, const size_t  compressionLevel  )

pure virtual

Write data into HDF5 file.

Parameters

[in]	file	- Handle to the HDF5 file.
[in]	matrixName	- HDF5 dataset name to write to.
[in]	compressionLevel	- Compression level for the HDF5 dataset.

Implemented in ComplexMatrix, IndexMatrix, and RealMatrix.

---

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

• MatrixClasses/BaseMatrix.h