From 3173a27ff685b14dab0098688d3395ae71edb028 Mon Sep 17 00:00:00 2001
From: Florent Pruvost <florent.pruvost@inria.fr>
Date: Tue, 23 Aug 2022 09:23:43 +0200
Subject: [PATCH] Polish for readibility and respect writing conventions

---
 doc/user/chapters/using.org                   |  9 ++---
 .../include/chameleon/chameleon_zlapack.h     | 16 ++++----
 lapack_api/src/lapack_api_common.c            |  2 +-
 lapack_api/src/lapack_zgemm.c                 |  5 ++-
 lapack_api/src/lapack_zhemm.c                 |  7 ++--
 lapack_api/src/lapack_zher2k.c                | 33 ++++++++--------
 lapack_api/src/lapack_zherk.c                 |  7 ++--
 lapack_api/src/lapack_zlauum.c                |  5 ++-
 lapack_api/src/lapack_zsymm.c                 |  5 ++-
 lapack_api/src/lapack_zsyr2k.c                | 39 ++++++++++---------
 lapack_api/src/lapack_zsyrk.c                 |  7 ++--
 lapack_api/src/lapack_ztrmm.c                 |  5 ++-
 lapack_api/src/lapack_ztrsm.c                 |  5 ++-
 13 files changed, 77 insertions(+), 68 deletions(-)

diff --git a/doc/user/chapters/using.org b/doc/user/chapters/using.org
index 1fcb4d84b..2847cd286 100644
--- a/doc/user/chapters/using.org
+++ b/doc/user/chapters/using.org
@@ -858,11 +858,10 @@
        * *Map functions*
          * map: apply a user operator on each tile of the matrix
 
-     In addition, all *BLAS 2/3 routines* (gemm, hemm, her2k, herk,
-     lauum, symm, syr2k, syrk, trmm, trsm) can be called using an
-     equivalent of the (C)BLAS/LAPACK(E) API. The parameters are the
-     same and the user just has to add *CHAMELEON_* to the standard name
-     of the routine. For example, in C
+     In addition, all *BLAS 3 routines* (gemm, hemm, her2k, herk, lauum, symm,
+     syr2k, syrk, trmm, trsm) can be called using an equivalent of the
+     (C)BLAS/LAPACK(E) API. The parameters are the same and the user just has
+     to add *CHAMELEON_* to the standard name of the routine. For example, in C
      #+begin_src
      CHAMELEON_Init(4,0);
      CHAMELEON_cblas_dgemm(CblasColMajor, CblasNoTrans, CblasNoTrans,
diff --git a/lapack_api/include/chameleon/chameleon_zlapack.h b/lapack_api/include/chameleon/chameleon_zlapack.h
index 10e4763af..77320305e 100644
--- a/lapack_api/include/chameleon/chameleon_zlapack.h
+++ b/lapack_api/include/chameleon/chameleon_zlapack.h
@@ -40,10 +40,10 @@ void CHAMELEON_cblas_zhemm( const CBLAS_ORDER order, const CBLAS_SIDE side, cons
                             const void *beta,        CHAMELEON_Complex64_t *C, const int ldc );
 
 void CHAMELEON_cblas_zher2k( const CBLAS_ORDER order, const CBLAS_UPLO uplo, const CBLAS_TRANSPOSE trans,
-                            const int N, const int K,
-                            const void *alpha, const CHAMELEON_Complex64_t *A, const int lda,
-                                               const CHAMELEON_Complex64_t *B, const int ldb,
-                            const double beta,       CHAMELEON_Complex64_t *C, const int ldc );
+                             const int N, const int K,
+                             const void *alpha, const CHAMELEON_Complex64_t *A, const int lda,
+                                                const CHAMELEON_Complex64_t *B, const int ldb,
+                             const double beta,       CHAMELEON_Complex64_t *C, const int ldc );
 
 void CHAMELEON_cblas_zherk( const CBLAS_ORDER order, const CBLAS_UPLO uplo, const CBLAS_TRANSPOSE trans,
                             const int N, const int K,
@@ -57,10 +57,10 @@ void CHAMELEON_cblas_zsymm( const CBLAS_ORDER order, const CBLAS_SIDE side, cons
                             const void *beta,        CHAMELEON_Complex64_t *C, const int ldc );
 
 void CHAMELEON_cblas_zsyr2k( const CBLAS_ORDER order, const CBLAS_UPLO uplo, const CBLAS_TRANSPOSE trans,
-                            const int N, const int K,
-                            const void *alpha, const CHAMELEON_Complex64_t *A, const int lda,
-                                               const CHAMELEON_Complex64_t *B, const int ldb,
-                            const void *beta,        CHAMELEON_Complex64_t *C, const int ldc );
+                             const int N, const int K,
+                             const void *alpha, const CHAMELEON_Complex64_t *A, const int lda,
+                                                const CHAMELEON_Complex64_t *B, const int ldb,
+                             const void *beta,        CHAMELEON_Complex64_t *C, const int ldc );
 
 void CHAMELEON_cblas_zsyrk( const CBLAS_ORDER order, const CBLAS_UPLO uplo, const CBLAS_TRANSPOSE trans,
                             const int N, const int K,
diff --git a/lapack_api/src/lapack_api_common.c b/lapack_api/src/lapack_api_common.c
index eaab7c29a..f1773234e 100644
--- a/lapack_api/src/lapack_api_common.c
+++ b/lapack_api/src/lapack_api_common.c
@@ -90,4 +90,4 @@ int chameleon_blastocblas_diag(const char* diag)
         fprintf(stderr, "CHAMELEON ERROR: %s(): %s\n", "chameleon_blastocblas_diag", "illegal value of BLAS diag parameter");
         return CHAMELEON_ERR_ILLEGAL_VALUE;
     }
