Update docs for LAPACK connector API files

Author: Cstandardlib

source/source_base/module_container/base/third_party/lapack.h

@@ -1,3 +1,15 @@
+/**
+ * @file lapack.h
+ * @brief This is a direct wrapper of some LAPACK routines.
+ * Direct wrapping of standard LAPACK routines. (column major, fortran style)
+ * 
+ * @note
+ * Some slight modification are made to fit the C++ style for overloading purpose.
+ * You can find some function with different parameter list than the original LAPACK routine.
+ * And some of these parameters are not referred in the function body. They are included just to
+ * ensure the same parameter list for overloaded functions with a uniform name.
+ */
+
 #ifndef BASE_THIRD_PARTY_LAPACK_H_
 #define BASE_THIRD_PARTY_LAPACK_H_
 
@@ -10,6 +22,10 @@
 #include <base/third_party/hipsolver.h>
 #endif
 
+/// This is a wrapper of some LAPACK routines.
+/// Direct wrapping of standard LAPACK routines. (column major, fortran style)
+/// with some slight modification to fit the C++ style for overloading purpose.
+
 //Naming convention of lapack subroutines : ammxxx, where
 //"a" specifies the data type:
 //  - d stands for double

source/source_base/module_external/lapack_connector.h

@@ -1,5 +1,24 @@
-#ifndef LAPACKCONNECTOR_HPP
-#define LAPACKCONNECTOR_HPP
+/**
+ * @file lapack_connector.h
+ * 
+ * @brief This is a wrapper of some LAPACK routines.
+ * 
+ * @warning MAY BE DEPRECATED IN THE FUTURE.
+ * 
+ * @note 
+ * !!! Note that 
+ * This wrapper is a <b>C++ style</b> wrapper of LAPACK routines,
+ * i.e., assuming that the input matrices are in \b row-major order.
+ * The data layout in C++ is row-major, C style,
+ * while the original LAPACK is column-major, fortran style.
+ * (ModuleBase::ComplexMatrix is in row-major order)
+ * The wrapper will do the data transformation between
+ * row-major and column-major order automatically.
+ * 
+ */
+
+#ifndef LAPACK_CONNECTOR_HPP
+#define LAPACK_CONNECTOR_HPP
 
 #include <new>
 #include <stdexcept>
@@ -11,8 +30,10 @@
 
 //Naming convention of lapack subroutines : ammxxx, where
 //"a" specifies the data type:
-//  - d stands for double
-//  - z stands for complex double
+// - s stands for float
+// - d stands for double
+// - c stands for complex float
+// - z stands for complex double
 //"mm" specifies the type of matrix, for example:
 //  - he stands for hermitian
 //  - sy stands for symmetric
@@ -468,4 +489,4 @@ class LapackConnector
         cherk_(&uplo_changed, &trans_changed, &n, &k, &alpha, A, &lda, &beta, C, &ldc);
     }
 };
-#endif  // LAPACKCONNECTOR_HPP
+#endif  // LAPACK_CONNECTOR_HPP

source/source_hsolver/kernels/hegvd_op.cpp

@@ -1,5 +1,4 @@
 #include "source_hsolver/kernels/hegvd_op.h"
-// #include "source_base/module_external/lapack_wrapper.h"
 #include "source_base/module_container/base/third_party/lapack.h"
 
 #include <algorithm>