166 lines
10 KiB
HTML
166 lines
10 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/option.hpp 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/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_e173a4984165953811b5143e3b27486f.html">util</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Classes</a> |
|
|
<a href="#namespaces">Namespaces</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">option.hpp File Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><div class="dynheader">
|
|
Include dependency graph for option.hpp:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="option_8hpp__incl.png" border="0" usemap="#src_2mlpack_2core_2util_2option_8hpp" alt=""/></div>
|
|
<map name="src_2mlpack_2core_2util_2option_8hpp" id="src_2mlpack_2core_2util_2option_8hpp">
|
|
<area shape="rect" id="node3" href="cli_8hpp.html" title="cli.hpp" alt="" coords="722,95,782,121"/>
|
|
<area shape="rect" id="node9" href="prereqs_8hpp.html" title="The core includes that mlpack expects; standard C++ includes and Armadillo. " alt="" coords="1583,319,1719,345"/>
|
|
<area shape="rect" id="node34" href="timers_8hpp.html" title="mlpack/core/util/timers.hpp" alt="" coords="424,401,603,427"/>
|
|
<area shape="rect" id="node37" href="cli__deleter_8hpp.html" title="cli_deleter.hpp" alt="" coords="569,169,676,196"/>
|
|
<area shape="rect" id="node38" href="src_2mlpack_2core_2util_2version_8hpp.html" title="version.hpp" alt="" coords="97,319,186,345"/>
|
|
<area shape="rect" id="node39" href="param_8hpp.html" title="param.hpp" alt="" coords="751,169,833,196"/>
|
|
<area shape="rect" id="node40" href="param__data_8hpp.html" title="param_data.hpp" alt="" coords="972,244,1087,271"/>
|
|
<area shape="rect" id="node42" href="print__param_8hpp.html" title="print_param.hpp" alt="" coords="867,169,981,196"/>
|
|
<area shape="rect" id="node44" href="output__param_8hpp.html" title="output_param.hpp" alt="" coords="1094,169,1221,196"/>
|
|
<area shape="rect" id="node46" href="default__param_8hpp.html" title="default_param.hpp" alt="" coords="1291,169,1421,196"/>
|
|
<area shape="rect" id="node48" href="string__type__param_8hpp.html" title="string_type_param.hpp" alt="" coords="1728,169,1883,196"/>
|
|
<area shape="rect" id="node25" href="serialization__shim_8hpp.html" title="mlpack/core/data/serialization\l_shim.hpp" alt="" coords="3189,393,3384,435"/>
|
|
<area shape="rect" id="node29" href="serialization__template__version_8hpp.html" title="mlpack/core/data/serialization\l_template_version.hpp" alt="" coords="1325,393,1520,435"/>
|
|
<area shape="rect" id="node31" href="arma__traits_8hpp.html" title="mlpack/core/util/arma\l_traits.hpp" alt="" coords="1741,393,1888,435"/>
|
|
<area shape="rect" id="node32" href="arma__config__check_8hpp.html" title="mlpack/core/util/arma\l_config_check.hpp" alt="" coords="1912,393,2059,435"/>
|
|
<area shape="rect" id="node33" href="log_8hpp.html" title="mlpack/core/util/log.hpp" alt="" coords="240,401,400,427"/>
|
|
<area shape="rect" id="node36" href="deprecated_8hpp.html" title="mlpack/core/util/deprecated.hpp" alt="" coords="2083,401,2290,427"/>
|
|
<area shape="rect" id="node26" href="sfinae__utility_8hpp.html" title="mlpack/core/util/sfinae\l_utility.hpp" alt="" coords="3346,483,3499,524"/>
|
|
</map>
|
|
</div>
|
|
</div>
|
|
<p><a href="option_8hpp_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="nested-classes"></a>
|
|
Classes</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classmlpack_1_1util_1_1Option.html">mlpack::util::Option< N ></a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A static object whose constructor registers a parameter with the <a class="el" href="classmlpack_1_1CLI.html" title="Parses the command line for parameters and holds user-specified parameters. ">CLI</a> class. <a href="classmlpack_1_1util_1_1Option.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classmlpack_1_1util_1_1ProgramDoc.html">mlpack::util::ProgramDoc</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A static object whose constructor registers program documentation with the <a class="el" href="classmlpack_1_1CLI.html" title="Parses the command line for parameters and holds user-specified parameters. ">CLI</a> class. <a href="classmlpack_1_1util_1_1ProgramDoc.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
|
|
Namespaces</h2></td></tr>
|
|
<tr class="memitem:namespacemlpack"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlpack.html">mlpack</a></td></tr>
|
|
<tr class="memdesc:namespacemlpack"><td class="mdescLeft"> </td><td class="mdescRight">Linear algebra utility functions, generally performed on matrices or vectors. <br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:namespacemlpack_1_1util"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlpack_1_1util.html">mlpack::util</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><dl class="section author"><dt>Author</dt><dd>Matthew Amidon</dd></dl>
|
|
<p>Definition of the Option class, which is used to define parameters which are used by CLI. The ProgramDoc class also resides here.</p>
|
|
<p>mlpack is free software; you may redistribute it and/or modify it under the terms of the 3-clause BSD license. You should have received a copy of the 3-clause BSD license along with mlpack. If not, see <a href="http://www.opensource.org/licenses/BSD-3-Clause">http://www.opensource.org/licenses/BSD-3-Clause</a> for more information. </p>
|
|
|
|
<p>Definition in file <a class="el" href="option_8hpp_source.html">option.hpp</a>.</p>
|
|
</div></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>
|