Skip to content

Commit 73cf98c

Browse files
committed
deploy: 5a0233b
1 parent 04b9ca2 commit 73cf98c

File tree

8 files changed

+92
-1
lines changed

8 files changed

+92
-1
lines changed

_sources/pyclassify.rst.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,10 @@ Submodule: helpers_secular
2727
:undoc-members:
2828
:show-inheritance:
2929

30+
Submodule: parallel_tridiag_eigen
31+
================
32+
33+
.. automodule:: pyclassify.parallel_tridiag_eigen
34+
:members:
35+
:undoc-members:
36+
:show-inheritance:

genindex.html

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,8 @@ <h2 id="B">B</h2>
5959
<h2 id="C">C</h2>
6060
<table style="width: 100%" class="indextable genindextable"><tr>
6161
<td style="width: 33%; vertical-align: top;"><ul>
62+
<li><a href="pyclassify.html#pyclassify.parallel_tridiag_eigen.check_column_directions">check_column_directions() (in module pyclassify.parallel_tridiag_eigen)</a>
63+
</li>
6264
<li><a href="pyclassify.html#pyclassify.utils.check_square_matrix">check_square_matrix() (in module pyclassify.utils)</a>
6365
</li>
6466
<li><a href="pyclassify.html#pyclassify.utils.check_symm_square">check_symm_square() (in module pyclassify.utils)</a>
@@ -92,6 +94,10 @@ <h2 id="E">E</h2>
9294

9395
<h2 id="F">F</h2>
9496
<table style="width: 100%" class="indextable genindextable"><tr>
97+
<td style="width: 33%; vertical-align: top;"><ul>
98+
<li><a href="pyclassify.html#pyclassify.parallel_tridiag_eigen.find_interval_extreme">find_interval_extreme() (in module pyclassify.parallel_tridiag_eigen)</a>
99+
</li>
100+
</ul></td>
95101
<td style="width: 33%; vertical-align: top;"><ul>
96102
<li><a href="pyclassify.html#pyclassify.zero_finder.find_root">find_root() (in module pyclassify.zero_finder)</a>
97103
</li>
@@ -130,6 +136,8 @@ <h2 id="M">M</h2>
130136

131137
<ul>
132138
<li><a href="pyclassify.html#module-pyclassify">pyclassify</a>
139+
</li>
140+
<li><a href="pyclassify.html#module-pyclassify.parallel_tridiag_eigen">pyclassify.parallel_tridiag_eigen</a>
133141
</li>
134142
<li><a href="pyclassify.html#module-pyclassify.utils">pyclassify.utils</a>
135143
</li>
@@ -142,6 +150,10 @@ <h2 id="M">M</h2>
142150
<h2 id="P">P</h2>
143151
<table style="width: 100%" class="indextable genindextable"><tr>
144152
<td style="width: 33%; vertical-align: top;"><ul>
153+
<li><a href="pyclassify.html#pyclassify.parallel_tridiag_eigen.parallel_eigen">parallel_eigen() (in module pyclassify.parallel_tridiag_eigen)</a>
154+
</li>
155+
<li><a href="pyclassify.html#pyclassify.parallel_tridiag_eigen.parallel_tridiag_eigen">parallel_tridiag_eigen() (in module pyclassify.parallel_tridiag_eigen)</a>
156+
</li>
145157
<li><a href="pyclassify.html#pyclassify.utils.poisson_2d_structure">poisson_2d_structure() (in module pyclassify.utils)</a>
146158
</li>
147159
<li><a href="pyclassify.html#pyclassify.power_method">power_method() (in module pyclassify)</a>
@@ -159,6 +171,13 @@ <h2 id="P">P</h2>
159171

160172
<ul>
161173
<li><a href="pyclassify.html#module-pyclassify">module</a>
174+
</li>
175+
</ul></li>
176+
<li>
177+
pyclassify.parallel_tridiag_eigen
178+
179+
<ul>
180+
<li><a href="pyclassify.html#module-pyclassify.parallel_tridiag_eigen">module</a>
162181
</li>
163182
</ul></li>
164183
<li>
@@ -227,6 +246,7 @@ <h1 class="logo"><a href="index.html">final_project</a></h1>
227246
<li class="toctree-l1"><a class="reference internal" href="pyclassify.html#module-pyclassify">Functions:</a></li>
228247
<li class="toctree-l1"><a class="reference internal" href="pyclassify.html#module-pyclassify.utils">Submodule: utils</a></li>
229248
<li class="toctree-l1"><a class="reference internal" href="pyclassify.html#submodule-helpers-secular">Submodule: helpers_secular</a></li>
249+
<li class="toctree-l1"><a class="reference internal" href="pyclassify.html#submodule-parallel-tridiag-eigen">Submodule: parallel_tridiag_eigen</a></li>
230250
</ul>
231251

232252
<div class="relations">

