|
1 | 1 | """ |
2 | | -Generalized Eigenvalue Decomposition |
| 2 | +Generalized Eigenvalue Decomposition. |
3 | 3 |
|
4 | 4 | This library contains different methods to adjust the format of |
5 | 5 | complex Hermitian matrices and find their eigenvectors and |
|
15 | 15 |
|
16 | 16 |
|
17 | 17 | def gevd(a, b=None): |
18 | | - """ This method computes the eigenvectors and the eigenvalues |
| 18 | + """This method computes the eigenvectors and the eigenvalues |
19 | 19 | of complex Hermitian matrices. The method finds a solution to |
20 | 20 | the problem AV = BVD where V are the eigenvectors and D are |
21 | 21 | the eigenvalues. |
@@ -116,7 +116,7 @@ def gevd(a, b=None): |
116 | 116 |
|
117 | 117 |
|
118 | 118 | def svdl(a): |
119 | | - """ Singular Value Decomposition (Left Singular Vectors) |
| 119 | + """ Singular Value Decomposition (Left Singular Vectors). |
120 | 120 |
|
121 | 121 | This function finds the eigenvalues and eigenvectors of the |
122 | 122 | input multiplied by its transpose (a x a.T). |
@@ -181,7 +181,7 @@ def svdl(a): |
181 | 181 |
|
182 | 182 |
|
183 | 183 | def f(ws): |
184 | | - """ Transform 1 |
| 184 | + """Transform 1. |
185 | 185 |
|
186 | 186 | This method takes a complex Hermitian matrix represented by its |
187 | 187 | upper triangular part and converts it to a block matrix |
@@ -253,7 +253,7 @@ def finv(wsh): |
253 | 253 |
|
254 | 254 |
|
255 | 255 | def g(ws): |
256 | | - """ Transform 2 |
| 256 | + """Transform 2. |
257 | 257 |
|
258 | 258 | This method takes a full complex matrix and converts it to a block |
259 | 259 | matrix. The result will have the following format: |
@@ -285,7 +285,7 @@ def g(ws): |
285 | 285 |
|
286 | 286 |
|
287 | 287 | def ginv(wsh): |
288 | | - """ Inverse transform 2 |
| 288 | + """Inverse transform 2. |
289 | 289 |
|
290 | 290 | This method takes a complex Hermitian matrix represented by a block |
291 | 291 | matrix and converts it to a full complex complex matrix. The |
@@ -314,7 +314,7 @@ def ginv(wsh): |
314 | 314 |
|
315 | 315 |
|
316 | 316 | def pos_def(ws, alpha=0.001, eps=1e-20): |
317 | | - """ Diagonal modification |
| 317 | + """Diagonal modification. |
318 | 318 |
|
319 | 319 | This method takes a complex Hermitian matrix represented by its upper |
320 | 320 | triangular part and adds the value of its trace multiplied by alpha |
@@ -357,7 +357,7 @@ def pos_def(ws, alpha=0.001, eps=1e-20): |
357 | 357 |
|
358 | 358 |
|
359 | 359 | def inv(x): |
360 | | - """ Inverse Hermitian Matrix |
| 360 | + """Inverse Hermitian Matrix. |
361 | 361 |
|
362 | 362 | This method finds the inverse of a complex Hermitian matrix |
363 | 363 | represented by its upper triangular part. The result will have |
|
0 commit comments