Teuchos  Trilinos Tools Package Version of the Day

Parse a Matrix Market banner line. More...
#include <Teuchos_MatrixMarket_Banner.hpp>
Public Member Functions  
Banner (const std::string &line, const bool tolerant=false)  
const std::string &  objectType () const 
The object type.  
const std::string &  matrixType () const 
Storage type of the matrix.  
const std::string &  dataType () const 
Data type of matrix entries.  
const std::string &  symmType () const 
Symmetric storage type. 
Parse a Matrix Market banner line.
The first line of a Matrix Market  format file, the "banner line," contains information for interpreting the rest of the file. This class parses the first line, canonicalizes the information therein, and stores it for later use.
Definition at line 67 of file Teuchos_MatrixMarket_Banner.hpp.
Teuchos::MatrixMarket::Banner::Banner  (  const std::string &  line, 
const bool  tolerant = false 

) 
Constructor
line  [in] The banner line to parse 
tolerant  [in] Whether to parse tolerantly. If false, we adhere strictly to the Matrix Market standard. If true, we allow all kinds of divergence therefrom (including an entirely empty banner line, for which we fill in some sensible defaults). 
Definition at line 154 of file Teuchos_MatrixMarket_Banner.cpp.
const std::string& Teuchos::MatrixMarket::Banner::objectType  (  )  const [inline] 
The object type.
The Matrix Market format specifies the "type of object" stored in the file. In the current version of the standard, the object type is always "matrix" (without the quotes). The standard leaves open the possibility of other types in future versions of the standard.
Definition at line 86 of file Teuchos_MatrixMarket_Banner.hpp.
const std::string& Teuchos::MatrixMarket::Banner::matrixType  (  )  const [inline] 
Storage type of the matrix.
"coordinate" means a sparse matrix, stored as (i,j,Aij) triples with onebased indices i and j. "array" means a dense matrix, stored in columnmajor order with one entry per line.
Definition at line 93 of file Teuchos_MatrixMarket_Banner.hpp.
const std::string& Teuchos::MatrixMarket::Banner::dataType  (  )  const [inline] 
Data type of matrix entries.
Data type of the matrix entries: "real", "complex", "integer", or "pattern".
Definition at line 99 of file Teuchos_MatrixMarket_Banner.hpp.
const std::string& Teuchos::MatrixMarket::Banner::symmType  (  )  const [inline] 
Symmetric storage type.
Describes whether and how symmetry is exploited when storing the matrix. "general" means nonsymmetric: all the matrix entries are stored. "symmetric", "skewsymmetric", and "hermitian" have their usual mathematical meaning, and also mean that only the upper or lower triangle (including the diagonal) of the matrix is stored. There's no way to tell from the banner whether the upper or lower triangle is stored; you have to examine the matrix entries.
Definition at line 122 of file Teuchos_MatrixMarket_Banner.hpp.