119 lines
12 KiB
HTML
119 lines
12 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/optimizers/gradient_descent/test_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
|
|
 <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 Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related 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 List</span></a></li>
|
|
<li><a href="globals.html"><span>File 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_c92267e6eea9957c44bb2efde721ca22.html">optimizers</a></li><li class="navelem"><a class="el" href="dir_6aa760fe348f674b356bdba40d95b29b.html">gradient_descent</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">test_function.hpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="gradient__descent_2test__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> </div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#ifndef MLPACK_CORE_OPTIMIZERS_GD_TEST_FUNCTION_HPP</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#define MLPACK_CORE_OPTIMIZERS_GD_TEST_FUNCTION_HPP</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <<a class="code" href="prereqs_8hpp.html">mlpack/prereqs.hpp</a>></span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="keyword">namespace </span><a class="code" href="namespacemlpack.html">mlpack</a> {</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">namespace </span>optimization {</div><div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="namespacemlpack_1_1optimization_1_1test.html"> 19</a></span> <span class="keyword">namespace </span>test {</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1test_1_1GDTestFunction.html"> 25</a></span> <span class="keyword">class </span><a class="code" href="classmlpack_1_1optimization_1_1test_1_1GDTestFunction.html">GDTestFunction</a></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> {</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1test_1_1GDTestFunction.html#a2b2cfa54b72e865d197c821823bb6f0a"> 29</a></span>  <a class="code" href="classmlpack_1_1optimization_1_1test_1_1GDTestFunction.html#a2b2cfa54b72e865d197c821823bb6f0a">GDTestFunction</a>() { }</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="classmlpack_1_1optimization_1_1test_1_1GDTestFunction.html#a62b5ec1dc6b97aed6820a9272b4de70b"> 32</a></span>  arma::mat <a class="code" href="classmlpack_1_1optimization_1_1test_1_1GDTestFunction.html#a62b5ec1dc6b97aed6820a9272b4de70b">GetInitialPoint</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> arma::mat(<span class="stringliteral">"1; 3; 2"</span>); }</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keywordtype">double</span> <a class="code" href="classmlpack_1_1optimization_1_1test_1_1GDTestFunction.html#a20389f791fe2edbcad1319b265aae013">Evaluate</a>(<span class="keyword">const</span> arma::mat& coordinates) <span class="keyword">const</span>;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordtype">void</span> <a class="code" href="classmlpack_1_1optimization_1_1test_1_1GDTestFunction.html#ae258c9cd113a03148eff31cbe8999896">Gradient</a>(<span class="keyword">const</span> arma::mat& coordinates, arma::mat& gradient) <span class="keyword">const</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> </div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> } <span class="comment">// namespace test</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> } <span class="comment">// namespace optimization</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> } <span class="comment">// namespace mlpack</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> <span class="preprocessor">#endif</span></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="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_1optimization_1_1test_1_1GDTestFunction_html_a2b2cfa54b72e865d197c821823bb6f0a"><div class="ttname"><a href="classmlpack_1_1optimization_1_1test_1_1GDTestFunction.html#a2b2cfa54b72e865d197c821823bb6f0a">mlpack::optimization::test::GDTestFunction::GDTestFunction</a></div><div class="ttdeci">GDTestFunction()</div><div class="ttdoc">Nothing to do for the constructor. </div><div class="ttdef"><b>Definition:</b> <a href="gradient__descent_2test__function_8hpp_source.html#l00029">test_function.hpp:29</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1test_1_1GDTestFunction_html_ae258c9cd113a03148eff31cbe8999896"><div class="ttname"><a href="classmlpack_1_1optimization_1_1test_1_1GDTestFunction.html#ae258c9cd113a03148eff31cbe8999896">mlpack::optimization::test::GDTestFunction::Gradient</a></div><div class="ttdeci">void Gradient(const arma::mat &coordinates, arma::mat &gradient) const </div><div class="ttdoc">Evaluate the gradient of a function. </div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1test_1_1GDTestFunction_html"><div class="ttname"><a href="classmlpack_1_1optimization_1_1test_1_1GDTestFunction.html">mlpack::optimization::test::GDTestFunction</a></div><div class="ttdoc">Very, very simple test function which is the composite of three other functions. </div><div class="ttdef"><b>Definition:</b> <a href="gradient__descent_2test__function_8hpp_source.html#l00025">test_function.hpp:25</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1test_1_1GDTestFunction_html_a20389f791fe2edbcad1319b265aae013"><div class="ttname"><a href="classmlpack_1_1optimization_1_1test_1_1GDTestFunction.html#a20389f791fe2edbcad1319b265aae013">mlpack::optimization::test::GDTestFunction::Evaluate</a></div><div class="ttdeci">double Evaluate(const arma::mat &coordinates) const </div><div class="ttdoc">Evaluate a function. </div></div>
|
|
<div class="ttc" id="classmlpack_1_1optimization_1_1test_1_1GDTestFunction_html_a62b5ec1dc6b97aed6820a9272b4de70b"><div class="ttname"><a href="classmlpack_1_1optimization_1_1test_1_1GDTestFunction.html#a62b5ec1dc6b97aed6820a9272b4de70b">mlpack::optimization::test::GDTestFunction::GetInitialPoint</a></div><div class="ttdeci">arma::mat GetInitialPoint() const </div><div class="ttdoc">Get the starting point. </div><div class="ttdef"><b>Definition:</b> <a href="gradient__descent_2test__function_8hpp_source.html#l00032">test_function.hpp:32</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <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>
|