eigensolver::EigenSolver< F > Class Template Referenceabstract

Interafce for eigenvalue solvers. More...

#include <eigens.hh>

Inheritance diagram for eigensolver::EigenSolver< F >:

Public Member Functions
virtual uint	converged () const =0
	Returns the number of converged eigen pairs. More...
virtual const concepts::Array< concepts::Vector< F > * > &	getEF ()=0
virtual const concepts::Array< F > &	getEV ()=0
	Returns an array with the eigen values. More...
virtual uint	iterations () const =0
	Returns the number of iterations. More...

Protected Member Functions
virtual std::ostream &	info (std::ostream &os) const
	Returns information in an output stream. More...

Detailed Description

template<typename F>
class eigensolver::EigenSolver< F >

Interafce for eigenvalue solvers.

Every new eigenvalue solver should implement this interface.

Author

Norbert Fernandes, 2002

Definition at line 23 of file eigens.hh.

Member Function Documentation

converged()

template<typename F >

virtual uint eigensolver::EigenSolver< F >::converged ( ) const

pure virtual

Returns the number of converged eigen pairs.

Implemented in eigensolver::InexactInv< F >, eigensolver::ArPackppGen< typename eigensolver::OperatorType< F, concepts::Real >::type, F, concepts::Real >, eigensolver::ArPackppStd< typename eigensolver::OperatorType< Cmplx, Real >::type >, eigensolver::ArPackppStd< F >, eigensolver::ArPack< F, G, H >, and eigensolver::ArPack< Real >.

getEF()

template<typename F >

virtual const concepts::Array<concepts::Vector<F>*>& eigensolver::EigenSolver< F >::getEF ( )

pure virtual

Implemented in eigensolver::SmallES< F >, eigensolver::JdbSym, eigensolver::InexactInv< F >, eigensolver::GEVPSolver< F >, eigensolver::DirPowIt< F, G >, eigensolver::Constrained, eigensolver::ArPackSymm, eigensolver::ArPackppGen< F, G, H >, eigensolver::ArPackppGen< typename eigensolver::OperatorType< F, concepts::Real >::type, F, concepts::Real >, eigensolver::ArPackppSymGen, eigensolver::ArPackppStd< T >, eigensolver::ArPackppStd< typename eigensolver::OperatorType< Cmplx, Real >::type >, eigensolver::ArPackppStd< F >, eigensolver::ArPack< F, G, H >, eigensolver::ArPack< Real >, and concepts::AnasaziES< ScalarT >.

getEV()

template<typename F >

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 eigensolver::SmallES< F >, eigensolver::JdbSym, eigensolver::InexactInv< F >, eigensolver::GEVPSolver< F >, eigensolver::DirPowIt< F, G >, eigensolver::Constrained, eigensolver::ArPackSymm, eigensolver::ArPackppGen< F, G, H >, eigensolver::ArPackppGen< typename eigensolver::OperatorType< F, concepts::Real >::type, F, concepts::Real >, eigensolver::ArPackppSymGen, eigensolver::ArPackppStd< T >, eigensolver::ArPackppStd< typename eigensolver::OperatorType< Cmplx, Real >::type >, eigensolver::ArPackppStd< F >, eigensolver::ArPack< F, G, H >, eigensolver::ArPack< Real >, and concepts::AnasaziES< ScalarT >.

info()

template<typename F >

virtual std::ostream& eigensolver::EigenSolver< F >::info ( std::ostream &  os ) const

protectedvirtual

Returns information in an output stream.

Reimplemented from concepts::OutputOperator.

Reimplemented in eigensolver::SmallES< F >, eigensolver::JdbSym, eigensolver::InexactInv< F >, eigensolver::GEVPSolver< F >, eigensolver::DirPowIt< F, G >, eigensolver::Constrained, eigensolver::ArPackSymm, eigensolver::ArPackppGen< F, G, H >, eigensolver::ArPackppGen< typename eigensolver::OperatorType< F, concepts::Real >::type, F, concepts::Real >, eigensolver::ArPackppSymGen, eigensolver::ArPackppStd< T >, eigensolver::ArPackppStd< typename eigensolver::OperatorType< Cmplx, Real >::type >, eigensolver::ArPackppStd< F >, eigensolver::ArPack< F, G, H >, and eigensolver::ArPack< Real >.

iterations()

template<typename F >

virtual uint eigensolver::EigenSolver< F >::iterations ( ) const

pure virtual

Returns the number of iterations.

Implemented in eigensolver::InexactInv< F >, eigensolver::ArPackppGen< typename eigensolver::OperatorType< F, concepts::Real >::type, F, concepts::Real >, eigensolver::ArPackppStd< typename eigensolver::OperatorType< Cmplx, Real >::type >, eigensolver::ArPackppStd< F >, eigensolver::ArPack< F, G, H >, and eigensolver::ArPack< Real >.

---

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

• eigensolver/eigens.hh