Classes
class	THLibClusterBasisIO
	cluster basis I/O in HLIBpro file format More...

class	TClusterBasisVis< T >
	base class for cluster basis visualisation More...

class	TPSClusterBasisVis< T >
	cluster basis visualisation in PostScript format More...

class	TClusterVis
	base class for cluster tree visualisation More...

class	TBlockClusterVis
	base class for block cluster tree visualisation More...

class	T2DClusterVis
	base class for cluster tree visualisation in 2D More...

class	TPSClusterVis
	class for cluster tree visualisation in PostScript format More...

class	TPDFClusterVis
	class for cluster tree visualisation in PDF format More...

class	T2DBlockClusterVis
	base class for block cluster tree visualisation in 2D More...

class	TPSBlockClusterVis
	class for block cluster tree visualisation in PostScript format More...

class	TPDFBlockClusterVis
	class for block cluster tree visualisation in PDF format More...

class	TVTKBlockClusterVis
	class for block cluster tree visualisation in VTK More...

class	TGVClusterVis
	cluster tree visualisation in GraphViz format More...

class	TGVBlockClusterVis
	block cluster tree visualisation in GraphViz format More...

class	TCoordIO
	Base class for coordinate I/O defining interface. More...

class	TAutoCoordIO
	Class for coordinate I/O with file format detection. More...

class	TSAMGCoordIO
	Class for coordinate I/O in SAMG format. More...

class	TMatlabCoordIO
	Class for coordinate I/O in Matlab format. More...

class	THproCoordIO
	Class for coordinate I/O in HLIB format. More...

class	TMMCoordIO
	Class for coordinate I/O in MatrixMarket format. More...

class	TPLTMGCoordIO
	Class for coordinate I/O in PLTMG format. More...

class	TGMSHCoordIO
	Class for coordinate I/O in GMSH format. More...

class	TPSCoordVis
	Coordinate visualisation in PostScript format. More...

class	TVTKCoordVis
	Coordinate visualisation in VTK format. More...

class	TGridIO
	Base class for reading grids. More...

class	TAutoGridIO
	Class for grid I/O with file format detection. More...

class	THLibGridIO
	Class for grid I/O in HLIB format. More...

class	TPlyGridIO
	Class for grid I/O in Ply format. More...

class	TSurfMeshGridIO
	Class for grid I/O in Surface Mesh format. More...

class	TGMSHGridIO
	Class for grid I/O in GMSH format. More...

class	TGridVis
	Base class for grid visualisation. More...

class	T2DGridVis
	Base class for 2D grid visualisation (by projection). More...

class	TPSGridVis
	Class for grid visualisation in PostScript format. More...

class	TPDFGridVis
	Class for grid visualisation in PDF format. More...

class	TVTKGridVis
	Class for grid visualisation in VTK format. More...

class	TAutoMatrixIO
	Class for matrix I/O with automatic file format detection. More...

class	TOctaveMatrixIO
	Class for matrix I/O in octave format. More...

class	TSAMGMatrixIO
	Class for matrix I/O in SAMG format. More...

class	TMatlabMatrixIO
	Class for matrix I/O in Matlab format. More...

class	THproMatrixIO
	Class for matrix I/O in HLIB format. More...

class	TPLTMGMatrixIO
	Class for matrix I/O in PLTMG format. More...

class	THBMatrixIO
	Class for matrix I/O in Harwell-Boeing and Rutherford-Boeing format. More...

class	TMMMatrixIO
	Class for matrix I/O in MatrixMarket format. More...

class	THDF5MatrixIO
	Class for matrix I/O in HDF5 format. More...

class	TH2LibMatrixIO
	Class for matrix I/O in format used by H2Lib. More...

class	TMatrixVisBase
	Implements 2D based matrix visualisation. More...

class	TPSMatrixVis
	class for matrix visualisation in PostScript format More...

class	TPDFMatrixVis
	class for matrix visualisation in PDF format More...

