blob: 0247f052b2e1d49e71601adf64841a445b1e1645 [file] [log] [blame]
<!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.6"/>
<title>mxnet: include/mxnet/c_lapack_api.h File Reference</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/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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 style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">mxnet
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<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>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;Members</span></a></li>
</ul>
</div>
<!-- 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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</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 id="nav-path" class="navpath">
<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="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">c_lapack_api.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Unified interface for LAPACK calls from within mxnet. Purpose is to hide the platform specific differences.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;dmlc/logging.h&gt;</code><br/>
</div><div class="textblock"><div class="dynheader">
Include dependency graph for c_lapack_api.h:</div>
<div class="dyncontent">
<div class="center"><img src="c__lapack__api_8h__incl.png" border="0" usemap="#include_2mxnet_2c__lapack__api_8h" alt=""/></div>
<map name="include_2mxnet_2c__lapack__api_8h" id="include_2mxnet_2c__lapack__api_8h">
</map>
</div>
</div>
<p><a href="c__lapack__api_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a56f112686aa64bf8a42204a3ff87ea46"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="c__lapack__api_8h.html#a56f112686aa64bf8a42204a3ff87ea46">MXNET_LAPACK_FSIGNATURE1</a>(func, dtype)&#160;&#160;&#160;void func##_(char* uplo, int* n, dtype* a, int* lda, int *info);</td></tr>
<tr class="separator:a56f112686aa64bf8a42204a3ff87ea46"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a220562c35966392841ae49fefe2dee5e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="c__lapack__api_8h.html#a220562c35966392841ae49fefe2dee5e">MXNET_LAPACK_ROW_MAJOR</a>&#160;&#160;&#160;101</td></tr>
<tr class="separator:a220562c35966392841ae49fefe2dee5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a49f324c038a0a1447ed094c679739ee7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="c__lapack__api_8h.html#a49f324c038a0a1447ed094c679739ee7">MXNET_LAPACK_COL_MAJOR</a>&#160;&#160;&#160;102</td></tr>
<tr class="separator:a49f324c038a0a1447ed094c679739ee7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2fa12bf140fecda6aac9336a61923713"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="c__lapack__api_8h.html#a2fa12bf140fecda6aac9336a61923713">CHECK_LAPACK_CONTIGUOUS</a>(a, b)&#160;&#160;&#160;CHECK_EQ(a, b) &lt;&lt; &quot;non contiguous memory for array in lapack call&quot;;</td></tr>
<tr class="separator:a2fa12bf140fecda6aac9336a61923713"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0c95bf8b79e51085d846c7a09ec22720"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="c__lapack__api_8h.html#a0c95bf8b79e51085d846c7a09ec22720">CHECK_LAPACK_UPLO</a>(a)&#160;&#160;&#160;CHECK(a == 'U' || a == 'L') &lt;&lt; &quot;neither L nor U specified as triangle in lapack call&quot;;</td></tr>
<tr class="separator:a0c95bf8b79e51085d846c7a09ec22720"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa5297300313445fa46d2d1d2fb38970c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="c__lapack__api_8h.html#aa5297300313445fa46d2d1d2fb38970c">MXNET_LAPACK_CWRAPPER1</a>(func, dtype)</td></tr>
<tr class="separator:aa5297300313445fa46d2d1d2fb38970c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:af111a2f312a185185d0937bd091637e4"><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="c__lapack__api_8h.html#af111a2f312a185185d0937bd091637e4">loup</a> (char uplo, bool invert)</td></tr>
<tr class="separator:af111a2f312a185185d0937bd091637e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Unified interface for LAPACK calls from within mxnet. Purpose is to hide the platform specific differences. </p>
<p>Copyright (c) 2017 by Contributors </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="a2fa12bf140fecda6aac9336a61923713"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define CHECK_LAPACK_CONTIGUOUS</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">a, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">b&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>&#160;&#160;&#160;CHECK_EQ(a, b) &lt;&lt; &quot;non contiguous memory for array in lapack call&quot;;</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a0c95bf8b79e51085d846c7a09ec22720"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define CHECK_LAPACK_UPLO</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">a</td><td>)</td>
<td>&#160;&#160;&#160;CHECK(a == 'U' || a == 'L') &lt;&lt; &quot;neither L nor U specified as triangle in lapack call&quot;;</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a49f324c038a0a1447ed094c679739ee7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MXNET_LAPACK_COL_MAJOR&#160;&#160;&#160;102</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="aa5297300313445fa46d2d1d2fb38970c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MXNET_LAPACK_CWRAPPER1</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">func, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">dtype&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><span class="keyword">inline</span> <span class="keywordtype">int</span> MXNET_LAPACK_##func(<span class="keywordtype">int</span> matrix_layout, <span class="keywordtype">char</span> uplo, <span class="keywordtype">int</span> n, dtype* a, <span class="keywordtype">int</span> lda ) { \</div>
<div class="line"> LOG(FATAL) &lt;&lt; <span class="stringliteral">&quot;MXNet build without lapack. Function &quot;</span> &lt;&lt; #func &lt;&lt; <span class="stringliteral">&quot; is not available.&quot;</span>; \</div>
<div class="line"> return 1; \</div>
<div class="line"> }</div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="a56f112686aa64bf8a42204a3ff87ea46"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MXNET_LAPACK_FSIGNATURE1</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">func, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">dtype&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>&#160;&#160;&#160;void func##_(char* uplo, int* n, dtype* a, int* lda, int *info);</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a220562c35966392841ae49fefe2dee5e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MXNET_LAPACK_ROW_MAJOR&#160;&#160;&#160;101</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="af111a2f312a185185d0937bd091637e4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">char loup </td>
<td>(</td>
<td class="paramtype">char&#160;</td>
<td class="paramname"><em>uplo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>invert</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Aug 6 2017 07:14:31 for mxnet by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>