Skip to content

Commit

Permalink
Merge pull request #171 from IOHprofiler/doc_python
Browse files Browse the repository at this point in the history
[WIP] Update problem documentation python
  • Loading branch information
jacobdenobel committed May 26, 2023
2 parents 91b2309 + 099f2ed commit 913f1de
Show file tree
Hide file tree
Showing 80 changed files with 2,250 additions and 243 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<map id="inheritance8d65a00182" name="inheritance8d65a00182">
<area shape="rect" id="node1" href="../api/ioh.iohcpp.problem.GraphProblem.html#ioh.iohcpp.problem.GraphProblem" target="_top" title="Graph&#45;based problems (submodular problems)" alt="" coords="401,80,516,105"/>
<area shape="rect" id="node4" href="../api/ioh.iohcpp.problem.MaxCoverage.html#ioh.iohcpp.problem.MaxCoverage" target="_top" title="Max&#45;Coverage problems" alt="" coords="572,5,684,31"/>
<area shape="rect" id="node5" href="../api/ioh.iohcpp.problem.MaxCut.html#ioh.iohcpp.problem.MaxCut" target="_top" title="Max&#45;Cut problems" alt="" coords="592,55,664,80"/>
<area shape="rect" id="node6" href="../api/ioh.iohcpp.problem.MaxInfluence.html#ioh.iohcpp.problem.MaxInfluence" target="_top" title="Max&#45;Influence problems" alt="" coords="573,104,683,129"/>
<area shape="rect" id="node7" href="../api/ioh.iohcpp.problem.PackWhileTravel.html#ioh.iohcpp.problem.PackWhileTravel" target="_top" title="Packing while traveling problems" alt="" coords="564,153,692,179"/>
<area shape="rect" id="node2" href="../api/ioh.iohcpp.problem.IntegerSingleObjective.html#ioh.iohcpp.problem.IntegerSingleObjective" target="_top" title="IntegerSingleObjective" alt="" coords="183,80,353,105"/>
</map>
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
<map id="inheritanceb56d784816" name="inheritanceb56d784816">
<area shape="rect" id="node1" href="../api/ioh.iohcpp.problem.ConcatenatedTrap.html#ioh.iohcpp.problem.ConcatenatedTrap" target="_top" title="Concatenated Trap (CT) is defined by partitioning a bit&#45;string into segments of length k and " alt="" coords="540,5,676,30"/>
<area shape="rect" id="node2" href="../api/ioh.iohcpp.problem.PBO.html#ioh.iohcpp.problem.PBO" target="_top" title="Pseudo&#45;Boolean Optimization (PBO) problem set." alt="" coords="395,564,466,589"/>
<area shape="rect" id="node5" href="../api/ioh.iohcpp.problem.IsingRing.html#ioh.iohcpp.problem.IsingRing" target="_top" title="The Ising Spin Glass model arose in solid&#45;state physics and statistical mechanics, aiming to " alt="" coords="567,54,649,79"/>
<area shape="rect" id="node6" href="../api/ioh.iohcpp.problem.IsingTorus.html#ioh.iohcpp.problem.IsingTorus" target="_top" title="The Ising Spin Glass model arose in solid&#45;state physics and statistical mechanics, aiming to " alt="" coords="566,102,651,127"/>
<area shape="rect" id="node7" href="../api/ioh.iohcpp.problem.IsingTriangular.html#ioh.iohcpp.problem.IsingTriangular" target="_top" title="The Ising Spin Glass model arose in solid&#45;state physics and statistical mechanics, aiming to " alt="" coords="550,151,666,176"/>
<area shape="rect" id="node8" href="../api/ioh.iohcpp.problem.LABS.html#ioh.iohcpp.problem.LABS" target="_top" title="Low Autocorrelation Binary Sequences (LABS):" alt="" coords="573,199,644,224"/>
<area shape="rect" id="node9" href="../api/ioh.iohcpp.problem.LeadingOnes.html#ioh.iohcpp.problem.LeadingOnes" target="_top" title="LeadingOnes:" alt="" coords="556,248,661,273"/>
<area shape="rect" id="node10" href="../api/ioh.iohcpp.problem.LeadingOnesDummy1.html#ioh.iohcpp.problem.LeadingOnesDummy1" target="_top" title="A variant of LeadingOnes applying the Dummy transformation of W&#45;model. m = 0.5n." alt="" coords="526,297,690,321"/>
<area shape="rect" id="node11" href="../api/ioh.iohcpp.problem.LeadingOnesDummy2.html#ioh.iohcpp.problem.LeadingOnesDummy2" target="_top" title="A variant of LeadingOnes applying the Dummy transformation of W&#45;model. m = 0.9n." alt="" coords="526,345,690,370"/>
<area shape="rect" id="node12" href="../api/ioh.iohcpp.problem.LeadingOnesEpistasis.html#ioh.iohcpp.problem.LeadingOnesEpistasis" target="_top" title="A variant of LeadingOnes applying the Epistasis transformation of W&#45;model.
u = 4." alt="" coords="527,394,689,419"/>
<area shape="rect" id="node13" href="../api/ioh.iohcpp.problem.LeadingOnesNeutrality.html#ioh.iohcpp.problem.LeadingOnesNeutrality" target="_top" title="A variant of LeadingOnes applying the Neutrality transformation of W&#45;model. mu = 3." alt="" coords="524,442,692,467"/>
<area shape="rect" id="node14" href="../api/ioh.iohcpp.problem.LeadingOnesRuggedness1.html#ioh.iohcpp.problem.LeadingOnesRuggedness1" target="_top" title="A variant of LeadingOnes applying the first Ruggnedness transformation in https://doi.org/10.1016/j.asoc.2019.106027." alt="" coords="513,491,703,516"/>
<area shape="rect" id="node15" href="../api/ioh.iohcpp.problem.LeadingOnesRuggedness2.html#ioh.iohcpp.problem.LeadingOnesRuggedness2" target="_top" title="A variant of LeadingOnes applying the second Ruggnedness transformation in https://doi.org/10.1016/j.asoc.2019.106027." alt="" coords="513,539,703,564"/>
<area shape="rect" id="node16" href="../api/ioh.iohcpp.problem.LeadingOnesRuggedness3.html#ioh.iohcpp.problem.LeadingOnesRuggedness3" target="_top" title="A variant of LeadingOnes applying the third Ruggnedness transformation in https://doi.org/10.1016/j.asoc.2019.106027." alt="" coords="513,588,703,613"/>
<area shape="rect" id="node17" href="../api/ioh.iohcpp.problem.Linear.html#ioh.iohcpp.problem.Linear" target="_top" title="A Linear Function with Harmonic Weights:" alt="" coords="573,636,644,661"/>
<area shape="rect" id="node18" href="../api/ioh.iohcpp.problem.MIS.html#ioh.iohcpp.problem.MIS" target="_top" title="The maximum independent vertex set (MIVS) formulated as " alt="" coords="573,685,644,710"/>
<area shape="rect" id="node19" href="../api/ioh.iohcpp.problem.NQueens.html#ioh.iohcpp.problem.NQueens" target="_top" title="The N&#45;queens problem (NQP) is defined as the task to place N queens on an N*N chessboard in such a " alt="" coords="568,733,648,758"/>
<area shape="rect" id="node20" href="../api/ioh.iohcpp.problem.OneMax.html#ioh.iohcpp.problem.OneMax" target="_top" title="OneMax:" alt="" coords="571,782,646,807"/>
<area shape="rect" id="node21" href="../api/ioh.iohcpp.problem.OneMaxDummy1.html#ioh.iohcpp.problem.OneMaxDummy1" target="_top" title="A variant of OneMax applying the Dummy transformation of W&#45;model. m = 0.5n." alt="" coords="541,831,675,855"/>
<area shape="rect" id="node22" href="../api/ioh.iohcpp.problem.OneMaxDummy2.html#ioh.iohcpp.problem.OneMaxDummy2" target="_top" title="A variant of OneMax applying the Dummy transformation of W&#45;model. m = 0.9n." alt="" coords="541,879,675,904"/>
<area shape="rect" id="node23" href="../api/ioh.iohcpp.problem.OneMaxEpistasis.html#ioh.iohcpp.problem.OneMaxEpistasis" target="_top" title="A variant of OneMax applying the Epistasis transformation of W&#45;model.
u = 4." alt="" coords="542,928,674,953"/>
<area shape="rect" id="node24" href="../api/ioh.iohcpp.problem.OneMaxNeutrality.html#ioh.iohcpp.problem.OneMaxNeutrality" target="_top" title="A variant of OneMax applying the Neutrality transformation of W&#45;model. mu = 3." alt="" coords="539,976,678,1001"/>
<area shape="rect" id="node25" href="../api/ioh.iohcpp.problem.OneMaxRuggedness1.html#ioh.iohcpp.problem.OneMaxRuggedness1" target="_top" title="A variant of OneMax applying the first Ruggnedness transformation in https://doi.org/10.1016/j.asoc.2019.106027." alt="" coords="528,1025,688,1050"/>
<area shape="rect" id="node26" href="../api/ioh.iohcpp.problem.OneMaxRuggedness2.html#ioh.iohcpp.problem.OneMaxRuggedness2" target="_top" title="A variant of OneMax applying the second Ruggnedness transformation in https://doi.org/10.1016/j.asoc.2019.106027." alt="" coords="528,1073,688,1098"/>
<area shape="rect" id="node27" href="../api/ioh.iohcpp.problem.OneMaxRuggedness3.html#ioh.iohcpp.problem.OneMaxRuggedness3" target="_top" title="A variant of OneMax applying the third Ruggnedness transformation in https://doi.org/10.1016/j.asoc.2019.106027." alt="" coords="528,1122,688,1147"/>
<area shape="rect" id="node3" href="../api/ioh.iohcpp.problem.IntegerSingleObjective.html#ioh.iohcpp.problem.IntegerSingleObjective" target="_top" title="IntegerSingleObjective" alt="" coords="180,564,348,589"/>
</map>
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<map id="inheritance2277b26ca0" name="inheritance2277b26ca0">
<area shape="rect" id="node1" href="../api/ioh.iohcpp.problem.IntegerSingleObjective.html#ioh.iohcpp.problem.IntegerSingleObjective" target="_top" title="IntegerSingleObjective" alt="" coords="189,5,359,31"/>
<area shape="rect" id="node3" href="../api/ioh.iohcpp.problem.IntegerStarDiscrepancy.html#ioh.iohcpp.problem.IntegerStarDiscrepancy" target="_top" title="Star&#45;discrepancy problems" alt="" coords="413,5,588,31"/>
<area shape="rect" id="node4" href="../api/ioh.iohcpp.problem.RealSingleObjective.html#ioh.iohcpp.problem.RealSingleObjective" target="_top" title="RealSingleObjective" alt="" coords="197,55,351,80"/>
<area shape="rect" id="node6" href="../api/ioh.iohcpp.problem.StarDiscrepancySampler.html#ioh.iohcpp.problem.StarDiscrepancySampler" target="_top" title="Methods which can be used to sample the initial grids for the star discrepancy problems" alt="" coords="183,104,365,129"/>
<area shape="rect" id="node5" href="../api/ioh.iohcpp.problem.RealStarDiscrepancy.html#ioh.iohcpp.problem.RealStarDiscrepancy" target="_top" title="Star&#45;discrepancy problems" alt="" coords="422,55,579,80"/>
</map>
12 changes: 6 additions & 6 deletions docs/api/ioh.iohcpp.ConstraintEnforcement.html
Original file line number Diff line number Diff line change
Expand Up @@ -410,14 +410,14 @@ <h1>ConstraintEnforcement<a class="headerlink" href="#constraintenforcement" tit
<dt class="sig sig-object py" id="ioh.iohcpp.ConstraintEnforcement">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ioh.iohcpp.</span></span><span class="sig-name descname"><span class="pre">ConstraintEnforcement</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#ioh.iohcpp.ConstraintEnforcement" title="ioh.iohcpp.ConstraintEnforcement"><span class="pre">ioh.iohcpp.ConstraintEnforcement</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ioh.iohcpp.ConstraintEnforcement" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">pybind11_object</span></code></p>
<p>Enum defining constraint handling strategies</p>
<p>Enum defining constraint handling strategies.</p>
<p>Members:</p>
<blockquote>
<div><p>NOT</p>
<p>HIDDEN</p>
<p>SOFT</p>
<p>HARD</p>
<p>OVERRIDE</p>
<div><p>NOT : Do not calculate the constraint at all</p>
<p>HIDDEN : Do not enforce, but still calculate to enable logging.</p>
<p>SOFT : Penalize (y + p), but aggregate all the constraint penalties into a sum</p>
<p>HARD : Penalize (p only), and if violation return only the penalty for this constraint in contraintset</p>
<p>OVERRIDE : Penalize (p only), and if violation return the custom penalization function this constraint in contraintset</p>
</div></blockquote>
<p class="rubric">Attributes Summary</p>
<div class="table-wrapper autosummary longtable docutils container">
Expand Down
14 changes: 13 additions & 1 deletion docs/api/ioh.iohcpp.IntegerConstraint.html
Original file line number Diff line number Diff line change
Expand Up @@ -408,8 +408,20 @@
<h1>IntegerConstraint<a class="headerlink" href="#integerconstraint" title="Permalink to this heading">#</a></h1>
<dl class="py class">
<dt class="sig sig-object py" id="ioh.iohcpp.IntegerConstraint">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ioh.iohcpp.</span></span><span class="sig-name descname"><span class="pre">IntegerConstraint</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self:</span> <span class="pre">ioh.iohcpp.IntegerConstraint</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fn:</span> <span class="pre">handle</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">weight:</span> <span class="pre">float</span> <span class="pre">=</span> <span class="pre">1.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exponent:</span> <span class="pre">float</span> <span class="pre">=</span> <span class="pre">1.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">enforced:</span> <span class="pre">ioh.iohcpp.ConstraintEnforcement</span> <span class="pre">=</span> <span class="pre">&lt;ConstraintEnforcement.SOFT:</span> <span class="pre">2&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'\n</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">General</span> <span class="pre">Constraint</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">defined</span> <span class="pre">by</span> <span class="pre">a</span> <span class="pre">function\n\n</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">Parameters\n</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">----------\n</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">f:</span> <span class="pre">list</span> <span class="pre">-&gt;</span> <span class="pre">float\n</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">A</span> <span class="pre">function</span> <span class="pre">that</span> <span class="pre">computes</span> <span class="pre">the</span> <span class="pre">violation</span> <span class="pre">of</span> <span class="pre">a</span> <span class="pre">point\n</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">weight:</span> <span class="pre">float\n</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">The</span> <span class="pre">weight</span> <span class="pre">given</span> <span class="pre">to</span> <span class="pre">the</span> <span class="pre">violation</span> <span class="pre">when</span> <span class="pre">penalizing</span> <span class="pre">the</span> <span class="pre">objective</span> <span class="pre">function\n</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">exponent:</span> <span class="pre">float\n</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">The</span> <span class="pre">exponent</span> <span class="pre">given</span> <span class="pre">to</span> <span class="pre">the</span> <span class="pre">violation</span> <span class="pre">when</span> <span class="pre">penalizing</span> <span class="pre">the</span> <span class="pre">objective</span> <span class="pre">function\n</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">enforced:</span> <span class="pre">ConstraintEnforcement\n</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">whether</span> <span class="pre">the</span> <span class="pre">constraint</span> <span class="pre">should</span> <span class="pre">be</span> <span class="pre">enforced\n</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">name:</span> <span class="pre">str\n</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">name</span> <span class="pre">of</span> <span class="pre">the</span> <span class="pre">constraint</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">\n</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ioh.iohcpp.IntegerConstraint" title="Permalink to this definition">#</a></dt>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ioh.iohcpp.</span></span><span class="sig-name descname"><span class="pre">IntegerConstraint</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self:</span> <span class="pre">ioh.iohcpp.IntegerConstraint</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fn:</span> <span class="pre">handle</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">weight:</span> <span class="pre">float</span> <span class="pre">=</span> <span class="pre">1.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exponent:</span> <span class="pre">float</span> <span class="pre">=</span> <span class="pre">1.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">enforced:</span> <span class="pre">ioh.iohcpp.ConstraintEnforcement</span> <span class="pre">=</span> <span class="pre">&lt;ConstraintEnforcement.SOFT:</span> <span class="pre">2&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ioh.iohcpp.IntegerConstraint" title="Permalink to this definition">#</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">AbstractIntegerConstraint</span></code></p>
<p>General Constraint, defined by a function</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>f</strong> (<em>list -&gt; float</em>) – A function that computes the violation of a point</p></li>
<li><p><strong>weight</strong> (<em>float</em>) – The weight given to the violation when penalizing the objective function</p></li>
<li><p><strong>exponent</strong> (<em>float</em>) – The exponent given to the violation when penalizing the objective function</p></li>
<li><p><strong>enforced</strong> (<a class="reference internal" href="ioh.iohcpp.ConstraintEnforcement.html#ioh.iohcpp.ConstraintEnforcement" title="ioh.iohcpp.ConstraintEnforcement"><em>ConstraintEnforcement</em></a>) – how the constraint should be enforced</p></li>
<li><p><strong>name</strong> (<em>str</em>) – name of the constraint</p></li>
</ul>
</dd>
</dl>
<p class="rubric">Attributes Summary</p>
<div class="table-wrapper autosummary longtable docutils container">
<table class="autosummary longtable docutils align-default">
Expand Down
Loading

0 comments on commit 913f1de

Please sign in to comment.