Update documentation from ginkgo-project/ginkgo@abe9ecf7f9

doc/develop/Examples.html

@@ -24,7 +24,7 @@
   <td id="projectlogo"><img alt="Logo" src="logo_doc.png"/></td>
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">Ginkgo
-   &#160;<span id="projectnumber">Generated from pipelines/1584141913 branch based on develop. Ginkgo version 1.10.0</span>
+   &#160;<span id="projectnumber">Generated from pipelines/1587108358 branch based on develop. Ginkgo version 1.10.0</span>
    </div>
    <div id="projectbrief">A numerical linear algebra library targeting many-core architectures</div>
   </td>

doc/develop/abstract__factory_8hpp_source.html

@@ -24,7 +24,7 @@
   <td id="projectlogo"><img alt="Logo" src="logo_doc.png"/></td>
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">Ginkgo
-   &#160;<span id="projectnumber">Generated from pipelines/1584141913 branch based on develop. Ginkgo version 1.10.0</span>
+   &#160;<span id="projectnumber">Generated from pipelines/1587108358 branch based on develop. Ginkgo version 1.10.0</span>
    </div>
    <div id="projectbrief">A numerical linear algebra library targeting many-core architectures</div>
   </td>
@@ -467,11 +467,11 @@
 <div class="ttc" id="aclassgko_1_1enable__parameters__type_html_a07bc1963e83201576761e013f22ce621"><div class="ttname"><a href="classgko_1_1enable__parameters__type.html#a07bc1963e83201576761e013f22ce621">gko::enable_parameters_type::on</a></div><div class="ttdeci">std::unique_ptr&lt; Factory &gt; on(std::shared_ptr&lt; const Executor &gt; exec) const</div><div class="ttdoc">Creates a new factory on the specified executor.</div><div class="ttdef"><b>Definition:</b> abstract_factory.hpp:233</div></div>
 <div class="ttc" id="aclassgko_1_1deferred__factory__parameter_html_a13303496365ba8dd8beb7d2f88e86a2a"><div class="ttname"><a href="classgko_1_1deferred__factory__parameter.html#a13303496365ba8dd8beb7d2f88e86a2a">gko::deferred_factory_parameter::on</a></div><div class="ttdeci">std::shared_ptr&lt; FactoryType &gt; on(std::shared_ptr&lt; const Executor &gt; exec) const</div><div class="ttdoc">Instantiates the deferred parameter into an actual factory.</div><div class="ttdef"><b>Definition:</b> abstract_factory.hpp:369</div></div>
 <div class="ttc" id="aclassgko_1_1AbstractFactory_html_a8bb9a83878530553e63d2f92e7b3e5c2"><div class="ttname"><a href="classgko_1_1AbstractFactory.html#a8bb9a83878530553e63d2f92e7b3e5c2">gko::AbstractFactory::generate</a></div><div class="ttdeci">std::unique_ptr&lt; abstract_product_type &gt; generate(Args &amp;&amp;... args) const</div><div class="ttdoc">Creates a new product from the given components.</div><div class="ttdef"><b>Definition:</b> abstract_factory.hpp:67</div></div>