class	TAutoVectorIO
	Class for vector I/O with automatic file format detection. More...

class	TSAMGVectorIO
	Class for vector I/O in SAMG format. More...

class	TMatlabVectorIO
	Class for vector I/O in Matlab format. More...

class	THproVectorIO
	Class for vector I/O in HLIB format. More...

class	THBVectorIO
	Class for vector I/O in Harwell-Boeing and Rutherford-Boeing format. More...

class	TMMVectorIO
	Class for vector I/O in MatrixMarket format. More...

Coordinate I/O
Functions for input/output of coordinates.
std::unique_ptr< TCoordinate >	read_coord (const char *filename)
	Read coord from file with automatic file format detection.

void	write_coord (const TCoordinate coord, const char filename)
	Write coord to file with automatic choice of file format.

Grid I/O
Functions for input/output of grids.
std::unique_ptr< TGrid >	read_grid (const std::string &filename)
	Read grid from file with automatic file format detection.

void	write_grid (const TGrid *grid, const std::string &filename)
	Write grid to file with automatic file format detection.

Matrix I/O
Functions for input/output of matrices.
template<typename value_t >
std::unique_ptr< TMatrix< value_t > >	read_matrix (const std::string &filename)
	Read matrix from file with automatic file format detection.

template<typename value_t >
std::unique_ptr< TMatrix< value_t > >	read_matrix (const std::string &filename, const std::string &matname)
	Read matrix from file with automatic file format detection.

template<typename value_t >
void	write_matrix (const TMatrix< value_t > *A, const std::string &filename)
	Write matrix to file with automatic choice of file format.

template<typename value_t >
void	write_matrix (const TMatrix< value_t > *A, const std::string &filename, const std::string &matname)
	Write matrix to file with automatic choice of file format.

template<typename value_t >
std::unique_ptr< TLinearOperator< value_t > >	read_linop (const std::string &filename)
	Read linear operator from file.

template<typename value_t >
void	write_linop (const TLinearOperator< value_t > *A, const std::string &filename)
	Write linear operator to file.

Vector I/O
Functions for input/output of vectors.
template<typename value_t >
std::unique_ptr< TVector< value_t > >	read_vector (const std::string &filename)
	Read vector from file with automatic file format detection.

template<typename value_t >
std::unique_ptr< TVector< value_t > >	read_vector (const std::string &filename, const std::string &vecname)
	Read vector from file with automatic file format detection.

template<typename value_t >
void	write_vector (const TVector< value_t > *A, const std::string &filename)
	Write vector to file with automatic choice of file format.

template<typename value_t >
void	write_vector (const TVector< value_t > *A, const std::string &filename, const std::string &vecname)
	Write vector to file with automatic choice of file format.

Detailed Description

This modules provides classes and functions for input/output of matrices, vectors, coordinates and grids.

#include <hlib-io.hh>

Function Documentation

◆ read_coord()

std::unique_ptr< TCoordinate > read_coord ( const char * filename )

      Read coord from file \a filename while the format of the file
      is detected automatically.

◆ read_grid()

std::unique_ptr< TGrid > read_grid ( const std::string & filename )

      Read grid from file \a filename while the format of the file
      is detected automatically based on the file content and the
      file name.

◆ read_linop()

template<typename value_t >

std::unique_ptr< TLinearOperator< value_t > > read_linop ( const std::string & filename )

      Read linear operator from file \a filename. Currently only the
      HLIBpro file format supports linear operators.

◆ read_matrix() [1/2]

template<typename value_t >

std::unique_ptr< TMatrix< value_t > > read_matrix ( const std::string & filename )

      Read matrix from file \a filename while the format of the file
      is detected automatically. If the file format supports storage
      of several matrices (or other objects), only the first matrix
      will be read.

◆ read_matrix() [2/2]

template<typename value_t >

