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-06-04 02:48:22 +02:00
parent 723c62a124
commit a88bbfe1fa
102 changed files with 467 additions and 320 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
docs/ParamConstraint_8h_source.html
View File

@@ -87,10 +87,13 @@ $(function() {
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;{</div>
<div class="line"><a name="l00008"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html"> 8</a></span>&#160; <span class="keyword">struct </span><a class="code" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160; {</div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160; <a class="code" href="structHazelnp_1_1ParamConstraint.html#afa9e1b4378c9fa1b4a7b5b792c062cbe">ParamConstraint</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; </div>
<div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#afbcc75c428381ab3a292d3f55945eb32"> 16</a></span>&#160; <span class="keyword">static</span> <a class="code" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a> <a class="code" href="structHazelnp_1_1ParamConstraint.html#afbcc75c428381ab3a292d3f55945eb32">Require</a>(<span class="keyword">const</span> std::string&amp; <a class="code" href="structHazelnp_1_1ParamConstraint.html#aac148076c5e0ab91c666f3343c30bd15">key</a>, <span class="keyword">const</span> std::vector&lt;std::string&gt;&amp; <a class="code" href="structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7">defaultValue</a> = {}, <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="l00010"></a><span class="lineno"> 10</span>&#160; <span class="keyword">public</span>:<span class="comment"></span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> //! Empty constructor</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"></span> <a class="code" href="structHazelnp_1_1ParamConstraint.html#afa9e1b4378c9fa1b4a7b5b792c062cbe">ParamConstraint</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> //! Constructs a require constraint. </span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> //! Think of the default value like of a list ofparameters. Like {&quot;--width&quot;, &quot;800&quot;}</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#afbcc75c428381ab3a292d3f55945eb32"> 16</a></span>&#160;<span class="comment"></span> <span class="keyword">static</span> <a class="code" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a> <a class="code" href="structHazelnp_1_1ParamConstraint.html#afbcc75c428381ab3a292d3f55945eb32">Require</a>(<span class="keyword">const</span> std::string&amp; <a class="code" href="structHazelnp_1_1ParamConstraint.html#aac148076c5e0ab91c666f3343c30bd15">key</a>, <span class="keyword">const</span> std::vector&lt;std::string&gt;&amp; <a class="code" href="structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7">defaultValue</a> = {}, <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">ParamConstraint</a> pc;</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; pc.<a class="code" href="structHazelnp_1_1ParamConstraint.html#aac148076c5e0ab91c666f3343c30bd15">key</a> = <a class="code" href="structHazelnp_1_1ParamConstraint.html#aac148076c5e0ab91c666f3343c30bd15">key</a>;</div>
@@ -99,8 +102,9 @@ $(function() {
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <span class="keywordflow">return</span> pc;</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; }</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; </div>
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#ab85210bb37bbace962ff08fcccdafaf2"> 27</a></span>&#160; <span class="keyword">static</span> <a class="code" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a> <a class="code" href="structHazelnp_1_1ParamConstraint.html#ab85210bb37bbace962ff08fcccdafaf2">TypeSafety</a>(<span class="keyword">const</span> std::string&amp; <a class="code" href="structHazelnp_1_1ParamConstraint.html#aac148076c5e0ab91c666f3343c30bd15">key</a>, <a class="code" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803f">DATA_TYPE</a> <a class="code" href="structHazelnp_1_1ParamConstraint.html#ac07a0c0555431d4b1e0bc6afdba41329">wantedType</a>, <span class="keywordtype">bool</span> <a class="code" href="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac">constrainType</a> = <span class="keyword">true</span>)</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="comment"> //! Constructs a type-safety constraint</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#ab85210bb37bbace962ff08fcccdafaf2"> 27</a></span>&#160;<span class="comment"></span> <span class="keyword">static</span> <a class="code" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a> <a class="code" href="structHazelnp_1_1ParamConstraint.html#ab85210bb37bbace962ff08fcccdafaf2">TypeSafety</a>(<span class="keyword">const</span> std::string&amp; <a class="code" href="structHazelnp_1_1ParamConstraint.html#aac148076c5e0ab91c666f3343c30bd15">key</a>, <a class="code" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803f">DATA_TYPE</a> <a class="code" href="structHazelnp_1_1ParamConstraint.html#ac07a0c0555431d4b1e0bc6afdba41329">wantedType</a>, <span class="keywordtype">bool</span> <a class="code" href="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac">constrainType</a> = <span class="keyword">true</span>)</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; {</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <a class="code" href="structHazelnp_1_1ParamConstraint.html">ParamConstraint</a> pc;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; pc.<a class="code" href="structHazelnp_1_1ParamConstraint.html#aac148076c5e0ab91c666f3343c30bd15">key</a> = <a class="code" href="structHazelnp_1_1ParamConstraint.html#aac148076c5e0ab91c666f3343c30bd15">key</a>;</div>
@@ -109,8 +113,9 @@ $(function() {
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keywordflow">return</span> pc;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; }</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; </div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#ab2a897c3044ae2d1a05952a804a3675b"> 38</a></span>&#160; <a class="code" href="structHazelnp_1_1ParamConstraint.html#ab2a897c3044ae2d1a05952a804a3675b">ParamConstraint</a>(<span class="keyword">const</span> std::string&amp; <a class="code" href="structHazelnp_1_1ParamConstraint.html#aac148076c5e0ab91c666f3343c30bd15">key</a>, <span class="keywordtype">bool</span> <a class="code" href="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac">constrainType</a>, <a class="code" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803f">DATA_TYPE</a> <a class="code" href="structHazelnp_1_1ParamConstraint.html#ac07a0c0555431d4b1e0bc6afdba41329">wantedType</a>, <span class="keyword">const</span> std::vector&lt;std::string&gt;&amp; <a class="code" href="structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7">defaultValue</a>, <span class="keywordtype">bool</span> <a class="code" href="structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c">required</a>)</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="comment"> //! Whole constructor</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#ab2a897c3044ae2d1a05952a804a3675b"> 38</a></span>&#160;<span class="comment"></span> <a class="code" href="structHazelnp_1_1ParamConstraint.html#ab2a897c3044ae2d1a05952a804a3675b">ParamConstraint</a>(<span class="keyword">const</span> std::string&amp; <a class="code" href="structHazelnp_1_1ParamConstraint.html#aac148076c5e0ab91c666f3343c30bd15">key</a>, <span class="keywordtype">bool</span> <a class="code" href="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac">constrainType</a>, <a class="code" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803f">DATA_TYPE</a> <a class="code" href="structHazelnp_1_1ParamConstraint.html#ac07a0c0555431d4b1e0bc6afdba41329">wantedType</a>, <span class="keyword">const</span> std::vector&lt;std::string&gt;&amp; <a class="code" href="structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7">defaultValue</a>, <span class="keywordtype">bool</span> <a class="code" href="structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c">required</a>)</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; :</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <a class="code" href="structHazelnp_1_1ParamConstraint.html#aac148076c5e0ab91c666f3343c30bd15">key</a>{ <a class="code" href="structHazelnp_1_1ParamConstraint.html#aac148076c5e0ab91c666f3343c30bd15">key</a> },</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</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>
@@ -120,16 +125,25 @@ $(function() {
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; {</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; }</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; </div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#aac148076c5e0ab91c666f3343c30bd15"> 50</a></span>&#160; std::string <a class="code" href="structHazelnp_1_1ParamConstraint.html#aac148076c5e0ab91c666f3343c30bd15">key</a>;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; </div>
<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac"> 54</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac">constrainType</a> = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; </div>
<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#ac07a0c0555431d4b1e0bc6afdba41329"> 57</a></span>&#160; <a class="code" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803f">DATA_TYPE</a> <a class="code" href="structHazelnp_1_1ParamConstraint.html#ac07a0c0555431d4b1e0bc6afdba41329">wantedType</a> = <a class="code" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803fa6d0c9fc747131795e6e5d0c5119f12cb">DATA_TYPE::VOID</a>;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; </div>
<div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7"> 62</a></span>&#160; std::vector&lt;std::string&gt; <a class="code" href="structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7">defaultValue</a>;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; </div>
<div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c"> 66</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c">required</a> = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="comment"> //! The key of the parameter to constrain</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#aac148076c5e0ab91c666f3343c30bd15"> 50</a></span>&#160;<span class="comment"></span> std::string <a class="code" href="structHazelnp_1_1ParamConstraint.html#aac148076c5e0ab91c666f3343c30bd15">key</a>;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="comment"> //! Should this parameter be forced to be of a certain type? </span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;<span class="comment"> //! Remember to set `constrainTo` to the wanted type</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac"> 54</a></span>&#160;<span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac">constrainType</a> = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="comment"> //! Constrain the parameter to this value. Requires `constrainType` to be set to true.</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#ac07a0c0555431d4b1e0bc6afdba41329"> 57</a></span>&#160;<span class="comment"></span> <a class="code" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803f">DATA_TYPE</a> <a class="code" href="structHazelnp_1_1ParamConstraint.html#ac07a0c0555431d4b1e0bc6afdba41329">wantedType</a> = <a class="code" href="namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803fa6d0c9fc747131795e6e5d0c5119f12cb">DATA_TYPE::VOID</a>;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;<span class="comment"> //! The default value for this parameter. </span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;<span class="comment"> //! Gets applied if this parameter was not given. </span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;<span class="comment"> //! Think of this like a list of parameters. Like {&quot;--width&quot;, &quot;800&quot;}</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7"> 62</a></span>&#160;<span class="comment"></span> std::vector&lt;std::string&gt; <a class="code" href="structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7">defaultValue</a>;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;<span class="comment"> //! If set to true, and no default value set,</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;<span class="comment"> //! an error will be produced if this parameter is not supplied by the user.</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c"> 66</a></span>&#160;<span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c">required</a> = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; };</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;}</div>
</div><!-- fragment --></div><!-- contents -->
@@ -149,7 +163,7 @@ $(function() {
<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#l00062">ParamConstraint.h:62</a></div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Jun 4 2021 02:43:55 for Leonetienne/Hazelnupp by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Fri Jun 4 2021 02:48:01 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>