<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.5"/> <title>Eigen: SparseLU_Structs.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> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); $(window).load(resizeHeight); </script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> <link href="eigendoxy.css" rel="stylesheet" type="text/css"> <!-- --> <script type="text/javascript" src="eigen_navtree_hacks.js"></script> <!-- <script type="text/javascript"> --> <!-- </script> --> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <!-- <a name="top"></a> --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectlogo"><img alt="Logo" src="Eigen_Silly_Professor_64x64.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname"><a href="http://eigen.tuxfamily.org">Eigen</a>  <span id="projectnumber">3.2.0</span> </div> </td> <td> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.5 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> </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"> $(document).ready(function(){initNavTree('SparseLU__Structs_8h_source.html','');}); </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)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></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 class="header"> <div class="headertitle"> <div class="title">SparseLU_Structs.h</div> </div> </div><!--header--> <div class="contents"> <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// This file is part of Eigen, a lightweight C++ template library</span></div> <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// for linear algebra.</span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">//</span></div> <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// Copyright (C) 2012 Désiré Nuentsa-Wakam <desire.nuentsa_wakam@inria.fr></span></div> <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">//</span></div> <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">// This Source Code Form is subject to the terms of the Mozilla</span></div> <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// Public License v. 2.0. If a copy of the MPL was not distributed</span></div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">// with this file, You can obtain one at http://mozilla.org/MPL/2.0/.</span></div> <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div> <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">/* </span></div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * NOTE: This file comes from a partly modified version of files slu_[s,d,c,z]defs.h</span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * -- SuperLU routine (version 4.1) --</span></div> <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * Univ. of California Berkeley, Xerox Palo Alto Research Center,</span></div> <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * and Lawrence Berkeley National Lab.</span></div> <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * November, 2010</span></div> <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * </span></div> <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * Global data structures used in LU factorization -</span></div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * </span></div> <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * nsuper: #supernodes = nsuper + 1, numbered [0, nsuper].</span></div> <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * (xsup,supno): supno[i] is the supernode no to which i belongs;</span></div> <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * xsup(s) points to the beginning of the s-th supernode.</span></div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * e.g. supno 0 1 2 2 3 3 3 4 4 4 4 4 (n=12)</span></div> <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * xsup 0 1 2 4 7 12</span></div> <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * Note: dfs will be performed on supernode rep. relative to the new </span></div> <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * row pivoting ordering</span></div> <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> *</span></div> <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * (xlsub,lsub): lsub[*] contains the compressed subscript of</span></div> <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * rectangular supernodes; xlsub[j] points to the starting</span></div> <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * location of the j-th column in lsub[*]. Note that xlsub </span></div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> * is indexed by column.</span></div> <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> * Storage: original row subscripts</span></div> <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> *</span></div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> * During the course of sparse LU factorization, we also use</span></div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> * (xlsub,lsub) for the purpose of symmetric pruning. For each</span></div> <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> * supernode {s,s+1,...,t=s+r} with first column s and last</span></div> <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> * column t, the subscript set</span></div> <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> * lsub[j], j=xlsub[s], .., xlsub[s+1]-1</span></div> <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> * is the structure of column s (i.e. structure of this supernode).</span></div> <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> * It is used for the storage of numerical values.</span></div> <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> * Furthermore,</span></div> <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> * lsub[j], j=xlsub[t], .., xlsub[t+1]-1</span></div> <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> * is the structure of the last column t of this supernode.</span></div> <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> * It is for the purpose of symmetric pruning. Therefore, the</span></div> <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> * structural subscripts can be rearranged without making physical</span></div> <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> * interchanges among the numerical values.</span></div> <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> *</span></div> <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> * However, if the supernode has only one column, then we</span></div> <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * only keep one set of subscripts. For any subscript interchange</span></div> <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> * performed, similar interchange must be done on the numerical</span></div> <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> * values.</span></div> <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> *</span></div> <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> * The last column structures (for pruning) will be removed</span></div> <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> * after the numercial LU factorization phase.</span></div> <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> *</span></div> <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> * (xlusup,lusup): lusup[*] contains the numerical values of the</span></div> <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> * rectangular supernodes; xlusup[j] points to the starting</span></div> <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> * location of the j-th column in storage vector lusup[*]</span></div> <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> * Note: xlusup is indexed by column.</span></div> <div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> * Each rectangular supernode is stored by column-major</span></div> <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> * scheme, consistent with Fortran 2-dim array storage.</span></div> <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> *</span></div> <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> * (xusub,ucol,usub): ucol[*] stores the numerical values of</span></div> <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> * U-columns outside the rectangular supernodes. The row</span></div> <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> * subscript of nonzero ucol[k] is stored in usub[k].</span></div> <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> * xusub[i] points to the starting location of column i in ucol.</span></div> <div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> * Storage: new row subscripts; that is subscripts of PA.</span></div> <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> */</span></div> <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div> <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="preprocessor">#ifndef EIGEN_LU_STRUCTS</span></div> <div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="preprocessor"></span><span class="preprocessor">#define EIGEN_LU_STRUCTS</span></div> <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="preprocessor"></span><span class="keyword">namespace </span>Eigen {</div> <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="keyword">namespace </span>internal {</div> <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  </div> <div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="keyword">typedef</span> <span class="keyword">enum</span> {LUSUP, UCOL, LSUB, USUB, LLVL, ULVL} MemType; </div> <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div> <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="keyword">template</span> <<span class="keyword">typename</span> IndexVector, <span class="keyword">typename</span> ScalarVector></div> <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="keyword">struct </span>LU_GlobalLU_t {</div> <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keyword">typedef</span> <span class="keyword">typename</span> IndexVector::Scalar Index; </div> <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  IndexVector xsup; <span class="comment">//First supernode column ... xsup(s) points to the beginning of the s-th supernode</span></div> <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  IndexVector supno; <span class="comment">// Supernode number corresponding to this column (column to supernode mapping)</span></div> <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  ScalarVector lusup; <span class="comment">// nonzero values of L ordered by columns </span></div> <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  IndexVector lsub; <span class="comment">// Compressed row indices of L rectangular supernodes. </span></div> <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  IndexVector xlusup; <span class="comment">// pointers to the beginning of each column in lusup</span></div> <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  IndexVector xlsub; <span class="comment">// pointers to the beginning of each column in lsub</span></div> <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  Index nzlmax; <span class="comment">// Current max size of lsub</span></div> <div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  Index nzlumax; <span class="comment">// Current max size of lusup</span></div> <div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  ScalarVector ucol; <span class="comment">// nonzero values of U ordered by columns </span></div> <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  IndexVector usub; <span class="comment">// row indices of U columns in ucol</span></div> <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  IndexVector xusub; <span class="comment">// Pointers to the beginning of each column of U in ucol </span></div> <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  Index nzumax; <span class="comment">// Current max size of ucol</span></div> <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  Index n; <span class="comment">// Number of columns in the matrix </span></div> <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  Index num_expansions; </div> <div class="line"><a name="l00093"></a><span class="lineno"> 93</span> };</div> <div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div> <div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment">// Values to set for performance</span></div> <div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="keyword">template</span> <<span class="keyword">typename</span> Index></div> <div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="keyword">struct </span>perfvalues {</div> <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  Index panel_size; <span class="comment">// a panel consists of at most <panel_size> consecutive columns</span></div> <div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  Index relax; <span class="comment">// To control degree of relaxing supernodes. If the number of nodes (columns) </span></div> <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="comment">// in a subtree of the elimination tree is less than relax, this subtree is considered </span></div> <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="comment">// as one supernode regardless of the row structures of those columns</span></div> <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  Index maxsuper; <span class="comment">// The maximum size for a supernode in complete LU</span></div> <div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  Index rowblk; <span class="comment">// The minimum row dimension for 2-D blocking to be used;</span></div> <div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  Index colblk; <span class="comment">// The minimum column dimension for 2-D blocking to be used;</span></div> <div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  Index fillfactor; <span class="comment">// The estimated fills factors for L and U, compared with A</span></div> <div class="line"><a name="l00106"></a><span class="lineno"> 106</span> }; </div> <div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div> <div class="line"><a name="l00108"></a><span class="lineno"> 108</span> } <span class="comment">// end namespace internal</span></div> <div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div> <div class="line"><a name="l00110"></a><span class="lineno"> 110</span> } <span class="comment">// end namespace Eigen</span></div> <div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="preprocessor">#endif // EIGEN_LU_STRUCTS</span></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_e49d68e3078f12dfcf157021597ad168.html">Eigen</a></li><li class="navelem"><a class="el" href="dir_64b228556dc7f9fe757d43bb57fbfc24.html">src</a></li><li class="navelem"><a class="el" href="dir_43b7fa11304fca39592f14c296504e53.html">SparseLU</a></li><li class="navelem"><b>SparseLU_Structs.h</b></li> <li class="footer">Generated on Mon Oct 28 2013 11:04:25 for Eigen by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.5 </li> </ul> </div> <!-- Piwik --> <!-- <script type="text/javascript"> var pkBaseURL = (("https:" == document.location.protocol) ? "https://stats.sylphide-consulting.com/piwik/" : "http://stats.sylphide-consulting.com/piwik/"); document.write(unescape("%3Cscript src='" + pkBaseURL + "piwik.js' type='text/javascript'%3E%3C/script%3E")); </script><script type="text/javascript"> try { var piwikTracker = Piwik.getTracker(pkBaseURL + "piwik.php", 20); piwikTracker.trackPageView(); piwikTracker.enableLinkTracking(); } catch( err ) {} </script><noscript><p><img src="http://stats.sylphide-consulting.com/piwik/piwik.php?idsite=20" style="border:0" alt="" /></p></noscript> --> <!-- End Piwik Tracking Code --> </body> </html>