std::unique_ptr< TMatrix< value_t > > read_matrix	(	const std::string &	filename,
		const std::string &	matname
	)

      Read matrix from file \a filename while the format of the file
      is detected automatically. If the file format supports named
      matrices, the matrix with the name \a matname will be read.
      Furthermore, if the file format supports storage of several matrices
      (or other objects), only the first matrix will be read.

◆ read_vector() [1/2]

template<typename value_t >

std::unique_ptr< TVector< value_t > > read_vector ( const std::string & filename )

      Read vector from file \a filename while the format of the file
      is detected automatically. If the file format supports storage
      of several matrices (or other objects), only the first vector
      will be read.

◆ read_vector() [2/2]

template<typename value_t >

std::unique_ptr< TVector< value_t > > read_vector	(	const std::string &	filename,
		const std::string &	vecname
	)

      Read vector from file \a filename while the format of the file
      is detected automatically. If the file format supports named
      matrices, the vector with the name \a vecname will be read.
      Furthermore, if the file format supports storage of several matrices
      (or other objects), only the first vector will be read.

◆ write_coord()

void write_coord	(	const TCoordinate *	coord,
		const char *	filename
	)

      Write coord \a coord to file \a filename with automatic choice
      of file format based on filename suffix:
      - hm     : HLIBpro format
      - mat, m : Matlab format
      - coo    : SAMG format

◆ write_grid()

void write_grid	(	const TGrid *	grid,
		const std::string &	filename
	)

      Write \a grid to file \a filename while the format of the file
      is detected automatically based on the file name.

◆ write_linop()

template<typename value_t >

void write_linop	(	const TLinearOperator< value_t > *	A,
		const std::string &	filename
	)

      Write linear operator \a A to file \a filename in HLIBpro format.

◆ write_matrix() [1/2]

template<typename value_t >

void write_matrix	(	const TMatrix< value_t > *	A,
		const std::string &	filename
	)

      Write matrix \a A to file \a filename while the format of the file
      is chosen automatically based upon the filename suffix.
      - hm                    : HLIBpro format
      - mat, m                : Matlab format
      - hb, rb, rua, rsa, psa : Harwell/Boeing format
      - amg                   : SAMG format
      - mtx                   : MatrixMarket format
      - hdf, h5               : HDF5 format

◆ write_matrix() [2/2]

template<typename value_t >

void write_matrix	(	const TMatrix< value_t > *	A,
		const std::string &	filename,
		const std::string &	matname
	)

      Write matrix \a A to file \a filename while the format of the file
      is chosen automatically based upon the filename suffix. If the file
      format supports named matrices, the matrix will be stored under the
      name \a matname.

◆ write_vector() [1/2]

template<typename value_t >

void write_vector	(	const TVector< value_t > *	A,
		const std::string &	filename
	)

      Write vector \a A to file \a filename while the format of the file
      is chosen automatically based upon the filename suffix.
      - hm                    : HLIBpro format
      - mat, m                : Matlab format
      - hb, rb, rua, rsa, psa : Harwell/Boeing format
      - rhs, sol              : SAMG format
      - mtx                   : VectorMarket format

◆ write_vector() [2/2]

template<typename value_t >

void write_vector	(	const TVector< value_t > *	A,
		const std::string &	filename,
		const std::string &	vecname
	)

      Write vector \a A to file \a filename while the format of the file
      is chosen automatically based upon the filename suffix. If the file
      format supports named matrices, the vector will be stored under the
      name \a vecname.

Classes

Coordinate I/O

Grid I/O

Matrix I/O

Vector I/O

Detailed Description

Function Documentation

◆ read_coord()

◆ read_grid()

◆ read_linop()

◆ read_matrix() [1/2]

◆ read_matrix() [2/2]

◆ read_vector() [1/2]

◆ read_vector() [2/2]

◆ write_coord()

◆ write_grid()

◆ write_linop()

◆ write_matrix() [1/2]

◆ write_matrix() [2/2]

◆ write_vector() [1/2]

◆ write_vector() [2/2]