MatrixStream.
More...
#include <matrixstream.h>

 MatrixStream (const Field &fld, std::istream &in) 
 Constructor from an input stream. More...


 ~MatrixStream () 
 Destructor.


void  newmatrix () 
 Re initiliaze after one matrix has been read. More...


bool  readWhiteSpace () 
 Read some white space (if there is any). More...


bool  nextTriple (size_t &, size_t &, Element &) 
 Read the next triple of row index, column index, value and store it in the three referenced elements. More...


bool  getArray (std::vector< Element > &array) 
 Get the whole matrix as a dense (rowmajor) array of elements. More...


bool  getRows (size_t &) 
 Get the number of rows in the matrix and store it in the given size_t. More...


bool  getColumns (size_t &) 
 Get the number of columns in the matrix and store it in the given size_t. More...


bool  getDimensions (size_t &, size_t &) 
 Get the number of rows and columns in the matrix and store them in the given ints. More...


MatrixStreamError  getError () const 
 Get the current state of the stream. More...


MatrixStreamError  reportError (const char *, int) const 
 Report the error to the error stream and return it. More...


int  getLineNumber () const 
 If the reader is in the GOOD state, get the line number it is on. More...


const Field &  getField () const 
 Get the Field that was passed to the constructor. More...


const char *  getFormat () const 
 Get a brief description of the format of the matrix being read. More...


const char *  getShortFormat () const 
 Get a very brief description of the matrix format. More...


bool  isSparse () const 
 Tell if the matrix being read is sparse. More...


template<class Field>
class LinBox::MatrixStream< Field >
MatrixStream.
 Examples:
 examples/checksolve.C, examples/doubledet.C, examples/omp_block_rank.C, examples/omp_smithvalence.C, examples/power_rank.C, examples/poweroftwo_ranks.C, examples/rank.C, examples/smith.C, examples/smithvalence.C, examples/smithvalence.h, examples/solve.C, examples/sparseelimrank.C, and examples/valence.C.
Constructor from an input stream.
 Parameters

fld  The Field used to read Elements from the matrix. 
in  The input stream from which to read 
 Exceptions

MatrixStreamError  if an error occurs in reading the first line (i.e. on initialization). 
Re initiliaze after one matrix has been read.
Read some white space (if there is any).
Using this method is preferable to letting the input stream handle whitespace skipping because this method will update the line number when breaks are encountered.
 Returns
 true iff there is more data after the whitespace.
bool nextTriple 
( 
size_t & 
m, 


size_t & 
n, 


Element & 
v 

) 
 
Read the next triple of row index, column index, value and store it in the three referenced elements.
 Returns
 true iff the read succeeded.
bool getArray 
( 
std::vector< Element > & 
array  ) 

Get the whole matrix as a dense (rowmajor) array of elements.
 Parameters

array  The array to fill with entries. May be resized as needed. 
bool getRows 
( 
size_t & 
m  ) 

Get the number of rows in the matrix and store it in the given size_t.
 Returns
 true iff the operation succeeded.
bool getColumns 
( 
size_t & 
n  ) 

Get the number of columns in the matrix and store it in the given size_t.
 Returns
 true iff the operation succeeded.
bool getDimensions 
( 
size_t & 
m, 


size_t & 
n 

) 
 
Get the number of rows and columns in the matrix and store them in the given ints.
 Returns
 true iff the operation succeeded.
MatrixStreamError getError 
( 
 ) 
const 

inline 
Get the current state of the stream.
Especially useful if called after nextTriple or one of the get operations on failure to get some information on what caused the failure.
MatrixStreamError reportError 
( 
const char * 
func, 


int 
line 

) 
 const 
Report the error to the error stream and return it.
Designed for throw operations.
int getLineNumber 
( 
 ) 
const 
If the reader is in the GOOD state, get the line number it is on.
Otherwise, get the line number on which the last error occurred.
const Field& getField 
( 
 ) 
const 

inline 
Get the Field that was passed to the constructor.
const char* getFormat 
( 
 ) 
const 

inline 
Get a brief description of the format of the matrix being read.
const char* getShortFormat 
( 
 ) 
const 

inline 
Get a very brief description of the matrix format.
Tell if the matrix being read is sparse.
 Returns
 true if the matrix is sparse, false if it is dense.
The documentation for this class was generated from the following files:
 matrixstream.h
 matrixstream.inl