FYS3150/Project-2
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
Cory Balaton
2023-09-24 16:02:40 +02:00
parent 58c58a97af
commit 3b1c42cf2d
8 changed files with 69 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
doc/html/jacobi_8hpp.html
View File

@@ -158,7 +158,9 @@ Janita Ovidie Sandtrøen Willumsen (janitaws) </dd></dl>
</div><div class="memdoc">
<p>Solves the eigenvalue problem using the jacobi rotation method. </p>
<p>Description</p>
<p>jacobi_eigensolver Initializes matrices A_m and R before going into the main loop.</p>
<p>For each iteration of the loop, it finds the largest absolute off-diagonal value of A_m, and then calls jacobi_rotate. The loop stops when the largest off-diagonal is less than the tolerance (eps) or if the maximum number of iterations has been reached.</p>
<p>The last thing this function does is to sort the eigenvalues and the corresponding eigenvectors in ascending order.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">A</td><td>The initial matrix to be solved </td></tr>
@@ -214,7 +216,7 @@ Janita Ovidie Sandtrøen Willumsen (janitaws) </dd></dl>
</div><div class="memdoc">
<p>Computes a single rotation. </p>
<p>Description</p>
<p>jacobi_rotate computes a single rotation for Jacobi's rotation algorithm. It starts by calculating tau, t (tan), c (cos), s (sin) and then updates A and R at rows/columsn k and l.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">A</td><td>Matrix A<sup> (m) </sup> </td></tr>