Skip to content

Commit

Permalink
Update documentation from ginkgo-project/ginkgo@4ce46c4929
Browse files Browse the repository at this point in the history
  • Loading branch information
ginkgo-bot committed Nov 29, 2024
1 parent ec8f286 commit a957f67
Show file tree
Hide file tree
Showing 1,989 changed files with 5,351 additions and 5,033 deletions.
2 changes: 1 addition & 1 deletion doc/develop/Examples.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
<td id="projectlogo"><img alt="Logo" src="logo_doc.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Ginkgo
&#160;<span id="projectnumber">Generated from pipelines/1564312238 branch based on develop. Ginkgo version 1.9.0</span>
&#160;<span id="projectnumber">Generated from pipelines/1565434519 branch based on develop. Ginkgo version 1.9.0</span>
</div>
<div id="projectbrief">A numerical linear algebra library targeting many-core architectures</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion doc/develop/abstract__factory_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
<td id="projectlogo"><img alt="Logo" src="logo_doc.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Ginkgo
&#160;<span id="projectnumber">Generated from pipelines/1564312238 branch based on develop. Ginkgo version 1.9.0</span>
&#160;<span id="projectnumber">Generated from pipelines/1565434519 branch based on develop. Ginkgo version 1.9.0</span>
</div>
<div id="projectbrief">A numerical linear algebra library targeting many-core architectures</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion doc/develop/adaptiveprecision-blockjacobi_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
<td id="projectlogo"><img alt="Logo" src="logo_doc.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Ginkgo
&#160;<span id="projectnumber">Generated from pipelines/1564312238 branch based on develop. Ginkgo version 1.9.0</span>
&#160;<span id="projectnumber">Generated from pipelines/1565434519 branch based on develop. Ginkgo version 1.9.0</span>
</div>
<div id="projectbrief">A numerical linear algebra library targeting many-core architectures</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion doc/develop/adaptiveprecision_blockjacobi.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
<td id="projectlogo"><img alt="Logo" src="logo_doc.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Ginkgo
&#160;<span id="projectnumber">Generated from pipelines/1564312238 branch based on develop. Ginkgo version 1.9.0</span>
&#160;<span id="projectnumber">Generated from pipelines/1565434519 branch based on develop. Ginkgo version 1.9.0</span>
</div>
<div id="projectbrief">A numerical linear algebra library targeting many-core architectures</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion doc/develop/amd_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
<td id="projectlogo"><img alt="Logo" src="logo_doc.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Ginkgo
&#160;<span id="projectnumber">Generated from pipelines/1564312238 branch based on develop. Ginkgo version 1.9.0</span>
&#160;<span id="projectnumber">Generated from pipelines/1565434519 branch based on develop. Ginkgo version 1.9.0</span>
</div>
<div id="projectbrief">A numerical linear algebra library targeting many-core architectures</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion doc/develop/annotated.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
<td id="projectlogo"><img alt="Logo" src="logo_doc.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Ginkgo
&#160;<span id="projectnumber">Generated from pipelines/1564312238 branch based on develop. Ginkgo version 1.9.0</span>
&#160;<span id="projectnumber">Generated from pipelines/1565434519 branch based on develop. Ginkgo version 1.9.0</span>
</div>
<div id="projectbrief">A numerical linear algebra library targeting many-core architectures</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion doc/develop/array_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
<td id="projectlogo"><img alt="Logo" src="logo_doc.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Ginkgo
&#160;<span id="projectnumber">Generated from pipelines/1564312238 branch based on develop. Ginkgo version 1.9.0</span>
&#160;<span id="projectnumber">Generated from pipelines/1565434519 branch based on develop. Ginkgo version 1.9.0</span>
</div>
<div id="projectbrief">A numerical linear algebra library targeting many-core architectures</div>
</td>
Expand Down
132 changes: 132 additions & 0 deletions doc/develop/assembly_8hpp_source.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.16"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Ginkgo: ginkgo/core/distributed/assembly.hpp 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>
<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>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="stylesheet.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 style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo_doc.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Ginkgo
&#160;<span id="projectnumber">Generated from pipelines/1565434519 branch based on develop. Ginkgo version 1.9.0</span>
</div>
<div id="projectbrief">A numerical linear algebra library targeting many-core architectures</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- 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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_a126f3af327e5d52996074ebe9cfe063.html">ginkgo</a></li><li class="navelem"><a class="el" href="dir_4b51d9bcd415f2b2d361511c67a395ad.html">core</a></li><li class="navelem"><a class="el" href="dir_78817d79c77d3fab4f4fa7c2a80cd570.html">distributed</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">assembly.hpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">// SPDX-FileCopyrightText: 2017 - 2024 The Ginkgo authors</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// SPDX-License-Identifier: BSD-3-Clause</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160; </div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#ifndef GKO_PUBLIC_CORE_DISTRIBUTED_ASSEMBLY_HPP_</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#define GKO_PUBLIC_CORE_DISTRIBUTED_ASSEMBLY_HPP_</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160; </div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160; </div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#include &lt;ginkgo/config.hpp&gt;</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160; </div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160; </div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#if GINKGO_BUILD_MPI</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; </div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; </div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#include &lt;ginkgo/core/base/device_matrix_data.hpp&gt;</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &lt;ginkgo/core/base/mpi.hpp&gt;</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &lt;ginkgo/core/base/range.hpp&gt;</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacegko.html">gko</a> {</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="keyword">namespace </span>experimental {</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="keyword">namespace </span>distributed {</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> LocalIndexType, <span class="keyword">typename</span> GlobalIndexType&gt;</div>
<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="classgko_1_1experimental_1_1distributed_1_1Partition.html"> 26</a></span>&#160;<span class="keyword">class </span><a class="code" href="classgko_1_1experimental_1_1distributed_1_1Partition.html">Partition</a>;</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; </div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> ValueType, <span class="keyword">typename</span> LocalIndexType, <span class="keyword">typename</span> GlobalIndexType&gt;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<a class="code" href="classgko_1_1device__matrix__data.html">device_matrix_data&lt;ValueType, GlobalIndexType&gt;</a> <a class="code" href="namespacegko_1_1experimental_1_1distributed.html#afcc07c02b461af86d0aa8eb3dd96ca02">assemble_rows_from_neighbors</a>(</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <a class="code" href="classgko_1_1experimental_1_1mpi_1_1communicator.html">mpi::communicator</a> comm,</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keyword">const</span> <a class="code" href="classgko_1_1device__matrix__data.html">device_matrix_data&lt;ValueType, GlobalIndexType&gt;</a>&amp; input,</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <a class="code" href="classgko_1_1ptr__param.html">ptr_param</a>&lt;<span class="keyword">const</span> <a class="code" href="classgko_1_1experimental_1_1distributed_1_1Partition.html">Partition&lt;LocalIndexType, GlobalIndexType&gt;</a>&gt; partition);</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; </div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;} <span class="comment">// namespace distributed</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;} <span class="comment">// namespace experimental</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;} <span class="comment">// namespace gko</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="preprocessor">#endif // GINKGO_BUILD_MPI</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="preprocessor">#endif // GKO_PUBLIC_CORE_DISTRIBUTED_ASSEMBLY_HPP_</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="anamespacegko_html"><div class="ttname"><a href="namespacegko.html">gko</a></div><div class="ttdoc">The Ginkgo namespace.</div><div class="ttdef"><b>Definition:</b> abstract_factory.hpp:20</div></div>
<div class="ttc" id="aclassgko_1_1experimental_1_1mpi_1_1communicator_html"><div class="ttname"><a href="classgko_1_1experimental_1_1mpi_1_1communicator.html">gko::experimental::mpi::communicator</a></div><div class="ttdoc">A thin wrapper of MPI_Comm that supports most MPI calls.</div><div class="ttdef"><b>Definition:</b> mpi.hpp:408</div></div>
<div class="ttc" id="aclassgko_1_1ptr__param_html"><div class="ttname"><a href="classgko_1_1ptr__param.html">gko::ptr_param</a></div><div class="ttdoc">This class is used for function parameters in the place of raw pointers.</div><div class="ttdef"><b>Definition:</b> utils_helper.hpp:41</div></div>
<div class="ttc" id="aclassgko_1_1experimental_1_1distributed_1_1Partition_html"><div class="ttname"><a href="classgko_1_1experimental_1_1distributed_1_1Partition.html">gko::experimental::distributed::Partition</a></div><div class="ttdoc">Represents a partition of a range of indices [0, size) into a disjoint set of parts.</div><div class="ttdef"><b>Definition:</b> assembly.hpp:26</div></div>
<div class="ttc" id="anamespacegko_1_1experimental_1_1distributed_html_afcc07c02b461af86d0aa8eb3dd96ca02"><div class="ttname"><a href="namespacegko_1_1experimental_1_1distributed.html#afcc07c02b461af86d0aa8eb3dd96ca02">gko::experimental::distributed::assemble_rows_from_neighbors</a></div><div class="ttdeci">device_matrix_data&lt; ValueType, GlobalIndexType &gt; assemble_rows_from_neighbors(mpi::communicator comm, const device_matrix_data&lt; ValueType, GlobalIndexType &gt; &amp;input, ptr_param&lt; const Partition&lt; LocalIndexType, GlobalIndexType &gt;&gt; partition)</div><div class="ttdoc">Assembles device_matrix_data entries owned by this MPI rank from other ranks and communicates entries...</div></div>
<div class="ttc" id="aclassgko_1_1device__matrix__data_html"><div class="ttname"><a href="classgko_1_1device__matrix__data.html">gko::device_matrix_data</a></div><div class="ttdoc">This type is a device-side equivalent to matrix_data.</div><div class="ttdef"><b>Definition:</b> device_matrix_data.hpp:36</div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.16
</small></address>
</body>
</html>
2 changes: 1 addition & 1 deletion doc/develop/base_2lin__op_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
<td id="projectlogo"><img alt="Logo" src="logo_doc.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Ginkgo
&#160;<span id="projectnumber">Generated from pipelines/1564312238 branch based on develop. Ginkgo version 1.9.0</span>
&#160;<span id="projectnumber">Generated from pipelines/1565434519 branch based on develop. Ginkgo version 1.9.0</span>
</div>
<div id="projectbrief">A numerical linear algebra library targeting many-core architectures</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion doc/develop/base_2polymorphic__object_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
<td id="projectlogo"><img alt="Logo" src="logo_doc.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Ginkgo
&#160;<span id="projectnumber">Generated from pipelines/1564312238 branch based on develop. Ginkgo version 1.9.0</span>
&#160;<span id="projectnumber">Generated from pipelines/1565434519 branch based on develop. Ginkgo version 1.9.0</span>
</div>
<div id="projectbrief">A numerical linear algebra library targeting many-core architectures</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion doc/develop/base_2stream_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
<td id="projectlogo"><img alt="Logo" src="logo_doc.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Ginkgo
&#160;<span id="projectnumber">Generated from pipelines/1564312238 branch based on develop. Ginkgo version 1.9.0</span>
&#160;<span id="projectnumber">Generated from pipelines/1565434519 branch based on develop. Ginkgo version 1.9.0</span>
</div>
<div id="projectbrief">A numerical linear algebra library targeting many-core architectures</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion doc/develop/base_2utils_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
<td id="projectlogo"><img alt="Logo" src="logo_doc.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Ginkgo
&#160;<span id="projectnumber">Generated from pipelines/1564312238 branch based on develop. Ginkgo version 1.9.0</span>
&#160;<span id="projectnumber">Generated from pipelines/1565434519 branch based on develop. Ginkgo version 1.9.0</span>
</div>
<div id="projectbrief">A numerical linear algebra library targeting many-core architectures</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion doc/develop/base_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
<td id="projectlogo"><img alt="Logo" src="logo_doc.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Ginkgo
&#160;<span id="projectnumber">Generated from pipelines/1564312238 branch based on develop. Ginkgo version 1.9.0</span>
&#160;<span id="projectnumber">Generated from pipelines/1565434519 branch based on develop. Ginkgo version 1.9.0</span>
</div>
<div id="projectbrief">A numerical linear algebra library targeting many-core architectures</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion doc/develop/batch__bicgstab_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
<td id="projectlogo"><img alt="Logo" src="logo_doc.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Ginkgo
&#160;<span id="projectnumber">Generated from pipelines/1564312238 branch based on develop. Ginkgo version 1.9.0</span>
&#160;<span id="projectnumber">Generated from pipelines/1565434519 branch based on develop. Ginkgo version 1.9.0</span>
</div>
<div id="projectbrief">A numerical linear algebra library targeting many-core architectures</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion doc/develop/batch__cg_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
<td id="projectlogo"><img alt="Logo" src="logo_doc.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Ginkgo
&#160;<span id="projectnumber">Generated from pipelines/1564312238 branch based on develop. Ginkgo version 1.9.0</span>
&#160;<span id="projectnumber">Generated from pipelines/1565434519 branch based on develop. Ginkgo version 1.9.0</span>
</div>
<div id="projectbrief">A numerical linear algebra library targeting many-core architectures</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion doc/develop/batch__csr_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
<td id="projectlogo"><img alt="Logo" src="logo_doc.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Ginkgo
&#160;<span id="projectnumber">Generated from pipelines/1564312238 branch based on develop. Ginkgo version 1.9.0</span>
&#160;<span id="projectnumber">Generated from pipelines/1565434519 branch based on develop. Ginkgo version 1.9.0</span>
</div>
<div id="projectbrief">A numerical linear algebra library targeting many-core architectures</div>
</td>
Expand Down
Loading

0 comments on commit a957f67

Please sign in to comment.