leonetienne/Hazelnupp
1
0
Fork 0
Code Issues 3 Pull Requests Packages Projects Releases Wiki Activity

Built mkdocs

Browse Source
This commit is contained in:
Leonetienne
2021-09-05 12:12:03 +02:00
parent 1a4869faa1
commit c0c5a3a06d
202 changed files with 2546 additions and 1638 deletions
Download Patch File Download Diff File Expand all files Collapse all files

177
docs/structHazelnp_1_1ParamConstraint.html
View File

@@ -91,7 +91,7 @@ Collaboration diagram for Hazelnp::ParamConstraint:</div>
<div class="dyncontent">
<div class="center"><img src="structHazelnp_1_1ParamConstraint__coll__graph.png" border="0" usemap="#Hazelnp_1_1ParamConstraint_coll__map" alt="Collaboration graph"/></div>
<map name="Hazelnp_1_1ParamConstraint_coll__map" id="Hazelnp_1_1ParamConstraint_coll__map">
<area shape="rect" title=" " alt="" coords="5,275,196,301"/>
<area shape="rect" title=" " alt="" coords="5,289,196,316"/>
<area shape="rect" title=" " alt="" coords="7,185,194,212"/>
<area shape="rect" title="STL class." alt="" coords="57,96,144,123"/>
<area shape="rect" title="STL class." alt="" coords="31,5,170,47"/>
@@ -103,18 +103,24 @@ 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: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>
<tr class="memitem:aea39497a14939fa887c236ee1e755cb3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structHazelnp_1_1ParamConstraint.html#aea39497a14939fa887c236ee1e755cb3">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::initializer_list&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>, const std::initializer_list&lt; std::string &gt; &amp;<a class="el" href="structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c">incompatibleParameters</a>)</td></tr>
<tr class="memdesc:aea39497a14939fa887c236ee1e755cb3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whole constructor. <a href="structHazelnp_1_1ParamConstraint.html#aea39497a14939fa887c236ee1e755cb3">More...</a><br /></td></tr>
<tr class="separator:aea39497a14939fa887c236ee1e755cb3"><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:a8a7e5d7ddffc3cfbb54ac6823dd7eded"><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#a8a7e5d7ddffc3cfbb54ac6823dd7eded">Require</a> (const std::initializer_list&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:a8a7e5d7ddffc3cfbb54ac6823dd7eded"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a require constraint. <a href="structHazelnp_1_1ParamConstraint.html#a8a7e5d7ddffc3cfbb54ac6823dd7eded">More...</a><br /></td></tr>
<tr class="separator:a8a7e5d7ddffc3cfbb54ac6823dd7eded"><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>
<tr class="memitem:a20fa41460106b5327a51114f8a187871"><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#a20fa41460106b5327a51114f8a187871">Incompatibility</a> (const std::initializer_list&lt; std::string &gt; &amp;<a class="el" href="structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c">incompatibleParameters</a>)</td></tr>
<tr class="memdesc:a20fa41460106b5327a51114f8a187871"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an incompatibility constraint. <a href="structHazelnp_1_1ParamConstraint.html#a20fa41460106b5327a51114f8a187871">More...</a><br /></td></tr>
<tr class="separator:a20fa41460106b5327a51114f8a187871"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6bb383f8945fb99cbd2370fd9a4bc6fc"><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#a6bb383f8945fb99cbd2370fd9a4bc6fc">Incompatibility</a> (const std::string &amp;<a class="el" href="structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c">incompatibleParameters</a>)</td></tr>
<tr class="memdesc:a6bb383f8945fb99cbd2370fd9a4bc6fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs an incompatibility constraint. <a href="structHazelnp_1_1ParamConstraint.html#a6bb383f8945fb99cbd2370fd9a4bc6fc">More...</a><br /></td></tr>
<tr class="separator:a6bb383f8945fb99cbd2370fd9a4bc6fc"><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>
@@ -131,6 +137,9 @@ Public Attributes</h2></td></tr>
<tr class="memitem:a8ccf3ebecc2d9d0105e181814af2943c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c">required</a> = false</td></tr>
<tr class="memdesc:a8ccf3ebecc2d9d0105e181814af2943c"><td class="mdescLeft">&#160;</td><td class="mdescRight">If set to true, and no default value set, an error will be produced if this parameter is not supplied by the user. <a href="structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c">More...</a><br /></td></tr>
<tr class="separator:a8ccf3ebecc2d9d0105e181814af2943c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf45734665238b51483f77701039108c"><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#acf45734665238b51483f77701039108c">incompatibleParameters</a></td></tr>
<tr class="memdesc:acf45734665238b51483f77701039108c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parameters that are incompatible with this parameter. <a href="structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c">More...</a><br /></td></tr>
<tr class="separator:acf45734665238b51483f77701039108c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
@@ -168,8 +177,8 @@ Friends</h2></td></tr>
</div>
</div>
<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>
<a id="aea39497a14939fa887c236ee1e755cb3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea39497a14939fa887c236ee1e755cb3">&#9670;&nbsp;</a></span>ParamConstraint() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
@@ -192,14 +201,20 @@ Friends</h2></td></tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector&lt; std::string &gt; &amp;&#160;</td>
<td class="paramtype">const std::initializer_list&lt; std::string &gt; &amp;&#160;</td>
<td class="paramname"><em>defaultValue</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>required</em>&#160;</td>
<td class="paramname"><em>required</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::initializer_list&lt; std::string &gt; &amp;&#160;</td>
<td class="paramname"><em>incompatibleParameters</em>&#160;</td>
</tr>
<tr>
<td></td>
@@ -216,21 +231,96 @@ Friends</h2></td></tr>
<p>Whole constructor. </p>
<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#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>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; }</div>
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00057">57</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; :</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</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="l00060"></a><span class="lineno"> 60</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="l00061"></a><span class="lineno"> 61</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="l00062"></a><span class="lineno"> 62</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="l00063"></a><span class="lineno"> 63</span>&#160; <a class="code" href="structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c">incompatibleParameters</a>{<a class="code" href="structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c">incompatibleParameters</a>}</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; {</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; }</div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a926e12fcb2fd0d031452c4bcc950bd6c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a926e12fcb2fd0d031452c4bcc950bd6c">&#9670;&nbsp;</a></span>Require()</h2>
<a id="a20fa41460106b5327a51114f8a187871"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a20fa41460106b5327a51114f8a187871">&#9670;&nbsp;</a></span>Incompatibility() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a> Hazelnp::ParamConstraint::Incompatibility </td>
<td>(</td>
<td class="paramtype">const std::initializer_list&lt; std::string &gt; &amp;&#160;</td>
<td class="paramname"><em>incompatibleParameters</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs an incompatibility constraint. </p>
<p>This means, that the following parameters are NOT compatible with this one and will throw an error if passed together </p>
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00037">37</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; {</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <a class="code" href="structHazelnp_1_1ParamConstraint.html#afa9e1b4378c9fa1b4a7b5b792c062cbe">ParamConstraint</a> pc;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; pc.incompatibleParameters = <a class="code" href="structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c">incompatibleParameters</a>;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; </div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keywordflow">return</span> pc;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; }</div>
</div><!-- fragment -->
</div>
</div>
<a id="a6bb383f8945fb99cbd2370fd9a4bc6fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6bb383f8945fb99cbd2370fd9a4bc6fc">&#9670;&nbsp;</a></span>Incompatibility() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a> Hazelnp::ParamConstraint::Incompatibility </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>incompatibleParameters</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs an incompatibility constraint. </p>
<p>This means, that the following parameters are NOT compatible with this one and will throw an error if passed together. Syntactical-sugar proxy method that will convert the lonely string to an initializer list for you :3 </p>
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00048">48</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; {</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <a class="code" href="structHazelnp_1_1ParamConstraint.html#afa9e1b4378c9fa1b4a7b5b792c062cbe">ParamConstraint</a> pc;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; pc.incompatibleParameters = { <a class="code" href="structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c">incompatibleParameters</a> };</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; </div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="keywordflow">return</span> pc;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; }</div>
</div><!-- fragment -->
</div>
</div>
<a id="a8a7e5d7ddffc3cfbb54ac6823dd7eded"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8a7e5d7ddffc3cfbb54ac6823dd7eded">&#9670;&nbsp;</a></span>Require()</h2>
<div class="memitem">
<div class="memproto">
@@ -241,7 +331,7 @@ Friends</h2></td></tr>
<tr>
<td class="memname">static <a class="el" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a> Hazelnp::ParamConstraint::Require </td>
<td>(</td>
<td class="paramtype">const std::vector&lt; std::string &gt; &amp;&#160;</td>
<td class="paramtype">const std::initializer_list&lt; std::string &gt; &amp;&#160;</td>
<td class="paramname"><em>defaultValue</em> = <code>{}</code>, </td>
</tr>
<tr>
@@ -268,7 +358,7 @@ Friends</h2></td></tr>
Think of the default value like of a list ofparameters. Like {"--width", "800"} </p>
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00016">16</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
<div class="fragment"><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; {}, <span class="keywordtype">bool</span> <a class="code" href="structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c">required</a> = <span class="keyword">true</span>)</div>
<div class="fragment"><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; {}, <span class="keywordtype">bool</span> <a class="code" href="structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c">required</a> = <span class="keyword">true</span>)</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; {</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; <a class="code" href="structHazelnp_1_1ParamConstraint.html#afa9e1b4378c9fa1b4a7b5b792c062cbe">ParamConstraint</a> pc;</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; pc.defaultValue = <a class="code" href="structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7">defaultValue</a>;</div>
@@ -347,7 +437,7 @@ Friends</h2></td></tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00067">67</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00092">92</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
</div>
</div>
@@ -367,7 +457,7 @@ Friends</h2></td></tr>
<p>Should this parameter be forced to be of a certain type? <br />
Remember to set <code>constrainTo</code> to the wanted type. </p>
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00048">48</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00070">70</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
</div>
</div>
@@ -388,7 +478,25 @@ Friends</h2></td></tr>
Gets applied if this parameter was not given. <br />
Think of this like a list of parameters. Like {"--width", "800"} </p>
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00056">56</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00078">78</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
</div>
</div>
<a id="acf45734665238b51483f77701039108c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf45734665238b51483f77701039108c">&#9670;&nbsp;</a></span>incompatibleParameters</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;std::string&gt; Hazelnp::ParamConstraint::incompatibleParameters</td>
</tr>
</table>
</div><div class="memdoc">
<p>Parameters that are incompatible with this parameter. </p>
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00085">85</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
</div>
</div>
@@ -406,7 +514,7 @@ Friends</h2></td></tr>
<p>If set to true, and no default value set, an error will be produced if this parameter is not supplied by the user. </p>
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00060">60</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00082">82</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
</div>
</div>
@@ -424,7 +532,7 @@ Friends</h2></td></tr>
<p>Constrain the parameter to this value. Requires <code>constrainType</code> to be set to true. </p>
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00051">51</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
<p class="definition">Definition at line <a class="el" href="ParamConstraint_8h_source.html#l00073">73</a> of file <a class="el" href="ParamConstraint_8h_source.html">ParamConstraint.h</a>.</p>
</div>
</div>
@@ -432,14 +540,15 @@ 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_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_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#l00073">ParamConstraint.h:73</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#l00070">ParamConstraint.h:70</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>
<div class="ttc" id="astructHazelnp_1_1ParamConstraint_html_acf45734665238b51483f77701039108c"><div class="ttname"><a href="structHazelnp_1_1ParamConstraint.html#acf45734665238b51483f77701039108c">Hazelnp::ParamConstraint::incompatibleParameters</a></div><div class="ttdeci">std::vector&lt; std::string &gt; incompatibleParameters</div><div class="ttdoc">Parameters that are incompatible with this parameter.</div><div class="ttdef"><b>Definition:</b> <a href="ParamConstraint_8h_source.html#l00085">ParamConstraint.h:85</a></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#l00082">ParamConstraint.h:82</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#l00078">ParamConstraint.h:78</a></div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Aug 4 2021 21:16:25 for Leonetienne/Hazelnupp by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Sun Sep 5 2021 12:11:51 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>