| <!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 content="text/xhtml;charset=utf-8" http-equiv="Content-Type"/> |
| <meta content="IE=9" http-equiv="X-UA-Compatible"/> |
| <meta content="Doxygen 1.8.13" name="generator"/> |
| <meta content="width=device-width, initial-scale=1" name="viewport"/> |
| <title>mxnet: include/mxnet/c_lapack_api.h Source File</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script src="jquery.js" type="text/javascript"></script> |
| <script src="dynsections.js" type="text/javascript"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script src="search/searchdata.js" type="text/javascript"></script> |
| <script src="search/search.js" type="text/javascript"></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 cellpadding="0" cellspacing="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">mxnet |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.13 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <script src="menudata.js" type="text/javascript"></script> |
| <script src="menu.js" type="text/javascript"></script> |
| <script type="text/javascript"> |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| </script> |
| <div id="main-nav"></div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" onkeydown="return searchBox.OnSearchSelectKey(event)" onmouseout="return searchBox.OnSearchSelectHide()" onmouseover="return searchBox.OnSearchSelectShow()"> |
| </div> |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe frameborder="0" id="MSearchResults" name="MSearchResults" src="javascript:void(0)"> |
| </iframe> |
| </div> |
| <div class="navpath" id="nav-path"> |
| <ul> |
| <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_1143c7affb9ebd026cb6818dd282def7.html">mxnet</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">c_lapack_api.h</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="c__lapack__api_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#ifndef MXNET_C_LAPACK_API_H_</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#define MXNET_C_LAPACK_API_H_</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">// Manually maintained list of LAPACK interfaces that can be used</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// within MXNET. Conventions:</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// - Interfaces must be compliant with lapacke.h in terms of signature and</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// naming conventions so wrapping a function "foo" which has the</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// signature</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// lapack_int LAPACKE_foo(int, char, lapack_int, float* , lapack_int)</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// within lapacke.h should result in a wrapper with the following signature</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">// int MXNET_LAPACK_foo(int, char, int, float* , int)</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">// Note that function signatures in lapacke.h will always have as first</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">// argument the storage order (row/col-major). All wrappers have to support</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">// that argument. The underlying fortran functions will always assume a</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">// column-major layout. It is the responsibility of the wrapper function</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">// to handle the (usual) case that it is called with data in row-major</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">// format, either by doing appropriate transpositions explicitly or using</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">// transposition options of the underlying fortran function.</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">// - It is ok to assume that matrices are stored in contiguous memory</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">// (which removes the need to do special handling for lda/ldb parameters</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">// and enables us to save additional matrix transpositions around</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">// the fortran calls).</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">// - It is desired to add some basic checking in the C++-wrappers in order</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">// to catch simple mistakes when calling these wrappers.</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">// - Must support compilation without lapack-package but issue runtime error in this case.</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include <dmlc/logging.h></span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">// Fortran signatures</span></div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="c__lapack__api_8h.html#a56f112686aa64bf8a42204a3ff87ea46"> 37</a></span> <span class="preprocessor"> #define MXNET_LAPACK_FSIGNATURE1(func, dtype) \</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor"> void func##_(char* uplo, int* n, dtype* a, int* lda, int *info);</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <a class="code" href="c__lapack__api_8h.html#a56f112686aa64bf8a42204a3ff87ea46">MXNET_LAPACK_FSIGNATURE1</a>(spotrf, <span class="keywordtype">float</span>)</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <a class="code" href="c__lapack__api_8h.html#a56f112686aa64bf8a42204a3ff87ea46">MXNET_LAPACK_FSIGNATURE1</a>(dpotrf, <span class="keywordtype">double</span>)</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <a class="code" href="c__lapack__api_8h.html#a56f112686aa64bf8a42204a3ff87ea46">MXNET_LAPACK_FSIGNATURE1</a>(spotri, <span class="keywordtype">float</span>)</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <a class="code" href="c__lapack__api_8h.html#a56f112686aa64bf8a42204a3ff87ea46">MXNET_LAPACK_FSIGNATURE1</a>(dpotri, <span class="keywordtype">double</span>)</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> }</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="c__lapack__api_8h.html#a220562c35966392841ae49fefe2dee5e"> 46</a></span> <span class="preprocessor">#define MXNET_LAPACK_ROW_MAJOR 101</span></div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="c__lapack__api_8h.html#a49f324c038a0a1447ed094c679739ee7"> 47</a></span> <span class="preprocessor">#define MXNET_LAPACK_COL_MAJOR 102</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="c__lapack__api_8h.html#a2fa12bf140fecda6aac9336a61923713"> 49</a></span> <span class="preprocessor">#define CHECK_LAPACK_CONTIGUOUS(a, b) \</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor"> CHECK_EQ(a, b) << "non contiguous memory for array in lapack call";</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="c__lapack__api_8h.html#a0c95bf8b79e51085d846c7a09ec22720"> 52</a></span> <span class="preprocessor">#define CHECK_LAPACK_UPLO(a) \</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="preprocessor"> CHECK(a == 'U' || a == 'L') << "neither L nor U specified as triangle in lapack call";</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div><div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="c__lapack__api_8h.html#af111a2f312a185185d0937bd091637e4"> 55</a></span> <span class="keyword">inline</span> <span class="keywordtype">char</span> <a class="code" href="c__lapack__api_8h.html#af111a2f312a185185d0937bd091637e4">loup</a>(<span class="keywordtype">char</span> uplo, <span class="keywordtype">bool</span> invert) { <span class="keywordflow">return</span> invert ? (uplo == <span class="charliteral">'U'</span> ? <span class="charliteral">'L'</span> : <span class="charliteral">'U'</span>) : uplo; }</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor">#if MXNET_USE_LAPACK</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="preprocessor"> #define MXNET_LAPACK_CWRAPPER1(func, dtype) \</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="preprocessor"> inline int MXNET_LAPACK_##func(int matrix_layout, char uplo, int n, dtype* a, int lda ) { \</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="preprocessor"> CHECK_LAPACK_CONTIGUOUS(n, lda); \</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="preprocessor"> CHECK_LAPACK_UPLO(uplo); \</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="preprocessor"> char o(loup(uplo, (matrix_layout == MXNET_LAPACK_ROW_MAJOR))); \</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="preprocessor"> int ret(0); \</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="preprocessor"> func##_(&o, &n, a, &lda, &ret); \</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="preprocessor"> return ret; \</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="preprocessor"> }</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <a class="code" href="c__lapack__api_8h.html#aa5297300313445fa46d2d1d2fb38970c">MXNET_LAPACK_CWRAPPER1</a>(spotrf, <span class="keywordtype">float</span>)</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <a class="code" href="c__lapack__api_8h.html#aa5297300313445fa46d2d1d2fb38970c">MXNET_LAPACK_CWRAPPER1</a>(dpotrf, <span class="keywordtype">double</span>)</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <a class="code" href="c__lapack__api_8h.html#aa5297300313445fa46d2d1d2fb38970c">MXNET_LAPACK_CWRAPPER1</a>(spotri, <span class="keywordtype">float</span>)</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <a class="code" href="c__lapack__api_8h.html#aa5297300313445fa46d2d1d2fb38970c">MXNET_LAPACK_CWRAPPER1</a>(dpotri, <span class="keywordtype">double</span>)</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment">// use pragma message instead of warning</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="preprocessor"> #pragma message("Warning: lapack usage not enabled, linalg-operators will not be available." \</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="preprocessor"> " Ensure that lapack library is installed and build with USE_LAPACK=1 to get lapack" \</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="preprocessor"> " functionalities.")</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment">// Define compilable stubs.</span></div><div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="c__lapack__api_8h.html#aa5297300313445fa46d2d1d2fb38970c"> 81</a></span> <span class="preprocessor"> #define MXNET_LAPACK_CWRAPPER1(func, dtype) \</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="preprocessor"> inline int MXNET_LAPACK_##func(int matrix_layout, char uplo, int n, dtype* a, int lda ) { \</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="preprocessor"> LOG(FATAL) << "MXNet build without lapack. Function " << #func << " is not available."; \</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="preprocessor"> return 1; \</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="preprocessor"> }</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <a class="code" href="c__lapack__api_8h.html#aa5297300313445fa46d2d1d2fb38970c">MXNET_LAPACK_CWRAPPER1</a>(spotrf, <span class="keywordtype">float</span>)</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <a class="code" href="c__lapack__api_8h.html#aa5297300313445fa46d2d1d2fb38970c">MXNET_LAPACK_CWRAPPER1</a>(dpotrf, <span class="keywordtype">double</span>)</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <a class="code" href="c__lapack__api_8h.html#aa5297300313445fa46d2d1d2fb38970c">MXNET_LAPACK_CWRAPPER1</a>(spotri, <span class="keywordtype">float</span>)</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <a class="code" href="c__lapack__api_8h.html#aa5297300313445fa46d2d1d2fb38970c">MXNET_LAPACK_CWRAPPER1</a>(dpotri, <span class="keywordtype">double</span>)</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="preprocessor">#endif // MXNET_C_LAPACK_API_H_</span></div><div class="ttc" id="c__lapack__api_8h_html_a56f112686aa64bf8a42204a3ff87ea46"><div class="ttname"><a href="c__lapack__api_8h.html#a56f112686aa64bf8a42204a3ff87ea46">MXNET_LAPACK_FSIGNATURE1</a></div><div class="ttdeci">#define MXNET_LAPACK_FSIGNATURE1(func, dtype)</div><div class="ttdef"><b>Definition:</b> c_lapack_api.h:37</div></div> |
| <div class="ttc" id="c__lapack__api_8h_html_af111a2f312a185185d0937bd091637e4"><div class="ttname"><a href="c__lapack__api_8h.html#af111a2f312a185185d0937bd091637e4">loup</a></div><div class="ttdeci">char loup(char uplo, bool invert)</div><div class="ttdef"><b>Definition:</b> c_lapack_api.h:55</div></div> |
| <div class="ttc" id="c__lapack__api_8h_html_aa5297300313445fa46d2d1d2fb38970c"><div class="ttname"><a href="c__lapack__api_8h.html#aa5297300313445fa46d2d1d2fb38970c">MXNET_LAPACK_CWRAPPER1</a></div><div class="ttdeci">#define MXNET_LAPACK_CWRAPPER1(func, dtype)</div><div class="ttdef"><b>Definition:</b> c_lapack_api.h:81</div></div> |
| </div><!-- fragment --></div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Fri Aug 11 2017 14:23:44 for mxnet by <a href="http://www.doxygen.org/index.html"> |
| <img alt="doxygen" class="footer" src="doxygen.png"/> |
| </a> 1.8.13 |
| </small></address> |
| </body> |
| </html> |
