Interafce for eigenvalue solvers. More...
#include <eigens.hh>
Public Member Functions | |
| virtual uint | converged () const =0 |
| Returns the number of converged eigen pairs. | |
| virtual const concepts::Array < concepts::Vector< F > * > & | getEF ()=0 |
| virtual const concepts::Array < F > & | getEV ()=0 |
| Returns an array with the eigen values. | |
| virtual uint | iterations () const =0 |
| Returns the number of iterations. | |
Protected Member Functions | |
| virtual std::ostream & | info (std::ostream &os) const |
| Returns information in an output stream. | |
Detailed Description
template<typename F>
class eigensolver::EigenSolver< F >
Interafce for eigenvalue solvers.
Every new eigenvalue solver should implement this interface.
Member Function Documentation
| virtual uint eigensolver::EigenSolver< F >::converged | ( | ) | const [pure virtual] |
Returns the number of converged eigen pairs.
Implemented in concepts::AnasaziES< ScalarT >, eigensolver::ArPack< F, G, H >, eigensolver::ArPackppStd< T >, eigensolver::ArPackppSymGen, eigensolver::ArPackppGen< F, G, H >, eigensolver::ArPackSymm, eigensolver::Constrained, eigensolver::DirPowIt< F, G >, eigensolver::InexactInv< F >, eigensolver::JdbSym, eigensolver::SmallES< F >, eigensolver::ArPack< Real >, eigensolver::ArPackppStd< H >, and eigensolver::ArPackppGen< H, F, concepts::Real >.
| virtual const concepts::Array<concepts::Vector<F>*>& eigensolver::EigenSolver< F >::getEF | ( | ) | [pure virtual] |
Implemented in concepts::AnasaziES< ScalarT >, eigensolver::ArPack< F, G, H >, eigensolver::ArPackppStd< T >, eigensolver::ArPackppSymGen, eigensolver::ArPackppGen< F, G, H >, eigensolver::ArPackSymm, eigensolver::Constrained, eigensolver::DirPowIt< F, G >, eigensolver::InexactInv< F >, eigensolver::JdbSym, eigensolver::SmallES< F >, eigensolver::ArPack< Real >, eigensolver::ArPackppStd< H >, and eigensolver::ArPackppGen< H, F, concepts::Real >.
| virtual const concepts::Array<F>& eigensolver::EigenSolver< F >::getEV | ( | ) | [pure virtual] |
Returns an array with the eigen values.
- Deprecated:
- : this interface requires that the returned array must be hold as a member variable of the class.
(use std::auto_pointer or similar)
Implemented in concepts::AnasaziES< ScalarT >, eigensolver::ArPack< F, G, H >, eigensolver::ArPackppStd< T >, eigensolver::ArPackppSymGen, eigensolver::ArPackppGen< F, G, H >, eigensolver::ArPackSymm, eigensolver::Constrained, eigensolver::DirPowIt< F, G >, eigensolver::InexactInv< F >, eigensolver::JdbSym, eigensolver::SmallES< F >, eigensolver::ArPack< Real >, eigensolver::ArPackppStd< H >, and eigensolver::ArPackppGen< H, F, concepts::Real >.
| virtual std::ostream& eigensolver::EigenSolver< F >::info | ( | std::ostream & | os | ) | const [protected, virtual] |
Returns information in an output stream.
Reimplemented from concepts::OutputOperator.
Reimplemented in concepts::AnasaziES< ScalarT >, eigensolver::ArPack< F, G, H >, eigensolver::ArPackppStd< T >, eigensolver::ArPackppSymGen, eigensolver::ArPackppGen< F, G, H >, eigensolver::ArPackSymm, eigensolver::Constrained, eigensolver::DirPowIt< F, G >, eigensolver::InexactInv< F >, eigensolver::JdbSym, eigensolver::SmallES< F >, eigensolver::ArPack< Real >, eigensolver::ArPackppStd< H >, and eigensolver::ArPackppGen< H, F, concepts::Real >.
| virtual uint eigensolver::EigenSolver< F >::iterations | ( | ) | const [pure virtual] |
Returns the number of iterations.
Implemented in concepts::AnasaziES< ScalarT >, eigensolver::ArPack< F, G, H >, eigensolver::ArPackppStd< T >, eigensolver::ArPackppSymGen, eigensolver::ArPackppGen< F, G, H >, eigensolver::ArPackSymm, eigensolver::Constrained, eigensolver::DirPowIt< F, G >, eigensolver::InexactInv< F >, eigensolver::JdbSym, eigensolver::SmallES< F >, eigensolver::ArPack< Real >, eigensolver::ArPackppStd< H >, and eigensolver::ArPackppGen< H, F, concepts::Real >.
The documentation for this class was generated from the following file:
- eigensolver/eigens.hh