Commit 1b087eb3 authored by Mathieu Faverge's avatar Mathieu Faverge

Merge branch 'codelet/cleanup' into 'master'

Cleanup OpenMP codelet and doc

See merge request solverstack/chameleon!141
parents fa6d78a3 978a5d43
......@@ -66,9 +66,8 @@
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* \retval <0 if -i, the i-th argument had an illegal value
* @retval CHAMELEON_SUCCESS successful exit
* @retval <0 if -i, the i-th argument had an illegal value
*
*******************************************************************************
*
......@@ -175,8 +174,7 @@ int CHAMELEON_zbuild( cham_uplo_t uplo, int M, int N,
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* @retval CHAMELEON_SUCCESS successful exit
*
*******************************************************************************
*
......
......@@ -75,8 +75,7 @@
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* @retval CHAMELEON_SUCCESS successful exit
*
*******************************************************************************
*
......@@ -211,8 +210,7 @@ int CHAMELEON_zgeadd( cham_trans_t trans, int M, int N,
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* @retval CHAMELEON_SUCCESS successful exit
*
*******************************************************************************
*
......
......@@ -56,9 +56,8 @@
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* \retval <0 if -i, the i-th argument had an illegal value
* @retval CHAMELEON_SUCCESS successful exit
* @retval <0 if -i, the i-th argument had an illegal value
*
*******************************************************************************
*
......@@ -165,8 +164,7 @@ int CHAMELEON_zgelqf( int M, int N,
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* @retval CHAMELEON_SUCCESS successful exit
*
*******************************************************************************
*
......
......@@ -54,9 +54,8 @@
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* \retval <0 if -i, the i-th argument had an illegal value
* @retval CHAMELEON_SUCCESS successful exit
* @retval <0 if -i, the i-th argument had an illegal value
*
*******************************************************************************
*
......@@ -164,8 +163,7 @@ int CHAMELEON_zgelqf_param( const libhqr_tree_t *qrtree, int M, int N,
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* @retval CHAMELEON_SUCCESS successful exit
*
*******************************************************************************
*
......
......@@ -62,9 +62,8 @@
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* \retval <0 if -i, the i-th argument had an illegal value
* @retval CHAMELEON_SUCCESS successful exit
* @retval <0 if -i, the i-th argument had an illegal value
*
*******************************************************************************
*
......@@ -186,8 +185,7 @@ int CHAMELEON_zgelqs( int M, int N, int NRHS,
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* @retval CHAMELEON_SUCCESS successful exit
*
*******************************************************************************
*
......
......@@ -64,9 +64,8 @@
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* \retval <0 if -i, the i-th argument had an illegal value
* @retval CHAMELEON_SUCCESS successful exit
* @retval <0 if -i, the i-th argument had an illegal value
*
*******************************************************************************
*
......@@ -192,8 +191,7 @@ int CHAMELEON_zgelqs_param( const libhqr_tree_t *qrtree, int M, int N, int NRHS,
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* @retval CHAMELEON_SUCCESS successful exit
*
*******************************************************************************
*
......
......@@ -89,9 +89,8 @@
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* \retval <0 if -i, the i-th argument had an illegal value
* @retval CHAMELEON_SUCCESS successful exit
* @retval <0 if -i, the i-th argument had an illegal value
*
*******************************************************************************
*
......@@ -244,8 +243,7 @@ int CHAMELEON_zgels( cham_trans_t trans, int M, int N, int NRHS,
*
*******************************************************************************
*
* @return
* \return CHAMELEON_SUCCESS successful exit
* @return CHAMELEON_SUCCESS successful exit
*
*******************************************************************************
*
......
......@@ -92,9 +92,8 @@
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* \retval <0 if -i, the i-th argument had an illegal value
* @retval CHAMELEON_SUCCESS successful exit
* @retval <0 if -i, the i-th argument had an illegal value
*
*******************************************************************************
*
......@@ -250,8 +249,7 @@ int CHAMELEON_zgels_param( const libhqr_tree_t *qrtree, cham_trans_t trans, int
*
*******************************************************************************
*
* @return
* \return CHAMELEON_SUCCESS successful exit
* @return CHAMELEON_SUCCESS successful exit
*
*******************************************************************************
*
......
......@@ -114,8 +114,7 @@
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* @retval CHAMELEON_SUCCESS successful exit
*
*******************************************************************************
*
......@@ -283,8 +282,7 @@ int CHAMELEON_zgemm( cham_trans_t transA, cham_trans_t transB, int M, int N, int
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* @retval CHAMELEON_SUCCESS successful exit
*
*******************************************************************************
*
......
......@@ -55,9 +55,8 @@
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* \retval <0 if -i, the i-th argument had an illegal value
* @retval CHAMELEON_SUCCESS successful exit
* @retval <0 if -i, the i-th argument had an illegal value
*
*******************************************************************************
*
......@@ -164,8 +163,7 @@ int CHAMELEON_zgeqrf( int M, int N,
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* @retval CHAMELEON_SUCCESS successful exit
*
*******************************************************************************
*
......
......@@ -59,9 +59,8 @@
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* \retval <0 if -i, the i-th argument had an illegal value
* @retval CHAMELEON_SUCCESS successful exit
* @retval <0 if -i, the i-th argument had an illegal value
*
*******************************************************************************
*
......@@ -173,8 +172,7 @@ int CHAMELEON_zgeqrf_param( const libhqr_tree_t *qrtree, int M, int N,
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* @retval CHAMELEON_SUCCESS successful exit
*
*******************************************************************************
*
......
......@@ -62,9 +62,8 @@
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* \retval <0 if -i, the i-th argument had an illegal value
* @retval CHAMELEON_SUCCESS successful exit
* @retval <0 if -i, the i-th argument had an illegal value
*
*******************************************************************************
*
......@@ -185,8 +184,7 @@ int CHAMELEON_zgeqrs( int M, int N, int NRHS,
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* @retval CHAMELEON_SUCCESS successful exit
*
*******************************************************************************
*
......
......@@ -58,9 +58,8 @@
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* \retval <0 if -i, the i-th argument had an illegal value
* @retval CHAMELEON_SUCCESS successful exit
* @retval <0 if -i, the i-th argument had an illegal value
*
*******************************************************************************
*
......@@ -182,8 +181,7 @@ int CHAMELEON_zgeqrs_param( const libhqr_tree_t *qrtree, int M, int N, int NRHS,
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* @retval CHAMELEON_SUCCESS successful exit
*
*******************************************************************************
*
......
......@@ -67,10 +67,9 @@
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* \retval <0 if -i, the i-th argument had an illegal value
* \retval >0 if i, U(i,i) is exactly zero. The factorization has been completed,
* @retval CHAMELEON_SUCCESS successful exit
* @retval <0 if -i, the i-th argument had an illegal value
* @retval >0 if i, U(i,i) is exactly zero. The factorization has been completed,
* but the factor U is exactly singular, so the solution could not be computed.
*
*******************************************************************************
......@@ -189,9 +188,8 @@ int CHAMELEON_zgesv_incpiv( int N, int NRHS,
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* \retval >0 if i, U(i,i) is exactly zero. The factorization has been completed,
* @retval CHAMELEON_SUCCESS successful exit
* @retval >0 if i, U(i,i) is exactly zero. The factorization has been completed,
* but the factor U is exactly singular, so the solution could not be computed.
*
*******************************************************************************
......
......@@ -66,10 +66,9 @@
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* \retval <0 if -i, the i-th argument had an illegal value
* \retval >0 if i, U(i,i) is exactly zero. The factorization has been completed,
* @retval CHAMELEON_SUCCESS successful exit
* @retval <0 if -i, the i-th argument had an illegal value
* @retval >0 if i, U(i,i) is exactly zero. The factorization has been completed,
* but the factor U is exactly singular, so the solution could not be computed.
*
*******************************************************************************
......@@ -179,9 +178,8 @@ int CHAMELEON_zgesv_nopiv( int N, int NRHS,
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* \retval >0 if i, U(i,i) is exactly zero. The factorization has been completed,
* @retval CHAMELEON_SUCCESS successful exit
* @retval >0 if i, U(i,i) is exactly zero. The factorization has been completed,
* but the factor U is exactly singular, so the solution could not be computed.
*
*******************************************************************************
......
......@@ -129,9 +129,8 @@
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* \retval <0 if -i, the i-th argument had an illegal value
* @retval CHAMELEON_SUCCESS successful exit
* @retval <0 if -i, the i-th argument had an illegal value
*
*******************************************************************************
*
......@@ -318,8 +317,7 @@ int CHAMELEON_zgesvd( cham_job_t jobu, cham_job_t jobvt,
*
*******************************************************************************
*
* @return
* \return CHAMELEON_SUCCESS successful exit
* @return CHAMELEON_SUCCESS successful exit
*
*******************************************************************************
*
......
......@@ -56,10 +56,9 @@
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* \retval <0 if -i, the i-th argument had an illegal value
* \retval >0 if i, U(i,i) is exactly zero. The factorization has been completed,
* @retval CHAMELEON_SUCCESS successful exit
* @retval <0 if -i, the i-th argument had an illegal value
* @retval >0 if i, U(i,i) is exactly zero. The factorization has been completed,
* but the factor U is exactly singular, and division by zero will occur
* if it is used to solve a system of equations.
*
......@@ -166,9 +165,8 @@ int CHAMELEON_zgetrf_incpiv( int M, int N,
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* \retval >0 if i, U(i,i) is exactly zero. The factorization has been completed,
* @retval CHAMELEON_SUCCESS successful exit
* @retval >0 if i, U(i,i) is exactly zero. The factorization has been completed,
* but the factor U is exactly singular, and division by zero will occur
* if it is used to solve a system of equations.
*
......
......@@ -50,10 +50,9 @@
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* \retval <0 if -i, the i-th argument had an illegal value
* \retval >0 if i, U(i,i) is exactly zero. The factorization has been
* @retval CHAMELEON_SUCCESS successful exit
* @retval <0 if -i, the i-th argument had an illegal value
* @retval >0 if i, U(i,i) is exactly zero. The factorization has been
* completed, but the factor U is exactly singular, and division
* by zero will occur if it is used to solve a system of
* equations.
......@@ -151,9 +150,8 @@ int CHAMELEON_zgetrf_nopiv( int M, int N,
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* \retval >0 if i, U(i,i) is exactly zero. The factorization has been completed,
* @retval CHAMELEON_SUCCESS successful exit
* @retval >0 if i, U(i,i) is exactly zero. The factorization has been completed,
* but the factor U is exactly singular, and division by zero will occur
* if it is used to solve a system of equations.
*
......
......@@ -69,9 +69,8 @@
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* \return <0 if -i, the i-th argument had an illegal value
* @retval CHAMELEON_SUCCESS successful exit
* @return <0 if -i, the i-th argument had an illegal value
*
*******************************************************************************
*
......@@ -194,8 +193,7 @@ int CHAMELEON_zgetrs_incpiv( cham_trans_t trans, int N, int NRHS,
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* @retval CHAMELEON_SUCCESS successful exit
*
*******************************************************************************
*
......
......@@ -64,9 +64,8 @@
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* \return <0 if -i, the i-th argument had an illegal value
* @retval CHAMELEON_SUCCESS successful exit
* @return <0 if -i, the i-th argument had an illegal value
*
*******************************************************************************
*
......@@ -181,8 +180,7 @@ int CHAMELEON_zgetrs_nopiv( cham_trans_t trans, int N, int NRHS,
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* @retval CHAMELEON_SUCCESS successful exit
*
*******************************************************************************
*
......
......@@ -79,10 +79,9 @@
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* \retval <0 if -i, the i-th argument had an illegal value
* \retval >0 if INFO = i, the algorithm failed to converge; i
* @retval CHAMELEON_SUCCESS successful exit
* @retval <0 if -i, the i-th argument had an illegal value
* @retval >0 if INFO = i, the algorithm failed to converge; i
* off-diagonal elements of an intermediate tridiagonal
* form did not converge to zero.
*
......@@ -219,10 +218,9 @@ int CHAMELEON_zheevd( cham_job_t jobz, cham_uplo_t uplo, int N,
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* \retval <0 if -i, the i-th argument had an illegal value
* \retval >0 if INFO = i, the algorithm failed to converge; i
* @retval CHAMELEON_SUCCESS successful exit
* @retval <0 if -i, the i-th argument had an illegal value
* @retval >0 if INFO = i, the algorithm failed to converge; i
* off-diagonal elements of an intermediate tridiagonal
* form did not converge to zero.
*
......
......@@ -90,8 +90,7 @@
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* @retval CHAMELEON_SUCCESS successful exit
*
*******************************************************************************
*
......@@ -248,8 +247,7 @@ int CHAMELEON_zhemm( cham_side_t side, cham_uplo_t uplo, int M, int N,
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* @retval CHAMELEON_SUCCESS successful exit
*
*******************************************************************************
*
......
......@@ -92,8 +92,7 @@
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* @retval CHAMELEON_SUCCESS successful exit
*
*******************************************************************************
*
......@@ -249,8 +248,7 @@ int CHAMELEON_zher2k( cham_uplo_t uplo, cham_trans_t trans, int N, int K,
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* @retval CHAMELEON_SUCCESS successful exit
*
*******************************************************************************
*
......
......@@ -82,8 +82,7 @@
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* @retval CHAMELEON_SUCCESS successful exit
*
*******************************************************************************
*
......@@ -225,8 +224,7 @@ int CHAMELEON_zherk( cham_uplo_t uplo, cham_trans_t trans, int N, int K,
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* @retval CHAMELEON_SUCCESS successful exit
*
*******************************************************************************
*
......
......@@ -92,10 +92,9 @@
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* \retval <0 if -i, the i-th argument had an illegal value
* \retval >0 if INFO = i, the algorithm failed to converge; i
* @retval CHAMELEON_SUCCESS successful exit
* @retval <0 if -i, the i-th argument had an illegal value
* @retval >0 if INFO = i, the algorithm failed to converge; i
* off-diagonal elements of an intermediate tridiagonal
* form did not converge to zero.
*
......@@ -245,10 +244,9 @@ int CHAMELEON_zhetrd( cham_job_t jobz, cham_uplo_t uplo, int N,
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* \retval <0 if -i, the i-th argument had an illegal value
* \retval >0 if INFO = i, the algorithm failed to converge; i
* @retval CHAMELEON_SUCCESS successful exit
* @retval <0 if -i, the i-th argument had an illegal value
* @retval >0 if INFO = i, the algorithm failed to converge; i
* off-diagonal elements of an intermediate tridiagonal
* form did not converge to zero.
*
......
......@@ -180,8 +180,7 @@ int CHAMELEON_zlacpy( cham_uplo_t uplo, int M, int N,
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* @retval CHAMELEON_SUCCESS successful exit
*
*******************************************************************************
*
......
......@@ -66,8 +66,7 @@
*
*******************************************************************************
*
* @return
* \retval the norm described above.
* @retval the norm described above.
*
*******************************************************************************
*
......@@ -176,8 +175,7 @@ double CHAMELEON_zlange(cham_normtype_t norm, int M, int N,
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* @retval CHAMELEON_SUCCESS successful exit
*
*******************************************************************************
*
......
......@@ -66,8 +66,7 @@
*
*******************************************************************************
*
* @return
* \retval the norm described above.
* @retval the norm described above.
*
*******************************************************************************
*
......@@ -180,8 +179,7 @@ double CHAMELEON_zlanhe(cham_normtype_t norm, cham_uplo_t uplo, int N,
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* @retval CHAMELEON_SUCCESS successful exit
*
*******************************************************************************
*
......
......@@ -66,8 +66,7 @@
*
*******************************************************************************
*
* @return
* \retval the norm described above.
* @retval the norm described above.
*
*******************************************************************************
*
......@@ -180,8 +179,7 @@ double CHAMELEON_zlansy(cham_normtype_t norm, cham_uplo_t uplo, int N,
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* @retval CHAMELEON_SUCCESS successful exit
*
*******************************************************************************
*
......
......@@ -78,8 +78,7 @@
*
*******************************************************************************
*
* @return
* \retval the norm described above.
* @retval the norm described above.
*
*******************************************************************************
*
......@@ -202,8 +201,7 @@ double CHAMELEON_zlantr(cham_normtype_t norm, cham_uplo_t uplo, cham_diag_t diag
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* @retval CHAMELEON_SUCCESS successful exit
*
*******************************************************************************
*
......
......@@ -57,8 +57,7 @@
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* @retval CHAMELEON_SUCCESS successful exit
*
*******************************************************************************
*
......@@ -168,8 +167,7 @@ int CHAMELEON_zlascal( cham_uplo_t uplo, int M, int N,
*
*******************************************************************************
*
* @return
* \retval CHAMELEON_SUCCESS successful exit
* @retval CHAMELEON_SUCCESS successful exit
*