Docs: class DiagoDavid

Cstandardlib · Cstandardlib · commit 61eaede11039 · 2024-12-17T06:57:57.000+08:00
diff --git a/source/module_hsolver/diago_david.h b/source/module_hsolver/diago_david.h
@@ -14,7 +14,7 @@ namespace hsolver
 {
 /**
  * @class DiagoDavid
- * @brief A class that implements the Davidson diagonalization algorithm for solving eigenvalue problems.
+ * @brief A class that implements the block-Davidson algorithm for solving generalized eigenvalue problems.
  *
  * The DiagoDavid class provides methods for performing iterative diagonalization using the Davidson algorithm.
  * It supports both real and complex data types and can be executed on different devices (CPU or GPU).

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ namespace hsolver`
`14`	`14`	`{`
`15`	`15`	`/**`
`16`	`16`	`* @class DiagoDavid`
`17`		`- * @brief A class that implements the Davidson diagonalization algorithm for solving eigenvalue problems.`
	`17`	`+ * @brief A class that implements the block-Davidson algorithm for solving generalized eigenvalue problems.`
`18`	`18`	`*`
`19`	`19`	`* The DiagoDavid class provides methods for performing iterative diagonalization using the Davidson algorithm.`
`20`	`20`	`* It supports both real and complex data types and can be executed on different devices (CPU or GPU).`