371 lines
18 KiB
HTML
371 lines
18 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: mlpack::optimization::AugLagrangianTestFunction Class 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/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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><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="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class 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="namespacemlpack.html">mlpack</a></li><li class="navelem"><a class="el" href="namespacemlpack_1_1optimization.html">optimization</a></li><li class="navelem"><a class="el" href="classmlpack_1_1optimization_1_1AugLagrangianTestFunction.html">AugLagrangianTestFunction</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pri-attribs">Private Attributes</a> |
|
|
<a href="classmlpack_1_1optimization_1_1AugLagrangianTestFunction-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">mlpack::optimization::AugLagrangianTestFunction Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>This function is taken from "Practical Mathematical Optimization" (Snyman), section 5.3.8 ("Application of the Augmented Lagrangian Method").
|
|
<a href="classmlpack_1_1optimization_1_1AugLagrangianTestFunction.html#details">More...</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:ad881628b1b254e1b622fe582d35ab0f8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmlpack_1_1optimization_1_1AugLagrangianTestFunction.html#ad881628b1b254e1b622fe582d35ab0f8">AugLagrangianTestFunction</a> ()</td></tr>
|
|
<tr class="separator:ad881628b1b254e1b622fe582d35ab0f8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a913b0481bdaade09fb1513e7b3bbe7ee"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmlpack_1_1optimization_1_1AugLagrangianTestFunction.html#a913b0481bdaade09fb1513e7b3bbe7ee">AugLagrangianTestFunction</a> (const arma::mat &initial_point)</td></tr>
|
|
<tr class="separator:a913b0481bdaade09fb1513e7b3bbe7ee"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9263b6611f9a8fda7e8612522f0f2e76"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classmlpack_1_1optimization_1_1AugLagrangianTestFunction.html#a9263b6611f9a8fda7e8612522f0f2e76">Evaluate</a> (const arma::mat &coordinates)</td></tr>
|
|
<tr class="separator:a9263b6611f9a8fda7e8612522f0f2e76"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af5fd75a0e8f39c0da51c6b4c2b93e789"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classmlpack_1_1optimization_1_1AugLagrangianTestFunction.html#af5fd75a0e8f39c0da51c6b4c2b93e789">EvaluateConstraint</a> (const size_t index, const arma::mat &coordinates)</td></tr>
|
|
<tr class="separator:af5fd75a0e8f39c0da51c6b4c2b93e789"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a360d90e3af11cb754e692617af22c672"><td class="memItemLeft" align="right" valign="top">const arma::mat & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmlpack_1_1optimization_1_1AugLagrangianTestFunction.html#a360d90e3af11cb754e692617af22c672">GetInitialPoint</a> () const </td></tr>
|
|
<tr class="separator:a360d90e3af11cb754e692617af22c672"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9a4ed0ff63676098335d0d2d5bf40d27"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmlpack_1_1optimization_1_1AugLagrangianTestFunction.html#a9a4ed0ff63676098335d0d2d5bf40d27">Gradient</a> (const arma::mat &coordinates, arma::mat &gradient)</td></tr>
|
|
<tr class="separator:a9a4ed0ff63676098335d0d2d5bf40d27"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a816d90b1353fd98358d22fd624512083"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmlpack_1_1optimization_1_1AugLagrangianTestFunction.html#a816d90b1353fd98358d22fd624512083">GradientConstraint</a> (const size_t index, const arma::mat &coordinates, arma::mat &gradient)</td></tr>
|
|
<tr class="separator:a816d90b1353fd98358d22fd624512083"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2badead8e3fe8225090df61b3aa646c3"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmlpack_1_1optimization_1_1AugLagrangianTestFunction.html#a2badead8e3fe8225090df61b3aa646c3">NumConstraints</a> () const </td></tr>
|
|
<tr class="separator:a2badead8e3fe8225090df61b3aa646c3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
|
|
Private Attributes</h2></td></tr>
|
|
<tr class="memitem:a22e207c6ef9cc281246507bb9915253c"><td class="memItemLeft" align="right" valign="top">arma::mat </td><td class="memItemRight" valign="bottom"><a class="el" href="classmlpack_1_1optimization_1_1AugLagrangianTestFunction.html#a22e207c6ef9cc281246507bb9915253c">initialPoint</a></td></tr>
|
|
<tr class="separator:a22e207c6ef9cc281246507bb9915253c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>This function is taken from "Practical Mathematical Optimization" (Snyman), section 5.3.8 ("Application of the Augmented Lagrangian Method"). </p>
|
|
<p>It has only one constraint.</p>
|
|
<p>The minimum that satisfies the constraint is x = [1, 4], with an objective value of 70. </p>
|
|
|
|
<p>Definition at line <a class="el" href="aug__lagrangian__test__functions_8hpp_source.html#l00028">28</a> of file <a class="el" href="aug__lagrangian__test__functions_8hpp_source.html">aug_lagrangian_test_functions.hpp</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="ad881628b1b254e1b622fe582d35ab0f8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">mlpack::optimization::AugLagrangianTestFunction::AugLagrangianTestFunction </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a913b0481bdaade09fb1513e7b3bbe7ee"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">mlpack::optimization::AugLagrangianTestFunction::AugLagrangianTestFunction </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const arma::mat & </td>
|
|
<td class="paramname"><em>initial_point</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a9263b6611f9a8fda7e8612522f0f2e76"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">double mlpack::optimization::AugLagrangianTestFunction::Evaluate </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const arma::mat & </td>
|
|
<td class="paramname"><em>coordinates</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="af5fd75a0e8f39c0da51c6b4c2b93e789"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">double mlpack::optimization::AugLagrangianTestFunction::EvaluateConstraint </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const size_t </td>
|
|
<td class="paramname"><em>index</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const arma::mat & </td>
|
|
<td class="paramname"><em>coordinates</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Referenced by <a class="el" href="aug__lagrangian__test__functions_8hpp_source.html#l00037">NumConstraints()</a>, and <a class="el" href="aug__lagrangian__test__functions_8hpp_source.html#l00070">mlpack::optimization::GockenbachFunction::NumConstraints()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a360d90e3af11cb754e692617af22c672"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const arma::mat& mlpack::optimization::AugLagrangianTestFunction::GetInitialPoint </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="aug__lagrangian__test__functions_8hpp_source.html#l00044">44</a> of file <a class="el" href="aug__lagrangian__test__functions_8hpp_source.html">aug_lagrangian_test_functions.hpp</a>.</p>
|
|
|
|
<p>References <a class="el" href="aug__lagrangian__test__functions_8hpp_source.html#l00047">initialPoint</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a9a4ed0ff63676098335d0d2d5bf40d27"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void mlpack::optimization::AugLagrangianTestFunction::Gradient </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const arma::mat & </td>
|
|
<td class="paramname"><em>coordinates</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">arma::mat & </td>
|
|
<td class="paramname"><em>gradient</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a816d90b1353fd98358d22fd624512083"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void mlpack::optimization::AugLagrangianTestFunction::GradientConstraint </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const size_t </td>
|
|
<td class="paramname"><em>index</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const arma::mat & </td>
|
|
<td class="paramname"><em>coordinates</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">arma::mat & </td>
|
|
<td class="paramname"><em>gradient</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Referenced by <a class="el" href="aug__lagrangian__test__functions_8hpp_source.html#l00037">NumConstraints()</a>, and <a class="el" href="aug__lagrangian__test__functions_8hpp_source.html#l00070">mlpack::optimization::GockenbachFunction::NumConstraints()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a2badead8e3fe8225090df61b3aa646c3"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t mlpack::optimization::AugLagrangianTestFunction::NumConstraints </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="aug__lagrangian__test__functions_8hpp_source.html#l00037">37</a> of file <a class="el" href="aug__lagrangian__test__functions_8hpp_source.html">aug_lagrangian_test_functions.hpp</a>.</p>
|
|
|
|
<p>References <a class="el" href="classmlpack_1_1optimization_1_1AugLagrangianTestFunction.html#af5fd75a0e8f39c0da51c6b4c2b93e789">EvaluateConstraint()</a>, and <a class="el" href="classmlpack_1_1optimization_1_1AugLagrangianTestFunction.html#a816d90b1353fd98358d22fd624512083">GradientConstraint()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a class="anchor" id="a22e207c6ef9cc281246507bb9915253c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">arma::mat mlpack::optimization::AugLagrangianTestFunction::initialPoint</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="aug__lagrangian__test__functions_8hpp_source.html#l00047">47</a> of file <a class="el" href="aug__lagrangian__test__functions_8hpp_source.html">aug_lagrangian_test_functions.hpp</a>.</p>
|
|
|
|
<p>Referenced by <a class="el" href="aug__lagrangian__test__functions_8hpp_source.html#l00044">GetInitialPoint()</a>, and <a class="el" href="aug__lagrangian__test__functions_8hpp_source.html#l00077">mlpack::optimization::GockenbachFunction::GetInitialPoint()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>src/mlpack/core/optimizers/aug_lagrangian/<a class="el" href="aug__lagrangian__test__functions_8hpp_source.html">aug_lagrangian_test_functions.hpp</a></li>
|
|
</ul>
|
|
</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>
|