Built mkdocs

This commit is contained in:
Leonetienne
2021-06-06 15:32:19 +02:00
parent 6166e43d31
commit 78e7f14b22
200 changed files with 1662 additions and 1472 deletions

View File

@@ -103,18 +103,18 @@ Public Member Functions</h2></td></tr>
<tr class="memitem:afa9e1b4378c9fa1b4a7b5b792c062cbe"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structHazelnp_1_1ParamConstraint.html#afa9e1b4378c9fa1b4a7b5b792c062cbe">ParamConstraint</a> ()=default</td></tr>
<tr class="memdesc:afa9e1b4378c9fa1b4a7b5b792c062cbe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Empty constructor. <a href="structHazelnp_1_1ParamConstraint.html#afa9e1b4378c9fa1b4a7b5b792c062cbe">More...</a><br /></td></tr>
<tr class="separator:afa9e1b4378c9fa1b4a7b5b792c062cbe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aed7cb14a27277bf57b7f2d53065a2406"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structHazelnp_1_1ParamConstraint.html#aed7cb14a27277bf57b7f2d53065a2406">ParamConstraint</a> (bool <a class="el" href="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac">constrainType</a>, <a class="el" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803f">DATA_TYPE</a> <a class="el" href="structHazelnp_1_1ParamConstraint.html#ac07a0c0555431d4b1e0bc6afdba41329">wantedType</a>, const std::vector&lt; std::string &gt; &amp;<a class="el" href="structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7">defaultValue</a>, bool <a class="el" href="structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c">required</a>)</td></tr>
<tr class="memdesc:aed7cb14a27277bf57b7f2d53065a2406"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whole constructor. <a href="structHazelnp_1_1ParamConstraint.html#aed7cb14a27277bf57b7f2d53065a2406">More...</a><br /></td></tr>
<tr class="separator:aed7cb14a27277bf57b7f2d53065a2406"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af261299848888fb106f5ba3b4c5a72ba"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structHazelnp_1_1ParamConstraint.html#af261299848888fb106f5ba3b4c5a72ba">ParamConstraint</a> (bool <a class="el" href="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac">constrainType</a>, <a class="el" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803f">DATA_TYPE</a> <a class="el" href="structHazelnp_1_1ParamConstraint.html#a203b6fd1b9788a529aa0f15fe94fd24a">requiredType</a>, const std::vector&lt; std::string &gt; &amp;<a class="el" href="structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7">defaultValue</a>, bool <a class="el" href="structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c">required</a>)</td></tr>
<tr class="memdesc:af261299848888fb106f5ba3b4c5a72ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whole constructor. <a href="structHazelnp_1_1ParamConstraint.html#af261299848888fb106f5ba3b4c5a72ba">More...</a><br /></td></tr>
<tr class="separator:af261299848888fb106f5ba3b4c5a72ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a926e12fcb2fd0d031452c4bcc950bd6c"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structHazelnp_1_1ParamConstraint.html#a926e12fcb2fd0d031452c4bcc950bd6c">Require</a> (const std::vector&lt; std::string &gt; &amp;<a class="el" href="structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7">defaultValue</a>={}, bool <a class="el" href="structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c">required</a>=true)</td></tr>
<tr class="memdesc:a926e12fcb2fd0d031452c4bcc950bd6c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a require constraint. <a href="structHazelnp_1_1ParamConstraint.html#a926e12fcb2fd0d031452c4bcc950bd6c">More...</a><br /></td></tr>
<tr class="separator:a926e12fcb2fd0d031452c4bcc950bd6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a15a860c63388ea3164e3d7b35b352e9a"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structHazelnp_1_1ParamConstraint.html#a15a860c63388ea3164e3d7b35b352e9a">TypeSafety</a> (<a class="el" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803f">DATA_TYPE</a> <a class="el" href="structHazelnp_1_1ParamConstraint.html#ac07a0c0555431d4b1e0bc6afdba41329">wantedType</a>, bool <a class="el" href="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac">constrainType</a>=true)</td></tr>
<tr class="memdesc:a15a860c63388ea3164e3d7b35b352e9a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a type-safety constraint. <a href="structHazelnp_1_1ParamConstraint.html#a15a860c63388ea3164e3d7b35b352e9a">More...</a><br /></td></tr>
<tr class="separator:a15a860c63388ea3164e3d7b35b352e9a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7df61dbc8dbaff4bc596fdf2c0532d5b"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structHazelnp_1_1ParamConstraint.html#a7df61dbc8dbaff4bc596fdf2c0532d5b">TypeSafety</a> (<a class="el" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803f">DATA_TYPE</a> <a class="el" href="structHazelnp_1_1ParamConstraint.html#a203b6fd1b9788a529aa0f15fe94fd24a">requiredType</a>, bool <a class="el" href="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac">constrainType</a>=true)</td></tr>
<tr class="memdesc:a7df61dbc8dbaff4bc596fdf2c0532d5b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a type-safety constraint. <a href="structHazelnp_1_1ParamConstraint.html#a7df61dbc8dbaff4bc596fdf2c0532d5b">More...</a><br /></td></tr>
<tr class="separator:a7df61dbc8dbaff4bc596fdf2c0532d5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
@@ -122,9 +122,9 @@ Public Attributes</h2></td></tr>
<tr class="memdesc:a88a4a4c215723259c71853992d09acac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Should this parameter be forced to be of a certain type? <br />
Remember to set <code>constrainTo</code> to the wanted type. <a href="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac">More...</a><br /></td></tr>
<tr class="separator:a88a4a4c215723259c71853992d09acac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac07a0c0555431d4b1e0bc6afdba41329"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803f">DATA_TYPE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structHazelnp_1_1ParamConstraint.html#ac07a0c0555431d4b1e0bc6afdba41329">wantedType</a> = <a class="el" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803fa6d0c9fc747131795e6e5d0c5119f12cb">DATA_TYPE::VOID</a></td></tr>
<tr class="memdesc:ac07a0c0555431d4b1e0bc6afdba41329"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constrain the parameter to this value. Requires <code>constrainType</code> to be set to true. <a href="structHazelnp_1_1ParamConstraint.html#ac07a0c0555431d4b1e0bc6afdba41329">More...</a><br /></td></tr>
<tr class="separator:ac07a0c0555431d4b1e0bc6afdba41329"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a203b6fd1b9788a529aa0f15fe94fd24a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803f">DATA_TYPE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structHazelnp_1_1ParamConstraint.html#a203b6fd1b9788a529aa0f15fe94fd24a">requiredType</a> = <a class="el" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803fa6d0c9fc747131795e6e5d0c5119f12cb">DATA_TYPE::VOID</a></td></tr>
<tr class="memdesc:a203b6fd1b9788a529aa0f15fe94fd24a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constrain the parameter to this value. Requires <code>constrainType</code> to be set to true. <a href="structHazelnp_1_1ParamConstraint.html#a203b6fd1b9788a529aa0f15fe94fd24a">More...</a><br /></td></tr>
<tr class="separator:a203b6fd1b9788a529aa0f15fe94fd24a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1d3a627b3a23fe0db3a368e51dbcd5a7"><td class="memItemLeft" align="right" valign="top">std::vector&lt; std::string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7">defaultValue</a></td></tr>
<tr class="memdesc:a1d3a627b3a23fe0db3a368e51dbcd5a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">The default value for this parameter. <a href="structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7">More...</a><br /></td></tr>
<tr class="separator:a1d3a627b3a23fe0db3a368e51dbcd5a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -168,8 +168,8 @@ Friends</h2></td></tr>
</div>
</div>
<a id="aed7cb14a27277bf57b7f2d53065a2406"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aed7cb14a27277bf57b7f2d53065a2406">&#9670;&nbsp;</a></span>ParamConstraint() <span class="overload">[2/2]</span></h2>
<a id="af261299848888fb106f5ba3b4c5a72ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af261299848888fb106f5ba3b4c5a72ba">&#9670;&nbsp;</a></span>ParamConstraint() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
@@ -187,7 +187,7 @@ Friends</h2></td></tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803f">DATA_TYPE</a>&#160;</td>
<td class="paramname"><em>wantedType</em>, </td>
<td class="paramname"><em>requiredType</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
@@ -219,7 +219,7 @@ Friends</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00036">36</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; :</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <a class="code" href="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac">constrainType</a>{ <a class="code" href="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac">constrainType</a> },</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <a class="code" href="structHazelnp_1_1ParamConstraint.html#ac07a0c0555431d4b1e0bc6afdba41329">wantedType</a>{ <a class="code" href="structHazelnp_1_1ParamConstraint.html#ac07a0c0555431d4b1e0bc6afdba41329">wantedType</a> },</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <a class="code" href="structHazelnp_1_1ParamConstraint.html#a203b6fd1b9788a529aa0f15fe94fd24a">requiredType</a>{ <a class="code" href="structHazelnp_1_1ParamConstraint.html#a203b6fd1b9788a529aa0f15fe94fd24a">requiredType</a> },</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <a class="code" href="structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7">defaultValue</a>{ <a class="code" href="structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7">defaultValue</a> },</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <a class="code" href="structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c">required</a>{ <a class="code" href="structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c">required</a> }</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; {</div>
@@ -279,8 +279,8 @@ Friends</h2></td></tr>
</div><!-- fragment -->
</div>
</div>
<a id="a15a860c63388ea3164e3d7b35b352e9a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a15a860c63388ea3164e3d7b35b352e9a">&#9670;&nbsp;</a></span>TypeSafety()</h2>
<a id="a7df61dbc8dbaff4bc596fdf2c0532d5b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7df61dbc8dbaff4bc596fdf2c0532d5b">&#9670;&nbsp;</a></span>TypeSafety()</h2>
<div class="memitem">
<div class="memproto">
@@ -292,7 +292,7 @@ Friends</h2></td></tr>
<td class="memname">static <a class="el" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a> Hazelnp::ParamConstraint::TypeSafety </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803f">DATA_TYPE</a>&#160;</td>
<td class="paramname"><em>wantedType</em>, </td>
<td class="paramname"><em>requiredType</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
@@ -319,7 +319,7 @@ Friends</h2></td></tr>
<div class="fragment"><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; {</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <a class="code" href="structHazelnp_1_1ParamConstraint.html#afa9e1b4378c9fa1b4a7b5b792c062cbe">ParamConstraint</a> pc;</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; pc.constrainType = <a class="code" href="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac">constrainType</a>;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; pc.wantedType = <a class="code" href="structHazelnp_1_1ParamConstraint.html#ac07a0c0555431d4b1e0bc6afdba41329">wantedType</a>;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; pc.requiredType = <a class="code" href="structHazelnp_1_1ParamConstraint.html#a203b6fd1b9788a529aa0f15fe94fd24a">requiredType</a>;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keywordflow">return</span> pc;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; }</div>
@@ -410,14 +410,14 @@ Friends</h2></td></tr>
</div>
</div>
<a id="ac07a0c0555431d4b1e0bc6afdba41329"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac07a0c0555431d4b1e0bc6afdba41329">&#9670;&nbsp;</a></span>wantedType</h2>
<a id="a203b6fd1b9788a529aa0f15fe94fd24a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a203b6fd1b9788a529aa0f15fe94fd24a">&#9670;&nbsp;</a></span>requiredType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803f">DATA_TYPE</a> Hazelnp::ParamConstraint::wantedType = <a class="el" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803fa6d0c9fc747131795e6e5d0c5119f12cb">DATA_TYPE::VOID</a></td>
<td class="memname"><a class="el" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803f">DATA_TYPE</a> Hazelnp::ParamConstraint::requiredType = <a class="el" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803fa6d0c9fc747131795e6e5d0c5119f12cb">DATA_TYPE::VOID</a></td>
</tr>
</table>
</div><div class="memdoc">
@@ -432,14 +432,14 @@ Friends</h2></td></tr>
<li>Hazelnupp/<a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a></li>
</ul>
</div><!-- contents -->
<div class="ttc" id="astructHazelnp_1_1ParamConstraint_html_ac07a0c0555431d4b1e0bc6afdba41329"><div class="ttname"><a href="structHazelnp_1_1ParamConstraint.html#ac07a0c0555431d4b1e0bc6afdba41329">Hazelnp::ParamConstraint::wantedType</a></div><div class="ttdeci">DATA_TYPE wantedType</div><div class="ttdoc">Constrain the parameter to this value. Requires constrainType to be set to true.</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00051">ParamConstraint.h:51</a></div></div>
<div class="ttc" id="astructHazelnp_1_1ParamConstraint_html_a203b6fd1b9788a529aa0f15fe94fd24a"><div class="ttname"><a href="structHazelnp_1_1ParamConstraint.html#a203b6fd1b9788a529aa0f15fe94fd24a">Hazelnp::ParamConstraint::requiredType</a></div><div class="ttdeci">DATA_TYPE requiredType</div><div class="ttdoc">Constrain the parameter to this value. Requires constrainType to be set to true.</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00051">ParamConstraint.h:51</a></div></div>
<div class="ttc" id="astructHazelnp_1_1ParamConstraint_html_a88a4a4c215723259c71853992d09acac"><div class="ttname"><a href="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac">Hazelnp::ParamConstraint::constrainType</a></div><div class="ttdeci">bool constrainType</div><div class="ttdoc">Should this parameter be forced to be of a certain type? Remember to set constrainTo to the wanted ...</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00048">ParamConstraint.h:48</a></div></div>
<div class="ttc" id="astructHazelnp_1_1ParamConstraint_html_afa9e1b4378c9fa1b4a7b5b792c062cbe"><div class="ttname"><a href="structHazelnp_1_1ParamConstraint.html#afa9e1b4378c9fa1b4a7b5b792c062cbe">Hazelnp::ParamConstraint::ParamConstraint</a></div><div class="ttdeci">ParamConstraint()=default</div><div class="ttdoc">Empty constructor.</div></div>
<div class="ttc" id="astructHazelnp_1_1ParamConstraint_html_a8ccf3ebecc2d9d0105e181814af2943c"><div class="ttname"><a href="structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c">Hazelnp::ParamConstraint::required</a></div><div class="ttdeci">bool required</div><div class="ttdoc">If set to true, and no default value set, an error will be produced if this parameter is not supplied...</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00060">ParamConstraint.h:60</a></div></div>
<div class="ttc" id="astructHazelnp_1_1ParamConstraint_html_a1d3a627b3a23fe0db3a368e51dbcd5a7"><div class="ttname"><a href="structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7">Hazelnp::ParamConstraint::defaultValue</a></div><div class="ttdeci">std::vector&lt; std::string &gt; defaultValue</div><div class="ttdoc">The default value for this parameter.</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00056">ParamConstraint.h:56</a></div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jun 5 2021 12:40:12 for Leonetienne/Hazelnupp by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Sun Jun 6 2021 15:32:08 for Leonetienne/Hazelnupp by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>