ug::MatrixFileType Class Reference

Representation of a matrix exchange file format. More...

#include <matrix_io.h>

Public Types
enum	Type { UNDEFINED = 0 , MATRIX_MARKET = 1 , HARWELL_BOING = 2 }
	Supported matrix exchange file formats. More...

Public Member Functions
bool	is_hb () const
	Tells whether this is a Harwell-Boing type. More...
bool	is_mm () const
	Tells whether this is a MatrixMarket type. More...
	MatrixFileType ()
	Default Constructor. More...
	MatrixFileType (int type)
	Constructor specifying file type. More...

Private Attributes
int	m_type
	Holds the file type value (which is one of MatrixFileType::Type) More...

Detailed Description

Representation of a matrix exchange file format.

Supported matrix exchange file formats are:

• MatrixMarket (http://math.nist.gov/MatrixMarket/formats.html#MMformat)

Note

The Harwell-Boing (http://math.nist.gov/MatrixMarket/formats.html#hb) format is not yet implemented.

Member Enumeration Documentation

Type

enum ug::MatrixFileType::Type

Supported matrix exchange file formats.

Enumerator
UNDEFINED	undefined format
MATRIX_MARKET	MatrixMarket format (by NIS)
HARWELL_BOING	Harwell-Boing format (by NIS)

Constructor & Destructor Documentation

MatrixFileType() [1/2]

ug::MatrixFileType::MatrixFileType ( )

inline

Default Constructor.

Initializes file format type to 0 (thus undefined).

MatrixFileType() [2/2]

ug::MatrixFileType::MatrixFileType ( int  type )

inline

Constructor specifying file type.

Initializes file format type to the given type.

Parameters

[in]

type

a valid value of MatrixFileType::Type

References m_type, and UG_ASSERT.

Member Function Documentation

is_hb()

bool ug::MatrixFileType::is_hb ( ) const

inline

Tells whether this is a Harwell-Boing type.

Returns

true if it is a Harwell-Boing file type, false otherwise.

References HARWELL_BOING, and m_type.

is_mm()

bool ug::MatrixFileType::is_mm ( ) const

inline

Tells whether this is a MatrixMarket type.

Returns

true if it is a MatrixMarket file type, false otherwise.

References m_type, and MATRIX_MARKET.

Member Data Documentation

m_type

int ug::MatrixFileType::m_type

private

Holds the file type value (which is one of MatrixFileType::Type)

Referenced by is_hb(), is_mm(), and MatrixFileType().

---

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

• ugbase/lib_algebra/common/matrixio/matrix_io.h