2460 lines
159 KiB
HTML
2460 lines
159 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/param.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> |
|
|
<a href="#define-members">Macros</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">param.hpp File Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><div class="dynheader">
|
|
This graph shows which files directly or indirectly include this file:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="param_8hpp__dep__incl.png" border="0" usemap="#src_2mlpack_2core_2util_2param_8hppdep" alt=""/></div>
|
|
<map name="src_2mlpack_2core_2util_2param_8hppdep" id="src_2mlpack_2core_2util_2param_8hppdep">
|
|
<area shape="rect" id="node2" href="cli_8hpp.html" title="src/mlpack/core/util\l/cli.hpp" alt="" coords="504,95,640,136"/>
|
|
<area shape="rect" id="node3" href="option_8hpp.html" title="src/mlpack/core/util\l/option.hpp" alt="" coords="423,184,559,225"/>
|
|
<area shape="rect" id="node4" href="core_8hpp.html" title="Include all of the base components required to write MLPACK methods, and the main MLPACK Doxygen docu..." alt="" coords="583,191,723,218"/>
|
|
<area shape="rect" id="node5" href="load__csv_8hpp.html" title="src/mlpack/core/data\l/load_csv.hpp" alt="" coords="5,281,149,322"/>
|
|
<area shape="rect" id="node6" href="adaboost__model_8hpp.html" title="src/mlpack/methods\l/adaboost/adaboost_model.hpp" alt="" coords="173,281,376,322"/>
|
|
<area shape="rect" id="node7" href="recurrent_8hpp.html" title="src/mlpack/methods\l/ann/layer/recurrent.hpp" alt="" coords="401,281,559,322"/>
|
|
<area shape="rect" id="node9" href="dbscan_8hpp.html" title="src/mlpack/methods\l/dbscan/dbscan.hpp" alt="" coords="583,281,723,322"/>
|
|
<area shape="rect" id="node10" href="gini__gain_8hpp.html" title="src/mlpack/methods\l/decision_tree/gini\l_gain.hpp" alt="" coords="747,273,887,329"/>
|
|
<area shape="rect" id="node12" href="serialization_8hpp.html" title="src/mlpack/tests/serialization.hpp" alt="" coords="923,392,1141,419"/>
|
|
<area shape="rect" id="node13" href="test__tools_8hpp.html" title="src/mlpack/tests/test\l_tools.hpp" alt="" coords="963,281,1109,322"/>
|
|
<area shape="rect" id="node8" href="layer_8hpp.html" title="src/mlpack/methods\l/ann/layer/layer.hpp" alt="" coords="410,385,550,426"/>
|
|
<area shape="rect" id="node11" href="decision__tree_8hpp.html" title="src/mlpack/methods\l/decision_tree/decision\l_tree.hpp" alt="" coords="740,377,895,433"/>
|
|
</map>
|
|
</div>
|
|
</div>
|
|
<p><a href="param_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_1data_1_1DatasetMapper.html">mlpack::data::DatasetMapper< PolicyType ></a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Auxiliary information for a dataset, including mappings to/from strings and the datatype of each dimension. <a href="classmlpack_1_1data_1_1DatasetMapper.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_1data"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemlpack_1_1data.html">mlpack::data</a></td></tr>
|
|
<tr class="memdesc:namespacemlpack_1_1data"><td class="mdescLeft"> </td><td class="mdescRight">Functions to load and save matrices and models. <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="define-members"></a>
|
|
Macros</h2></td></tr>
|
|
<tr class="memitem:afef4dcbf5fa0b81c4daf50f77b4391af"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="param_8hpp.html#afef4dcbf5fa0b81c4daf50f77b4391af">PARAM_COL</a>(ID, DESC, ALIAS, REQ, TRANS, IN)</td></tr>
|
|
<tr class="separator:afef4dcbf5fa0b81c4daf50f77b4391af"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a36713e2f7157727157af4a92f1c2ad5d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="param_8hpp.html#a36713e2f7157727157af4a92f1c2ad5d">PARAM_COL_IN</a>(ID, DESC, ALIAS)   <a class="el" href="param_8hpp.html#afef4dcbf5fa0b81c4daf50f77b4391af">PARAM_COL</a>(ID, DESC, ALIAS, false, true, true)</td></tr>
|
|
<tr class="memdesc:a36713e2f7157727157af4a92f1c2ad5d"><td class="mdescLeft"> </td><td class="mdescRight">Define a vector input parameter (type arma::vec). <a href="#a36713e2f7157727157af4a92f1c2ad5d">More...</a><br /></td></tr>
|
|
<tr class="separator:a36713e2f7157727157af4a92f1c2ad5d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a07120f558c6c681b2a27a719a7c39bd2"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="param_8hpp.html#a07120f558c6c681b2a27a719a7c39bd2">PARAM_COL_OUT</a>(ID, DESC, ALIAS)   <a class="el" href="param_8hpp.html#afef4dcbf5fa0b81c4daf50f77b4391af">PARAM_COL</a>(ID, DESC, ALIAS, false, true, false)</td></tr>
|
|
<tr class="memdesc:a07120f558c6c681b2a27a719a7c39bd2"><td class="mdescLeft"> </td><td class="mdescRight">Define a vector output parameter (type arma::vec). <a href="#a07120f558c6c681b2a27a719a7c39bd2">More...</a><br /></td></tr>
|
|
<tr class="separator:a07120f558c6c681b2a27a719a7c39bd2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a14e7059294c684b01128819daea241d4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="param_8hpp.html#a14e7059294c684b01128819daea241d4">PARAM_DOUBLE_IN</a>(ID, DESC, ALIAS, DEF)   <a class="el" href="param_8hpp.html#a71739f2cfc051c5575d2080203025631">PARAM_IN</a>(double, ID, DESC, ALIAS, DEF, false)</td></tr>
|
|
<tr class="memdesc:a14e7059294c684b01128819daea241d4"><td class="mdescLeft"> </td><td class="mdescRight">Define a double input parameter. <a href="#a14e7059294c684b01128819daea241d4">More...</a><br /></td></tr>
|
|
<tr class="separator:a14e7059294c684b01128819daea241d4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1236858e19f2e8be7da663d4aecfac9f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="param_8hpp.html#a1236858e19f2e8be7da663d4aecfac9f">PARAM_DOUBLE_IN_REQ</a>(ID, DESC, ALIAS)   <a class="el" href="param_8hpp.html#a71739f2cfc051c5575d2080203025631">PARAM_IN</a>(double, ID, DESC, ALIAS, 0.0d, true)</td></tr>
|
|
<tr class="memdesc:a1236858e19f2e8be7da663d4aecfac9f"><td class="mdescLeft"> </td><td class="mdescRight">Define a required double parameter. <a href="#a1236858e19f2e8be7da663d4aecfac9f">More...</a><br /></td></tr>
|
|
<tr class="separator:a1236858e19f2e8be7da663d4aecfac9f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa39a5fa65308f2d5581c01cfae5f9203"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="param_8hpp.html#aa39a5fa65308f2d5581c01cfae5f9203">PARAM_DOUBLE_OUT</a>(ID, DESC)   <a class="el" href="param_8hpp.html#afe71e03991bbb1721872dbf20620b37a">PARAM_OUT</a>(double, ID, DESC, "", 0.0, false)</td></tr>
|
|
<tr class="memdesc:aa39a5fa65308f2d5581c01cfae5f9203"><td class="mdescLeft"> </td><td class="mdescRight">Define a double output parameter. <a href="#aa39a5fa65308f2d5581c01cfae5f9203">More...</a><br /></td></tr>
|
|
<tr class="separator:aa39a5fa65308f2d5581c01cfae5f9203"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a59a38dfe16c56a278bd89817216a3739"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="param_8hpp.html#a59a38dfe16c56a278bd89817216a3739">PARAM_FLAG</a>(ID, DESC, ALIAS)   <a class="el" href="param_8hpp.html#a71739f2cfc051c5575d2080203025631">PARAM_IN</a>(bool, ID, DESC, ALIAS, false, false);</td></tr>
|
|
<tr class="memdesc:a59a38dfe16c56a278bd89817216a3739"><td class="mdescLeft"> </td><td class="mdescRight">Define a flag parameter. <a href="#a59a38dfe16c56a278bd89817216a3739">More...</a><br /></td></tr>
|
|
<tr class="separator:a59a38dfe16c56a278bd89817216a3739"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a71739f2cfc051c5575d2080203025631"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="param_8hpp.html#a71739f2cfc051c5575d2080203025631">PARAM_IN</a>(T, ID, DESC, ALIAS, DEF, REQ)</td></tr>
|
|
<tr class="memdesc:a71739f2cfc051c5575d2080203025631"><td class="mdescLeft"> </td><td class="mdescRight">Define an input parameter. <a href="#a71739f2cfc051c5575d2080203025631">More...</a><br /></td></tr>
|
|
<tr class="separator:a71739f2cfc051c5575d2080203025631"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a627025f18abd2735345f03fd733ccd9b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="param_8hpp.html#a627025f18abd2735345f03fd733ccd9b">PARAM_INT_IN</a>(ID, DESC, ALIAS, DEF)   <a class="el" href="param_8hpp.html#a71739f2cfc051c5575d2080203025631">PARAM_IN</a>(int, ID, DESC, ALIAS, DEF, false)</td></tr>
|
|
<tr class="memdesc:a627025f18abd2735345f03fd733ccd9b"><td class="mdescLeft"> </td><td class="mdescRight">Define an integer input parameter. <a href="#a627025f18abd2735345f03fd733ccd9b">More...</a><br /></td></tr>
|
|
<tr class="separator:a627025f18abd2735345f03fd733ccd9b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a59102e55c5d69d23909a75bd6093f816"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="param_8hpp.html#a59102e55c5d69d23909a75bd6093f816">PARAM_INT_IN_REQ</a>(ID, DESC, ALIAS)   <a class="el" href="param_8hpp.html#a71739f2cfc051c5575d2080203025631">PARAM_IN</a>(int, ID, DESC, ALIAS, 0, true)</td></tr>
|
|
<tr class="memdesc:a59102e55c5d69d23909a75bd6093f816"><td class="mdescLeft"> </td><td class="mdescRight">Define a required integer input parameter. <a href="#a59102e55c5d69d23909a75bd6093f816">More...</a><br /></td></tr>
|
|
<tr class="separator:a59102e55c5d69d23909a75bd6093f816"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a50b8bfabec3f0b64fb6e15837da50aa0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="param_8hpp.html#a50b8bfabec3f0b64fb6e15837da50aa0">PARAM_INT_OUT</a>(ID, DESC)   <a class="el" href="param_8hpp.html#a71739f2cfc051c5575d2080203025631">PARAM_IN</a>(int, ID, DESC, "", 0, false)</td></tr>
|
|
<tr class="memdesc:a50b8bfabec3f0b64fb6e15837da50aa0"><td class="mdescLeft"> </td><td class="mdescRight">Define an integer output parameter. <a href="#a50b8bfabec3f0b64fb6e15837da50aa0">More...</a><br /></td></tr>
|
|
<tr class="separator:a50b8bfabec3f0b64fb6e15837da50aa0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4ce453a83dd3e3efc08a335b0e2775ea"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="param_8hpp.html#a4ce453a83dd3e3efc08a335b0e2775ea">PARAM_MATRIX</a>(ID, DESC, ALIAS, REQ, TRANS, IN)</td></tr>
|
|
<tr class="separator:a4ce453a83dd3e3efc08a335b0e2775ea"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a444c996b7e4b9dadaa5e43a7d7798f71"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="param_8hpp.html#a444c996b7e4b9dadaa5e43a7d7798f71">PARAM_MATRIX_AND_INFO_IN</a>(ID, DESC, ALIAS)   <a class="el" href="param_8hpp.html#a71739f2cfc051c5575d2080203025631">PARAM_IN</a>(<a class="el" href="param_8hpp.html#a56a316ac6f3ea218df55afae8376ce4e">TUPLE_TYPE</a>, ID, DESC, ALIAS, <a class="el" href="param_8hpp.html#a56a316ac6f3ea218df55afae8376ce4e">TUPLE_TYPE</a>(), false)</td></tr>
|
|
<tr class="separator:a444c996b7e4b9dadaa5e43a7d7798f71"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a49e6517671e6c8173dd3570de950363b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="param_8hpp.html#a49e6517671e6c8173dd3570de950363b">PARAM_MATRIX_IN</a>(ID, DESC, ALIAS)   <a class="el" href="param_8hpp.html#a4ce453a83dd3e3efc08a335b0e2775ea">PARAM_MATRIX</a>(ID, DESC, ALIAS, false, true, true)</td></tr>
|
|
<tr class="memdesc:a49e6517671e6c8173dd3570de950363b"><td class="mdescLeft"> </td><td class="mdescRight">Define a matrix input parameter. <a href="#a49e6517671e6c8173dd3570de950363b">More...</a><br /></td></tr>
|
|
<tr class="separator:a49e6517671e6c8173dd3570de950363b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a20dc72054c6568f040bdc8a5512acacb"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="param_8hpp.html#a20dc72054c6568f040bdc8a5512acacb">PARAM_MATRIX_IN_REQ</a>(ID, DESC, ALIAS)   <a class="el" href="param_8hpp.html#a4ce453a83dd3e3efc08a335b0e2775ea">PARAM_MATRIX</a>(ID, DESC, ALIAS, true, true, true)</td></tr>
|
|
<tr class="memdesc:a20dc72054c6568f040bdc8a5512acacb"><td class="mdescLeft"> </td><td class="mdescRight">Define a required matrix input parameter. <a href="#a20dc72054c6568f040bdc8a5512acacb">More...</a><br /></td></tr>
|
|
<tr class="separator:a20dc72054c6568f040bdc8a5512acacb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a20f436f371a7613b532ae3a4c0416b30"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="param_8hpp.html#a20f436f371a7613b532ae3a4c0416b30">PARAM_MATRIX_OUT</a>(ID, DESC, ALIAS)   <a class="el" href="param_8hpp.html#a4ce453a83dd3e3efc08a335b0e2775ea">PARAM_MATRIX</a>(ID, DESC, ALIAS, false, true, false)</td></tr>
|
|
<tr class="memdesc:a20f436f371a7613b532ae3a4c0416b30"><td class="mdescLeft"> </td><td class="mdescRight">Define a matrix output parameter. <a href="#a20f436f371a7613b532ae3a4c0416b30">More...</a><br /></td></tr>
|
|
<tr class="separator:a20f436f371a7613b532ae3a4c0416b30"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1e4f86c8f4de8e3f932c4cedbe4d8157"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="param_8hpp.html#a1e4f86c8f4de8e3f932c4cedbe4d8157">PARAM_MODEL</a>(TYPE, ID, DESC, ALIAS, REQ, IN)</td></tr>
|
|
<tr class="separator:a1e4f86c8f4de8e3f932c4cedbe4d8157"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a663f71826f69f70d119b5f577d20721e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="param_8hpp.html#a663f71826f69f70d119b5f577d20721e">PARAM_MODEL_IN</a>(TYPE, ID, DESC, ALIAS)   <a class="el" href="param_8hpp.html#a1e4f86c8f4de8e3f932c4cedbe4d8157">PARAM_MODEL</a>(TYPE, ID, DESC, ALIAS, false, true)</td></tr>
|
|
<tr class="memdesc:a663f71826f69f70d119b5f577d20721e"><td class="mdescLeft"> </td><td class="mdescRight">Define an input model. <a href="#a663f71826f69f70d119b5f577d20721e">More...</a><br /></td></tr>
|
|
<tr class="separator:a663f71826f69f70d119b5f577d20721e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a42961ca5512a6e6ab58cdcd15e374fca"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="param_8hpp.html#a42961ca5512a6e6ab58cdcd15e374fca">PARAM_MODEL_IN_REQ</a>(TYPE, ID, DESC, ALIAS)   <a class="el" href="param_8hpp.html#a1e4f86c8f4de8e3f932c4cedbe4d8157">PARAM_MODEL</a>(TYPE, ID, DESC, ALIAS, true, true)</td></tr>
|
|
<tr class="memdesc:a42961ca5512a6e6ab58cdcd15e374fca"><td class="mdescLeft"> </td><td class="mdescRight">Define a required input model. <a href="#a42961ca5512a6e6ab58cdcd15e374fca">More...</a><br /></td></tr>
|
|
<tr class="separator:a42961ca5512a6e6ab58cdcd15e374fca"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a303372e5feffaee9bd0a4bb50f3011b1"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="param_8hpp.html#a303372e5feffaee9bd0a4bb50f3011b1">PARAM_MODEL_OUT</a>(TYPE, ID, DESC, ALIAS)   <a class="el" href="param_8hpp.html#a1e4f86c8f4de8e3f932c4cedbe4d8157">PARAM_MODEL</a>(TYPE, ID, DESC, ALIAS, false, false)</td></tr>
|
|
<tr class="memdesc:a303372e5feffaee9bd0a4bb50f3011b1"><td class="mdescLeft"> </td><td class="mdescRight">Define an output model. <a href="#a303372e5feffaee9bd0a4bb50f3011b1">More...</a><br /></td></tr>
|
|
<tr class="separator:a303372e5feffaee9bd0a4bb50f3011b1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afe71e03991bbb1721872dbf20620b37a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="param_8hpp.html#afe71e03991bbb1721872dbf20620b37a">PARAM_OUT</a>(T, ID, DESC, ALIAS, DEF, REQ)</td></tr>
|
|
<tr class="separator:afe71e03991bbb1721872dbf20620b37a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac3efb084f2c69acdb9368f4fb9db654f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="param_8hpp.html#ac3efb084f2c69acdb9368f4fb9db654f">PARAM_ROW</a>(ID, DESC, ALIAS, REQ, TRANS, IN)</td></tr>
|
|
<tr class="separator:ac3efb084f2c69acdb9368f4fb9db654f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a503427b6b8cca3f0948487006e7f11b4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="param_8hpp.html#a503427b6b8cca3f0948487006e7f11b4">PARAM_ROW_IN</a>(ID, DESC, ALIAS)   <a class="el" href="param_8hpp.html#ac3efb084f2c69acdb9368f4fb9db654f">PARAM_ROW</a>(ID, DESC, ALIAS, false, true, true)</td></tr>
|
|
<tr class="memdesc:a503427b6b8cca3f0948487006e7f11b4"><td class="mdescLeft"> </td><td class="mdescRight">Define a row vector input parameter (type arma::rowvec). <a href="#a503427b6b8cca3f0948487006e7f11b4">More...</a><br /></td></tr>
|
|
<tr class="separator:a503427b6b8cca3f0948487006e7f11b4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9beb54447b7992ecff903397abb60f73"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="param_8hpp.html#a9beb54447b7992ecff903397abb60f73">PARAM_ROW_OUT</a>(ID, DESC, ALIAS)   <a class="el" href="param_8hpp.html#ac3efb084f2c69acdb9368f4fb9db654f">PARAM_ROW</a>(ID, DESC, ALIAS, false, true, false)</td></tr>
|
|
<tr class="memdesc:a9beb54447b7992ecff903397abb60f73"><td class="mdescLeft"> </td><td class="mdescRight">Define a row vector output parameter (type arma::rowvec). <a href="#a9beb54447b7992ecff903397abb60f73">More...</a><br /></td></tr>
|
|
<tr class="separator:a9beb54447b7992ecff903397abb60f73"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9514ae93b51ba592bc3299da8326bb80"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="param_8hpp.html#a9514ae93b51ba592bc3299da8326bb80">PARAM_STRING_IN</a>(ID, DESC, ALIAS, DEF)   <a class="el" href="param_8hpp.html#a71739f2cfc051c5575d2080203025631">PARAM_IN</a>(<a class="el" href="bindings_2matlab_2CMakeLists_8txt.html#acb14fd14ddd837abe9630e0d8a43703b">std::string</a>, ID, DESC, ALIAS, DEF, false)</td></tr>
|
|
<tr class="memdesc:a9514ae93b51ba592bc3299da8326bb80"><td class="mdescLeft"> </td><td class="mdescRight">Define a string input parameter. <a href="#a9514ae93b51ba592bc3299da8326bb80">More...</a><br /></td></tr>
|
|
<tr class="separator:a9514ae93b51ba592bc3299da8326bb80"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a39f209691f1ca8c649a40cb22cea5408"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="param_8hpp.html#a39f209691f1ca8c649a40cb22cea5408">PARAM_STRING_IN_REQ</a>(ID, DESC, ALIAS)   <a class="el" href="param_8hpp.html#a71739f2cfc051c5575d2080203025631">PARAM_IN</a>(<a class="el" href="bindings_2matlab_2CMakeLists_8txt.html#acb14fd14ddd837abe9630e0d8a43703b">std::string</a>, ID, DESC, ALIAS, "", true)</td></tr>
|
|
<tr class="memdesc:a39f209691f1ca8c649a40cb22cea5408"><td class="mdescLeft"> </td><td class="mdescRight">Define a required string parameter. <a href="#a39f209691f1ca8c649a40cb22cea5408">More...</a><br /></td></tr>
|
|
<tr class="separator:a39f209691f1ca8c649a40cb22cea5408"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a94d8f8edc103da0e05f04fce245e8a93"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="param_8hpp.html#a94d8f8edc103da0e05f04fce245e8a93">PARAM_STRING_OUT</a>(ID, DESC, ALIAS)   <a class="el" href="param_8hpp.html#afe71e03991bbb1721872dbf20620b37a">PARAM_OUT</a>(<a class="el" href="bindings_2matlab_2CMakeLists_8txt.html#acb14fd14ddd837abe9630e0d8a43703b">std::string</a>, ID, DESC, ALIAS, "", false)</td></tr>
|
|
<tr class="memdesc:a94d8f8edc103da0e05f04fce245e8a93"><td class="mdescLeft"> </td><td class="mdescRight">Define a string output parameter. <a href="#a94d8f8edc103da0e05f04fce245e8a93">More...</a><br /></td></tr>
|
|
<tr class="separator:a94d8f8edc103da0e05f04fce245e8a93"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a237697d0b35e7e6484e8ce52c0ed00c9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="param_8hpp.html#a237697d0b35e7e6484e8ce52c0ed00c9">PARAM_TMATRIX_IN</a>(ID, DESC, ALIAS)   <a class="el" href="param_8hpp.html#a4ce453a83dd3e3efc08a335b0e2775ea">PARAM_MATRIX</a>(ID, DESC, ALIAS, false, false, true)</td></tr>
|
|
<tr class="memdesc:a237697d0b35e7e6484e8ce52c0ed00c9"><td class="mdescLeft"> </td><td class="mdescRight">Define a transposed matrix input parameter. <a href="#a237697d0b35e7e6484e8ce52c0ed00c9">More...</a><br /></td></tr>
|
|
<tr class="separator:a237697d0b35e7e6484e8ce52c0ed00c9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a580cb0e5b1c587a4bc5b7211aa2c414b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="param_8hpp.html#a580cb0e5b1c587a4bc5b7211aa2c414b">PARAM_TMATRIX_IN_REQ</a>(ID, DESC, ALIAS)   <a class="el" href="param_8hpp.html#a4ce453a83dd3e3efc08a335b0e2775ea">PARAM_MATRIX</a>(ID, DESC, ALIAS, true, false, true)</td></tr>
|
|
<tr class="memdesc:a580cb0e5b1c587a4bc5b7211aa2c414b"><td class="mdescLeft"> </td><td class="mdescRight">Define a required transposed matrix input parameter. <a href="#a580cb0e5b1c587a4bc5b7211aa2c414b">More...</a><br /></td></tr>
|
|
<tr class="separator:a580cb0e5b1c587a4bc5b7211aa2c414b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a76754d246b86d1b159270e4794c25019"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="param_8hpp.html#a76754d246b86d1b159270e4794c25019">PARAM_TMATRIX_OUT</a>(ID, DESC, ALIAS)   <a class="el" href="param_8hpp.html#a4ce453a83dd3e3efc08a335b0e2775ea">PARAM_MATRIX</a>(ID, DESC, ALIAS, false, false, false)</td></tr>
|
|
<tr class="memdesc:a76754d246b86d1b159270e4794c25019"><td class="mdescLeft"> </td><td class="mdescRight">Define a transposed matrix output parameter. <a href="#a76754d246b86d1b159270e4794c25019">More...</a><br /></td></tr>
|
|
<tr class="separator:a76754d246b86d1b159270e4794c25019"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad293cdde75e8b7986b01b50fc05e0186"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="param_8hpp.html#ad293cdde75e8b7986b01b50fc05e0186">PARAM_UCOL</a>(ID, DESC, ALIAS, REQ, TRANS, IN)</td></tr>
|
|
<tr class="separator:ad293cdde75e8b7986b01b50fc05e0186"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a55c356a0f2cc3df7122b3f033033538e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="param_8hpp.html#a55c356a0f2cc3df7122b3f033033538e">PARAM_UCOL_IN</a>(ID, DESC, ALIAS)   <a class="el" href="param_8hpp.html#ad293cdde75e8b7986b01b50fc05e0186">PARAM_UCOL</a>(ID, DESC, ALIAS, false, true, true)</td></tr>
|
|
<tr class="memdesc:a55c356a0f2cc3df7122b3f033033538e"><td class="mdescLeft"> </td><td class="mdescRight">Define an unsigned vector input parameter (type arma::Col<size_t>). <a href="#a55c356a0f2cc3df7122b3f033033538e">More...</a><br /></td></tr>
|
|
<tr class="separator:a55c356a0f2cc3df7122b3f033033538e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac8b7f343ae79cb1ec43a0d2eb791090d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="param_8hpp.html#ac8b7f343ae79cb1ec43a0d2eb791090d">PARAM_UCOL_OUT</a>(ID, DESC, ALIAS)   <a class="el" href="param_8hpp.html#ad293cdde75e8b7986b01b50fc05e0186">PARAM_UCOL</a>(ID, DESC, ALIAS, false, true, false)</td></tr>
|
|
<tr class="memdesc:ac8b7f343ae79cb1ec43a0d2eb791090d"><td class="mdescLeft"> </td><td class="mdescRight">Define an unsigned vector output parameter (type arma::Col<size_t>). <a href="#ac8b7f343ae79cb1ec43a0d2eb791090d">More...</a><br /></td></tr>
|
|
<tr class="separator:ac8b7f343ae79cb1ec43a0d2eb791090d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6bcf880c112f92361cdb4a3536fba0ca"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="param_8hpp.html#a6bcf880c112f92361cdb4a3536fba0ca">PARAM_UMATRIX</a>(ID, DESC, ALIAS, REQ, TRANS, IN)</td></tr>
|
|
<tr class="separator:a6bcf880c112f92361cdb4a3536fba0ca"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0db58e2b5c75754d200638093b9cc40f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="param_8hpp.html#a0db58e2b5c75754d200638093b9cc40f">PARAM_UMATRIX_IN</a>(ID, DESC, ALIAS)   <a class="el" href="param_8hpp.html#a6bcf880c112f92361cdb4a3536fba0ca">PARAM_UMATRIX</a>(ID, DESC, ALIAS, false, true, true)</td></tr>
|
|
<tr class="memdesc:a0db58e2b5c75754d200638093b9cc40f"><td class="mdescLeft"> </td><td class="mdescRight">Define an unsigned matrix input parameter (arma::Mat<size_t>). <a href="#a0db58e2b5c75754d200638093b9cc40f">More...</a><br /></td></tr>
|
|
<tr class="separator:a0db58e2b5c75754d200638093b9cc40f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaf334355d68e6667f4e50e071eee4d63"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="param_8hpp.html#aaf334355d68e6667f4e50e071eee4d63">PARAM_UMATRIX_IN_REQ</a>(ID, DESC, ALIAS)   <a class="el" href="param_8hpp.html#a6bcf880c112f92361cdb4a3536fba0ca">PARAM_UMATRIX</a>(ID, DESC, ALIAS, true, true, true)</td></tr>
|
|
<tr class="memdesc:aaf334355d68e6667f4e50e071eee4d63"><td class="mdescLeft"> </td><td class="mdescRight">Define a required unsigned matrix input parameter (arma::Mat<size_t>). <a href="#aaf334355d68e6667f4e50e071eee4d63">More...</a><br /></td></tr>
|
|
<tr class="separator:aaf334355d68e6667f4e50e071eee4d63"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a145abfa58262c15f01139092ececc571"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="param_8hpp.html#a145abfa58262c15f01139092ececc571">PARAM_UMATRIX_OUT</a>(ID, DESC, ALIAS)   <a class="el" href="param_8hpp.html#a6bcf880c112f92361cdb4a3536fba0ca">PARAM_UMATRIX</a>(ID, DESC, ALIAS, false, true, false)</td></tr>
|
|
<tr class="memdesc:a145abfa58262c15f01139092ececc571"><td class="mdescLeft"> </td><td class="mdescRight">Define an unsigned matrix output parameter (arma::Mat<size_t>). <a href="#a145abfa58262c15f01139092ececc571">More...</a><br /></td></tr>
|
|
<tr class="separator:a145abfa58262c15f01139092ececc571"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a79385d438fe2c4f19f6d563d26592aea"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="param_8hpp.html#a79385d438fe2c4f19f6d563d26592aea">PARAM_UROW</a>(ID, DESC, ALIAS, REQ, TRANS, IN)</td></tr>
|
|
<tr class="separator:a79385d438fe2c4f19f6d563d26592aea"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a311a7e2ebd5c3c73bb58206337e1da5d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="param_8hpp.html#a311a7e2ebd5c3c73bb58206337e1da5d">PARAM_UROW_IN</a>(ID, DESC, ALIAS)   <a class="el" href="param_8hpp.html#a79385d438fe2c4f19f6d563d26592aea">PARAM_UROW</a>(ID, DESC, ALIAS, false, true, true)</td></tr>
|
|
<tr class="memdesc:a311a7e2ebd5c3c73bb58206337e1da5d"><td class="mdescLeft"> </td><td class="mdescRight">Define an unsigned row vector input parameter (type arma::Row<size_t>). <a href="#a311a7e2ebd5c3c73bb58206337e1da5d">More...</a><br /></td></tr>
|
|
<tr class="separator:a311a7e2ebd5c3c73bb58206337e1da5d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0027b7ba5f161851bf91b167c8891058"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="param_8hpp.html#a0027b7ba5f161851bf91b167c8891058">PARAM_UROW_OUT</a>(ID, DESC, ALIAS)   <a class="el" href="param_8hpp.html#a79385d438fe2c4f19f6d563d26592aea">PARAM_UROW</a>(ID, DESC, ALIAS, false, true, false)</td></tr>
|
|
<tr class="memdesc:a0027b7ba5f161851bf91b167c8891058"><td class="mdescLeft"> </td><td class="mdescRight">Define an unsigned row vector output parameter (type arma::Row<size_t>). <a href="#a0027b7ba5f161851bf91b167c8891058">More...</a><br /></td></tr>
|
|
<tr class="separator:a0027b7ba5f161851bf91b167c8891058"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8431e7deab47987cfdb2ae3f242c72bc"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="param_8hpp.html#a8431e7deab47987cfdb2ae3f242c72bc">PARAM_VECTOR_IN</a>(T, ID, DESC, ALIAS)   <a class="el" href="param_8hpp.html#a71739f2cfc051c5575d2080203025631">PARAM_IN</a>(std::vector<T>, ID, DESC, ALIAS, std::vector<T>(), false)</td></tr>
|
|
<tr class="memdesc:a8431e7deab47987cfdb2ae3f242c72bc"><td class="mdescLeft"> </td><td class="mdescRight">Define a std::vector input parameter. <a href="#a8431e7deab47987cfdb2ae3f242c72bc">More...</a><br /></td></tr>
|
|
<tr class="separator:a8431e7deab47987cfdb2ae3f242c72bc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a83c3be131e322e0a661c8ddf9c3c7df6"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="param_8hpp.html#a83c3be131e322e0a661c8ddf9c3c7df6">PARAM_VECTOR_IN_REQ</a>(T, ID, DESC, ALIAS)   <a class="el" href="param_8hpp.html#a71739f2cfc051c5575d2080203025631">PARAM_IN</a>(std::vector<T>, ID, DESC, ALIAS, std::vector<T>(), true);</td></tr>
|
|
<tr class="memdesc:a83c3be131e322e0a661c8ddf9c3c7df6"><td class="mdescLeft"> </td><td class="mdescRight">Define a required vector parameter. <a href="#a83c3be131e322e0a661c8ddf9c3c7df6">More...</a><br /></td></tr>
|
|
<tr class="separator:a83c3be131e322e0a661c8ddf9c3c7df6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a06f7737525c7db616d248d1bfdf0ee38"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="param_8hpp.html#a06f7737525c7db616d248d1bfdf0ee38">PARAM_VECTOR_OUT</a>(T, ID)   <a class="el" href="param_8hpp.html#afe71e03991bbb1721872dbf20620b37a">PARAM_OUT</a>(std::vector<T>, ID, DESC, "", std::vector<T>(), false)</td></tr>
|
|
<tr class="memdesc:a06f7737525c7db616d248d1bfdf0ee38"><td class="mdescLeft"> </td><td class="mdescRight">Define a vector output parameter. <a href="#a06f7737525c7db616d248d1bfdf0ee38">More...</a><br /></td></tr>
|
|
<tr class="separator:a06f7737525c7db616d248d1bfdf0ee38"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad781e52fa8bee6ec70cabb646fa16e00"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="param_8hpp.html#ad781e52fa8bee6ec70cabb646fa16e00">PROGRAM_INFO</a>(NAME, DESC)</td></tr>
|
|
<tr class="memdesc:ad781e52fa8bee6ec70cabb646fa16e00"><td class="mdescLeft"> </td><td class="mdescRight">Document an executable. <a href="#ad781e52fa8bee6ec70cabb646fa16e00">More...</a><br /></td></tr>
|
|
<tr class="separator:ad781e52fa8bee6ec70cabb646fa16e00"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a56a316ac6f3ea218df55afae8376ce4e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="param_8hpp.html#a56a316ac6f3ea218df55afae8376ce4e">TUPLE_TYPE</a>   std::tuple<<a class="el" href="namespacemlpack_1_1data.html#a78dcb1509876d801331776f0b895cffb">mlpack::data::DatasetInfo</a>, arma::mat></td></tr>
|
|
<tr class="memdesc:a56a316ac6f3ea218df55afae8376ce4e"><td class="mdescLeft"> </td><td class="mdescRight">Define an input DatasetInfo/matrix parameter. <a href="#a56a316ac6f3ea218df55afae8376ce4e">More...</a><br /></td></tr>
|
|
<tr class="separator:a56a316ac6f3ea218df55afae8376ce4e"><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>
|
|
<dd>
|
|
Ryan Curtin</dd></dl>
|
|
<p>Definition of PARAM_*_IN() and PARAM_*_OUT() macros, as well as the <a class="el" href="param_8hpp.html#ad781e52fa8bee6ec70cabb646fa16e00" title="Document an executable. ">PROGRAM_INFO()</a> macro, which are used to define input and output parameters of command-line programs and bindings to other languages.</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="param_8hpp_source.html">param.hpp</a>.</p>
|
|
</div><h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a class="anchor" id="afef4dcbf5fa0b81c4daf50f77b4391af"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PARAM_COL</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ID, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DESC, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ALIAS, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">REQ, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">TRANS, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">IN </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><div class="line"><span class="keyword">static</span> <a class="code" href="classmlpack_1_1util_1_1Option.html">mlpack::util::Option<arma::vec> \</a></div><div class="line"><a class="code" href="classmlpack_1_1util_1_1Option.html"> JOIN</a>(cli_option_dummy_object_col_, __LINE__) \</div><div class="line"> (arma::vec(), ID, DESC, ALIAS, REQ, IN, !TRANS);</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><!-- fragment -->
|
|
<p>Definition at line <a class="el" href="param_8hpp_source.html#l01081">1081</a> of file <a class="el" href="param_8hpp_source.html">param.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a36713e2f7157727157af4a92f1c2ad5d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PARAM_COL_IN</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ID, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DESC, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ALIAS </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td>   <a class="el" href="param_8hpp.html#afef4dcbf5fa0b81c4daf50f77b4391af">PARAM_COL</a>(ID, DESC, ALIAS, false, true, true)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Define a vector input parameter (type arma::vec). </p>
|
|
<p>From the command line, the user can specify the file that holds the vector, using the name of the vector parameter with "_file" appended (and the same alias). So for instance, if the name of the vector parameter was "vec", the user could specify that the "vec" vector was held in vec.csv by giving the parameter:</p>
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> --vec_file vector.csv</div></div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ID</td><td>Name of the parameter. </td></tr>
|
|
<tr><td class="paramname">DESC</td><td>Description of the parameter (1-2 sentences). </td></tr>
|
|
<tr><td class="paramname">ALIAS</td><td>An alias for the parameter (one letter).</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000018">Bug:</a></b></dt><dd>The <b>COUNTER</b> variable is used in most cases to guarantee a unique global identifier for options declared using the PARAM_*() macros. However, not all compilers have this support–most notably, gcc < 4.3. In that case, the <b>LINE</b> macro is used as an attempt to get a unique global identifier, but collisions are still possible, and they produce bizarre error messages. See <a href="https://github.com/mlpack/mlpack/issues/100">https://github.com/mlpack/mlpack/issues/100</a> for more information. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="param_8hpp_source.html#l00510">510</a> of file <a class="el" href="param_8hpp_source.html">param.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a07120f558c6c681b2a27a719a7c39bd2"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PARAM_COL_OUT</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ID, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DESC, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ALIAS </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td>   <a class="el" href="param_8hpp.html#afef4dcbf5fa0b81c4daf50f77b4391af">PARAM_COL</a>(ID, DESC, ALIAS, false, true, false)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Define a vector output parameter (type arma::vec). </p>
|
|
<p>When the program terminates, the vector will be saved to whatever it was set to during the program. From the command-line, the user may specify the file in which to save the output vector using a string option that is the name of the matrix parameter with "_file" appended. So, for instance, if the name of the output vector parameter was "vec", the user could specify that the "vec" vector should be saved in vector.csv by giving the parameter:</p>
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> --vec_file vector.csv</div></div><!-- fragment --><p>The output vector will not be printed on stdout, like the other output option types.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ID</td><td>Name of the parameter. </td></tr>
|
|
<tr><td class="paramname">DESC</td><td>Description of the parameter (1-2 sentences). </td></tr>
|
|
<tr><td class="paramname">ALIAS</td><td>An alias for the parameter (one letter).</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000022">Bug:</a></b></dt><dd>The <b>COUNTER</b> variable is used in most cases to guarantee a unique global identifier for options declared using the PARAM_*() macros. However, not all compilers have this support–most notably, gcc < 4.3. In that case, the <b>LINE</b> macro is used as an attempt to get a unique global identifier, but collisions are still possible, and they produce bizarre error messages. See <a href="https://github.com/mlpack/mlpack/issues/100">https://github.com/mlpack/mlpack/issues/100</a> for more information. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="param_8hpp_source.html#l00620">620</a> of file <a class="el" href="param_8hpp_source.html">param.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a14e7059294c684b01128819daea241d4"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PARAM_DOUBLE_IN</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ID, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DESC, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ALIAS, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DEF </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td>   <a class="el" href="param_8hpp.html#a71739f2cfc051c5575d2080203025631">PARAM_IN</a>(double, ID, DESC, ALIAS, DEF, false)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Define a double input parameter. </p>
|
|
<p>The parameter can then be specified on the command line with –ID=value.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ID</td><td>Name of the parameter. </td></tr>
|
|
<tr><td class="paramname">DESC</td><td>Quick description of the parameter (1-2 sentences). </td></tr>
|
|
<tr><td class="paramname">ALIAS</td><td>An alias for the parameter (one letter). </td></tr>
|
|
<tr><td class="paramname">DEF</td><td>Default value of the parameter.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classmlpack_1_1CLI.html" title="Parses the command line for parameters and holds user-specified parameters. ">mlpack::CLI</a>, <a class="el" href="param_8hpp.html#ad781e52fa8bee6ec70cabb646fa16e00" title="Document an executable. ">PROGRAM_INFO()</a></dd></dl>
|
|
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000005">Bug:</a></b></dt><dd>The <b>COUNTER</b> variable is used in most cases to guarantee a unique global identifier for options declared using the PARAM_*() macros. However, not all compilers have this support–most notably, gcc < 4.3. In that case, the <b>LINE</b> macro is used as an attempt to get a unique global identifier, but collisions are still possible, and they produce bizarre error messages. See <a href="https://github.com/mlpack/mlpack/issues/100">https://github.com/mlpack/mlpack/issues/100</a> for more information. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="param_8hpp_source.html#l00145">145</a> of file <a class="el" href="param_8hpp_source.html">param.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a1236858e19f2e8be7da663d4aecfac9f"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PARAM_DOUBLE_IN_REQ</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ID, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DESC, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ALIAS </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td>   <a class="el" href="param_8hpp.html#a71739f2cfc051c5575d2080203025631">PARAM_IN</a>(double, ID, DESC, ALIAS, 0.0d, true)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Define a required double parameter. </p>
|
|
<p>The parameter must then be specified on the command line with –ID=value.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ID</td><td>Name of the parameter. </td></tr>
|
|
<tr><td class="paramname">DESC</td><td>Quick description of the parameter (1-2 sentences). </td></tr>
|
|
<tr><td class="paramname">ALIAS</td><td>An alias for the parameter (one letter).</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classmlpack_1_1CLI.html" title="Parses the command line for parameters and holds user-specified parameters. ">mlpack::CLI</a>, <a class="el" href="param_8hpp.html#ad781e52fa8bee6ec70cabb646fa16e00" title="Document an executable. ">PROGRAM_INFO()</a></dd></dl>
|
|
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000030">Bug:</a></b></dt><dd>The <b>COUNTER</b> variable is used in most cases to guarantee a unique global identifier for options declared using the PARAM_*() macros. However, not all compilers have this support–most notably, gcc < 4.3. In that case, the <b>LINE</b> macro is used as an attempt to get a unique global identifier, but collisions are still possible, and they produce bizarre error messages. See <a href="https://github.com/mlpack/mlpack/issues/100">https://github.com/mlpack/mlpack/issues/100</a> for more information. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="param_8hpp_source.html#l00935">935</a> of file <a class="el" href="param_8hpp_source.html">param.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aa39a5fa65308f2d5581c01cfae5f9203"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PARAM_DOUBLE_OUT</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ID, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DESC </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td>   <a class="el" href="param_8hpp.html#afe71e03991bbb1721872dbf20620b37a">PARAM_OUT</a>(double, ID, DESC, "", 0.0, false)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Define a double output parameter. </p>
|
|
<p>This parameter will be printed on stdout at the end of the program; for instance, if the parameter name is "number" and the value is 5.012, the output on stdout would be of the following form:</p>
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> number: 5.012</div></div><!-- fragment --><p>If the parameter is not set by the end of the program, a fatal runtime error will be issued.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ID</td><td>Name of the parameter. </td></tr>
|
|
<tr><td class="paramname">DESC</td><td>Quick description of the parameter (1-2 sentences).</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classmlpack_1_1CLI.html" title="Parses the command line for parameters and holds user-specified parameters. ">mlpack::CLI</a>, <a class="el" href="param_8hpp.html#ad781e52fa8bee6ec70cabb646fa16e00" title="Document an executable. ">PROGRAM_INFO()</a></dd></dl>
|
|
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000006">Bug:</a></b></dt><dd>The <b>COUNTER</b> variable is used in most cases to guarantee a unique global identifier for options declared using the PARAM_*() macros. However, not all compilers have this support–most notably, gcc < 4.3. In that case, the <b>LINE</b> macro is used as an attempt to get a unique global identifier, but collisions are still possible, and they produce bizarre error messages. See <a href="https://github.com/mlpack/mlpack/issues/100">https://github.com/mlpack/mlpack/issues/100</a> for more information. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="param_8hpp_source.html#l00173">173</a> of file <a class="el" href="param_8hpp_source.html">param.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a59a38dfe16c56a278bd89817216a3739"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PARAM_FLAG</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ID, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DESC, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ALIAS </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td>   <a class="el" href="param_8hpp.html#a71739f2cfc051c5575d2080203025631">PARAM_IN</a>(bool, ID, DESC, ALIAS, false, false);</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Define a flag parameter. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ID</td><td>Name of the parameter. </td></tr>
|
|
<tr><td class="paramname">DESC</td><td>Quick description of the parameter (1-2 sentences). </td></tr>
|
|
<tr><td class="paramname">ALIAS</td><td>An alias for the parameter (one letter).</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classmlpack_1_1CLI.html" title="Parses the command line for parameters and holds user-specified parameters. ">mlpack::CLI</a>, <a class="el" href="param_8hpp.html#ad781e52fa8bee6ec70cabb646fa16e00" title="Document an executable. ">PROGRAM_INFO()</a></dd></dl>
|
|
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000002">Bug:</a></b></dt><dd>The <b>COUNTER</b> variable is used in most cases to guarantee a unique global identifier for options declared using the PARAM_*() macros. However, not all compilers have this support–most notably, gcc < 4.3. In that case, the <b>LINE</b> macro is used as an attempt to get a unique global identifier, but collisions are still possible, and they produce bizarre error messages. See <a href="https://github.com/mlpack/mlpack/issues/100">https://github.com/mlpack/mlpack/issues/100</a> for more information. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="param_8hpp_source.html#l00069">69</a> of file <a class="el" href="param_8hpp_source.html">param.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a71739f2cfc051c5575d2080203025631"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PARAM_IN</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">T, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ID, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DESC, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ALIAS, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DEF, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">REQ </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><div class="line"><span class="keyword">static</span> <a class="code" href="classmlpack_1_1util_1_1Option.html">mlpack::util::Option<T> \</a></div><div class="line"><a class="code" href="classmlpack_1_1util_1_1Option.html"> JOIN</a>(JOIN(cli_option_dummy_object_in_, __LINE__), opt) \</div><div class="line"> (DEF, ID, DESC, ALIAS, REQ, <span class="keyword">true</span>, <span class="keyword">false</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><!-- fragment -->
|
|
<p>Define an input parameter. </p>
|
|
<p>Don't use this function; use the other ones above that call it. Note that we are using the <b>LINE</b> macro for naming these actual parameters when <b>COUNTER</b> does not exist, which is a bit of an ugly hack... but this is the preprocessor, after all. We don't have much choice other than ugliness.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">T</td><td>Type of the parameter. </td></tr>
|
|
<tr><td class="paramname">ID</td><td>Name of the parameter. </td></tr>
|
|
<tr><td class="paramname">DESC</td><td>Description of the parameter (1-2 sentences). </td></tr>
|
|
<tr><td class="paramname">ALIAS</td><td>Alias for this parameter (one letter). </td></tr>
|
|
<tr><td class="paramname">DEF</td><td>Default value of the parameter. </td></tr>
|
|
<tr><td class="paramname">REQ</td><td>Whether or not parameter is required (boolean value). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="param_8hpp_source.html#l01061">1061</a> of file <a class="el" href="param_8hpp_source.html">param.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a627025f18abd2735345f03fd733ccd9b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PARAM_INT_IN</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ID, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DESC, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ALIAS, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DEF </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td>   <a class="el" href="param_8hpp.html#a71739f2cfc051c5575d2080203025631">PARAM_IN</a>(int, ID, DESC, ALIAS, DEF, false)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Define an integer input parameter. </p>
|
|
<p>The parameter can then be specified on the command line with –ID=value.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ID</td><td>Name of the parameter. </td></tr>
|
|
<tr><td class="paramname">DESC</td><td>Quick description of the parameter (1-2 sentences). </td></tr>
|
|
<tr><td class="paramname">ALIAS</td><td>An alias for the parameter (one letter). </td></tr>
|
|
<tr><td class="paramname">DEF</td><td>Default value of the parameter.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classmlpack_1_1CLI.html" title="Parses the command line for parameters and holds user-specified parameters. ">mlpack::CLI</a>, <a class="el" href="param_8hpp.html#ad781e52fa8bee6ec70cabb646fa16e00" title="Document an executable. ">PROGRAM_INFO()</a></dd></dl>
|
|
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000003">Bug:</a></b></dt><dd>The <b>COUNTER</b> variable is used in most cases to guarantee a unique global identifier for options declared using the PARAM_*() macros. However, not all compilers have this support–most notably, gcc < 4.3. In that case, the <b>LINE</b> macro is used as an attempt to get a unique global identifier, but collisions are still possible, and they produce bizarre error messages. See <a href="https://github.com/mlpack/mlpack/issues/100">https://github.com/mlpack/mlpack/issues/100</a> for more information. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="param_8hpp_source.html#l00093">93</a> of file <a class="el" href="param_8hpp_source.html">param.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a59102e55c5d69d23909a75bd6093f816"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PARAM_INT_IN_REQ</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ID, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DESC, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ALIAS </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td>   <a class="el" href="param_8hpp.html#a71739f2cfc051c5575d2080203025631">PARAM_IN</a>(int, ID, DESC, ALIAS, 0, true)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Define a required integer input parameter. </p>
|
|
<p>The parameter must then be specified on the command line with –ID=value.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ID</td><td>Name of the parameter. </td></tr>
|
|
<tr><td class="paramname">DESC</td><td>Quick description of the parameter (1-2 sentences). </td></tr>
|
|
<tr><td class="paramname">ALIAS</td><td>An alias for the parameter (one letter).</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classmlpack_1_1CLI.html" title="Parses the command line for parameters and holds user-specified parameters. ">mlpack::CLI</a>, <a class="el" href="param_8hpp.html#ad781e52fa8bee6ec70cabb646fa16e00" title="Document an executable. ">PROGRAM_INFO()</a></dd></dl>
|
|
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000029">Bug:</a></b></dt><dd>The <b>COUNTER</b> variable is used in most cases to guarantee a unique global identifier for options declared using the PARAM_*() macros. However, not all compilers have this support–most notably, gcc < 4.3. In that case, the <b>LINE</b> macro is used as an attempt to get a unique global identifier, but collisions are still possible, and they produce bizarre error messages. See <a href="https://github.com/mlpack/mlpack/issues/100">https://github.com/mlpack/mlpack/issues/100</a> for more information. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="param_8hpp_source.html#l00913">913</a> of file <a class="el" href="param_8hpp_source.html">param.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a50b8bfabec3f0b64fb6e15837da50aa0"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PARAM_INT_OUT</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ID, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DESC </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td>   <a class="el" href="param_8hpp.html#a71739f2cfc051c5575d2080203025631">PARAM_IN</a>(int, ID, DESC, "", 0, false)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Define an integer output parameter. </p>
|
|
<p>This parameter will be printed on stdout at the end of the program; for instance, if the parameter name is "number" and the value is 5, the output on stdout would be of the following form:</p>
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> number: 5</div></div><!-- fragment --><p>If the parameter is not set by the end of the program, a fatal runtime error will be issued.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ID</td><td>Name of the parameter. </td></tr>
|
|
<tr><td class="paramname">DESC</td><td>Quick description of the parameter (1-2 sentences).</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classmlpack_1_1CLI.html" title="Parses the command line for parameters and holds user-specified parameters. ">mlpack::CLI</a>, <a class="el" href="param_8hpp.html#ad781e52fa8bee6ec70cabb646fa16e00" title="Document an executable. ">PROGRAM_INFO()</a></dd></dl>
|
|
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000004">Bug:</a></b></dt><dd>The <b>COUNTER</b> variable is used in most cases to guarantee a unique global identifier for options declared using the PARAM_*() macros. However, not all compilers have this support–most notably, gcc < 4.3. In that case, the <b>LINE</b> macro is used as an attempt to get a unique global identifier, but collisions are still possible, and they produce bizarre error messages. See <a href="https://github.com/mlpack/mlpack/issues/100">https://github.com/mlpack/mlpack/issues/100</a> for more information. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="param_8hpp_source.html#l00121">121</a> of file <a class="el" href="param_8hpp_source.html">param.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a4ce453a83dd3e3efc08a335b0e2775ea"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PARAM_MATRIX</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ID, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DESC, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ALIAS, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">REQ, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">TRANS, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">IN </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><div class="line"><span class="keyword">static</span> <a class="code" href="classmlpack_1_1util_1_1Option.html">mlpack::util::Option<arma::mat> \</a></div><div class="line"><a class="code" href="classmlpack_1_1util_1_1Option.html"> JOIN</a>(JOIN(cli_option_dummy_object_matrix_, __LINE__), opt) \</div><div class="line"> (arma::mat(), ID, DESC, ALIAS, REQ, IN, !TRANS);</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><!-- fragment -->
|
|
<p>Definition at line <a class="el" href="param_8hpp_source.html#l01071">1071</a> of file <a class="el" href="param_8hpp_source.html">param.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a444c996b7e4b9dadaa5e43a7d7798f71"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PARAM_MATRIX_AND_INFO_IN</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ID, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DESC, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ALIAS </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td>   <a class="el" href="param_8hpp.html#a71739f2cfc051c5575d2080203025631">PARAM_IN</a>(<a class="el" href="param_8hpp.html#a56a316ac6f3ea218df55afae8376ce4e">TUPLE_TYPE</a>, ID, DESC, ALIAS, <a class="el" href="param_8hpp.html#a56a316ac6f3ea218df55afae8376ce4e">TUPLE_TYPE</a>(), false)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="param_8hpp_source.html#l00804">804</a> of file <a class="el" href="param_8hpp_source.html">param.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a49e6517671e6c8173dd3570de950363b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PARAM_MATRIX_IN</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ID, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DESC, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ALIAS </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td>   <a class="el" href="param_8hpp.html#a4ce453a83dd3e3efc08a335b0e2775ea">PARAM_MATRIX</a>(ID, DESC, ALIAS, false, true, true)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Define a matrix input parameter. </p>
|
|
<p>From the command line, the user can specify the file that holds the matrix, using the name of the matrix parameter with "_file" appended (and the same alias). So for instance, if the name of the matrix parameter was "mat", the user could specify that the "mat" matrix was held in matrix.csv by giving the parameter</p>
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> --mat_file matrix.csv</div></div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ID</td><td>Name of the parameter. </td></tr>
|
|
<tr><td class="paramname">DESC</td><td>Description of the parameter (1-2 sentences). </td></tr>
|
|
<tr><td class="paramname">ALIAS</td><td>An alias for the parameter (one letter).</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000009">Bug:</a></b></dt><dd>The <b>COUNTER</b> variable is used in most cases to guarantee a unique global identifier for options declared using the PARAM_*() macros. However, not all compilers have this support–most notably, gcc < 4.3. In that case, the <b>LINE</b> macro is used as an attempt to get a unique global identifier, but collisions are still possible, and they produce bizarre error messages. See <a href="https://github.com/mlpack/mlpack/issues/100">https://github.com/mlpack/mlpack/issues/100</a> for more information. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="param_8hpp_source.html#l00253">253</a> of file <a class="el" href="param_8hpp_source.html">param.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a20dc72054c6568f040bdc8a5512acacb"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PARAM_MATRIX_IN_REQ</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ID, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DESC, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ALIAS </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td>   <a class="el" href="param_8hpp.html#a4ce453a83dd3e3efc08a335b0e2775ea">PARAM_MATRIX</a>(ID, DESC, ALIAS, true, true, true)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Define a required matrix input parameter. </p>
|
|
<p>From the command line, the user can specify the file that holds the matrix, using the name of the matrix parameter with "_file" appended (and the same alias). So for instance, if the name of the matrix parameter was "mat", the user could specify that the "mat" matrix was held in matrix.csv by giving the parameter</p>
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> --mat_file matrix.csv</div></div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ID</td><td>Name of the parameter. </td></tr>
|
|
<tr><td class="paramname">DESC</td><td>Description of the parameter (1-2 sentences). </td></tr>
|
|
<tr><td class="paramname">ALIAS</td><td>An alias for the parameter (one letter).</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000010">Bug:</a></b></dt><dd>The <b>COUNTER</b> variable is used in most cases to guarantee a unique global identifier for options declared using the PARAM_*() macros. However, not all compilers have this support–most notably, gcc < 4.3. In that case, the <b>LINE</b> macro is used as an attempt to get a unique global identifier, but collisions are still possible, and they produce bizarre error messages. See <a href="https://github.com/mlpack/mlpack/issues/100">https://github.com/mlpack/mlpack/issues/100</a> for more information. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="param_8hpp_source.html#l00279">279</a> of file <a class="el" href="param_8hpp_source.html">param.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a20f436f371a7613b532ae3a4c0416b30"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PARAM_MATRIX_OUT</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ID, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DESC, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ALIAS </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td>   <a class="el" href="param_8hpp.html#a4ce453a83dd3e3efc08a335b0e2775ea">PARAM_MATRIX</a>(ID, DESC, ALIAS, false, true, false)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Define a matrix output parameter. </p>
|
|
<p>When the program terminates, the matrix will be saved to whatever it was set to by CLI::GetParam<arma::mat>(ID) during the program. From the command-line, the user may specify the file in which to save the output matrix using a string option that is the name of the matrix parameter with "_file" appended. So, for instance, if the name of the output matrix parameter was "mat", the user could speicfy that the "mat" matrix should be saved in matrix.csv by giving the parameter</p>
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> --mat_file matrix.csv</div></div><!-- fragment --><p>The output matrix will not be printed on stdout, like the other output option types.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ID</td><td>Name of the parameter. </td></tr>
|
|
<tr><td class="paramname">DESC</td><td>Description of the parameter (1-2 sentences). </td></tr>
|
|
<tr><td class="paramname">ALIAS</td><td>An alias for the parameter (one letter).</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000011">Bug:</a></b></dt><dd>The <b>COUNTER</b> variable is used in most cases to guarantee a unique global identifier for options declared using the PARAM_*() macros. However, not all compilers have this support–most notably, gcc < 4.3. In that case, the <b>LINE</b> macro is used as an attempt to get a unique global identifier, but collisions are still possible, and they produce bizarre error messages. See <a href="https://github.com/mlpack/mlpack/issues/100">https://github.com/mlpack/mlpack/issues/100</a> for more information. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="param_8hpp_source.html#l00310">310</a> of file <a class="el" href="param_8hpp_source.html">param.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a1e4f86c8f4de8e3f932c4cedbe4d8157"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PARAM_MODEL</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">TYPE, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ID, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DESC, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ALIAS, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">REQ, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">IN </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><div class="line"><span class="keyword">static</span> <a class="code" href="classmlpack_1_1util_1_1Option.html">mlpack::util::Option<TYPE> \</a></div><div class="line"><a class="code" href="classmlpack_1_1util_1_1Option.html"> JOIN</a>(JOIN(cli_option_dummy_object_model_, __LINE__), opt) \</div><div class="line"> (TYPE(), ID, DESC, ALIAS, REQ, IN);</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><!-- fragment -->
|
|
<p>Definition at line <a class="el" href="param_8hpp_source.html#l01101">1101</a> of file <a class="el" href="param_8hpp_source.html">param.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a663f71826f69f70d119b5f577d20721e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PARAM_MODEL_IN</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">TYPE, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ID, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DESC, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ALIAS </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td>   <a class="el" href="param_8hpp.html#a1e4f86c8f4de8e3f932c4cedbe4d8157">PARAM_MODEL</a>(TYPE, ID, DESC, ALIAS, false, true)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Define an input model. </p>
|
|
<p>From the command line, the user can specify the file that holds the model, using the name of the model parameter with "_file" appended (and the same alias). So for instance, if the name of the model parameter was "model", the user could specify that the "model" model was held in model.bin by giving the parameter</p>
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> --model_file model.bin</div></div><!-- fragment --><p>Note that the first parameter of this model is the type (the class name) of the model to be loaded. This model type must have a Serialize() function; a compilation error (a very long and complex one) will result if the model type does not have the following function:</p>
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> template<typename Archive></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> void Serialize(Archive& ar, const unsigned int version);</div></div><!-- fragment --><p>This is the <a class="el" href="namespaceboost_1_1serialization.html">boost::serialization</a> <a class="el" href="namespaceboost_1_1serialization.html#a5c7f0e288c18c6887ba037b2bef6230d" title="Catch a call to serialize() with a PointerShim, and call the Serialize() function directly...">serialize()</a> function, just with a capital s for Serialize() (see <a class="el" href="serialization__shim_8hpp.html">src/mlpack/core/data/serialization_shim.hpp</a>).</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">TYPE</td><td>Type of the model to be loaded. </td></tr>
|
|
<tr><td class="paramname">ID</td><td>Name of the parameter. </td></tr>
|
|
<tr><td class="paramname">DESC</td><td>Description of the parameter. </td></tr>
|
|
<tr><td class="paramname">ALIAS</td><td>An alias for the parameter (one letter). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="param_8hpp_source.html#l00836">836</a> of file <a class="el" href="param_8hpp_source.html">param.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a42961ca5512a6e6ab58cdcd15e374fca"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PARAM_MODEL_IN_REQ</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">TYPE, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ID, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DESC, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ALIAS </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td>   <a class="el" href="param_8hpp.html#a1e4f86c8f4de8e3f932c4cedbe4d8157">PARAM_MODEL</a>(TYPE, ID, DESC, ALIAS, true, true)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Define a required input model. </p>
|
|
<p>From the command line, the user can specify the file that holds the model, using the name of the model parameter with "_file" appended (and the same alias). So for instance, if the name of the model parameter was "model", the user could specify that the "model" model was held in model.bin by giving the parameter</p>
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> --model_file model.bin</div></div><!-- fragment --><p>Note that the first parameter of this model is the type (the class name) of the model to be loaded. This model type must have a Serialize() function; a compilation error (a very long and complex one) will result if the model type does not have the following function:</p>
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> template<typename Archive></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> void Serialize(Archive& ar, const unsigned int version);</div></div><!-- fragment --><p>This is the <a class="el" href="namespaceboost_1_1serialization.html">boost::serialization</a> <a class="el" href="namespaceboost_1_1serialization.html#a5c7f0e288c18c6887ba037b2bef6230d" title="Catch a call to serialize() with a PointerShim, and call the Serialize() function directly...">serialize()</a> function, just with a capital s for Serialize() (see <a class="el" href="serialization__shim_8hpp.html">src/mlpack/core/data/serialization_shim.hpp</a>).</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">TYPE</td><td>Type of the model to be loaded. </td></tr>
|
|
<tr><td class="paramname">ID</td><td>Name of the parameter. </td></tr>
|
|
<tr><td class="paramname">DESC</td><td>Description of the parameter. </td></tr>
|
|
<tr><td class="paramname">ALIAS</td><td>An alias for the parameter (one letter). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="param_8hpp_source.html#l00868">868</a> of file <a class="el" href="param_8hpp_source.html">param.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a303372e5feffaee9bd0a4bb50f3011b1"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PARAM_MODEL_OUT</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">TYPE, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ID, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DESC, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ALIAS </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td>   <a class="el" href="param_8hpp.html#a1e4f86c8f4de8e3f932c4cedbe4d8157">PARAM_MODEL</a>(TYPE, ID, DESC, ALIAS, false, false)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Define an output model. </p>
|
|
<p>From the command line, the user can specify the file that should hold the model, using the name of the model parameter with "_file" appended (and the same alias). So for instance, if the user desires to save the model to model.bin and the parameter name is "model", they could specify</p>
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> --model_file model.bin</div></div><!-- fragment --><p>The model will be saved at the termination of the program. If you use a parameter of this type, you must call CLI::Destroy() at the end of your program.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">TYPE</td><td>Type of the model to be saved. </td></tr>
|
|
<tr><td class="paramname">ID</td><td>Name of the parameter. </td></tr>
|
|
<tr><td class="paramname">DESC</td><td>Description of the parameter. </td></tr>
|
|
<tr><td class="paramname">ALIAS</td><td>An alias for the parameter (one letter). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="param_8hpp_source.html#l00891">891</a> of file <a class="el" href="param_8hpp_source.html">param.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="afe71e03991bbb1721872dbf20620b37a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PARAM_OUT</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">T, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ID, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DESC, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ALIAS, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DEF, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">REQ </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><div class="line"><span class="keyword">static</span> <a class="code" href="classmlpack_1_1util_1_1Option.html">mlpack::util::Option<T> \</a></div><div class="line"><a class="code" href="classmlpack_1_1util_1_1Option.html"> JOIN</a>(JOIN(cli_option_dummy_object_out_, __LINE__), opt) \</div><div class="line"> (DEF, ID, DESC, ALIAS, REQ, <span class="keyword">false</span>, <span class="keyword">false</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><!-- fragment -->
|
|
<p>Definition at line <a class="el" href="param_8hpp_source.html#l01066">1066</a> of file <a class="el" href="param_8hpp_source.html">param.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ac3efb084f2c69acdb9368f4fb9db654f"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PARAM_ROW</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ID, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DESC, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ALIAS, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">REQ, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">TRANS, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">IN </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><div class="line"><span class="keyword">static</span> <a class="code" href="classmlpack_1_1util_1_1Option.html">mlpack::util::Option<arma::rowvec> \</a></div><div class="line"><a class="code" href="classmlpack_1_1util_1_1Option.html"> JOIN</a>(cli_option_dummy_object_row_, __LINE__) \</div><div class="line"> (arma::rowvec(), ID, DESC, ALIAS, REQ, IN, !TRANS);</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><!-- fragment -->
|
|
<p>Definition at line <a class="el" href="param_8hpp_source.html#l01091">1091</a> of file <a class="el" href="param_8hpp_source.html">param.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a503427b6b8cca3f0948487006e7f11b4"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PARAM_ROW_IN</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ID, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DESC, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ALIAS </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td>   <a class="el" href="param_8hpp.html#ac3efb084f2c69acdb9368f4fb9db654f">PARAM_ROW</a>(ID, DESC, ALIAS, false, true, true)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Define a row vector input parameter (type arma::rowvec). </p>
|
|
<p>From the command line, the user can specify the file that holds the vector, using the name of the vector parameter with "_file" appended (and the same alias). So for instance, if the name of the vector parameter was "vec", the user could specify that the "vec" vector was held in vec.csv by giving the parameter:</p>
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> --vec_file vector.csv</div></div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ID</td><td>Name of the parameter. </td></tr>
|
|
<tr><td class="paramname">DESC</td><td>Description of the parameter (1-2 sentences). </td></tr>
|
|
<tr><td class="paramname">ALIAS</td><td>An alias for the parameter (one letter).</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000019">Bug:</a></b></dt><dd>The <b>COUNTER</b> variable is used in most cases to guarantee a unique global identifier for options declared using the PARAM_*() macros. However, not all compilers have this support–most notably, gcc < 4.3. In that case, the <b>LINE</b> macro is used as an attempt to get a unique global identifier, but collisions are still possible, and they produce bizarre error messages. See <a href="https://github.com/mlpack/mlpack/issues/100">https://github.com/mlpack/mlpack/issues/100</a> for more information. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="param_8hpp_source.html#l00536">536</a> of file <a class="el" href="param_8hpp_source.html">param.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a9beb54447b7992ecff903397abb60f73"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PARAM_ROW_OUT</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ID, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DESC, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ALIAS </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td>   <a class="el" href="param_8hpp.html#ac3efb084f2c69acdb9368f4fb9db654f">PARAM_ROW</a>(ID, DESC, ALIAS, false, true, false)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Define a row vector output parameter (type arma::rowvec). </p>
|
|
<p>When the program terminates, the vector will be saved to whatever it was set to during the program. From the command-line, the user may specify the file in which to save the output vector using a string option that is the name of the matrix parameter with "_file" appended. So, for instance, if the name of the output vector parameter was "vec", the user could specify that the "vec" vector should be saved in vector.csv by giving the parameter:</p>
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> --vec_file vector.csv</div></div><!-- fragment --><p>The output vector will not be printed on stdout, like the other output option types.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ID</td><td>Name of the parameter. </td></tr>
|
|
<tr><td class="paramname">DESC</td><td>Description of the parameter (1-2 sentences). </td></tr>
|
|
<tr><td class="paramname">ALIAS</td><td>An alias for the parameter (one letter).</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000023">Bug:</a></b></dt><dd>The <b>COUNTER</b> variable is used in most cases to guarantee a unique global identifier for options declared using the PARAM_*() macros. However, not all compilers have this support–most notably, gcc < 4.3. In that case, the <b>LINE</b> macro is used as an attempt to get a unique global identifier, but collisions are still possible, and they produce bizarre error messages. See <a href="https://github.com/mlpack/mlpack/issues/100">https://github.com/mlpack/mlpack/issues/100</a> for more information. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="param_8hpp_source.html#l00651">651</a> of file <a class="el" href="param_8hpp_source.html">param.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a9514ae93b51ba592bc3299da8326bb80"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PARAM_STRING_IN</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ID, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DESC, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ALIAS, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DEF </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td>   <a class="el" href="param_8hpp.html#a71739f2cfc051c5575d2080203025631">PARAM_IN</a>(<a class="el" href="bindings_2matlab_2CMakeLists_8txt.html#acb14fd14ddd837abe9630e0d8a43703b">std::string</a>, ID, DESC, ALIAS, DEF, false)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Define a string input parameter. </p>
|
|
<p>The parameter can then be specified on the command line with –ID=value. If ALIAS is equal to DEF_MOD (which is set using the <a class="el" href="param_8hpp.html#ad781e52fa8bee6ec70cabb646fa16e00" title="Document an executable. ">PROGRAM_INFO()</a> macro), the parameter can be specified with just –ID=value.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ID</td><td>Name of the parameter. </td></tr>
|
|
<tr><td class="paramname">DESC</td><td>Quick description of the parameter (1-2 sentences). </td></tr>
|
|
<tr><td class="paramname">ALIAS</td><td>An alias for the parameter (one letter). </td></tr>
|
|
<tr><td class="paramname">DEF</td><td>Default value of the parameter.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classmlpack_1_1CLI.html" title="Parses the command line for parameters and holds user-specified parameters. ">mlpack::CLI</a>, <a class="el" href="param_8hpp.html#ad781e52fa8bee6ec70cabb646fa16e00" title="Document an executable. ">PROGRAM_INFO()</a></dd></dl>
|
|
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000007">Bug:</a></b></dt><dd>The <b>COUNTER</b> variable is used in most cases to guarantee a unique global identifier for options declared using the PARAM_*() macros. However, not all compilers have this support–most notably, gcc < 4.3. In that case, the <b>LINE</b> macro is used as an attempt to get a unique global identifier, but collisions are still possible, and they produce bizarre error messages. See <a href="https://github.com/mlpack/mlpack/issues/100">https://github.com/mlpack/mlpack/issues/100</a> for more information. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="param_8hpp_source.html#l00198">198</a> of file <a class="el" href="param_8hpp_source.html">param.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a39f209691f1ca8c649a40cb22cea5408"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PARAM_STRING_IN_REQ</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ID, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DESC, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ALIAS </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td>   <a class="el" href="param_8hpp.html#a71739f2cfc051c5575d2080203025631">PARAM_IN</a>(<a class="el" href="bindings_2matlab_2CMakeLists_8txt.html#acb14fd14ddd837abe9630e0d8a43703b">std::string</a>, ID, DESC, ALIAS, "", true)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Define a required string parameter. </p>
|
|
<p>The parameter must then be specified on the command line with –ID=value.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ID</td><td>Name of the parameter. </td></tr>
|
|
<tr><td class="paramname">DESC</td><td>Quick description of the parameter (1-2 sentences). </td></tr>
|
|
<tr><td class="paramname">ALIAS</td><td>An alias for the parameter (one letter).</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classmlpack_1_1CLI.html" title="Parses the command line for parameters and holds user-specified parameters. ">mlpack::CLI</a>, <a class="el" href="param_8hpp.html#ad781e52fa8bee6ec70cabb646fa16e00" title="Document an executable. ">PROGRAM_INFO()</a></dd></dl>
|
|
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000031">Bug:</a></b></dt><dd>The <b>COUNTER</b> variable is used in most cases to guarantee a unique global identifier for options declared using the PARAM_*() macros. However, not all compilers have this support–most notably, gcc < 4.3. In that case, the <b>LINE</b> macro is used as an attempt to get a unique global identifier, but collisions are still possible, and they produce bizarre error messages. See <a href="https://github.com/mlpack/mlpack/issues/100">https://github.com/mlpack/mlpack/issues/100</a> for more information. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="param_8hpp_source.html#l00957">957</a> of file <a class="el" href="param_8hpp_source.html">param.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a94d8f8edc103da0e05f04fce245e8a93"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PARAM_STRING_OUT</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ID, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DESC, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ALIAS </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td>   <a class="el" href="param_8hpp.html#afe71e03991bbb1721872dbf20620b37a">PARAM_OUT</a>(<a class="el" href="bindings_2matlab_2CMakeLists_8txt.html#acb14fd14ddd837abe9630e0d8a43703b">std::string</a>, ID, DESC, ALIAS, "", false)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Define a string output parameter. </p>
|
|
<p>The string will be printed to stdout at the end of the program. For instance, if there was a string output parameter called "something" with value "hello", at the end of the program the output would be of the following form:</p>
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> something: "hello"</div></div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ID</td><td>Name of the parameter. </td></tr>
|
|
<tr><td class="paramname">DESC</td><td>Quick description of the parameter (1-2 sentences). </td></tr>
|
|
<tr><td class="paramname">ALIAS</td><td>An alias for the parameter (one letter).</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classmlpack_1_1CLI.html" title="Parses the command line for parameters and holds user-specified parameters. ">mlpack::CLI</a>, <a class="el" href="param_8hpp.html#ad781e52fa8bee6ec70cabb646fa16e00" title="Document an executable. ">PROGRAM_INFO()</a></dd></dl>
|
|
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000008">Bug:</a></b></dt><dd>The <b>COUNTER</b> variable is used in most cases to guarantee a unique global identifier for options declared using the PARAM_*() macros. However, not all compilers have this support–most notably, gcc < 4.3. In that case, the <b>LINE</b> macro is used as an attempt to get a unique global identifier, but collisions are still possible, and they produce bizarre error messages. See <a href="https://github.com/mlpack/mlpack/issues/100">https://github.com/mlpack/mlpack/issues/100</a> for more information. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="param_8hpp_source.html#l00227">227</a> of file <a class="el" href="param_8hpp_source.html">param.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a237697d0b35e7e6484e8ce52c0ed00c9"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PARAM_TMATRIX_IN</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ID, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DESC, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ALIAS </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td>   <a class="el" href="param_8hpp.html#a4ce453a83dd3e3efc08a335b0e2775ea">PARAM_MATRIX</a>(ID, DESC, ALIAS, false, false, true)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Define a transposed matrix input parameter. </p>
|
|
<p>This is useful when data is desired in row-major form instead of the usual column-major form. From the command line, the user can specify the file that holds the matrix, using the name of the matrix parameter with "_file" appended (and the same alias). So for instance, if the name of the matrix parameter was "mat", the user could specify that the "mat" matrix was held in matrix.csv by giving the parameter</p>
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> --mat_file matrix.csv</div></div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ID</td><td>Name of the parameter. </td></tr>
|
|
<tr><td class="paramname">DESC</td><td>Description of the parameter (1-2 sentences). </td></tr>
|
|
<tr><td class="paramname">ALIAS</td><td>An alias for the parameter (one letter).</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000012">Bug:</a></b></dt><dd>The <b>COUNTER</b> variable is used in most cases to guarantee a unique global identifier for options declared using the PARAM_*() macros. However, not all compilers have this support–most notably, gcc < 4.3. In that case, the <b>LINE</b> macro is used as an attempt to get a unique global identifier, but collisions are still possible, and they produce bizarre error messages. See <a href="https://github.com/mlpack/mlpack/issues/100">https://github.com/mlpack/mlpack/issues/100</a> for more information. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="param_8hpp_source.html#l00337">337</a> of file <a class="el" href="param_8hpp_source.html">param.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a580cb0e5b1c587a4bc5b7211aa2c414b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PARAM_TMATRIX_IN_REQ</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ID, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DESC, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ALIAS </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td>   <a class="el" href="param_8hpp.html#a4ce453a83dd3e3efc08a335b0e2775ea">PARAM_MATRIX</a>(ID, DESC, ALIAS, true, false, true)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Define a required transposed matrix input parameter. </p>
|
|
<p>This is useful when data is desired in row-major form instead of the usual column-major form. From the command line, the user can specify the file that holds the matrix, using the name of the matrix parameter with "_file" appended (and the same alias). So for instance, if the name of the matrix parameter was "mat", the user could specify that the "mat" matrix was held in matrix.csv by giving the parameter</p>
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> --mat_file matrix.csv</div></div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ID</td><td>Name of the parameter. </td></tr>
|
|
<tr><td class="paramname">DESC</td><td>Description of the parameter (1-2 sentences). </td></tr>
|
|
<tr><td class="paramname">ALIAS</td><td>An alias for the parameter (one letter).</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000013">Bug:</a></b></dt><dd>The <b>COUNTER</b> variable is used in most cases to guarantee a unique global identifier for options declared using the PARAM_*() macros. However, not all compilers have this support–most notably, gcc < 4.3. In that case, the <b>LINE</b> macro is used as an attempt to get a unique global identifier, but collisions are still possible, and they produce bizarre error messages. See <a href="https://github.com/mlpack/mlpack/issues/100">https://github.com/mlpack/mlpack/issues/100</a> for more information. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="param_8hpp_source.html#l00365">365</a> of file <a class="el" href="param_8hpp_source.html">param.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a76754d246b86d1b159270e4794c25019"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PARAM_TMATRIX_OUT</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ID, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DESC, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ALIAS </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td>   <a class="el" href="param_8hpp.html#a4ce453a83dd3e3efc08a335b0e2775ea">PARAM_MATRIX</a>(ID, DESC, ALIAS, false, false, false)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Define a transposed matrix output parameter. </p>
|
|
<p>This is useful when data is stored in a row-major form instead of the usual column-major form. When the program terminates, the matrix will be saved to whatever it was set to by CLI::GetParam<arma::mat>(ID) during the program. From the command-line, the user may specify the file in which to save the output matrix using a string option that is the name of the matrix parameter with "_file" appended. So, for instance, if the name of the output matrix parameter was "mat", the user could speicfy that the "mat" matrix should be saved in matrix.csv by giving the parameter</p>
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> --mat_file matrix.csv</div></div><!-- fragment --><p>The output matrix will not be printed on stdout, like the other output option types.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ID</td><td>Name of the parameter. </td></tr>
|
|
<tr><td class="paramname">DESC</td><td>Description of the parameter (1-2 sentences). </td></tr>
|
|
<tr><td class="paramname">ALIAS</td><td>An alias for the parameter (one letter).</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000014">Bug:</a></b></dt><dd>The <b>COUNTER</b> variable is used in most cases to guarantee a unique global identifier for options declared using the PARAM_*() macros. However, not all compilers have this support–most notably, gcc < 4.3. In that case, the <b>LINE</b> macro is used as an attempt to get a unique global identifier, but collisions are still possible, and they produce bizarre error messages. See <a href="https://github.com/mlpack/mlpack/issues/100">https://github.com/mlpack/mlpack/issues/100</a> for more information. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="param_8hpp_source.html#l00398">398</a> of file <a class="el" href="param_8hpp_source.html">param.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad293cdde75e8b7986b01b50fc05e0186"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PARAM_UCOL</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ID, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DESC, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ALIAS, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">REQ, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">TRANS, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">IN </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><div class="line"><span class="keyword">static</span> <a class="code" href="classmlpack_1_1util_1_1Option.html">mlpack::util::Option<arma::Col<size_t></a>> \</div><div class="line"> JOIN(cli_option_dummy_object_ucol_, __LINE__) \</div><div class="line"> (arma::Col<size_t>(), ID, DESC, ALIAS, REQ, IN, !TRANS);</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><!-- fragment -->
|
|
<p>Definition at line <a class="el" href="param_8hpp_source.html#l01086">1086</a> of file <a class="el" href="param_8hpp_source.html">param.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a55c356a0f2cc3df7122b3f033033538e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PARAM_UCOL_IN</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ID, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DESC, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ALIAS </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td>   <a class="el" href="param_8hpp.html#ad293cdde75e8b7986b01b50fc05e0186">PARAM_UCOL</a>(ID, DESC, ALIAS, false, true, true)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Define an unsigned vector input parameter (type arma::Col<size_t>). </p>
|
|
<p>From the command line, the user can specify the file that holds the vector, using the name of the vector parameter with "_file" appended (and the same alias). So for instance, if the name of the vector parameter was "vec", the user could specify that the "vec" vector was held in vec.csv by giving the parameter:</p>
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> --vec_file vector.csv</div></div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ID</td><td>Name of the parameter. </td></tr>
|
|
<tr><td class="paramname">DESC</td><td>Description of the parameter (1-2 sentences). </td></tr>
|
|
<tr><td class="paramname">ALIAS</td><td>An alias for the parameter (one letter).</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000020">Bug:</a></b></dt><dd>The <b>COUNTER</b> variable is used in most cases to guarantee a unique global identifier for options declared using the PARAM_*() macros. However, not all compilers have this support–most notably, gcc < 4.3. In that case, the <b>LINE</b> macro is used as an attempt to get a unique global identifier, but collisions are still possible, and they produce bizarre error messages. See <a href="https://github.com/mlpack/mlpack/issues/100">https://github.com/mlpack/mlpack/issues/100</a> for more information. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="param_8hpp_source.html#l00562">562</a> of file <a class="el" href="param_8hpp_source.html">param.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ac8b7f343ae79cb1ec43a0d2eb791090d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PARAM_UCOL_OUT</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ID, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DESC, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ALIAS </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td>   <a class="el" href="param_8hpp.html#ad293cdde75e8b7986b01b50fc05e0186">PARAM_UCOL</a>(ID, DESC, ALIAS, false, true, false)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Define an unsigned vector output parameter (type arma::Col<size_t>). </p>
|
|
<p>When the program terminates, the vector will be saved to whatever it was set to during the program. From the command-line, the user may specify the file in which to save the output vector using a string option that is the name of the matrix parameter with "_file" appended. So, for instance, if the name of the output vector parameter was "vec", the user could specify that the "vec" vector should be saved in vector.csv by giving the parameter:</p>
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> --vec_file vector.csv</div></div><!-- fragment --><p>The output vector will not be printed on stdout, like the other output option types.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ID</td><td>Name of the parameter. </td></tr>
|
|
<tr><td class="paramname">DESC</td><td>Description of the parameter (1-2 sentences). </td></tr>
|
|
<tr><td class="paramname">ALIAS</td><td>An alias for the parameter (one letter).</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000024">Bug:</a></b></dt><dd>The <b>COUNTER</b> variable is used in most cases to guarantee a unique global identifier for options declared using the PARAM_*() macros. However, not all compilers have this support–most notably, gcc < 4.3. In that case, the <b>LINE</b> macro is used as an attempt to get a unique global identifier, but collisions are still possible, and they produce bizarre error messages. See <a href="https://github.com/mlpack/mlpack/issues/100">https://github.com/mlpack/mlpack/issues/100</a> for more information. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="param_8hpp_source.html#l00682">682</a> of file <a class="el" href="param_8hpp_source.html">param.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6bcf880c112f92361cdb4a3536fba0ca"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PARAM_UMATRIX</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ID, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DESC, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ALIAS, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">REQ, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">TRANS, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">IN </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><div class="line"><span class="keyword">static</span> <a class="code" href="classmlpack_1_1util_1_1Option.html">mlpack::util::Option<arma::Mat<size_t></a>> \</div><div class="line"> JOIN(JOIN(cli_option_dummy_object_umatrix_, __LINE__), opt) \</div><div class="line"> (arma::Mat<size_t>(), ID, DESC, ALIAS, REQ, IN, !TRANS);</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><!-- fragment -->
|
|
<p>Definition at line <a class="el" href="param_8hpp_source.html#l01076">1076</a> of file <a class="el" href="param_8hpp_source.html">param.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0db58e2b5c75754d200638093b9cc40f"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PARAM_UMATRIX_IN</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ID, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DESC, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ALIAS </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td>   <a class="el" href="param_8hpp.html#a6bcf880c112f92361cdb4a3536fba0ca">PARAM_UMATRIX</a>(ID, DESC, ALIAS, false, true, true)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Define an unsigned matrix input parameter (arma::Mat<size_t>). </p>
|
|
<p>From the command line, the user can specify the file that holds the matrix, using the name of the matrix parameter with "_file" appended (and the same alias). So for instance, if the name of the matrix parameter was "mat", the user could specify that the "mat" matrix was held in matrix.csv by giving the parameter</p>
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> --mat_file matrix.csv</div></div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ID</td><td>Name of the parameter. </td></tr>
|
|
<tr><td class="paramname">DESC</td><td>Description of the parameter (1-2 sentences). </td></tr>
|
|
<tr><td class="paramname">ALIAS</td><td>An alias for the parameter (one letter).</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000015">Bug:</a></b></dt><dd>The <b>COUNTER</b> variable is used in most cases to guarantee a unique global identifier for options declared using the PARAM_*() macros. However, not all compilers have this support–most notably, gcc < 4.3. In that case, the <b>LINE</b> macro is used as an attempt to get a unique global identifier, but collisions are still possible, and they produce bizarre error messages. See <a href="https://github.com/mlpack/mlpack/issues/100">https://github.com/mlpack/mlpack/issues/100</a> for more information. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="param_8hpp_source.html#l00424">424</a> of file <a class="el" href="param_8hpp_source.html">param.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aaf334355d68e6667f4e50e071eee4d63"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PARAM_UMATRIX_IN_REQ</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ID, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DESC, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ALIAS </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td>   <a class="el" href="param_8hpp.html#a6bcf880c112f92361cdb4a3536fba0ca">PARAM_UMATRIX</a>(ID, DESC, ALIAS, true, true, true)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Define a required unsigned matrix input parameter (arma::Mat<size_t>). </p>
|
|
<p>From the command line, the user can specify the file that holds the matrix, using the name of the matrix parameter with "_file" appended (and the same alias). So for instance, if the name of the matrix parameter was "mat", the user could specify that the "mat" matrix was held in matrix.csv by giving the parameter</p>
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> --mat_file matrix.csv</div></div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ID</td><td>Name of the parameter. </td></tr>
|
|
<tr><td class="paramname">DESC</td><td>Description of the parameter (1-2 sentences). </td></tr>
|
|
<tr><td class="paramname">ALIAS</td><td>An alias for the parameter (one letter).</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000016">Bug:</a></b></dt><dd>The <b>COUNTER</b> variable is used in most cases to guarantee a unique global identifier for options declared using the PARAM_*() macros. However, not all compilers have this support–most notably, gcc < 4.3. In that case, the <b>LINE</b> macro is used as an attempt to get a unique global identifier, but collisions are still possible, and they produce bizarre error messages. See <a href="https://github.com/mlpack/mlpack/issues/100">https://github.com/mlpack/mlpack/issues/100</a> for more information. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="param_8hpp_source.html#l00451">451</a> of file <a class="el" href="param_8hpp_source.html">param.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a145abfa58262c15f01139092ececc571"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PARAM_UMATRIX_OUT</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ID, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DESC, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ALIAS </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td>   <a class="el" href="param_8hpp.html#a6bcf880c112f92361cdb4a3536fba0ca">PARAM_UMATRIX</a>(ID, DESC, ALIAS, false, true, false)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Define an unsigned matrix output parameter (arma::Mat<size_t>). </p>
|
|
<p>When the program terminates, the matrix will be saved to whatever it was set to by CLI::GetParam<arma::Mat<size_t>>(ID) during the program. From the command-line, the user may specify the file in which to save the output matrix using a string option that is the name of the matrix parameter with "_file" appended. So, for instance, if the name of the output matrix parameter was "mat", the user could speicfy that the "mat" matrix should be saved in matrix.csv by giving the parameter</p>
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> --mat_file matrix.csv</div></div><!-- fragment --><p>The output matrix will not be printed on stdout, like the other output option types.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ID</td><td>Name of the parameter. </td></tr>
|
|
<tr><td class="paramname">DESC</td><td>Description of the parameter (1-2 sentences). </td></tr>
|
|
<tr><td class="paramname">ALIAS</td><td>An alias for the parameter (one letter).</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000017">Bug:</a></b></dt><dd>The <b>COUNTER</b> variable is used in most cases to guarantee a unique global identifier for options declared using the PARAM_*() macros. However, not all compilers have this support–most notably, gcc < 4.3. In that case, the <b>LINE</b> macro is used as an attempt to get a unique global identifier, but collisions are still possible, and they produce bizarre error messages. See <a href="https://github.com/mlpack/mlpack/issues/100">https://github.com/mlpack/mlpack/issues/100</a> for more information. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="param_8hpp_source.html#l00483">483</a> of file <a class="el" href="param_8hpp_source.html">param.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a79385d438fe2c4f19f6d563d26592aea"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PARAM_UROW</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ID, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DESC, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ALIAS, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">REQ, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">TRANS, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">IN </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><div class="line"><span class="keyword">static</span> <a class="code" href="classmlpack_1_1util_1_1Option.html">mlpack::util::Option<arma::Row<size_t></a>> \</div><div class="line"> JOIN(cli_option_dummy_object_urow_, __LINE__) \</div><div class="line"> (arma::Row<size_t>(), ID, DESC, ALIAS, REQ, IN, !TRANS);</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><!-- fragment -->
|
|
<p>Definition at line <a class="el" href="param_8hpp_source.html#l01096">1096</a> of file <a class="el" href="param_8hpp_source.html">param.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a311a7e2ebd5c3c73bb58206337e1da5d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PARAM_UROW_IN</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ID, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DESC, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ALIAS </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td>   <a class="el" href="param_8hpp.html#a79385d438fe2c4f19f6d563d26592aea">PARAM_UROW</a>(ID, DESC, ALIAS, false, true, true)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Define an unsigned row vector input parameter (type arma::Row<size_t>). </p>
|
|
<p>From the command line, the user can specify the file that holds the vector, using the name of the vector parameter with "_file" appended (and the same alias). So for instance, if the name of the vector parameter was "vec", the user could specify that the "vec" vector was held in vec.csv by giving the parameter:</p>
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> --vec_file vector.csv</div></div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ID</td><td>Name of the parameter. </td></tr>
|
|
<tr><td class="paramname">DESC</td><td>Description of the parameter (1-2 sentences). </td></tr>
|
|
<tr><td class="paramname">ALIAS</td><td>An alias for the parameter (one letter).</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000021">Bug:</a></b></dt><dd>The <b>COUNTER</b> variable is used in most cases to guarantee a unique global identifier for options declared using the PARAM_*() macros. However, not all compilers have this support–most notably, gcc < 4.3. In that case, the <b>LINE</b> macro is used as an attempt to get a unique global identifier, but collisions are still possible, and they produce bizarre error messages. See <a href="https://github.com/mlpack/mlpack/issues/100">https://github.com/mlpack/mlpack/issues/100</a> for more information. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="param_8hpp_source.html#l00589">589</a> of file <a class="el" href="param_8hpp_source.html">param.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0027b7ba5f161851bf91b167c8891058"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PARAM_UROW_OUT</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ID, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DESC, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ALIAS </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td>   <a class="el" href="param_8hpp.html#a79385d438fe2c4f19f6d563d26592aea">PARAM_UROW</a>(ID, DESC, ALIAS, false, true, false)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Define an unsigned row vector output parameter (type arma::Row<size_t>). </p>
|
|
<p>When the program terminates, the vector will be saved to whatever it was set to during the program. From the command-line, the user may specify the file in which to save the output vector using a string option that is the name of the matrix parameter with "_file" appended. So, for instance, if the name of the output vector parameter was "vec", the user could specify that the "vec" vector should be saved in vector.csv by giving the parameter:</p>
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> --vec_file vector.csv</div></div><!-- fragment --><p>The output vector will not be printed on stdout, like the other output option types.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ID</td><td>Name of the parameter. </td></tr>
|
|
<tr><td class="paramname">DESC</td><td>Description of the parameter (1-2 sentences). </td></tr>
|
|
<tr><td class="paramname">ALIAS</td><td>An alias for the parameter (one letter).</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000025">Bug:</a></b></dt><dd>The <b>COUNTER</b> variable is used in most cases to guarantee a unique global identifier for options declared using the PARAM_*() macros. However, not all compilers have this support–most notably, gcc < 4.3. In that case, the <b>LINE</b> macro is used as an attempt to get a unique global identifier, but collisions are still possible, and they produce bizarre error messages. See <a href="https://github.com/mlpack/mlpack/issues/100">https://github.com/mlpack/mlpack/issues/100</a> for more information. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="param_8hpp_source.html#l00713">713</a> of file <a class="el" href="param_8hpp_source.html">param.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a8431e7deab47987cfdb2ae3f242c72bc"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PARAM_VECTOR_IN</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">T, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ID, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DESC, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ALIAS </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td>   <a class="el" href="param_8hpp.html#a71739f2cfc051c5575d2080203025631">PARAM_IN</a>(std::vector<T>, ID, DESC, ALIAS, std::vector<T>(), false)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Define a std::vector input parameter. </p>
|
|
<p>The parameter can then be specified on the command line with –ID=value1,value2,value3.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ID</td><td>Name of the parameter. </td></tr>
|
|
<tr><td class="paramname">DESC</td><td>Quick description of the parameter (1-2 sentences). </td></tr>
|
|
<tr><td class="paramname">ALIAS</td><td>An alias for the parameter (one letter). </td></tr>
|
|
<tr><td class="paramname">DEF</td><td>Default value of the parameter.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classmlpack_1_1CLI.html" title="Parses the command line for parameters and holds user-specified parameters. ">mlpack::CLI</a>, <a class="el" href="param_8hpp.html#ad781e52fa8bee6ec70cabb646fa16e00" title="Document an executable. ">PROGRAM_INFO()</a></dd></dl>
|
|
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000026">Bug:</a></b></dt><dd>The <b>COUNTER</b> variable is used in most cases to guarantee a unique global identifier for options declared using the PARAM_*() macros. However, not all compilers have this support–most notably, gcc < 4.3. In that case, the <b>LINE</b> macro is used as an attempt to get a unique global identifier, but collisions are still possible, and they produce bizarre error messages. See <a href="https://github.com/mlpack/mlpack/issues/100">https://github.com/mlpack/mlpack/issues/100</a> for more information. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="param_8hpp_source.html#l00737">737</a> of file <a class="el" href="param_8hpp_source.html">param.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a83c3be131e322e0a661c8ddf9c3c7df6"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PARAM_VECTOR_IN_REQ</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">T, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ID, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DESC, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ALIAS </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td>   <a class="el" href="param_8hpp.html#a71739f2cfc051c5575d2080203025631">PARAM_IN</a>(std::vector<T>, ID, DESC, ALIAS, std::vector<T>(), true);</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Define a required vector parameter. </p>
|
|
<p>The parameter must then be specified on the command line with –ID=value1,value2,value3.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ID</td><td>Name of the parameter. </td></tr>
|
|
<tr><td class="paramname">DESC</td><td>Quick description of the parameter (1-2 sentences). </td></tr>
|
|
<tr><td class="paramname">ALIAS</td><td>An alias for the parameter (one letter).</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classmlpack_1_1CLI.html" title="Parses the command line for parameters and holds user-specified parameters. ">mlpack::CLI</a>, <a class="el" href="param_8hpp.html#ad781e52fa8bee6ec70cabb646fa16e00" title="Document an executable. ">PROGRAM_INFO()</a></dd></dl>
|
|
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000032">Bug:</a></b></dt><dd>The <b>COUNTER</b> variable is used in most cases to guarantee a unique global identifier for options declared using the PARAM_*() macros. However, not all compilers have this support–most notably, gcc < 4.3. In that case, the <b>LINE</b> macro is used as an attempt to get a unique global identifier, but collisions are still possible, and they produce bizarre error messages. See <a href="https://github.com/mlpack/mlpack/issues/100">https://github.com/mlpack/mlpack/issues/100</a> for more information. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="param_8hpp_source.html#l00980">980</a> of file <a class="el" href="param_8hpp_source.html">param.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a06f7737525c7db616d248d1bfdf0ee38"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PARAM_VECTOR_OUT</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">T, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">ID </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td>   <a class="el" href="param_8hpp.html#afe71e03991bbb1721872dbf20620b37a">PARAM_OUT</a>(std::vector<T>, ID, DESC, "", std::vector<T>(), false)</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Define a vector output parameter. </p>
|
|
<p>This vector will be printed on stdout at the end of the program; for instance, if the parameter name is "vector" and the vector holds the array { 1, 2, 3, 4 }, the output on stdout would be of the following form:</p>
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> vector: 1, 2, 3, 4</div></div><!-- fragment --><p>If the parameter is not set by the end of the program, a fatal runtime error will be issued.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ID</td><td>Name of the parameter. </td></tr>
|
|
<tr><td class="paramname">DESC</td><td>Quick description of the parameter (1-2 sentences).</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classmlpack_1_1CLI.html" title="Parses the command line for parameters and holds user-specified parameters. ">mlpack::CLI</a>, <a class="el" href="param_8hpp.html#ad781e52fa8bee6ec70cabb646fa16e00" title="Document an executable. ">PROGRAM_INFO()</a></dd></dl>
|
|
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000027">Bug:</a></b></dt><dd>The <b>COUNTER</b> variable is used in most cases to guarantee a unique global identifier for options declared using the PARAM_*() macros. However, not all compilers have this support–most notably, gcc < 4.3. In that case, the <b>LINE</b> macro is used as an attempt to get a unique global identifier, but collisions are still possible, and they produce bizarre error messages. See <a href="https://github.com/mlpack/mlpack/issues/100">https://github.com/mlpack/mlpack/issues/100</a> for more information. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="param_8hpp_source.html#l00766">766</a> of file <a class="el" href="param_8hpp_source.html">param.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ad781e52fa8bee6ec70cabb646fa16e00"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define PROGRAM_INFO</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">NAME, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">DESC </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<b>Value:</b><div class="fragment"><div class="line"><span class="keyword">static</span> mlpack::util::ProgramDoc \</div><div class="line"> cli_programdoc_dummy_object = <a class="code" href="classmlpack_1_1util_1_1ProgramDoc.html">mlpack::util::ProgramDoc</a>(NAME, DESC);</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><!-- fragment -->
|
|
<p>Document an executable. </p>
|
|
<p>Only one instance of this macro should be present in your program! Therefore, use it in the main.cpp (or corresponding executable) in your program.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classmlpack_1_1CLI.html" title="Parses the command line for parameters and holds user-specified parameters. ">mlpack::CLI</a>, <a class="el" href="param_8hpp.html#a59a38dfe16c56a278bd89817216a3739" title="Define a flag parameter. ">PARAM_FLAG()</a>, <a class="el" href="param_8hpp.html#a627025f18abd2735345f03fd733ccd9b" title="Define an integer input parameter. ">PARAM_INT_IN()</a>, <a class="el" href="param_8hpp.html#a14e7059294c684b01128819daea241d4" title="Define a double input parameter. ">PARAM_DOUBLE_IN()</a>, <a class="el" href="param_8hpp.html#a9514ae93b51ba592bc3299da8326bb80" title="Define a string input parameter. ">PARAM_STRING_IN()</a>, <a class="el" href="param_8hpp.html#a8431e7deab47987cfdb2ae3f242c72bc" title="Define a std::vector input parameter. ">PARAM_VECTOR_IN()</a>, <a class="el" href="param_8hpp.html#a50b8bfabec3f0b64fb6e15837da50aa0" title="Define an integer output parameter. ">PARAM_INT_OUT()</a>, <a class="el" href="param_8hpp.html#aa39a5fa65308f2d5581c01cfae5f9203" title="Define a double output parameter. ">PARAM_DOUBLE_OUT()</a>, <a class="el" href="param_8hpp.html#a06f7737525c7db616d248d1bfdf0ee38" title="Define a vector output parameter. ">PARAM_VECTOR_OUT()</a>, <a class="el" href="param_8hpp.html#a59102e55c5d69d23909a75bd6093f816" title="Define a required integer input parameter. ">PARAM_INT_IN_REQ()</a>, <a class="el" href="param_8hpp.html#a1236858e19f2e8be7da663d4aecfac9f" title="Define a required double parameter. ">PARAM_DOUBLE_IN_REQ()</a>, <a class="el" href="param_8hpp.html#a39f209691f1ca8c649a40cb22cea5408" title="Define a required string parameter. ">PARAM_STRING_IN_REQ()</a>, <a class="el" href="param_8hpp.html#a83c3be131e322e0a661c8ddf9c3c7df6" title="Define a required vector parameter. ">PARAM_VECTOR_IN_REQ()</a>, PARAM_INT_OUT_REQ(), PARAM_DOUBLE_OUT_REQ(), PARAM_VECTOR_OUT_REQ(), PARAM_STRING_OUT_REQ().</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">NAME</td><td>Short string representing the name of the program. </td></tr>
|
|
<tr><td class="paramname">DESC</td><td>Long string describing what the program does and possibly a simple usage example. Newlines should not be used here; this is taken care of by CLI (however, you can explicitly specify newlines to denote new paragraphs). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="param_8hpp_source.html#l00049">49</a> of file <a class="el" href="param_8hpp_source.html">param.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a56a316ac6f3ea218df55afae8376ce4e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define TUPLE_TYPE   std::tuple<<a class="el" href="namespacemlpack_1_1data.html#a78dcb1509876d801331776f0b895cffb">mlpack::data::DatasetInfo</a>, arma::mat></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Define an input DatasetInfo/matrix parameter. </p>
|
|
<p>From the command line, the user can specify the file that holds the matrix, using the name of the matrix parameter with "_file" appended (and the same alias). So for instance, if the name of the matrix parameter was "matrix", the user could specify that the "matrix" matrix was held in file.csv by giving the parameter</p>
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> --matrix_file file.csv</div></div><!-- fragment --><p>Then the DatasetInfo and matrix type could be accessed with</p>
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> DatasetInfo d = std::move(</div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>  CLI::GetParam<std::tuple<arma::mat, DatasetInfo>>("matrix").get<0>());</div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> arma::mat m = std::move(</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>  CLI::GetParam<std::tuple<arma::mat, DatasetInfo>>("matrix").get<1>());</div></div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ID</td><td>Name of the parameter. </td></tr>
|
|
<tr><td class="paramname">DESC</td><td>Quick description of the parameter (1-2 sentences). </td></tr>
|
|
<tr><td class="paramname">ALIAS</td><td>One-character string representing the alias of the parameter.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classmlpack_1_1CLI.html" title="Parses the command line for parameters and holds user-specified parameters. ">mlpack::CLI</a>, <a class="el" href="param_8hpp.html#ad781e52fa8bee6ec70cabb646fa16e00" title="Document an executable. ">PROGRAM_INFO()</a></dd></dl>
|
|
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000028">Bug:</a></b></dt><dd>The <b>COUNTER</b> variable is used in most cases to guarantee a unique global identifier for options declared using the PARAM_*() macros. However, not all compilers have this support–most notably, gcc < 4.3. In that case, the <b>LINE</b> macro is used as an attempt to get a unique global identifier, but collisions are still possible, and they produce bizarre error messages. See <a href="https://github.com/mlpack/mlpack/issues/100">https://github.com/mlpack/mlpack/issues/100</a> for more information. </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="param_8hpp_source.html#l00803">803</a> of file <a class="el" href="param_8hpp_source.html">param.hpp</a>.</p>
|
|
|
|
</div>
|
|
</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>
|