Main Page   Namespace List   Compound List   File List   Compound Members   File Members  

HBF Class Reference

Storage of matrix in Harwell Boeing Format. More...

#include <hbf.h>

List of all members.

Public Methods

 HBF ()
 Empty constructor. More...

void create (const int d, const int n)
 Full constructor with input parameters. More...

 ~HBF ()
 Destructor. More...

int size () const
 Give the non-zero values number of matrix. More...

int order () const
 Give the dimension of matrix. More...

psi_type type () const
 Give the current model type. More...

double maxi () const
 Give the largest element (in modulo) of continuous time matrix. More...

bool is_empty () const
 Test if a current HBF structure exists. More...

double val (const int i) const
 Give the ith non-zero value of matrix. More...

int col (const int i) const
 Give the ith column index. More...

int row (const int i) const
 Give the ith row beginning index of matrix. More...

int valbyrow (const int i) const
 Give the non-null values number of the ith row. More...

int zero_or_one ()
 Test the numerotation of input model. More...

void update ()
 Transformation of HBF numerotation. More...

void read_hbf_r (const psi_name path)
 Reading of a 'row' HBF model. More...

void read_marca (const psi_name path)
 Reading of a MARCA model. More...

void read_hbf_c (const psi_name path)
 Reading of a PEPS model. More...

void uniformization ()
 Uniformization of a continuous time model. More...

void write_unif (const psi_name file)
 Writing of a unif file in HBF (classical) format. More...

void col2row ()
 Conversion of a column HBF model to a row HBF model. More...

void convert ()
 Writing of a col2row() conversion. More...

void scale (const double d)
 Multiplication of matrix by a double input value. More...

void give_a_name (const psi_name file)
 Baptise HBF storage. More...

psi_name name () const
 Give the current model's name. More...

int out_degree () const
 Give the maximum out_degree of matrix. More...

void transform (const int d)
 Width transformation of matrix. More...


Static Public Attributes

HBF hbf = HBF()

Private Attributes

psi_name model_name
psi_type model_type
int dimension
int nz_number
vector< double > Val
vector< int > Col
vector< int > Row
vector< int > ValbyRow
double biggest


Detailed Description

Storage of matrix in Harwell Boeing Format.

There exists three possibilities to import a matrix :

The state numerotation can start from zero or from one.


Constructor & Destructor Documentation

HBF::HBF  
 

Empty constructor.

HBF::~HBF  
 

Destructor.


Member Function Documentation

int HBF::col const int    i const [inline]
 

Give the ith column index.

void HBF::col2row  
 

Conversion of a column HBF model to a row HBF model.

void HBF::convert  
 

Writing of a col2row() conversion.

void HBF::create const int    d,
const int    n
 

Full constructor with input parameters.

Parameters:
d  an integer corresponding to the dimension.
n  an integer corresponding to the non-null values number.

void HBF::give_a_name const psi_name    file [inline]
 

Baptise HBF storage.

Parameters:
file  an input psi_name.

bool HBF::is_empty   const [inline]
 

Test if a current HBF structure exists.

Returns:
true if an HBF structure is in memory, false otherwise.

double HBF::maxi   const [inline]
 

Give the largest element (in modulo) of continuous time matrix.

psi_name HBF::name   const [inline]
 

Give the current model's name.

int HBF::order   const [inline]
 

Give the dimension of matrix.

int HBF::out_degree   const
 

Give the maximum out_degree of matrix.

void HBF::read_hbf_c const psi_name    path
 

Reading of a PEPS model.

Parameters:
path  an input psi_name path.

void HBF::read_hbf_r const psi_name    path
 

Reading of a 'row' HBF model.

Parameters:
path  an input psi_name path.

void HBF::read_marca const psi_name    path
 

Reading of a MARCA model.

Parameters:
path  an input psi_name path.

int HBF::row const int    i const [inline]
 

Give the ith row beginning index of matrix.

void HBF::scale const double    d
 

Multiplication of matrix by a double input value.

int HBF::size   const [inline]
 

Give the non-zero values number of matrix.

void HBF::transform const int    d
 

Width transformation of matrix.

Parameters:
d  an integer corresponding to the new matrix width.

psi_type HBF::type   const [inline]
 

Give the current model type.

PSI accepts discrete and continuous time model.

void HBF::uniformization  
 

Uniformization of a continuous time model.

.

void HBF::update  
 

Transformation of HBF numerotation.

PSI numerotation begin from zero and so needs a modification for models started from one.

double HBF::val const int    i const [inline]
 

Give the ith non-zero value of matrix.

int HBF::valbyrow const int    i const [inline]
 

Give the non-null values number of the ith row.

void HBF::write_unif const psi_name    file
 

Writing of a unif file in HBF (classical) format.

Parameters:
file  a string corresponding to the output file.

int HBF::zero_or_one   [inline]
 

Test the numerotation of input model.

This method permit to the PSI user to construct his model with numerotation choice.

Returns:
0 if the input model start from zero and 1 if the input model start from one.


Member Data Documentation

double HBF::biggest [private]
 

Largest element (in modulo) of the generator

vector<int> HBF::Col [private]
 

Storage of column indexes

int HBF::dimension [private]
 

States number of the model

HBF HBF::hbf = HBF() [static]
 

psi_name HBF::model_name [private]
 

Model's name

psi_type HBF::model_type [private]
 

Time type model

int HBF::nz_number [private]
 

Number of non zero elements of generator matrix

vector<int> HBF::Row [private]
 

Storage of row beginning

vector<double> HBF::Val [private]
 

Storage of non zero values

vector<int> HBF::ValbyRow [private]
 

Storage of the non-zero values number by row


The documentation for this class was generated from the following files:
Generated on Tue Dec 10 12:44:34 2002 for PSI_ALIAS by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002