HBIO Class Reference

Harwell Boeing sparse matrix file format I/O class. More...

#include <hbio.hpp>

Public Member Functions
	HBIO ()
	Constructor. More...
	~HBIO ()
	Destructor. More...
void	write (const std::string filename) const
	Write file filename. More...
void	read (const std::string filename)
	Read file filename. More...
const std::string	get_title (void) const
	Get file title (max 72 chars) More...
void	set_title (const std::string ttitle)
	Set file title (max 72 chars) More...
const std::string	get_key (void) const
	Get file key (max 8 chars) More...
void	set_key (const std::string kkey)
	Set file key (max 8 chars) More...
int	get_valacc (void) const
	Get value accuracy (in chars) More...
void	set_valacc (int vvalacc)
	Set value accuracy (in chars) More...
int	get_rhsacc (void) const
	Get right hand side accuracy (in chars) More...
void	set_rhsacc (int rrhsacc)
	Set right hand side accuracy (in chars) More...
void	get_matrix (CColMatrix &mmat) const
	Get matrix. More...
void	set_matrix (const CColMatrix &mmat)
	Set matrix. More...
void	get_rhs_vector (Vector &rrhs) const
	Get right hand side vector. More...
void	set_rhs_vector (const Vector &rrhs)
	Set right hand side vector. More...
void	get_solution_vector (Vector &ssol) const
	Get solution vector. More...
void	set_solution_vector (const Vector &ssol)
	Set solution vector. More...

Detailed Description

Harwell Boeing sparse matrix file format I/O class.

Class for reading and writing linear algebra problems (matrices and vectors) in the standard Harwell Boeing (HB) sparse matrix file format. The HBIO class supports a limited subset of HB file format features. The most basic features including title, key, selectable number accuracy, problem matrix, right hand side vector and the solution vector are supported. The HB format stores matrices in compressed column mode with fortran indexing (indices starting from 1), but the matrices are converted to 0 based indexing when read to memory.

Constructor & Destructor Documentation

HBIO()

HBIO::HBIO ( )

inline

Constructor.

~HBIO()

HBIO::~HBIO ( )

inline

Destructor.

Member Function Documentation

get_key()

const std::string HBIO::get_key ( void  ) const

inline

Get file key (max 8 chars)

get_matrix()

void HBIO::get_matrix

(

CColMatrix &

mmat

)

const

Get matrix.

get_rhs_vector()

void HBIO::get_rhs_vector

(

Vector &

rrhs

)

const

Get right hand side vector.

get_rhsacc()

int HBIO::get_rhsacc ( void  ) const

inline

Get right hand side accuracy (in chars)

get_solution_vector()

void HBIO::get_solution_vector

(

Vector &

ssol

)

const

Get solution vector.

get_title()

const std::string HBIO::get_title ( void  ) const

inline

Get file title (max 72 chars)

get_valacc()

int HBIO::get_valacc ( void  ) const

inline

Get value accuracy (in chars)

read()

void HBIO::read

(

const std::string

filename

)

Read file filename.

set_key()

void HBIO::set_key ( const std::string  kkey )

inline

Set file key (max 8 chars)

set_matrix()

void HBIO::set_matrix

(

const CColMatrix &

mmat

)

Set matrix.

set_rhs_vector()

void HBIO::set_rhs_vector

(

const Vector &

rrhs

)

Set right hand side vector.

set_rhsacc()

void HBIO::set_rhsacc ( int  rrhsacc )

inline

Set right hand side accuracy (in chars)

set_solution_vector()

void HBIO::set_solution_vector

(

const Vector &

ssol

)

Set solution vector.

set_title()

void HBIO::set_title ( const std::string  ttitle )

inline

Set file title (max 72 chars)

set_valacc()

void HBIO::set_valacc ( int  vvalacc )

inline

Set value accuracy (in chars)

write()

void HBIO::write

(

const std::string

filename

)

const

Write file filename.

---

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

• hbio.hpp
• hbio.cpp