-<div class="ttc" id="aclassgko_1_1EnableAbstractPolymorphicObject_html"><div class="ttname"><a href="classgko_1_1EnableAbstractPolymorphicObject.html">gko::EnableAbstractPolymorphicObject</a></div><div class="ttdoc">This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...</div><div class="ttdef"><b>Definition:</b> polymorphic_object.hpp:345</div></div>
+<div class="ttc" id="aclassgko_1_1EnableAbstractPolymorphicObject_html"><div class="ttname"><a href="classgko_1_1EnableAbstractPolymorphicObject.html">gko::EnableAbstractPolymorphicObject</a></div><div class="ttdoc">This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...</div><div class="ttdef"><b>Definition:</b> polymorphic_object.hpp:354</div></div>
 <div class="ttc" id="aclassgko_1_1EnableDefaultFactory_html"><div class="ttname"><a href="classgko_1_1EnableDefaultFactory.html">gko::EnableDefaultFactory</a></div><div class="ttdoc">This mixin provides a default implementation of a concrete factory.</div><div class="ttdef"><b>Definition:</b> abstract_factory.hpp:124</div></div>
 <div class="ttc" id="aclassgko_1_1EnableDefaultFactory_html_a1d077101d9e788e6c65f088612d14cc3"><div class="ttname"><a href="classgko_1_1EnableDefaultFactory.html#a1d077101d9e788e6c65f088612d14cc3">gko::EnableDefaultFactory::create</a></div><div class="ttdeci">static parameters_type create()</div><div class="ttdoc">Creates a new ParametersType object which can be used to instantiate a new ConcreteFactory.</div><div class="ttdef"><b>Definition:</b> abstract_factory.hpp:168</div></div>
 <div class="ttc" id="aclassgko_1_1EnableDefaultFactory_html_ae32f2b3100640293f3a46e1280965162"><div class="ttname"><a href="classgko_1_1EnableDefaultFactory.html#ae32f2b3100640293f3a46e1280965162">gko::EnableDefaultFactory::get_parameters</a></div><div class="ttdeci">const parameters_type &amp; get_parameters() const noexcept</div><div class="ttdoc">Returns the parameters of the factory.</div><div class="ttdef"><b>Definition:</b> abstract_factory.hpp:151</div></div>
-<div class="ttc" id="aclassgko_1_1EnablePolymorphicAssignment_html"><div class="ttname"><a href="classgko_1_1EnablePolymorphicAssignment.html">gko::EnablePolymorphicAssignment</a></div><div class="ttdoc">This mixin is used to enable a default PolymorphicObject::copy_from() implementation for objects that...</div><div class="ttdef"><b>Definition:</b> polymorphic_object.hpp:723</div></div>
+<div class="ttc" id="aclassgko_1_1EnablePolymorphicAssignment_html"><div class="ttname"><a href="classgko_1_1EnablePolymorphicAssignment.html">gko::EnablePolymorphicAssignment</a></div><div class="ttdoc">This mixin is used to enable a default PolymorphicObject::copy_from() implementation for objects that...</div><div class="ttdef"><b>Definition:</b> polymorphic_object.hpp:743</div></div>
 <div class="ttc" id="anamespacegko_html"><div class="ttname"><a href="namespacegko.html">gko</a></div><div class="ttdoc">The Ginkgo namespace.</div><div class="ttdef"><b>Definition:</b> abstract_factory.hpp:20</div></div>
 <div class="ttc" id="aclassgko_1_1deferred__factory__parameter_html_af89a9f8423e6727573029fa0c881b6d1"><div class="ttname"><a href="classgko_1_1deferred__factory__parameter.html#af89a9f8423e6727573029fa0c881b6d1">gko::deferred_factory_parameter::deferred_factory_parameter</a></div><div class="ttdeci">deferred_factory_parameter(ParametersType parameters)</div><div class="ttdoc">Creates a deferred factory parameter object from a factory_parameters-like object.</div><div class="ttdef"><b>Definition:</b> abstract_factory.hpp:359</div></div>
 <div class="ttc" id="aclassgko_1_1deferred__factory__parameter_html_ade191bb3a9d7ffc65392b87233d63098"><div class="ttname"><a href="classgko_1_1deferred__factory__parameter.html#ade191bb3a9d7ffc65392b87233d63098">gko::deferred_factory_parameter::deferred_factory_parameter</a></div><div class="ttdeci">deferred_factory_parameter(std::unique_ptr&lt; ConcreteFactoryType, Deleter &gt; factory)</div><div class="ttdoc">Creates a deferred factory parameter by taking ownership of a preexisting factory with unique ownersh...</div><div class="ttdef"><b>Definition:</b> abstract_factory.hpp:341</div></div>
