120 lines
15 KiB
HTML
120 lines
15 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 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_e173a4984165953811b5143e3b27486f.html">util</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">option.hpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="option_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="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#ifndef MLPACK_CORE_UTIL_OPTION_HPP</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#define MLPACK_CORE_UTIL_OPTION_HPP</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include "<a class="code" href="cli_8hpp.html">cli.hpp</a>"</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">namespace </span><a class="code" href="namespacemlpack.html">mlpack</a> {</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">namespace </span>util {</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">template</span><<span class="keyword">typename</span> N></div><div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="classmlpack_1_1util_1_1Option.html"> 32</a></span> <span class="keyword">class </span><a class="code" href="classmlpack_1_1util_1_1Option.html">Option</a></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> {</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="classmlpack_1_1util_1_1Option.html#a99c63eab37ecb4b97edac1f7c7470614"> 50</a></span>  <a class="code" href="classmlpack_1_1util_1_1Option.html#a99c63eab37ecb4b97edac1f7c7470614">Option</a>(<span class="keyword">const</span> N defaultValue,</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keyword">const</span> <a class="code" href="bindings_2matlab_2CMakeLists_8txt.html#ad3a3f86b22ab94a882506e9e614165f1">std::string</a>& identifier,</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">const</span> <a class="code" href="bindings_2matlab_2CMakeLists_8txt.html#ad3a3f86b22ab94a882506e9e614165f1">std::string</a>& description,</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">const</span> <a class="code" href="bindings_2matlab_2CMakeLists_8txt.html#ad3a3f86b22ab94a882506e9e614165f1">std::string</a>& alias,</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">const</span> <span class="keywordtype">bool</span> required = <span class="keyword">false</span>,</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">const</span> <span class="keywordtype">bool</span> input = <span class="keyword">true</span>,</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">const</span> <span class="keywordtype">bool</span> noTranspose = <span class="keyword">false</span>)</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  {</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  CLI::Add<N>(defaultValue, identifier, description, alias[0], required,</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  input, noTranspose);</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  }</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> };</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div><div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="classmlpack_1_1util_1_1ProgramDoc.html"> 71</a></span> <span class="keyword">class </span><a class="code" href="classmlpack_1_1util_1_1ProgramDoc.html">ProgramDoc</a></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> {</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <a class="code" href="classmlpack_1_1util_1_1ProgramDoc.html">ProgramDoc</a>(<span class="keyword">const</span> <a class="code" href="bindings_2matlab_2CMakeLists_8txt.html#ad3a3f86b22ab94a882506e9e614165f1">std::string</a>& programName,</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keyword">const</span> <a class="code" href="bindings_2matlab_2CMakeLists_8txt.html#ad3a3f86b22ab94a882506e9e614165f1">std::string</a>& documentation);</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div><div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="classmlpack_1_1util_1_1ProgramDoc.html#a3bc6af4a515a280ff1dcc2caec404327"> 87</a></span>  <a class="code" href="bindings_2matlab_2CMakeLists_8txt.html#ad3a3f86b22ab94a882506e9e614165f1">std::string</a> <a class="code" href="classmlpack_1_1util_1_1ProgramDoc.html#a3bc6af4a515a280ff1dcc2caec404327">programName</a>;</div><div class="line"><a name="l00089"></a><span class="lineno"><a class="line" href="classmlpack_1_1util_1_1ProgramDoc.html#a1088a9e5a986fb6fe3133115985819dd"> 89</a></span>  <a class="code" href="bindings_2matlab_2CMakeLists_8txt.html#ad3a3f86b22ab94a882506e9e614165f1">std::string</a> <a class="code" href="classmlpack_1_1util_1_1ProgramDoc.html#a1088a9e5a986fb6fe3133115985819dd">documentation</a>;</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> };</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> } <span class="comment">// namespace util</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> } <span class="comment">// namespace mlpack</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="classmlpack_1_1util_1_1Option_html"><div class="ttname"><a href="classmlpack_1_1util_1_1Option.html">mlpack::util::Option</a></div><div class="ttdoc">A static object whose constructor registers a parameter with the CLI class. </div><div class="ttdef"><b>Definition:</b> <a href="option_8hpp_source.html#l00032">option.hpp:32</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_1util_1_1Option_html_a99c63eab37ecb4b97edac1f7c7470614"><div class="ttname"><a href="classmlpack_1_1util_1_1Option.html#a99c63eab37ecb4b97edac1f7c7470614">mlpack::util::Option::Option</a></div><div class="ttdeci">Option(const N defaultValue, const std::string &identifier, const std::string &description, const std::string &alias, const bool required=false, const bool input=true, const bool noTranspose=false)</div><div class="ttdoc">Construct an Option object. </div><div class="ttdef"><b>Definition:</b> <a href="option_8hpp_source.html#l00050">option.hpp:50</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1util_1_1ProgramDoc_html_a3bc6af4a515a280ff1dcc2caec404327"><div class="ttname"><a href="classmlpack_1_1util_1_1ProgramDoc.html#a3bc6af4a515a280ff1dcc2caec404327">mlpack::util::ProgramDoc::programName</a></div><div class="ttdeci">std::string programName</div><div class="ttdoc">The name of the program. </div><div class="ttdef"><b>Definition:</b> <a href="option_8hpp_source.html#l00087">option.hpp:87</a></div></div>
|
|
<div class="ttc" id="cli_8hpp_html"><div class="ttname"><a href="cli_8hpp.html">cli.hpp</a></div></div>
|
|
<div class="ttc" id="bindings_2matlab_2CMakeLists_8txt_html_ad3a3f86b22ab94a882506e9e614165f1"><div class="ttname"><a href="bindings_2matlab_2CMakeLists_8txt.html#ad3a3f86b22ab94a882506e9e614165f1">string</a></div><div class="ttdeci">test cpp RESULT_VARIABLE MEX_RESULT_TRASH OUTPUT_VARIABLE MEX_OUTPUT ERROR_VARIABLE MEX_ERROR_TRASH string(REGEX MATCH"Warning: You are using"MEX_WARNING"${MEX_OUTPUT}") if(MEX_WARNING) string(REGEX REPLACE".*using [a-zA-Z]* version \"([0-9.]*)[^\"]*\".*""\\1"OTHER_COMPILER_VERSION"$</div><div class="ttdef"><b>Definition:</b> <a href="bindings_2matlab_2CMakeLists_8txt_source.html#l00018">CMakeLists.txt:18</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1util_1_1ProgramDoc_html"><div class="ttname"><a href="classmlpack_1_1util_1_1ProgramDoc.html">mlpack::util::ProgramDoc</a></div><div class="ttdoc">A static object whose constructor registers program documentation with the CLI class. </div><div class="ttdef"><b>Definition:</b> <a href="option_8hpp_source.html#l00071">option.hpp:71</a></div></div>
|
|
<div class="ttc" id="classmlpack_1_1util_1_1ProgramDoc_html_a1088a9e5a986fb6fe3133115985819dd"><div class="ttname"><a href="classmlpack_1_1util_1_1ProgramDoc.html#a1088a9e5a986fb6fe3133115985819dd">mlpack::util::ProgramDoc::documentation</a></div><div class="ttdeci">std::string documentation</div><div class="ttdoc">Documentation for what the program does. </div><div class="ttdef"><b>Definition:</b> <a href="option_8hpp_source.html#l00089">option.hpp:89</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>
|