-}
\ No newline at end of file
+}
diff --git a/lapack_api/src/lapack_zgemm.c b/lapack_api/src/lapack_zgemm.c
index 1ac81eb6d..86c22af92 100644
--- a/lapack_api/src/lapack_zgemm.c
+++ b/lapack_api/src/lapack_zgemm.c
@@ -125,8 +125,9 @@ void CHAMELEON_cblas_zgemm( const CBLAS_ORDER order, const CBLAS_TRANSPOSE trans
                                                const CHAMELEON_Complex64_t *B, const int ldb,
                             const void *beta,        CHAMELEON_Complex64_t *C, const int ldc )
 {
-    if (order != CblasColMajor){
-        fprintf(stderr, "CHAMELEON ERROR: %s(): %s\n", "CHAMELEON_cblas_zgemm", "illegal value of order");
+    if ( order != CblasColMajor ){
+        fprintf( stderr, "CHAMELEON ERROR: %s(): %s\n", "CHAMELEON_cblas_zgemm", "illegal value of order" );
+        return;
     }
 
 #if defined(PRECISION_z) || defined(PRECISION_c)
diff --git a/lapack_api/src/lapack_zhemm.c b/lapack_api/src/lapack_zhemm.c
index 10b314326..9a07c7764 100644
--- a/lapack_api/src/lapack_zhemm.c
+++ b/lapack_api/src/lapack_zhemm.c
@@ -27,7 +27,7 @@ void CHAMELEON_blas_zhemm ( const char* side, const char* uplo,
                             const int* m, const int* n,
                             const CHAMELEON_Complex64_t* alpha, const CHAMELEON_Complex64_t* a, const int* lda,
                                                                 const CHAMELEON_Complex64_t* b, const int* ldb,
-                            const CHAMELEON_Complex64_t* beta,  CHAMELEON_Complex64_t* c, const int* ldc )
+                            const CHAMELEON_Complex64_t* beta,        CHAMELEON_Complex64_t* c, const int* ldc )
 {
     CHAMELEON_cblas_zhemm( CblasColMajor,
                            chameleon_blastocblas_side(side),
@@ -123,8 +123,9 @@ void CHAMELEON_cblas_zhemm( const CBLAS_ORDER order, const CBLAS_SIDE side, cons
                                                const CHAMELEON_Complex64_t *B, const int ldb,
                             const void *beta,        CHAMELEON_Complex64_t *C, const int ldc )
 {
-    if (order != CblasColMajor){
-        fprintf(stderr, "CHAMELEON ERROR: %s(): %s\n", "CHAMELEON_cblas_zhemm", "illegal value of order");
+    if ( order != CblasColMajor ){
+        fprintf( stderr, "CHAMELEON ERROR: %s(): %s\n", "CHAMELEON_cblas_zhemm", "illegal value of order" );
+        return;
     }
 
 #if defined(PRECISION_z) || defined(PRECISION_c)
diff --git a/lapack_api/src/lapack_zher2k.c b/lapack_api/src/lapack_zher2k.c
index b1c154172..9154e9703 100644
--- a/lapack_api/src/lapack_zher2k.c
+++ b/lapack_api/src/lapack_zher2k.c
@@ -24,18 +24,18 @@
 
 #define CHAMELEON_blas_zher2k CHAMELEON_GLOBAL( chameleon_blas_zher2k, CHAMELEON_BLAS_Zher2k )
 void CHAMELEON_blas_zher2k ( const char* uplo, const char* trans,
-                            const int* n, const int* k,
-                            const CHAMELEON_Complex64_t* alpha, const CHAMELEON_Complex64_t* a, const int* lda,
-                                                                const CHAMELEON_Complex64_t* b, const int* ldb,
-                            const double* beta,  CHAMELEON_Complex64_t* c, const int* ldc )
+                             const int* n, const int* k,
+                             const CHAMELEON_Complex64_t* alpha, const CHAMELEON_Complex64_t* a, const int* lda,
+                                                                 const CHAMELEON_Complex64_t* b, const int* ldb,
+                             const double* beta,                       CHAMELEON_Complex64_t* c, const int* ldc )
 {
     CHAMELEON_cblas_zher2k( CblasColMajor,
-                           chameleon_blastocblas_uplo(uplo),
-                           chameleon_blastocblas_trans(trans),
-                           *n, *k,
-                           CBLAS_SADDR(*alpha), a, *lda,
-                           b, *ldb,
-                           *beta, c, *ldc );
+                            chameleon_blastocblas_uplo(uplo),
+                            chameleon_blastocblas_trans(trans),
+                            *n, *k,
+                            CBLAS_SADDR(*alpha), a, *lda,
+                            b, *ldb,
+                            *beta, c, *ldc );
 }
 
 /* C CBLAS interface */
@@ -120,13 +120,14 @@ void CHAMELEON_blas_zher2k ( const char* uplo, const char* trans,
  *
  */
 void CHAMELEON_cblas_zher2k( const CBLAS_ORDER order, const CBLAS_UPLO uplo, const CBLAS_TRANSPOSE trans,
-                            const int N, const int K,
-                            const void *alpha, const CHAMELEON_Complex64_t *A, const int lda,
-                                               const CHAMELEON_Complex64_t *B, const int ldb,
-                            const double beta,       CHAMELEON_Complex64_t *C, const int ldc )
+                             const int N, const int K,
+                             const void *alpha, const CHAMELEON_Complex64_t *A, const int lda,
+                                                const CHAMELEON_Complex64_t *B, const int ldb,
+                             const double beta,       CHAMELEON_Complex64_t *C, const int ldc )
 {
-    if (order != CblasColMajor){
-        fprintf(stderr, "CHAMELEON ERROR: %s(): %s\n", "CHAMELEON_cblas_zher2k", "illegal value of order");
+    if ( order != CblasColMajor ){
+        fprintf( stderr, "CHAMELEON ERROR: %s(): %s\n", "CHAMELEON_cblas_zher2k", "illegal value of order" );
+        return;
     }
 
 #if defined(PRECISION_z) || defined(PRECISION_c)
diff --git a/lapack_api/src/lapack_zherk.c b/lapack_api/src/lapack_zherk.c
index 67f7ab904..9b5b80a7f 100644
--- a/lapack_api/src/lapack_zherk.c
+++ b/lapack_api/src/lapack_zherk.c
@@ -26,7 +26,7 @@
 void CHAMELEON_blas_zherk ( const char* uplo, const char* trans,
                             const int* n, const int* k,
                             const double* alpha, const CHAMELEON_Complex64_t* a, const int* lda,
-                            const double* beta,  CHAMELEON_Complex64_t* c, const int* ldc )
+                            const double* beta,        CHAMELEON_Complex64_t* c, const int* ldc )
 {
     CHAMELEON_cblas_zherk( CblasColMajor,
                            chameleon_blastocblas_uplo(uplo),
@@ -112,8 +112,9 @@ void CHAMELEON_cblas_zherk( const CBLAS_ORDER order, const CBLAS_UPLO uplo, cons
                             const double alpha, const CHAMELEON_Complex64_t *A, const int lda,
                             const double beta,        CHAMELEON_Complex64_t *C, const int ldc )
 {
-    if (order != CblasColMajor){
-        fprintf(stderr, "CHAMELEON ERROR: %s(): %s\n", "CHAMELEON_cblas_zherk", "illegal value of order");
+    if ( order != CblasColMajor ){
+        fprintf( stderr, "CHAMELEON ERROR: %s(): %s\n", "CHAMELEON_cblas_zherk", "illegal value of order" );
+        return;
     }
 
     CHAMELEON_zherk( (cham_uplo_t)uplo, (cham_trans_t)trans, N, K,
diff --git a/lapack_api/src/lapack_zlauum.c b/lapack_api/src/lapack_zlauum.c
index a0a3f2d24..4216edcd4 100644
--- a/lapack_api/src/lapack_zlauum.c
+++ b/lapack_api/src/lapack_zlauum.c
@@ -87,8 +87,9 @@ void CHAMELEON_lapack_zlauum ( const char* uplo, const int* n,
 int CHAMELEON_lapacke_zlauum( int matrix_layout, char uplo, int N,
                               CHAMELEON_Complex64_t *A, int lda )
 {
-    if (matrix_layout != CblasColMajor){
-        fprintf(stderr, "CHAMELEON ERROR: %s(): %s\n", "CHAMELEON_lapacke_zlauum", "illegal value of matrix_layout");
+    if ( matrix_layout != CblasColMajor ){
+        fprintf( stderr, "CHAMELEON ERROR: %s(): %s\n", "CHAMELEON_lapacke_zlauum", "illegal value of matrix_layout" );
+        return;
     }
 
     return CHAMELEON_zlauum( (cham_uplo_t)chameleon_blastocblas_uplo(&uplo), N,
diff --git a/lapack_api/src/lapack_zsymm.c b/lapack_api/src/lapack_zsymm.c
index 410eac0f1..37e31a1f3 100644
--- a/lapack_api/src/lapack_zsymm.c
+++ b/lapack_api/src/lapack_zsymm.c
@@ -123,8 +123,9 @@ void CHAMELEON_cblas_zsymm( const CBLAS_ORDER order, const CBLAS_SIDE side, cons
                                                const CHAMELEON_Complex64_t *B, const int ldb,
                             const void *beta,        CHAMELEON_Complex64_t *C, const int ldc )
 {
-    if (order != CblasColMajor){
-        fprintf(stderr, "CHAMELEON ERROR: %s(): %s\n", "CHAMELEON_cblas_zsymm", "illegal value of order");
+    if ( order != CblasColMajor ){
+        fprintf( stderr, "CHAMELEON ERROR: %s(): %s\n", "CHAMELEON_cblas_zsymm", "illegal value of order" );
+        return;
     }
 
 #if defined(PRECISION_z) || defined(PRECISION_c)
diff --git a/lapack_api/src/lapack_zsyr2k.c b/lapack_api/src/lapack_zsyr2k.c
index a25540b32..15f55c710 100644
--- a/lapack_api/src/lapack_zsyr2k.c
+++ b/lapack_api/src/lapack_zsyr2k.c
@@ -24,18 +24,18 @@
 
 #define CHAMELEON_blas_zsyr2k CHAMELEON_GLOBAL( chameleon_blas_zsyr2k, CHAMELEON_BLAS_Zsyr2k )
 void CHAMELEON_blas_zsyr2k ( const char* uplo, const char* trans,
-                            const int* n, const int* k,
-                            const CHAMELEON_Complex64_t* alpha, const CHAMELEON_Complex64_t* a, const int* lda,
-                                                                const CHAMELEON_Complex64_t* b, const int* ldb,
-                            const CHAMELEON_Complex64_t* beta,  CHAMELEON_Complex64_t* c, const int* ldc )
+                             const int* n, const int* k,
+                             const CHAMELEON_Complex64_t* alpha, const CHAMELEON_Complex64_t* a, const int* lda,
+                                                                 const CHAMELEON_Complex64_t* b, const int* ldb,
+                             const CHAMELEON_Complex64_t* beta,        CHAMELEON_Complex64_t* c, const int* ldc )
 {
     CHAMELEON_cblas_zsyr2k( CblasColMajor,
-                           chameleon_blastocblas_uplo(uplo),
-                           chameleon_blastocblas_trans(trans),
-                           *n, *k,
-                           CBLAS_SADDR(*alpha), a, *lda,
-                           b, *ldb,
-                           CBLAS_SADDR(*beta), c, *ldc );
+                            chameleon_blastocblas_uplo(uplo),
+                            chameleon_blastocblas_trans(trans),
+                            *n, *k,
+                            CBLAS_SADDR(*alpha), a, *lda,
+                            b, *ldb,
+                            CBLAS_SADDR(*beta), c, *ldc );
 }
 
 /* C CBLAS interface */
@@ -116,13 +116,14 @@ void CHAMELEON_blas_zsyr2k ( const char* uplo, const char* trans,
  *
  */
 void CHAMELEON_cblas_zsyr2k( const CBLAS_ORDER order, const CBLAS_UPLO uplo, const CBLAS_TRANSPOSE trans,
-                            const int N, const int K,
-                            const void *alpha, const CHAMELEON_Complex64_t *A, const int lda,
-                                               const CHAMELEON_Complex64_t *B, const int ldb,
-                            const void *beta,        CHAMELEON_Complex64_t *C, const int ldc )
+                             const int N, const int K,
+                             const void *alpha, const CHAMELEON_Complex64_t *A, const int lda,
+                                                const CHAMELEON_Complex64_t *B, const int ldb,
+                             const void *beta,        CHAMELEON_Complex64_t *C, const int ldc )
 {
-    if (order != CblasColMajor){
-        fprintf(stderr, "CHAMELEON ERROR: %s(): %s\n", "CHAMELEON_cblas_zsyr2k", "illegal value of order");
+    if ( order != CblasColMajor ){
+        fprintf( stderr, "CHAMELEON ERROR: %s(): %s\n", "CHAMELEON_cblas_zsyr2k", "illegal value of order" );
+        return;
     }
 
 #if defined(PRECISION_z) || defined(PRECISION_c)
@@ -134,7 +135,7 @@ void CHAMELEON_cblas_zsyr2k( const CBLAS_ORDER order, const CBLAS_UPLO uplo, con
 #endif
 
     CHAMELEON_zsyr2k( (cham_uplo_t)uplo, (cham_trans_t)trans, N, K,
-                     alphac, (CHAMELEON_Complex64_t *)A, lda,
-                     (CHAMELEON_Complex64_t *)B, ldb,
-                     betac, (CHAMELEON_Complex64_t *)C, ldc );
+                      alphac, (CHAMELEON_Complex64_t *)A, lda,
+                      (CHAMELEON_Complex64_t *)B, ldb,
+                      betac, (CHAMELEON_Complex64_t *)C, ldc );
 }
diff --git a/lapack_api/src/lapack_zsyrk.c b/lapack_api/src/lapack_zsyrk.c
index 374cc3193..9ac63d931 100644
--- a/lapack_api/src/lapack_zsyrk.c
+++ b/lapack_api/src/lapack_zsyrk.c
@@ -26,7 +26,7 @@
 void CHAMELEON_blas_zsyrk ( const char* uplo, const char* trans,
                             const int* n, const int* k,
                             const CHAMELEON_Complex64_t* alpha, const CHAMELEON_Complex64_t* a, const int* lda,
-                            const CHAMELEON_Complex64_t* beta,  CHAMELEON_Complex64_t* c, const int* ldc )
+                            const CHAMELEON_Complex64_t* beta,        CHAMELEON_Complex64_t* c, const int* ldc )
 {
     CHAMELEON_cblas_zsyrk( CblasColMajor,
                            chameleon_blastocblas_uplo(uplo),
@@ -110,8 +110,9 @@ void CHAMELEON_cblas_zsyrk( const CBLAS_ORDER order, const CBLAS_UPLO uplo, cons
                             const void *alpha, const CHAMELEON_Complex64_t *A, const int lda,
                             const void *beta,        CHAMELEON_Complex64_t *C, const int ldc )
 {
-    if (order != CblasColMajor){
-        fprintf(stderr, "CHAMELEON ERROR: %s(): %s\n", "CHAMELEON_cblas_zsyrk", "illegal value of order");
+    if ( order != CblasColMajor ){
+        fprintf( stderr, "CHAMELEON ERROR: %s(): %s\n", "CHAMELEON_cblas_zsyrk", "illegal value of order" );
+        return;
     }
 
 #if defined(PRECISION_z) || defined(PRECISION_c)
diff --git a/lapack_api/src/lapack_ztrmm.c b/lapack_api/src/lapack_ztrmm.c
index 2811813d1..4e571213d 100644
--- a/lapack_api/src/lapack_ztrmm.c
+++ b/lapack_api/src/lapack_ztrmm.c
@@ -118,8 +118,9 @@ void CHAMELEON_cblas_ztrmm( const CBLAS_ORDER order, const CBLAS_SIDE side, cons
                             const void *alpha, const CHAMELEON_Complex64_t *A, const int lda,
                                                const CHAMELEON_Complex64_t *B, const int ldb )
 {
-    if (order != CblasColMajor){
-        fprintf(stderr, "CHAMELEON ERROR: %s(): %s\n", "CHAMELEON_cblas_ztrmm", "illegal value of order");
+    if ( order != CblasColMajor ){
+        fprintf( stderr, "CHAMELEON ERROR: %s(): %s\n", "CHAMELEON_cblas_ztrmm", "illegal value of order" );
+        return;
     }
 
 #if defined(PRECISION_z) || defined(PRECISION_c)
diff --git a/lapack_api/src/lapack_ztrsm.c b/lapack_api/src/lapack_ztrsm.c
index 30aa75eaa..08c337093 100644
--- a/lapack_api/src/lapack_ztrsm.c
+++ b/lapack_api/src/lapack_ztrsm.c
@@ -138,8 +138,9 @@ void CHAMELEON_cblas_ztrsm( const CBLAS_ORDER order, const CBLAS_SIDE side, cons
                             const void *alpha, const CHAMELEON_Complex64_t *A, const int lda,
                                                const CHAMELEON_Complex64_t *B, const int ldb )
 {
-    if (order != CblasColMajor){
-        fprintf(stderr, "CHAMELEON ERROR: %s(): %s\n", "CHAMELEON_cblas_ztrsm", "illegal value of order");
+    if ( order != CblasColMajor ){
+        fprintf( stderr, "CHAMELEON ERROR: %s(): %s\n", "CHAMELEON_cblas_ztrsm", "illegal value of order" );
+        return;
     }
 
 #if defined(PRECISION_z) || defined(PRECISION_c)
-- 
GitLab