@@ -481,7 +481,7 @@
 <div class="ttc" id="aclassgko_1_1enable__parameters__type_html"><div class="ttname"><a href="classgko_1_1enable__parameters__type.html">gko::enable_parameters_type</a></div><div class="ttdoc">The enable_parameters_type mixin is used to create a base implementation of the factory parameters st...</div><div class="ttdef"><b>Definition:</b> abstract_factory.hpp:211</div></div>
 <div class="ttc" id="aclassgko_1_1deferred__factory__parameter_html_a888d64b7a719796fe7ca15518a71b486"><div class="ttname"><a href="classgko_1_1deferred__factory__parameter.html#a888d64b7a719796fe7ca15518a71b486">gko::deferred_factory_parameter::is_empty</a></div><div class="ttdeci">bool is_empty() const</div><div class="ttdoc">Returns true iff the parameter is empty.</div><div class="ttdef"><b>Definition:</b> abstract_factory.hpp:378</div></div>
 <div class="ttc" id="aclassgko_1_1deferred__factory__parameter_html"><div class="ttname"><a href="classgko_1_1deferred__factory__parameter.html">gko::deferred_factory_parameter</a></div><div class="ttdoc">Represents a factory parameter of factory type that can either initialized by a pre-existing factory ...</div><div class="ttdef"><b>Definition:</b> abstract_factory.hpp:309</div></div>
-<div class="ttc" id="aclassgko_1_1EnablePolymorphicObject_html"><div class="ttname"><a href="classgko_1_1EnablePolymorphicObject.html">gko::EnablePolymorphicObject</a></div><div class="ttdoc">This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...</div><div class="ttdef"><b>Definition:</b> polymorphic_object.hpp:661</div></div>
+<div class="ttc" id="aclassgko_1_1EnablePolymorphicObject_html"><div class="ttname"><a href="classgko_1_1EnablePolymorphicObject.html">gko::EnablePolymorphicObject</a></div><div class="ttdoc">This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...</div><div class="ttdef"><b>Definition:</b> polymorphic_object.hpp:667</div></div>
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
 Generated by &#160;<a href="http://www.doxygen.org/index.html">

doc/develop/adaptiveprecision-blockjacobi_8hpp_source.html

@@ -24,7 +24,7 @@
   <td id="projectlogo"><img alt="Logo" src="logo_doc.png"/></td>
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">Ginkgo
-   &#160;<span id="projectnumber">Generated from pipelines/1584141913 branch based on develop. Ginkgo version 1.10.0</span>
+   &#160;<span id="projectnumber">Generated from pipelines/1587108358 branch based on develop. Ginkgo version 1.10.0</span>
    </div>
    <div id="projectbrief">A numerical linear algebra library targeting many-core architectures</div>
   </td>

doc/develop/adaptiveprecision_blockjacobi.html

@@ -24,7 +24,7 @@
   <td id="projectlogo"><img alt="Logo" src="logo_doc.png"/></td>
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">Ginkgo
-   &#160;<span id="projectnumber">Generated from pipelines/1584141913 branch based on develop. Ginkgo version 1.10.0</span>
+   &#160;<span id="projectnumber">Generated from pipelines/1587108358 branch based on develop. Ginkgo version 1.10.0</span>
    </div>
    <div id="projectbrief">A numerical linear algebra library targeting many-core architectures</div>
   </td>

doc/develop/amd_8hpp_source.html

@@ -24,7 +24,7 @@
   <td id="projectlogo"><img alt="Logo" src="logo_doc.png"/></td>
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">Ginkgo
-   &#160;<span id="projectnumber">Generated from pipelines/1584141913 branch based on develop. Ginkgo version 1.10.0</span>
+   &#160;<span id="projectnumber">Generated from pipelines/1587108358 branch based on develop. Ginkgo version 1.10.0</span>
    </div>
    <div id="projectbrief">A numerical linear algebra library targeting many-core architectures</div>
   </td>
@@ -140,7 +140,7 @@
 </div><!-- fragment --></div><!-- contents -->
 <div class="ttc" id="aclassgko_1_1experimental_1_1reorder_1_1Amd_html"><div class="ttname"><a href="classgko_1_1experimental_1_1reorder_1_1Amd.html">gko::experimental::reorder::Amd</a></div><div class="ttdoc">Computes a Approximate Minimum Degree (AMD) reordering of an input matrix.</div><div class="ttdef"><b>Definition:</b> amd.hpp:36</div></div>
 <div class="ttc" id="aclassgko_1_1matrix_1_1Permutation_html"><div class="ttname"><a href="classgko_1_1matrix_1_1Permutation.html">gko::matrix::Permutation</a></div><div class="ttdoc">Permutation is a matrix format that represents a permutation matrix, i.e.</div><div class="ttdef"><b>Definition:</b> permutation.hpp:111</div></div>
-<div class="ttc" id="aclassgko_1_1EnablePolymorphicAssignment_html"><div class="ttname"><a href="classgko_1_1EnablePolymorphicAssignment.html">gko::EnablePolymorphicAssignment</a></div><div class="ttdoc">This mixin is used to enable a default PolymorphicObject::copy_from() implementation for objects that...</div><div class="ttdef"><b>Definition:</b> polymorphic_object.hpp:723</div></div>
+<div class="ttc" id="aclassgko_1_1EnablePolymorphicAssignment_html"><div class="ttname"><a href="classgko_1_1EnablePolymorphicAssignment.html">gko::EnablePolymorphicAssignment</a></div><div class="ttdoc">This mixin is used to enable a default PolymorphicObject::copy_from() implementation for objects that...</div><div class="ttdef"><b>Definition:</b> polymorphic_object.hpp:743</div></div>
 <div class="ttc" id="agroup__LinOp_html_ga49d4c09c39f06b22bebbbfd1d8bfe450"><div class="ttname"><a href="group__LinOp.html#ga49d4c09c39f06b22bebbbfd1d8bfe450">GKO_FACTORY_PARAMETER_SCALAR</a></div><div class="ttdeci">#define GKO_FACTORY_PARAMETER_SCALAR(_name, _default)</div><div class="ttdoc">Creates a scalar factory parameter in the factory parameters structure.</div><div class="ttdef"><b>Definition:</b> abstract_factory.hpp:445</div></div>
 <div class="ttc" id="aclassgko_1_1experimental_1_1reorder_1_1Amd_html_a03fa10a26c275d6aa5e87c97836f3169"><div class="ttname"><a href="classgko_1_1experimental_1_1reorder_1_1Amd.html#a03fa10a26c275d6aa5e87c97836f3169">gko::experimental::reorder::Amd::build</a></div><div class="ttdeci">static parameters_type build()</div><div class="ttdoc">Creates a new parameter_type to set up the factory.</div><div class="ttdef"><b>Definition:</b> amd.hpp:80</div></div>
 <div class="ttc" id="anamespacegko_html"><div class="ttname"><a href="namespacegko.html">gko</a></div><div class="ttdoc">The Ginkgo namespace.</div><div class="ttdef"><b>Definition:</b> abstract_factory.hpp:20</div></div>
@@ -151,7 +151,7 @@
 <div class="ttc" id="astructgko_1_1experimental_1_1reorder_1_1Amd_1_1parameters__type_html"><div class="ttname"><a href="structgko_1_1experimental_1_1reorder_1_1Amd_1_1parameters__type.html">gko::experimental::reorder::Amd::parameters_type</a></div><div class="ttdef"><b>Definition:</b> amd.hpp:46</div></div>
 <div class="ttc" id="aclassgko_1_1LinOpFactory_html"><div class="ttname"><a href="classgko_1_1LinOpFactory.html">gko::LinOpFactory</a></div><div class="ttdoc">A LinOpFactory represents a higher order mapping which transforms one linear operator into another.</div><div class="ttdef"><b>Definition:</b> lin_op.hpp:384</div></div>
 <div class="ttc" id="aclassgko_1_1enable__parameters__type_html"><div class="ttname"><a href="classgko_1_1enable__parameters__type.html">gko::enable_parameters_type</a></div><div class="ttdoc">The enable_parameters_type mixin is used to create a base implementation of the factory parameters st...</div><div class="ttdef"><b>Definition:</b> abstract_factory.hpp:211</div></div>
-<div class="ttc" id="aclassgko_1_1EnablePolymorphicObject_html"><div class="ttname"><a href="classgko_1_1EnablePolymorphicObject.html">gko::EnablePolymorphicObject</a></div><div class="ttdoc">This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...</div><div class="ttdef"><b>Definition:</b> polymorphic_object.hpp:661</div></div>
+<div class="ttc" id="aclassgko_1_1EnablePolymorphicObject_html"><div class="ttname"><a href="classgko_1_1EnablePolymorphicObject.html">gko::EnablePolymorphicObject</a></div><div class="ttdoc">This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...</div><div class="ttdef"><b>Definition:</b> polymorphic_object.hpp:667</div></div>
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
 Generated by &#160;<a href="http://www.doxygen.org/index.html">

doc/develop/annotated.html

@@ -24,7 +24,7 @@
   <td id="projectlogo"><img alt="Logo" src="logo_doc.png"/></td>
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">Ginkgo
-   &#160;<span id="projectnumber">Generated from pipelines/1584141913 branch based on develop. Ginkgo version 1.10.0</span>
+   &#160;<span id="projectnumber">Generated from pipelines/1587108358 branch based on develop. Ginkgo version 1.10.0</span>
    </div>
    <div id="projectbrief">A numerical linear algebra library targeting many-core architectures</div>
   </td>
@@ -194,8 +194,6 @@
 <tr id="row_0_3_4_0_" style="display:none;"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span id="arr_0_3_4_0_" class="arrow" onclick="toggleFolder('0_3_4_0_')">&#9658;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgko_1_1experimental_1_1solver_1_1Direct.html" target="_self">Direct</a></td><td class="desc">A direct solver based on a factorization into lower and upper triangular factors (with an optional diagonal scaling) </td></tr>
 <tr id="row_0_3_4_0_0_" style="display:none;"><td class="entry"><span style="width:80px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgko_1_1experimental_1_1solver_1_1Direct_1_1Factory.html" target="_self">Factory</a></td><td class="desc"></td></tr>
 <tr id="row_0_3_4_0_1_" style="display:none;"><td class="entry"><span style="width:80px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgko_1_1experimental_1_1solver_1_1Direct_1_1parameters__type.html" target="_self">parameters_type</a></td><td class="desc"></td></tr>
-<tr id="row_0_3_5_" style="display:none;"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgko_1_1experimental_1_1EnableDistributedLinOp.html" target="_self">EnableDistributedLinOp</a></td><td class="desc">This mixin does the same as <a class="el" href="classgko_1_1EnableLinOp.html" title="The EnableLinOp mixin can be used to provide sensible default implementations of the majority of the ...">EnableLinOp</a>, but for concrete types that are derived from <a class="el" href="classgko_1_1experimental_1_1distributed_1_1DistributedBase.html" title="A base class for distributed objects.">distributed::DistributedBase</a> </td></tr>
-<tr id="row_0_3_6_" style="display:none;"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgko_1_1experimental_1_1EnableDistributedPolymorphicObject.html" target="_self">EnableDistributedPolymorphicObject</a></td><td class="desc">This mixin does the same as <a class="el" href="classgko_1_1EnablePolymorphicObject.html" title="This mixin inherits from (a subclass of) PolymorphicObject and provides a base implementation of a ne...">EnablePolymorphicObject</a>, but for concrete types that are derived from <a class="el" href="classgko_1_1experimental_1_1distributed_1_1DistributedBase.html" title="A base class for distributed objects.">distributed::DistributedBase</a> </td></tr>
 <tr id="row_0_4_" style="display:none;"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_4_" class="arrow" onclick="toggleFolder('0_4_')">&#9658;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacegko_1_1factorization.html" target="_self">factorization</a></td><td class="desc">The Factorization namespace </td></tr>
 <tr id="row_0_4_0_" style="display:none;"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span id="arr_0_4_0_" class="arrow" onclick="toggleFolder('0_4_0_')">&#9658;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgko_1_1factorization_1_1Ic.html" target="_self">Ic</a></td><td class="desc">Represents an incomplete Cholesky factorization (IC(0)) of a sparse matrix </td></tr>
 <tr id="row_0_4_0_0_" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgko_1_1factorization_1_1Ic_1_1Factory.html" target="_self">Factory</a></td><td class="desc"></td></tr>

doc/develop/array_8hpp_source.html

@@ -24,7 +24,7 @@
   <td id="projectlogo"><img alt="Logo" src="logo_doc.png"/></td>
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">Ginkgo
-   &#160;<span id="projectnumber">Generated from pipelines/1584141913 branch based on develop. Ginkgo version 1.10.0</span>
+   &#160;<span id="projectnumber">Generated from pipelines/1587108358 branch based on develop. Ginkgo version 1.10.0</span>
    </div>
    <div id="projectbrief">A numerical linear algebra library targeting many-core architectures</div>
   </td>