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-20 16:49:55 +02:00
parent 725cf5b33a
commit 162e884d47
17 changed files with 226 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
doc/html/jacobi_8cpp.html
View File

@@ -88,6 +88,7 @@ Functions</h2></td></tr>
<tr class="memdesc:a49809414937a1491ff04ec3dc780982a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computes a single rotation. <br /></td></tr>
<tr class="separator:a49809414937a1491ff04ec3dc780982a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5a8da00df38bec1046249e8589a8aad0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="jacobi_8cpp.html#a5a8da00df38bec1046249e8589a8aad0">jacobi_eigensolver</a> (const arma::mat &amp;A, double eps, arma::vec &amp;eigenvalues, arma::mat &amp;eigenvectors, const int maxiter, int &amp;iterations, bool &amp;converged)</td></tr>
<tr class="memdesc:a5a8da00df38bec1046249e8589a8aad0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Solves the eigenvalue problem using the jacobi rotation method. <br /></td></tr>
<tr class="separator:a5a8da00df38bec1046249e8589a8aad0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
@@ -95,7 +96,7 @@ Functions</h2></td></tr>
<dl class="section author"><dt>Author</dt><dd>Cory Alexander Balaton (coryab) </dd>
<dd>
Janita Ovidie Sandtrøen Willumsen (janitaws) </dd></dl>
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000001">Bug:</a></b></dt><dd>No known bugs </dd></dl>
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000001">Bug:</a></b></dt><dd>The eigenvalues fail the test. When comparing them to arma::eigsym there is one value that is way off when testing with a 6x6 matrix. </dd></dl>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a5a8da00df38bec1046249e8589a8aad0" name="a5a8da00df38bec1046249e8589a8aad0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5a8da00df38bec1046249e8589a8aad0">&#9670;&#160;</a></span>jacobi_eigensolver()</h2>
@@ -152,7 +153,8 @@ Janita Ovidie Sandtrøen Willumsen (janitaws) </dd></dl>
</tr>
</table>
</div><div class="memdoc">
<p>@ brief Solves the eigenvalue problem using the jacobi rotation method.</p>
<p>Solves the eigenvalue problem using the jacobi rotation method. </p>
<p>Description</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">