Files
mlpack/doc/html/softmax__regression__function_8hpp_source.html
T

133 lines
31 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/methods/softmax_regression/softmax_regression_function.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_3cfbf900288ec2fe8dd2c2c8482f216e.html">methods</a></li><li class="navelem"><a class="el" href="dir_ef6c2ad6ea2e7fbc564fdee0127eb9cb.html">softmax_regression</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">softmax_regression_function.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="softmax__regression__function_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="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#ifndef MLPACK_METHODS_SOFTMAX_REGRESSION_SOFTMAX_REGRESSION_FUNCTION_HPP</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#define MLPACK_METHODS_SOFTMAX_REGRESSION_SOFTMAX_REGRESSION_FUNCTION_HPP</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="prereqs_8hpp.html">mlpack/prereqs.hpp</a>&gt;</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacemlpack.html">mlpack</a> {</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="keyword">namespace </span>regression {</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;</div><div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html"> 21</a></span>&#160;<span class="keyword">class </span><a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html">SoftmaxRegressionFunction</a></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;{</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#a04fb165933a254fa25c59a2c7abb93cd">SoftmaxRegressionFunction</a>(<span class="keyword">const</span> arma::mat&amp; <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#a2e3f74b4fcf2b741173be496b6529714">data</a>,</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keyword">const</span> arma::Row&lt;size_t&gt;&amp; labels,</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keyword">const</span> <span class="keywordtype">size_t</span> <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#a101ba2df474ecdc8df13a578894812a6">numClasses</a>,</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keyword">const</span> <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#a670dad5b9bcd03bf0af094a1a4ef3d7f">lambda</a> = 0.0001,</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keyword">const</span> <span class="keywordtype">bool</span> <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#aa1347374266670a5662bde98c7554b9f">fitIntercept</a> = <span class="keyword">false</span>);</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keyword">const</span> arma::mat <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#aef36a1980d482c89e57e5a39c36e0758">InitializeWeights</a>();</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="keyword">static</span> <span class="keyword">const</span> arma::mat <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#aef36a1980d482c89e57e5a39c36e0758">InitializeWeights</a>(<span class="keyword">const</span> <span class="keywordtype">size_t</span> featureSize,</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keyword">const</span> <span class="keywordtype">size_t</span> numClasses,</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keyword">const</span> <span class="keywordtype">bool</span> <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#aa1347374266670a5662bde98c7554b9f">fitIntercept</a> = <span class="keyword">false</span>);</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#aef36a1980d482c89e57e5a39c36e0758">InitializeWeights</a>(arma::mat &amp;weights,</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keyword">const</span> <span class="keywordtype">size_t</span> featureSize,</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keyword">const</span> <span class="keywordtype">size_t</span> numClasses,</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="keyword">const</span> <span class="keywordtype">bool</span> <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#aa1347374266670a5662bde98c7554b9f">fitIntercept</a> = <span class="keyword">false</span>);</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#aff612342ba94ce27464f9b094b27d9e9">GetGroundTruthMatrix</a>(<span class="keyword">const</span> arma::Row&lt;size_t&gt;&amp; labels,</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; arma::sp_mat&amp; <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#a6f41ab9a1064fc773375e0aa94095120">groundTruth</a>);</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160;</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#a8e5db78a1d8bdcd2fd34bba2a119a6ec">GetProbabilitiesMatrix</a>(<span class="keyword">const</span> arma::mat&amp; parameters,</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; arma::mat&amp; probabilities) <span class="keyword">const</span>;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#a9a019e8fc0180563709261da7a2873ce">Evaluate</a>(<span class="keyword">const</span> arma::mat&amp; parameters) <span class="keyword">const</span>;</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160;</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#a6dbfb5cd32ab9e770fb965dc778adde4">Gradient</a>(<span class="keyword">const</span> arma::mat&amp; parameters, arma::mat&amp; gradient) <span class="keyword">const</span>;</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160;</div><div class="line"><a name="l00115"></a><span class="lineno"><a class="line" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#ab380449ee1fef938ff483abf91c88b2d"> 115</a></span>&#160; <span class="keyword">const</span> arma::mat&amp; <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#ab380449ee1fef938ff483abf91c88b2d">GetInitialPoint</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#acb264cabc7ece311ce0a4fc716ac06a0">initialPoint</a>; }</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160;</div><div class="line"><a name="l00118"></a><span class="lineno"><a class="line" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#a8103ebfe7f88389b2345e80375947f8b"> 118</a></span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#a8103ebfe7f88389b2345e80375947f8b">NumClasses</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#a101ba2df474ecdc8df13a578894812a6">numClasses</a>; }</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160;</div><div class="line"><a name="l00121"></a><span class="lineno"><a class="line" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#af33aac8a050be127b82f40ff60cf7981"> 121</a></span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#af33aac8a050be127b82f40ff60cf7981">FeatureSize</a>()<span class="keyword"> const</span></div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160;<span class="keyword"> </span>{</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#aa1347374266670a5662bde98c7554b9f">fitIntercept</a> ? <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#acb264cabc7ece311ce0a4fc716ac06a0">initialPoint</a>.n_cols - 1 :</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#acb264cabc7ece311ce0a4fc716ac06a0">initialPoint</a>.n_cols;</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; }</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160;</div><div class="line"><a name="l00128"></a><span class="lineno"><a class="line" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#ab4406833a9268b8729d53e7ff3a46d21"> 128</a></span>&#160; <span class="keywordtype">double</span>&amp; <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#ab4406833a9268b8729d53e7ff3a46d21">Lambda</a>() { <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#a670dad5b9bcd03bf0af094a1a4ef3d7f">lambda</a>; }</div><div class="line"><a name="l00130"></a><span class="lineno"><a class="line" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#aa9e4a31b2e3df431f3d4fa78cbbc1d67"> 130</a></span>&#160; <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#aa9e4a31b2e3df431f3d4fa78cbbc1d67">Lambda</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#a670dad5b9bcd03bf0af094a1a4ef3d7f">lambda</a>; }</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160;</div><div class="line"><a name="l00133"></a><span class="lineno"><a class="line" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#a2b8f1ae12cb6aed7031b1c532a6fbd6f"> 133</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#a2b8f1ae12cb6aed7031b1c532a6fbd6f">FitIntercept</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#aa1347374266670a5662bde98c7554b9f">fitIntercept</a>; }</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160;</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160; <span class="keyword">private</span>:</div><div class="line"><a name="l00137"></a><span class="lineno"><a class="line" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#a2e3f74b4fcf2b741173be496b6529714"> 137</a></span>&#160; <span class="keyword">const</span> arma::mat&amp; <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#a2e3f74b4fcf2b741173be496b6529714">data</a>;</div><div class="line"><a name="l00139"></a><span class="lineno"><a class="line" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#a6f41ab9a1064fc773375e0aa94095120"> 139</a></span>&#160; arma::sp_mat <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#a6f41ab9a1064fc773375e0aa94095120">groundTruth</a>;</div><div class="line"><a name="l00141"></a><span class="lineno"><a class="line" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#acb264cabc7ece311ce0a4fc716ac06a0"> 141</a></span>&#160; arma::mat <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#acb264cabc7ece311ce0a4fc716ac06a0">initialPoint</a>;</div><div class="line"><a name="l00143"></a><span class="lineno"><a class="line" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#a101ba2df474ecdc8df13a578894812a6"> 143</a></span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#a101ba2df474ecdc8df13a578894812a6">numClasses</a>;</div><div class="line"><a name="l00145"></a><span class="lineno"><a class="line" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#a670dad5b9bcd03bf0af094a1a4ef3d7f"> 145</a></span>&#160; <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#a670dad5b9bcd03bf0af094a1a4ef3d7f">lambda</a>;</div><div class="line"><a name="l00147"></a><span class="lineno"><a class="line" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#aa1347374266670a5662bde98c7554b9f"> 147</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#aa1347374266670a5662bde98c7554b9f">fitIntercept</a>;</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160;};</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160;</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160;} <span class="comment">// namespace regression</span></div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160;} <span class="comment">// namespace mlpack</span></div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160;</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="classmlpack_1_1regression_1_1SoftmaxRegressionFunction_html_ab4406833a9268b8729d53e7ff3a46d21"><div class="ttname"><a href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#ab4406833a9268b8729d53e7ff3a46d21">mlpack::regression::SoftmaxRegressionFunction::Lambda</a></div><div class="ttdeci">double &amp; Lambda()</div><div class="ttdoc">Sets the regularization parameter. </div><div class="ttdef"><b>Definition:</b> <a href="softmax__regression__function_8hpp_source.html#l00128">softmax_regression_function.hpp:128</a></div></div>
<div class="ttc" id="namespacemlpack_html"><div class="ttname"><a href="namespacemlpack.html">mlpack</a></div><div class="ttdoc">Linear algebra utility functions, generally performed on matrices or vectors. </div><div class="ttdef"><b>Definition:</b> <a href="binarize_8hpp_source.html#l00018">binarize.hpp:18</a></div></div>
<div class="ttc" id="classmlpack_1_1regression_1_1SoftmaxRegressionFunction_html_a8e5db78a1d8bdcd2fd34bba2a119a6ec"><div class="ttname"><a href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#a8e5db78a1d8bdcd2fd34bba2a119a6ec">mlpack::regression::SoftmaxRegressionFunction::GetProbabilitiesMatrix</a></div><div class="ttdeci">void GetProbabilitiesMatrix(const arma::mat &amp;parameters, arma::mat &amp;probabilities) const </div><div class="ttdoc">Evaluate the probabilities matrix with the passed parameters. </div></div>
<div class="ttc" id="prereqs_8hpp_html"><div class="ttname"><a href="prereqs_8hpp.html">prereqs.hpp</a></div><div class="ttdoc">The core includes that mlpack expects; standard C++ includes and Armadillo. </div></div>
<div class="ttc" id="classmlpack_1_1regression_1_1SoftmaxRegressionFunction_html_aa1347374266670a5662bde98c7554b9f"><div class="ttname"><a href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#aa1347374266670a5662bde98c7554b9f">mlpack::regression::SoftmaxRegressionFunction::fitIntercept</a></div><div class="ttdeci">bool fitIntercept</div><div class="ttdoc">Intercept term flag. </div><div class="ttdef"><b>Definition:</b> <a href="softmax__regression__function_8hpp_source.html#l00147">softmax_regression_function.hpp:147</a></div></div>
<div class="ttc" id="classmlpack_1_1regression_1_1SoftmaxRegressionFunction_html_a9a019e8fc0180563709261da7a2873ce"><div class="ttname"><a href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#a9a019e8fc0180563709261da7a2873ce">mlpack::regression::SoftmaxRegressionFunction::Evaluate</a></div><div class="ttdeci">double Evaluate(const arma::mat &amp;parameters) const </div><div class="ttdoc">Evaluates the objective function of the softmax regression model using the given parameters. </div></div>
<div class="ttc" id="classmlpack_1_1regression_1_1SoftmaxRegressionFunction_html_a8103ebfe7f88389b2345e80375947f8b"><div class="ttname"><a href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#a8103ebfe7f88389b2345e80375947f8b">mlpack::regression::SoftmaxRegressionFunction::NumClasses</a></div><div class="ttdeci">size_t NumClasses() const </div><div class="ttdoc">Gets the number of classes. </div><div class="ttdef"><b>Definition:</b> <a href="softmax__regression__function_8hpp_source.html#l00118">softmax_regression_function.hpp:118</a></div></div>
<div class="ttc" id="classmlpack_1_1regression_1_1SoftmaxRegressionFunction_html_a2e3f74b4fcf2b741173be496b6529714"><div class="ttname"><a href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#a2e3f74b4fcf2b741173be496b6529714">mlpack::regression::SoftmaxRegressionFunction::data</a></div><div class="ttdeci">const arma::mat &amp; data</div><div class="ttdoc">Training data matrix. </div><div class="ttdef"><b>Definition:</b> <a href="softmax__regression__function_8hpp_source.html#l00137">softmax_regression_function.hpp:137</a></div></div>
<div class="ttc" id="classmlpack_1_1regression_1_1SoftmaxRegressionFunction_html_ab380449ee1fef938ff483abf91c88b2d"><div class="ttname"><a href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#ab380449ee1fef938ff483abf91c88b2d">mlpack::regression::SoftmaxRegressionFunction::GetInitialPoint</a></div><div class="ttdeci">const arma::mat &amp; GetInitialPoint() const </div><div class="ttdoc">Return the initial point for the optimization. </div><div class="ttdef"><b>Definition:</b> <a href="softmax__regression__function_8hpp_source.html#l00115">softmax_regression_function.hpp:115</a></div></div>
<div class="ttc" id="classmlpack_1_1regression_1_1SoftmaxRegressionFunction_html_aef36a1980d482c89e57e5a39c36e0758"><div class="ttname"><a href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#aef36a1980d482c89e57e5a39c36e0758">mlpack::regression::SoftmaxRegressionFunction::InitializeWeights</a></div><div class="ttdeci">const arma::mat InitializeWeights()</div><div class="ttdoc">Initializes the parameters of the model to suitable values. </div></div>
<div class="ttc" id="classmlpack_1_1regression_1_1SoftmaxRegressionFunction_html_a670dad5b9bcd03bf0af094a1a4ef3d7f"><div class="ttname"><a href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#a670dad5b9bcd03bf0af094a1a4ef3d7f">mlpack::regression::SoftmaxRegressionFunction::lambda</a></div><div class="ttdeci">double lambda</div><div class="ttdoc">L2-regularization constant. </div><div class="ttdef"><b>Definition:</b> <a href="softmax__regression__function_8hpp_source.html#l00145">softmax_regression_function.hpp:145</a></div></div>
<div class="ttc" id="classmlpack_1_1regression_1_1SoftmaxRegressionFunction_html_af33aac8a050be127b82f40ff60cf7981"><div class="ttname"><a href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#af33aac8a050be127b82f40ff60cf7981">mlpack::regression::SoftmaxRegressionFunction::FeatureSize</a></div><div class="ttdeci">size_t FeatureSize() const </div><div class="ttdoc">Gets the features size of the training data. </div><div class="ttdef"><b>Definition:</b> <a href="softmax__regression__function_8hpp_source.html#l00121">softmax_regression_function.hpp:121</a></div></div>
<div class="ttc" id="classmlpack_1_1regression_1_1SoftmaxRegressionFunction_html_a6f41ab9a1064fc773375e0aa94095120"><div class="ttname"><a href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#a6f41ab9a1064fc773375e0aa94095120">mlpack::regression::SoftmaxRegressionFunction::groundTruth</a></div><div class="ttdeci">arma::sp_mat groundTruth</div><div class="ttdoc">Label matrix for the provided data. </div><div class="ttdef"><b>Definition:</b> <a href="softmax__regression__function_8hpp_source.html#l00139">softmax_regression_function.hpp:139</a></div></div>
<div class="ttc" id="classmlpack_1_1regression_1_1SoftmaxRegressionFunction_html_a2b8f1ae12cb6aed7031b1c532a6fbd6f"><div class="ttname"><a href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#a2b8f1ae12cb6aed7031b1c532a6fbd6f">mlpack::regression::SoftmaxRegressionFunction::FitIntercept</a></div><div class="ttdeci">bool FitIntercept() const </div><div class="ttdoc">Gets the intercept flag. </div><div class="ttdef"><b>Definition:</b> <a href="softmax__regression__function_8hpp_source.html#l00133">softmax_regression_function.hpp:133</a></div></div>
<div class="ttc" id="classmlpack_1_1regression_1_1SoftmaxRegressionFunction_html"><div class="ttname"><a href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html">mlpack::regression::SoftmaxRegressionFunction</a></div><div class="ttdef"><b>Definition:</b> <a href="softmax__regression__function_8hpp_source.html#l00021">softmax_regression_function.hpp:21</a></div></div>
<div class="ttc" id="classmlpack_1_1regression_1_1SoftmaxRegressionFunction_html_a04fb165933a254fa25c59a2c7abb93cd"><div class="ttname"><a href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#a04fb165933a254fa25c59a2c7abb93cd">mlpack::regression::SoftmaxRegressionFunction::SoftmaxRegressionFunction</a></div><div class="ttdeci">SoftmaxRegressionFunction(const arma::mat &amp;data, const arma::Row&lt; size_t &gt; &amp;labels, const size_t numClasses, const double lambda=0.0001, const bool fitIntercept=false)</div><div class="ttdoc">Construct the Softmax Regression objective function with the given parameters. </div></div>
<div class="ttc" id="classmlpack_1_1regression_1_1SoftmaxRegressionFunction_html_aff612342ba94ce27464f9b094b27d9e9"><div class="ttname"><a href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#aff612342ba94ce27464f9b094b27d9e9">mlpack::regression::SoftmaxRegressionFunction::GetGroundTruthMatrix</a></div><div class="ttdeci">void GetGroundTruthMatrix(const arma::Row&lt; size_t &gt; &amp;labels, arma::sp_mat &amp;groundTruth)</div><div class="ttdoc">Constructs the ground truth label matrix with the passed labels. </div></div>
<div class="ttc" id="classmlpack_1_1regression_1_1SoftmaxRegressionFunction_html_a6dbfb5cd32ab9e770fb965dc778adde4"><div class="ttname"><a href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#a6dbfb5cd32ab9e770fb965dc778adde4">mlpack::regression::SoftmaxRegressionFunction::Gradient</a></div><div class="ttdeci">void Gradient(const arma::mat &amp;parameters, arma::mat &amp;gradient) const </div><div class="ttdoc">Evaluates the gradient values of the objective function given the current set of parameters. </div></div>
<div class="ttc" id="classmlpack_1_1regression_1_1SoftmaxRegressionFunction_html_aa9e4a31b2e3df431f3d4fa78cbbc1d67"><div class="ttname"><a href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#aa9e4a31b2e3df431f3d4fa78cbbc1d67">mlpack::regression::SoftmaxRegressionFunction::Lambda</a></div><div class="ttdeci">double Lambda() const </div><div class="ttdoc">Gets the regularization parameter. </div><div class="ttdef"><b>Definition:</b> <a href="softmax__regression__function_8hpp_source.html#l00130">softmax_regression_function.hpp:130</a></div></div>
<div class="ttc" id="classmlpack_1_1regression_1_1SoftmaxRegressionFunction_html_acb264cabc7ece311ce0a4fc716ac06a0"><div class="ttname"><a href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#acb264cabc7ece311ce0a4fc716ac06a0">mlpack::regression::SoftmaxRegressionFunction::initialPoint</a></div><div class="ttdeci">arma::mat initialPoint</div><div class="ttdoc">Initial parameter point. </div><div class="ttdef"><b>Definition:</b> <a href="softmax__regression__function_8hpp_source.html#l00141">softmax_regression_function.hpp:141</a></div></div>
<div class="ttc" id="classmlpack_1_1regression_1_1SoftmaxRegressionFunction_html_a101ba2df474ecdc8df13a578894812a6"><div class="ttname"><a href="classmlpack_1_1regression_1_1SoftmaxRegressionFunction.html#a101ba2df474ecdc8df13a578894812a6">mlpack::regression::SoftmaxRegressionFunction::numClasses</a></div><div class="ttdeci">size_t numClasses</div><div class="ttdoc">Number of classes. </div><div class="ttdef"><b>Definition:</b> <a href="softmax__regression__function_8hpp_source.html#l00143">softmax_regression_function.hpp:143</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>