index.html

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,13 @@ <h1>Table of Contents<a class="headerlink" href="#table-of-contents" title="Link
7575
<li class="toctree-l2"><a class="reference internal" href="pyclassify.html#pyclassify.zero_finder.secular_solver_python"><code class="docutils literal notranslate"><span class="pre">secular_solver_python()</span></code></a></li>
7676
</ul>
7777
</li>
78+
<li class="toctree-l1"><a class="reference internal" href="pyclassify.html#submodule-parallel-tridiag-eigen">Submodule: parallel_tridiag_eigen</a><ul>
79+
<li class="toctree-l2"><a class="reference internal" href="pyclassify.html#pyclassify.parallel_tridiag_eigen.check_column_directions"><code class="docutils literal notranslate"><span class="pre">check_column_directions()</span></code></a></li>
80+
<li class="toctree-l2"><a class="reference internal" href="pyclassify.html#pyclassify.parallel_tridiag_eigen.find_interval_extreme"><code class="docutils literal notranslate"><span class="pre">find_interval_extreme()</span></code></a></li>
81+
<li class="toctree-l2"><a class="reference internal" href="pyclassify.html#pyclassify.parallel_tridiag_eigen.parallel_eigen"><code class="docutils literal notranslate"><span class="pre">parallel_eigen()</span></code></a></li>
82+
<li class="toctree-l2"><a class="reference internal" href="pyclassify.html#pyclassify.parallel_tridiag_eigen.parallel_tridiag_eigen"><code class="docutils literal notranslate"><span class="pre">parallel_tridiag_eigen()</span></code></a></li>
83+
</ul>
84+
</li>
7885
</ul>
7986
</div>
8087
</section>
@@ -397,6 +404,7 @@ <h1 class="logo"><a href="#">final_project</a></h1>
397404
<li class="toctree-l1"><a class="reference internal" href="pyclassify.html#module-pyclassify">Functions:</a></li>
398405
<li class="toctree-l1"><a class="reference internal" href="pyclassify.html#module-pyclassify.utils">Submodule: utils</a></li>
399406
<li class="toctree-l1"><a class="reference internal" href="pyclassify.html#submodule-helpers-secular">Submodule: helpers_secular</a></li>
407+
<li class="toctree-l1"><a class="reference internal" href="pyclassify.html#submodule-parallel-tridiag-eigen">Submodule: parallel_tridiag_eigen</a></li>
400408
</ul>
401409

402410
<div class="relations">

objects.inv

59 Bytes
Binary file not shown.

py-modindex.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,11 @@ <h1>Python Module Index</h1>
5252
<td>
5353
<a href="pyclassify.html#module-pyclassify"><code class="xref">pyclassify</code></a></td><td>
5454
<em></em></td></tr>
55+
<tr class="cg-1">
56+
<td></td>
57+
<td>&#160;&#160;&#160;
58+
<a href="pyclassify.html#module-pyclassify.parallel_tridiag_eigen"><code class="xref">pyclassify.parallel_tridiag_eigen</code></a></td><td>
59+
<em></em></td></tr>
5560
<tr class="cg-1">
5661
<td></td>
5762
<td>&#160;&#160;&#160;
@@ -96,6 +101,7 @@ <h1 class="logo"><a href="index.html">final_project</a></h1>
96101
<li class="toctree-l1"><a class="reference internal" href="pyclassify.html#module-pyclassify">Functions:</a></li>
97102
<li class="toctree-l1"><a class="reference internal" href="pyclassify.html#module-pyclassify.utils">Submodule: utils</a></li>
98103
<li class="toctree-l1"><a class="reference internal" href="pyclassify.html#submodule-helpers-secular">Submodule: helpers_secular</a></li>
104+
<li class="toctree-l1"><a class="reference internal" href="pyclassify.html#submodule-parallel-tridiag-eigen">Submodule: parallel_tridiag_eigen</a></li>
99105
</ul>
100106

101107
<div class="relations">

pyclassify.html

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -590,6 +590,48 @@ <h1>Submodule: helpers_secular<a class="headerlink" href="#submodule-helpers-sec
590590
</dl>
591591
</dd></dl>
592592

