Files
mlpack/doc/html/arma__traits_8hpp_source.html
T

114 lines
17 KiB
HTML

<!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.11"/>
<title>mlpack: src/mlpack/core/util/arma_traits.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>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="extra-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="projectalign" style="padding-left: 0.5em;">
<div id="projectname">mlpack
&#160;<span id="projectnumber">master</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<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="pages.html"><span>Related&#160;Pages</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)">
</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_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_44a936ef30fc126706c6284a2fc0c990.html">mlpack</a></li><li class="navelem"><a class="el" href="dir_f7ac9cdfd28b2e882eb44d163e3b98b4.html">core</a></li><li class="navelem"><a class="el" href="dir_e173a4984165953811b5143e3b27486f.html">util</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">arma_traits.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="arma__traits_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#ifndef MLPACK_CORE_UTIL_ARMA_TRAITS_HPP</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#define MLPACK_CORE_UTIL_ARMA_TRAITS_HPP</span></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="comment">// Structs have public members by default (that&#39;s why they are chosen over</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment">// classes).</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> VecType&gt;</div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="structIsVector.html"> 35</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structIsVector.html">IsVector</a></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;{</div><div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="structIsVector.html#a5ec0c1366b298b7200906b0772831f45"> 37</a></span>&#160; <span class="keyword">const</span> <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="structIsVector.html#a5ec0c1366b298b7200906b0772831f45">value</a> = <span class="keyword">false</span>;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;};</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="comment">// Commenting out the first template per case, because</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="comment">//Visual Studio doesn&#39;t like this instantiaion pattern (error C2910).</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="comment">//template&lt;&gt;</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> eT&gt;</div><div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="structIsVector_3_01arma_1_1Col_3_01eT_01_4_01_4.html"> 44</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structIsVector.html">IsVector</a>&lt;arma::Col&lt;eT&gt; &gt;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;{</div><div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="structIsVector_3_01arma_1_1Col_3_01eT_01_4_01_4.html#acf47df24029079ca1d890c32c148814d"> 46</a></span>&#160; <span class="keyword">const</span> <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="structIsVector.html#a5ec0c1366b298b7200906b0772831f45">value</a> = <span class="keyword">true</span>;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;};</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="comment">//template&lt;&gt;</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> eT&gt;</div><div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="structIsVector_3_01arma_1_1SpCol_3_01eT_01_4_01_4.html"> 51</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structIsVector.html">IsVector</a>&lt;arma::SpCol&lt;eT&gt; &gt;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;{</div><div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="structIsVector_3_01arma_1_1SpCol_3_01eT_01_4_01_4.html#a611edc88eef6969629ac2e0991bc32c9"> 53</a></span>&#160; <span class="keyword">const</span> <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="structIsVector.html#a5ec0c1366b298b7200906b0772831f45">value</a> = <span class="keyword">true</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="comment">//template&lt;&gt;</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> eT&gt;</div><div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="structIsVector_3_01arma_1_1Row_3_01eT_01_4_01_4.html"> 58</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structIsVector.html">IsVector</a>&lt;arma::Row&lt;eT&gt; &gt;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;{</div><div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="structIsVector_3_01arma_1_1Row_3_01eT_01_4_01_4.html#a0f839e96733edeb3d9591ac270a37f1c"> 60</a></span>&#160; <span class="keyword">const</span> <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="structIsVector.html#a5ec0c1366b298b7200906b0772831f45">value</a> = <span class="keyword">true</span>;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;};</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;<span class="comment">//template&lt;&gt;</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> eT&gt;</div><div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="structIsVector_3_01arma_1_1SpRow_3_01eT_01_4_01_4.html"> 65</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structIsVector.html">IsVector</a>&lt;arma::SpRow&lt;eT&gt; &gt;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;{</div><div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="structIsVector_3_01arma_1_1SpRow_3_01eT_01_4_01_4.html#ae34a53ab0f3ad0e317a28cee06e5c596"> 67</a></span>&#160; <span class="keyword">const</span> <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="structIsVector.html#a5ec0c1366b298b7200906b0772831f45">value</a> = <span class="keyword">true</span>;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;};</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;<span class="comment">//template&lt;&gt;</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> eT&gt;</div><div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="structIsVector_3_01arma_1_1subview__col_3_01eT_01_4_01_4.html"> 72</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structIsVector.html">IsVector</a>&lt;arma::subview_col&lt;eT&gt; &gt;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;{</div><div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="structIsVector_3_01arma_1_1subview__col_3_01eT_01_4_01_4.html#ad456570d0b6fd307d1e3f71265ea385f"> 74</a></span>&#160; <span class="keyword">const</span> <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="structIsVector.html#a5ec0c1366b298b7200906b0772831f45">value</a> = <span class="keyword">true</span>;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;};</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160;<span class="comment">//template&lt;&gt;</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> eT&gt;</div><div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="structIsVector_3_01arma_1_1subview__row_3_01eT_01_4_01_4.html"> 79</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structIsVector.html">IsVector</a>&lt;arma::subview_row&lt;eT&gt; &gt;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;{</div><div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="structIsVector_3_01arma_1_1subview__row_3_01eT_01_4_01_4.html#aa89229a6d5fd4fd5b946217d20151c48"> 81</a></span>&#160; <span class="keyword">const</span> <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="structIsVector.html#a5ec0c1366b298b7200906b0772831f45">value</a> = <span class="keyword">true</span>;</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;};</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;<span class="comment">// I&#39;m not so sure about this one. An SpSubview object can be a row or column,</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;<span class="comment">// but it can also be a matrix subview.</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;<span class="comment">//template&lt;&gt;</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;<span class="keyword">template</span>&lt;<span class="keyword">typename</span> eT&gt;</div><div class="line"><a name="l00089"></a><span class="lineno"><a class="line" href="structIsVector_3_01arma_1_1SpSubview_3_01eT_01_4_01_4.html"> 89</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structIsVector.html">IsVector</a>&lt;arma::SpSubview&lt;eT&gt; &gt;</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;{</div><div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="structIsVector_3_01arma_1_1SpSubview_3_01eT_01_4_01_4.html#af4e0f76aa9ad00c0aa492cb8e9725b59"> 91</a></span>&#160; <span class="keyword">const</span> <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="structIsVector.html#a5ec0c1366b298b7200906b0772831f45">value</a> = <span class="keyword">true</span>;</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;};</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="structIsVector_html_a5ec0c1366b298b7200906b0772831f45"><div class="ttname"><a href="structIsVector.html#a5ec0c1366b298b7200906b0772831f45">IsVector::value</a></div><div class="ttdeci">static const bool value</div><div class="ttdef"><b>Definition:</b> <a href="arma__traits_8hpp_source.html#l00037">arma_traits.hpp:37</a></div></div>
<div class="ttc" id="structIsVector_html"><div class="ttname"><a href="structIsVector.html">IsVector</a></div><div class="ttdoc">If value == true, then VecType is some sort of Armadillo vector or subview. </div><div class="ttdef"><b>Definition:</b> <a href="arma__traits_8hpp_source.html#l00035">arma_traits.hpp:35</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- 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.11
</small></address>
</body>
<script type="text/javascript">
var x = document.getElementsByClassName("formulaDsp");
var i;
for (i = 0; i < x.length; i++)
{
x[i].width /= 4;
}
</script>
</html>