Skip to content

Commit

Permalink
Deploying to gh-pages from @ af61e8c 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
bluescarni committed Feb 20, 2024
1 parent 24a7fe0 commit 7a267e1
Show file tree
Hide file tree
Showing 28 changed files with 960 additions and 966 deletions.
2 changes: 0 additions & 2 deletions _sources/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@ pygmo has the following **mandatory** runtime dependencies:
Additionally, pygmo has the following **optional** runtime
dependencies:

* `dill <https://dill.readthedocs.io>`__, which can be used as an
alternative serialization backend,
* `Matplotlib <https://matplotlib.org/>`__, which is used by a few
plotting utilities,
* `NetworkX <https://networkx.github.io/>`__, which is used for
Expand Down
38 changes: 19 additions & 19 deletions algorithm.html

Large diffs are not rendered by default.

878 changes: 439 additions & 439 deletions algorithms.html

Large diffs are not rendered by default.

34 changes: 17 additions & 17 deletions archipelago.html

Large diffs are not rendered by default.

28 changes: 14 additions & 14 deletions bfe.html
Original file line number Diff line number Diff line change
Expand Up @@ -436,7 +436,7 @@ <h1>Batch fitness evaluator<a class="headerlink" href="#batch-fitness-evaluator"
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><ul class="simple">
<li><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#NotImplementedError" title="(in Python v3.11)"><strong>NotImplementedError</strong></a> – if <em>udbfe</em> does not implement the mandatory methods detailed above</p></li>
<li><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#NotImplementedError" title="(in Python v3.12)"><strong>NotImplementedError</strong></a> – if <em>udbfe</em> does not implement the mandatory methods detailed above</p></li>
<li><p><strong>unspecified</strong> – any exception thrown by methods of the UDBFE invoked during construction,
the deep copy of the UDBFE, the constructor of the underlying C++ class, or
failures at the intersection between C++ and Python (e.g., type conversion errors, mismatched function
Expand Down Expand Up @@ -473,7 +473,7 @@ <h1>Batch fitness evaluator<a class="headerlink" href="#batch-fitness-evaluator"
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><ul class="simple">
<li><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.11)"><strong>ValueError</strong></a> – if <em>dvs</em> or the return value produced by the UDBFE are incompatible with the input problem <em>prob</em></p></li>
<li><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.12)"><strong>ValueError</strong></a> – if <em>dvs</em> or the return value produced by the UDBFE are incompatible with the input problem <em>prob</em></p></li>
<li><p><strong>unspecified</strong> – any exception raised by the invocation of the UDBFE, or by failures at the intersection
between C++ and Python (e.g., type conversion errors, mismatched function signatures, etc.)</p></li>
</ul>
Expand All @@ -498,25 +498,25 @@ <h1>Batch fitness evaluator<a class="headerlink" href="#batch-fitness-evaluator"
<dd><p>Extract the user-defined batch fitness evaluator (bfe).</p>
<p>This method allows to extract a reference to the user-defined bfe (UDBFE) stored within this
<a class="reference internal" href="#pygmo.bfe" title="pygmo.bfe"><code class="xref py py-class docutils literal notranslate"><span class="pre">bfe</span></code></a> instance. The behaviour of this function depends on the value
of <em>t</em> (which must be a <a class="reference external" href="https://docs.python.org/3/library/functions.html#type" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">type</span></code></a>) and on the type of the internal UDBFE:</p>
of <em>t</em> (which must be a <a class="reference external" href="https://docs.python.org/3/library/functions.html#type" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">type</span></code></a>) and on the type of the internal UDBFE:</p>
<ul class="simple">
<li><p>if the type of the UDBFE is <em>t</em>, then a reference to the UDBFE will be returned
(this mirrors the behaviour of the corresponding C++ method
<a class="reference external" href="https://esa.github.io/pagmo2/docs/cpp/bfe.html#_CPPv4I0ENK5pagmo3bfe7extractEPK1Tv" title="(in pagmo v2.19.0)"><code class="xref cpp cpp-func docutils literal notranslate"><span class="pre">pagmo::bfe::extract()</span></code></a>),</p></li>
<li><p>if <em>t</em> is <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a> and the UDBFE is a Python object (as opposed to an
<li><p>if <em>t</em> is <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a> and the UDBFE is a Python object (as opposed to an
<a class="reference internal" href="bfes.html#bfes-cpp"><span class="std std-ref">exposed C++ bfe</span></a>), then a reference to the
UDBFE will be returned (this allows to extract a Python UDBFE without knowing its type),</p></li>
<li><p>otherwise, <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.11)"><code class="xref py py-data docutils literal notranslate"><span class="pre">None</span></code></a> will be returned.</p></li>
<li><p>otherwise, <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">None</span></code></a> will be returned.</p></li>
</ul>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>t</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#type" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">type</span></code></a>) – the type of the user-defined bfe to extract</p>
<dd class="field-odd"><p><strong>t</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#type" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">type</span></code></a>) – the type of the user-defined bfe to extract</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>a reference to the internal user-defined bfe, or <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.11)"><code class="xref py py-data docutils literal notranslate"><span class="pre">None</span></code></a> if the extraction fails</p>
<dd class="field-even"><p>a reference to the internal user-defined bfe, or <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">None</span></code></a> if the extraction fails</p>
</dd>
<dt class="field-odd">Raises</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#TypeError" title="(in Python v3.11)"><strong>TypeError</strong></a> – if <em>t</em> is not a <a class="reference external" href="https://docs.python.org/3/library/functions.html#type" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">type</span></code></a></p>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#TypeError" title="(in Python v3.12)"><strong>TypeError</strong></a> – if <em>t</em> is not a <a class="reference external" href="https://docs.python.org/3/library/functions.html#type" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">type</span></code></a></p>
</dd>
</dl>
<p class="rubric">Examples</p>
Expand Down Expand Up @@ -549,7 +549,7 @@ <h1>Batch fitness evaluator<a class="headerlink" href="#batch-fitness-evaluator"
<dd class="field-odd"><p>extra info about the UDBFE</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)">str</a></p>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a></p>
</dd>
<dt class="field-odd">Raises</dt>
<dd class="field-odd"><p><strong>unspecified</strong> – any exception thrown by the <code class="docutils literal notranslate"><span class="pre">get_extra_info()</span></code> method of the UDBFE</p>
Expand All @@ -568,7 +568,7 @@ <h1>Batch fitness evaluator<a class="headerlink" href="#batch-fitness-evaluator"
<dd class="field-odd"><p>the bfe’s name</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)">str</a></p>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)">str</a></p>
</dd>
</dl>
</dd></dl>
Expand All @@ -595,17 +595,17 @@ <h1>Batch fitness evaluator<a class="headerlink" href="#batch-fitness-evaluator"
<dt class="sig sig-object py" id="pygmo.bfe.is_">
<span class="sig-name descname"><span class="pre">is_</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pygmo.bfe.is_" title="Permalink to this definition">#</a></dt>
<dd><p>Check the type of the user-defined batch fitness evaluator.</p>
<p>This method returns <a class="reference external" href="https://docs.python.org/3/library/constants.html#False" title="(in Python v3.11)"><code class="xref py py-data docutils literal notranslate"><span class="pre">False</span></code></a> if <a class="reference internal" href="#pygmo.bfe.extract" title="pygmo.bfe.extract"><code class="xref py py-func docutils literal notranslate"><span class="pre">extract(t)</span></code></a> returns
<a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.11)"><code class="xref py py-data docutils literal notranslate"><span class="pre">None</span></code></a>, and <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.11)"><code class="xref py py-data docutils literal notranslate"><span class="pre">True</span></code></a> otherwise.</p>
<p>This method returns <a class="reference external" href="https://docs.python.org/3/library/constants.html#False" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">False</span></code></a> if <a class="reference internal" href="#pygmo.bfe.extract" title="pygmo.bfe.extract"><code class="xref py py-func docutils literal notranslate"><span class="pre">extract(t)</span></code></a> returns
<a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">None</span></code></a>, and <a class="reference external" href="https://docs.python.org/3/library/constants.html#True" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">True</span></code></a> otherwise.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>t</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#type" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">type</span></code></a>) – the type that will be compared to the type of the UDBFE</p>
<dd class="field-odd"><p><strong>t</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#type" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">type</span></code></a>) – the type that will be compared to the type of the UDBFE</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>whether the UDBFE is of type <em>t</em> or not</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.11)">bool</a></p>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)">bool</a></p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p><strong>unspecified</strong> – any exception thrown by <a class="reference internal" href="#pygmo.bfe.extract" title="pygmo.bfe.extract"><code class="xref py py-func docutils literal notranslate"><span class="pre">extract()</span></code></a></p>
Expand Down
Loading

0 comments on commit 7a267e1

Please sign in to comment.