Commit 1b536648 authored by MIJIEUX Thomas's avatar MIJIEUX Thomas

Fix doxygen errors

parent 0a5070f0
......@@ -159,8 +159,7 @@ public:
*
* \param[in,out] X Initial guess solution and solution in ouput
* \param[in] B Block containing Right Hand Side
* \param algo instance of Algorithm as returned by one of the
::fabulous::arnoldi_XX() function family
* \param algo instance of Algorithm as returned by ::fabulous::bgcr::std()
* \param max_mvp Maximum number of Matrix Vector Product.
* \param max_krylov_space_size maximum size of Krylov space
* \param[in] epsilon Target accuracy
......
......@@ -162,8 +162,15 @@ public:
*
* \param[in,out] X Initial guess solution and solution in ouput
* \param[in] B Block containing Right Hand Side
* \param algo instance of Algorithm as returned by one of the
::fabulous::arnoldi_XX() function family
* \param algo instance of Algorithm as returned by one of the following:
* - ::fabulous::bgmres::std()
* - ::fabulous::bgmres::qr()
* - ::fabulous::bgmres::qrdr()
* - ::fabulous::bgmres::ib()
* - ::fabulous::bgmres::ibdr()
* - ::fabulous::bgmres::qribdr()
* - ::fabulous::bgmres::cham_qr()
* - ::fabulous::bgmres::cham_tl()
* \param max_mvp Maximum number of Matrix Vector Product.
* \param max_krylov_space_size maximum size of Krylov space
* \param[in] epsilon Target accuracy
......
......@@ -144,7 +144,7 @@ public:
* \param i starting line of subblock
* \param j starting column of subblock
* \param m number of line in subblock
* \param j number of column in subblock
* \param n number of column in subblock
*/
Block sub_block(int i, int j, int m, int n)
{
......
......@@ -57,6 +57,7 @@ public:
* \brief create \f$\mathscr{F}\f$
* \param max_krylov_space_size maximum size of Krylov search space
* \param nbRHS number of right hand side
* \param logger object logging the application trace and floating point operations count
*/
HessIB(int max_krylov_space_size, int nbRHS, Logger<P> &logger):
super{max_krylov_space_size+nbRHS, max_krylov_space_size},
......
......@@ -61,6 +61,7 @@ public:
* \brief create \f$\mathscr{F}\f$
* \param max_krylov_space_size maximum size of Krylov search space
* \param nbRHS number of right hand side
* \param logger object logging the application trace and floating point operations count
*/
HessIBDR(int max_krylov_space_size, int nbRHS, Logger<P> &logger):
super{max_krylov_space_size+nbRHS, max_krylov_space_size},
......
......@@ -318,6 +318,7 @@ public:
* \brief create \f$\mathscr{F}\f$
* \param max_krylov_space_size maximum size of Krylov search space
* \param nbRHS number of right hand side
* \param logger object logging the application trace and floating point operations count
*/
HessQRIBDR(int max_krylov_space_size, int nbRHS, Logger<P> &logger):
super{max_krylov_space_size+nbRHS, max_krylov_space_size},
......
......@@ -35,9 +35,10 @@ private:
* Same as above, but we store the ortho coefficients inside a temporary
* block in order to be able to call this function twice in case of Iterated processus.
*
* \param[in] base the current base of the Krylov search space
* \param[in] A user matrix callback object
* \param[in] V the primary base of the Krylov search space
* \param[in] Z the secondary base of the Krylov search space
* \param[in,out] W block to be orthogonalized against current base
* \param[out] H block to write the orthogonalization coeffs
*/
template<class Matrix, class S>
void IMGS(Matrix &A, Base<S> &V, Base<S> &Z, Block<S> &W)
......@@ -86,7 +87,8 @@ private:
}
public:
OrthogonalizerBlock(const OrthoParam &param, int nbrhs_alloc):
OrthogonalizerBlock(const OrthoParam &param /*!< orthogonalization parameters */,
int nbrhs_alloc /*!< nbRHS */):
OrthoParam{param},
_nb_flops{0},
_nbrhs_alloc{nbrhs_alloc}
......@@ -96,9 +98,10 @@ public:
/**
* \brief Orthogonalization process dispatcher.
*
* \param[in] base the current base of the Krylov search space
* \param[in] A user matrix callback object
* \param[in] V the primary base of the Krylov search space
* \param[in] Z the secondary base of the Krylov search space
* \param[in,out] W block to be orthogonalized against current base
* \param[out] H block to write the orthogonalization coeffs
*/
template<class Matrix, class S>
int64_t dispatch(Matrix &A, Base<S> &V, Base<S> &Z, Block<S> &W)
......
......@@ -452,7 +452,7 @@ int fabulous_solve_QRDR(int nrhs, void *B, int ldb, void *X, int ldx,
* \return number of matrix vector product performed
*/
int fabulous_solve_QRIBDR(int nrhs, void *B, int ldb, void *X, int ldx,
int nb_eigen_pair, void *target,
int k, void *target,
fabulous_handle handle);
/**
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment