documentation updated to v1.1.0

yixuan · Jan 1, 2025 · e77917b · e77917b
1 parent 1f4dd52
commit e77917b
Show file tree

Hide file tree

Showing 304 changed files with 15,341 additions and 14,640 deletions.
diff --git a/doc/CompInfo_8h_source.html b/doc/CompInfo_8h_source.html
diff --git a/doc/DavidsonSymEigsSolver_8h_source.html b/doc/DavidsonSymEigsSolver_8h_source.html
diff --git a/doc/DenseCholesky_8h_source.html b/doc/DenseCholesky_8h_source.html
diff --git a/doc/DenseGenComplexShiftSolve_8h_source.html b/doc/DenseGenComplexShiftSolve_8h_source.html
diff --git a/doc/DenseGenMatProd_8h_source.html b/doc/DenseGenMatProd_8h_source.html
diff --git a/doc/DenseGenRealShiftSolve_8h_source.html b/doc/DenseGenRealShiftSolve_8h_source.html
diff --git a/doc/DenseHermMatProd_8h_source.html b/doc/DenseHermMatProd_8h_source.html
diff --git a/doc/DenseSymMatProd_8h_source.html b/doc/DenseSymMatProd_8h_source.html
diff --git a/doc/DenseSymShiftSolve_8h_source.html b/doc/DenseSymShiftSolve_8h_source.html
diff --git a/doc/GEigsMode_8h_source.html b/doc/GEigsMode_8h_source.html
diff --git a/doc/GenEigsBase_8h_source.html b/doc/GenEigsBase_8h_source.html
diff --git a/doc/GenEigsComplexShiftSolver_8h_source.html b/doc/GenEigsComplexShiftSolver_8h_source.html
diff --git a/doc/GenEigsRealShiftSolver_8h_source.html b/doc/GenEigsRealShiftSolver_8h_source.html
diff --git a/doc/GenEigsSolver_8h_source.html b/doc/GenEigsSolver_8h_source.html
diff --git a/doc/HermEigsBase_8h_source.html b/doc/HermEigsBase_8h_source.html
diff --git a/doc/HermEigsSolver_8h_source.html b/doc/HermEigsSolver_8h_source.html
@@ -0,0 +1,158 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<meta http-equiv="X-UA-Compatible" content="IE=11"/>
+<meta name="generator" content="Doxygen 1.13.0"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<title>Spectra: Spectra/HermEigsSolver.h Source File</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="jquery.js"></script>
+<script type="text/javascript" src="dynsections.js"></script>
+<script type="text/javascript" src="clipboard.js"></script>
+<link href="navtree.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="navtreedata.js"></script>
+<script type="text/javascript" src="navtree.js"></script>
+<script type="text/javascript" src="resize.js"></script>
+<script type="text/javascript" src="cookie.js"></script>
+<link href="search/search.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="search/searchdata.js"></script>
+<script type="text/javascript" src="search/search.js"></script>
+<script type="text/x-mathjax-config">
+MathJax.Hub.Config({
+  extensions: ["tex2jax.js"],
+  jax: ["input/TeX","output/HTML-CSS"],
+});
+</script>
+<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
+</head>
+<body>
+<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
+<div id="titlearea">
+<table cellspacing="0" cellpadding="0">
+ <tbody>
+ <tr id="projectrow">
+  <td id="projectalign">
+   <div id="projectname">Spectra<span id="projectnumber">&#160;1.1.0</span>
+   </div>
+   <div id="projectbrief">Header-only C++ Library for Large Scale Eigenvalue Problems</div>
+  </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- Generated by Doxygen 1.13.0 -->
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
+var searchBox = new SearchBox("searchBox", "search/",'.html');
+/* @license-end */
+</script>
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
+$(function() { codefold.init(0); });
+/* @license-end */
+</script>
+<script type="text/javascript" src="menudata.js"></script>
+<script type="text/javascript" src="menu.js"></script>
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
+$(function() {
+  initMenu('',true,false,'search.php','Search',true);
+  $(function() { init_search(); });
+});
+/* @license-end */
+</script>
+<div id="main-nav"></div>
+</div><!-- top -->
+<div id="side-nav" class="ui-resizable side-nav-resizable">
+  <div id="nav-tree">
+    <div id="nav-tree-contents">
+      <div id="nav-sync" class="sync"></div>
+    </div>
+  </div>
+  <div id="splitbar" style="-moz-user-select:none;" 
+       class="ui-resizable-handle">
+  </div>
+</div>
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
+$(function(){initNavTree('HermEigsSolver_8h_source.html',''); initResizable(true); });
+/* @license-end */
+</script>
+<div id="doc-content">
+<!-- window showing the filter options -->
+<div id="MSearchSelectWindow"
+     onmouseover="return searchBox.OnSearchSelectShow()"
+     onmouseout="return searchBox.OnSearchSelectHide()"
+     onkeydown="return searchBox.OnSearchSelectKey(event)">
+</div>
+
+<!-- iframe showing the search results (closed by default) -->
+<div id="MSearchResultsWindow">
+<div id="MSearchResults">
+<div class="SRPage">
+<div id="SRIndex">
+<div id="SRResults"></div>
+<div class="SRStatus" id="Loading">Loading...</div>
+<div class="SRStatus" id="Searching">Searching...</div>
+<div class="SRStatus" id="NoMatches">No Matches</div>
+</div>
+</div>
+</div>
+</div>
+
+<div class="header">
+  <div class="headertitle"><div class="title">HermEigsSolver.h</div></div>
+</div><!--header-->
+<div class="contents">
+<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">// Copyright (C) 2024-2025 Yixuan Qiu &lt;[email protected]&gt;</span></div>
+<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment">//</span></div>
+<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment">// This Source Code Form is subject to the terms of the Mozilla</span></div>
+<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment">// Public License v. 2.0. If a copy of the MPL was not distributed</span></div>
+<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment">// with this file, You can obtain one at https://mozilla.org/MPL/2.0/.</span></div>
+<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span> </div>
+<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="preprocessor">#ifndef SPECTRA_HERM_EIGS_SOLVER_H</span></div>
+<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="preprocessor">#define SPECTRA_HERM_EIGS_SOLVER_H</span></div>
+<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span> </div>
+<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="preprocessor">#include &lt;Eigen/Core&gt;</span></div>
+<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span> </div>
+<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="preprocessor">#include &quot;HermEigsBase.h&quot;</span></div>
+<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="preprocessor">#include &quot;Util/SelectionRule.h&quot;</span></div>
+<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="preprocessor">#include &quot;MatOp/DenseHermMatProd.h&quot;</span></div>
+<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span> </div>
+<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="keyword">namespace </span>Spectra {</div>
+<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span></div>
+<div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span><span class="keyword">template</span> &lt;<span class="keyword">typename</span> OpType = DenseHermMatProd&lt;<span class="keywordtype">double</span>&gt;&gt;</div>
+<div class="foldopen" id="foldopen00116" data-start="{" data-end="};">
+<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"><a class="line" href="classSpectra_1_1HermEigsSolver.html">  116</a></span><span class="keyword">class </span><a class="code hl_function" href="classSpectra_1_1HermEigsSolver.html#a463d32667b451155d4aaf34fab0eb256">HermEigsSolver</a> : <span class="keyword">public</span> <a class="code hl_class" href="classSpectra_1_1HermEigsBase.html">HermEigsBase</a>&lt;OpType, IdentityBOp&gt;</div>
+<div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span>{</div>
+<div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span><span class="keyword">private</span>:</div>
+<div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span>    <span class="keyword">using </span>Index = Eigen::Index;</div>
+<div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span> </div>
+<div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span><span class="keyword">public</span>:</div>
+<div class="foldopen" id="foldopen00139" data-start="{" data-end="}">
+<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"><a class="line" href="classSpectra_1_1HermEigsSolver.html#a463d32667b451155d4aaf34fab0eb256">  139</a></span>    <a class="code hl_function" href="classSpectra_1_1HermEigsSolver.html#a463d32667b451155d4aaf34fab0eb256">HermEigsSolver</a>(OpType&amp; op, Index nev, Index ncv) :</div>
+<div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span>        <a class="code hl_class" href="classSpectra_1_1HermEigsBase.html">HermEigsBase</a>&lt;OpType, IdentityBOp&gt;(op, IdentityBOp(), nev, ncv)</div>
+<div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span>    {}</div>
+</div>
+<div class="line"><a id="l00142" name="l00142"></a><span class="lineno">  142</span>};</div>
+</div>
+<div class="line"><a id="l00143" name="l00143"></a><span class="lineno">  143</span> </div>
+<div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span>}  <span class="comment">// namespace Spectra</span></div>
+<div class="line"><a id="l00145" name="l00145"></a><span class="lineno">  145</span> </div>
+<div class="line"><a id="l00146" name="l00146"></a><span class="lineno">  146</span><span class="preprocessor">#endif  </span><span class="comment">// SPECTRA_HERM_EIGS_SOLVER_H</span></div>
+<div class="ttc" id="aclassSpectra_1_1HermEigsBase_html"><div class="ttname"><a href="classSpectra_1_1HermEigsBase.html">Spectra::HermEigsBase</a></div><div class="ttdef"><b>Definition</b> <a href="HermEigsBase_8h_source.html#l00044">HermEigsBase.h:45</a></div></div>
+<div class="ttc" id="aclassSpectra_1_1HermEigsSolver_html_a463d32667b451155d4aaf34fab0eb256"><div class="ttname"><a href="classSpectra_1_1HermEigsSolver.html#a463d32667b451155d4aaf34fab0eb256">Spectra::HermEigsSolver::HermEigsSolver</a></div><div class="ttdeci">HermEigsSolver(OpType &amp;op, Index nev, Index ncv)</div><div class="ttdef"><b>Definition</b> <a href="#l00139">HermEigsSolver.h:139</a></div></div>
+</div><!-- fragment --></div><!-- contents -->
+</div><!-- doc-content -->
+<!-- start footer part -->
+<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
+  <ul>
+    <li class="navelem"><a class="el" href="dir_003cf391efc3c607d1216ffb6d73bbb5.html">Spectra</a></li><li class="navelem"><b>HermEigsSolver.h</b></li>
+    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.0 </li>
+  </ul>
+</div>
+</body>
+</html>