Eigen-unsupported  3.4.90 (git rev 67eeba6e720c5745abc77ae6c92ce0a44aa7b7ae)
Eigen::MatrixMarketIterator< Scalar > Class Template Reference

Detailed Description

template<typename Scalar>
class Eigen::MatrixMarketIterator< Scalar >

Iterator to browse matrices from a specified folder.

This is used to load all the matrices from a folder. The matrices should be in Matrix Market format It is assumed that the matrices are named as matname.mtx and matname_SPD.mtx if the matrix is Symmetric and positive definite (or Hermitian) The right hand side vectors are loaded as well, if they exist. They should be named as matname_b.mtx. Note that the right hand side for a SPD matrix is named as matname_SPD_b.mtx

Sometimes a reference solution is available. In this case, it should be named as matname_x.mtx

Sample code

Template Parameters
ScalarThe scalar type

Public Member Functions

MatrixTypematrix ()
VectorTyperefX ()
VectorTyperhs ()

Member Function Documentation

◆ matrix()

template<typename Scalar >
MatrixType& Eigen::MatrixMarketIterator< Scalar >::matrix ( )

Return the sparse matrix corresponding to the current file

◆ refX()

template<typename Scalar >
VectorType& Eigen::MatrixMarketIterator< Scalar >::refX ( )

Return a reference solution If it is not provided and if the right hand side is not available then refX is randomly generated such that A*refX = b where A and b are the matrix and the rhs. Note that when a rhs is provided, refX is not available

◆ rhs()

template<typename Scalar >
VectorType& Eigen::MatrixMarketIterator< Scalar >::rhs ( )

Return the right hand side corresponding to the current matrix. If the rhs file is not provided, a random rhs is generated

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