Commit 0ddbe1e7 authored Jan 17, 2025 by Giovanni La Mura

Add missing doxygen inline documentation in header files

parent 103e75a8

src/include/algebraic.h

+3 −0

Original line number	Diff line number	Diff line
		@@ -34,6 +34,9 @@
		* \param mat: `complex double **` The matrix to be inverted (must be a square matrix).
		* \param size: `np_int` The size of the matrix (i.e. the number of its rows or columns).
		* \param ier: `int &` Reference to an integer variable for returning a result flag.
		* \param maxrefiters: `int &` Reference to the maximum number of refinement iterations.
		* \param accuracygoal: `double &` Reference to the requested accuracy level.
		* \param refinemode: `int` Flag for refinement mode selection.
		* \param max_size: `np_int` The maximum expected size (required by some call-backs,
		* optional, defaults to 0).
		* \param target_device: `int` ID of target GPU, if available (defaults to 0).

src/include/cublas_calls.h

+2 −1

Original line number	Diff line number	Diff line
		@@ -42,7 +42,8 @@ void cublas_zinvert(dcomplex **mat, np_int n, int device_id);
		* \param mat: Matrix of complex. The matrix to be inverted.
		* \param n: `np_int` The number of rows and columns of the [n x n] matrix.
		* \param maxrefiters: `int` Maximum number of refinement iterations to apply.
		* \param accuracygoal: `double` Accuracy to achieve in iterative refinement, defined as the module of the maximum difference between the identity matrix and the matrix product of the (approximate) inverse times the original matrix. On return, it contains the actually achieved accuracy
		* \param accuracygoal: `double &` Accuracy to achieve in iterative refinement, defined as the module of the maximum difference between the identity matrix and the matrix product of the (approximate) inverse times the original matrix. On return, it contains the actually achieved accuracy.
		* \param refinemode: `int` Flag to choose the refinement mode.
		* \param device_id: `int` ID of the device for matrix inversion offloading.
		*/
		void cublas_zinvert_and_refine(dcomplex **mat, np_int n, int &maxrefiters, double &accuracygoal, int refinemode, int device_id);

src/include/inclu_subs.h

+0 −1

Original line number	Diff line number	Diff line
		@@ -56,7 +56,6 @@ void incms(dcomplex *am, double enti, ParticleDescriptor c1);

		/*! \brief C++ porting of INDME.
		*
		* \param li: `int` Maximum internal field expansion order.
		* \param i: `int` 1-based sphere configuration index.
		* \param npnt: `int` TBD.
		* \param npntts: `int` TBD.

src/include/lapack_calls.h

+2 −1

Original line number	Diff line number	Diff line
		@@ -43,7 +43,8 @@ void zinvert(dcomplex **mat, np_int n, int &jer);
		* \param n: `np_int` The number of rows and columns of the [n x n] matrix.
		* \param jer: `int &` Reference to an integer return flag.
		* \param maxrefiters: `int` Maximum number of refinement iterations.
		* \param accuracygoal: `double` Accuracy to achieve in iterative refinement, defined as the module of the maximum difference between the identity matrix and the matrix product of the (approximate) inverse times the original matrix. On return, it contains the actually achieved accuracy
		* \param accuracygoal: `double &` Accuracy to achieve in iterative refinement, defined as the module of the maximum difference between the identity matrix and the matrix product of the (approximate) inverse times the original matrix. On return, it contains the actually achieved accuracy.
		* \param refinemode: `int` Flag to control the refinement mode.
		*/
		void zinvert_and_refine(dcomplex **mat, np_int n, int &jer, int &maxrefiters, double &accuracygoal, int refinemode);

src/include/magma_calls.h

+2 −1

Original line number	Diff line number	Diff line
		@@ -44,7 +44,8 @@ void magma_zinvert(dcomplex **mat, np_int n, int &jer, int device_id=0);
		* \param n: `np_int` The number of rows and columns of the [n x n] matrix.
		* \param jer: `int &` Reference to an integer return flag.
		* \param maxrefiters: `int` Maximum number of refinement iterations to apply.
		* \param accuracygoal: `double` Accuracy to achieve in iterative refinement, defined as the module of the maximum difference between the identity matrix and the matrix product of the (approximate) inverse times the original matrix. On return, it contains the actually achieved accuracy
		* \param accuracygoal: `double &` Accuracy to achieve in iterative refinement, defined as the module of the maximum difference between the identity matrix and the matrix product of the (approximate) inverse times the original matrix. On return, it contains the actually achieved accuracy.
		* \param refinemode: `int` Flag to control the refinement mode.
		* \param device_id: `int` ID of the device for matrix inversion offloading.
		*/
		void magma_zinvert_and_refine(dcomplex **mat, np_int n, int &jer, int &maxrefiters, double &accuracygoal, int refinemode, int device_id);