593+
</section>
594+
<section id="submodule-parallel-tridiag-eigen">
595+
<h1>Submodule: parallel_tridiag_eigen<a class="headerlink" href="#submodule-parallel-tridiag-eigen" title="Link to this heading"></a></h1>
596+
<dl class="py function" id="module-pyclassify.parallel_tridiag_eigen">
597+
<dt class="sig sig-object py" id="pyclassify.parallel_tridiag_eigen.check_column_directions">
598+
<span class="sig-prename descclassname"><span class="pre">pyclassify.parallel_tridiag_eigen.</span></span><span class="sig-name descname"><span class="pre">check_column_directions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">A</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">B</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyclassify.parallel_tridiag_eigen.check_column_directions" title="Link to this definition"></a></dt>
599+
<dd></dd></dl>
600+
601+
<dl class="py function">
602+
<dt class="sig sig-object py" id="pyclassify.parallel_tridiag_eigen.find_interval_extreme">
603+
<span class="sig-prename descclassname"><span class="pre">pyclassify.parallel_tridiag_eigen.</span></span><span class="sig-name descname"><span class="pre">find_interval_extreme</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">total_dimension</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n_processor</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyclassify.parallel_tridiag_eigen.find_interval_extreme" title="Link to this definition"></a></dt>
604+
<dd><dl class="simple">
605+
<dt>Computes the intervals for vector for being scattered.</dt><dd><dl class="simple">
606+
<dt>Input:</dt><dd><p>-total_dimension: the dimension of the vector that has to be splitted
607+
-n_processor: the number of processor to which the scatter vector has to be sent</p>
608+
</dd>
609+
</dl>
610+
</dd>
611+
</dl>
612+
</dd></dl>
613+
614+
<dl class="py function">
615+
<dt class="sig sig-object py" id="pyclassify.parallel_tridiag_eigen.parallel_eigen">
616+
<span class="sig-prename descclassname"><span class="pre">pyclassify.parallel_tridiag_eigen.</span></span><span class="sig-name descname"><span class="pre">parallel_eigen</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">main_diag</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">off_diag</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tol_QR</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1e-15</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_iterQR</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">5000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tol_deflation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1e-15</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyclassify.parallel_tridiag_eigen.parallel_eigen" title="Link to this definition"></a></dt>
617+
<dd></dd></dl>
618+
619+
<dl class="py function">
620+
<dt class="sig sig-object py" id="pyclassify.parallel_tridiag_eigen.parallel_tridiag_eigen">
621+
<span class="sig-prename descclassname"><span class="pre">pyclassify.parallel_tridiag_eigen.</span></span><span class="sig-name descname"><span class="pre">parallel_tridiag_eigen</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">diag</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">off</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">comm</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tol_factor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1e-16</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">min_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">depth</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">profiler</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tol_QR</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1e-08</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_iterQR</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">5000</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyclassify.parallel_tridiag_eigen.parallel_tridiag_eigen" title="Link to this definition"></a></dt>
622+
<dd><dl>
623+
<dt>Computes eigenvalues and eigenvectors of a symmetric tridiagonal matrix.</dt><dd><p>Input:
624+
-diag: diagonal part of the tridiagonal matrix
625+
-off: off diagonal part of the tridiagonal matrix
626+
-comm: MPI communicator
627+
-tol_factor: tollerance for the deflating step</p>
628+
<p>Output:
629+
-final_eigvals: return the eigenvalues of the tridiagonal matrix
630+
-final_eigvecs: return the eigenvectors of the tridiagonal matrix</p>
631+
</dd>
632+
</dl>
633+
</dd></dl>
634+
593635
</section>
594636

595637

@@ -649,6 +691,13 @@ <h1 class="logo"><a href="index.html">final_project</a></h1>
649691
<li class="toctree-l2"><a class="reference internal" href="#pyclassify.zero_finder.secular_solver_python"><code class="docutils literal notranslate"><span class="pre">secular_solver_python()</span></code></a></li>
650692
</ul>
651693
</li>
694+
<li class="toctree-l1"><a class="reference internal" href="#submodule-parallel-tridiag-eigen">Submodule: parallel_tridiag_eigen</a><ul>
695+
<li class="toctree-l2"><a class="reference internal" href="#pyclassify.parallel_tridiag_eigen.check_column_directions"><code class="docutils literal notranslate"><span class="pre">check_column_directions()</span></code></a></li>
696+
<li class="toctree-l2"><a class="reference internal" href="#pyclassify.parallel_tridiag_eigen.find_interval_extreme"><code class="docutils literal notranslate"><span class="pre">find_interval_extreme()</span></code></a></li>
697+
<li class="toctree-l2"><a class="reference internal" href="#pyclassify.parallel_tridiag_eigen.parallel_eigen"><code class="docutils literal notranslate"><span class="pre">parallel_eigen()</span></code></a></li>
698+
<li class="toctree-l2"><a class="reference internal" href="#pyclassify.parallel_tridiag_eigen.parallel_tridiag_eigen"><code class="docutils literal notranslate"><span class="pre">parallel_tridiag_eigen()</span></code></a></li>
699+
</ul>
700+
</li>
652701
</ul>
653702

654703
<div class="relations">

search.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,7 @@ <h3>Navigation</h3>
8989
<li class="toctree-l1"><a class="reference internal" href="pyclassify.html#module-pyclassify">Functions:</a></li>
9090
<li class="toctree-l1"><a class="reference internal" href="pyclassify.html#module-pyclassify.utils">Submodule: utils</a></li>
9191
<li class="toctree-l1"><a class="reference internal" href="pyclassify.html#submodule-helpers-secular">Submodule: helpers_secular</a></li>
92+
<li class="toctree-l1"><a class="reference internal" href="pyclassify.html#submodule-parallel-tridiag-eigen">Submodule: parallel_tridiag_eigen</a></li>
9293
</ul>
9394

9495
<div class="relations">

0 commit comments

Comments
 (0)