Skip to content
Snippets Groups Projects
Commit 928c6c58 authored by Christoph Grüninger's avatar Christoph Grüninger
Browse files

[doxygen] Escape #, <, and > in arpackpp.hh

parent 5dee23be
No related branches found
No related tags found
1 merge request!552Fix Doxygen warnings
......@@ -235,8 +235,8 @@ namespace Dune
* respectively singular values shall be considered;
* is assumed to have blocklevel 2.
* \tparam BlockVector Type of the associated vectors; compatible with the
* rows of a BCRSMatrix object (if #rows >= #ncols) or
* its columns (if #rows < #ncols).
* rows of a BCRSMatrix object (if \#rows \>= \#ncols) or
* its columns (if \#rows \< \#ncols).
*
* \author Sebastian Westerheide.
*/
......@@ -257,13 +257,13 @@ namespace Dune
* algorithm, c*nIterationsMax iterations may
* be performed, where c is a natural number.
* \param[in] verbosity_level Verbosity setting;
* >= 1: algorithms print a preamble and
* the final result,
* >= 2: algorithms print information about
* the problem solved using ARPACK++,
* >= 3: the final result output includes
* the approximated eigenvector,
* >= 4: sets the ARPACK(++) verbosity mode.
* \>= 1: algorithms print a preamble and
* \>= 2: algorithms print information about
* \>= 3: the final result output includes
* \>= 4: sets the ARPACK(++) verbosity mode.
*/
ArPackPlusPlus_Algorithms (const BCRSMatrix& m,
const unsigned int nIterationsMax = 100000,
......@@ -603,8 +603,8 @@ namespace Dune
* (0 == machine precision).
* \param[out] sigma The approximated largest singular value.
* \param[out] x The associated approximated right-singular
* vector (if #rows >= #ncols) respectively
* left-singular vector (if #rows < #ncols).
* vector (if \#rows \>= \#ncols) respectively
* left-singular vector (if \#rows \< \#ncols).
*/
inline void computeNonSymMax (const Real& epsilon,
BlockVector& x, Real& sigma) const
......@@ -715,8 +715,8 @@ namespace Dune
* (0 == machine precision).
* \param[out] sigma The approximated smallest singular value.
* \param[out] x The associated approximated right-singular
* vector (if #rows >= #ncols) respectively
* left-singular vector (if #rows < #ncols).
* vector (if \#rows \>= \#ncols) respectively
* left-singular vector (if \#rows \< \#ncols).
*/
inline void computeNonSymMin (const Real& epsilon,
BlockVector& x, Real& sigma) const
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment