update documentation

ginkgo-project · May 17, 2024 · 399b6b3 · 399b6b3
1 parent 141365e
commit 399b6b3
Show file tree

Hide file tree

Showing 11 changed files with 174 additions and 18 deletions.
diff --git a/include/ginkgo/core/solver/bicg.hpp b/include/ginkgo/core/solver/bicg.hpp
@@ -82,9 +82,22 @@ class Bicg
     GKO_ENABLE_LIN_OP_FACTORY(Bicg, parameters, Factory);
     GKO_ENABLE_BUILD_METHOD(Factory);
 
+    /**
+     * Create the parameters from the property_tree.
+     * Because this is directly tied to the specific type. The value/index type
+     * settings are ignored and type_descriptor is for children objects.
+     *
+     * @param config  the property tree for setting
+     * @param context  the registry
+     * @param td_for_child  the type descriptor for children objects. The
+     *                      default will directly from the specific type.
+     *
+     * @return parameters
+     */
     static parameters_type parse(const config::pnode& config,
                                  const config::registry& context,
-                                 const config::type_descriptor& td_for_child);
+                                 const config::type_descriptor& td_for_child =
+                                     config::make_type_descriptor<ValueType>());
 
 protected:
     void apply_impl(const LinOp* b, LinOp* x) const override;

diff --git a/include/ginkgo/core/solver/bicgstab.hpp b/include/ginkgo/core/solver/bicgstab.hpp
@@ -80,9 +80,22 @@ class Bicgstab
     GKO_ENABLE_LIN_OP_FACTORY(Bicgstab, parameters, Factory);
     GKO_ENABLE_BUILD_METHOD(Factory);
 
+    /**
+     * Create the parameters from the property_tree.
+     * Because this is directly tied to the specific type. The value/index type
+     * settings are ignored and type_descriptor is for children objects.
+     *
+     * @param config  the property tree for setting
+     * @param context  the registry
+     * @param td_for_child  the type descriptor for children objects. The
+     *                      default will directly from the specific type.
+     *
+     * @return parameters
+     */
     static parameters_type parse(const config::pnode& config,
                                  const config::registry& context,
-                                 const config::type_descriptor& td_for_child);
+                                 const config::type_descriptor& td_for_child =
+                                     config::make_type_descriptor<ValueType>());
 
 protected:
     void apply_impl(const LinOp* b, LinOp* x) const override;

diff --git a/include/ginkgo/core/solver/cb_gmres.hpp b/include/ginkgo/core/solver/cb_gmres.hpp
@@ -147,9 +147,22 @@ class CbGmres : public EnableLinOp<CbGmres<ValueType>>,
     GKO_ENABLE_LIN_OP_FACTORY(CbGmres, parameters, Factory);
     GKO_ENABLE_BUILD_METHOD(Factory);
 
+    /**
+     * Create the parameters from the property_tree.
+     * Because this is directly tied to the specific type. The value/index type
+     * settings are ignored and type_descriptor is for children objects.
+     *
+     * @param config  the property tree for setting
+     * @param context  the registry
+     * @param td_for_child  the type descriptor for children objects. The
+     *                      default will directly from the specific type.
+     *
+     * @return parameters
+     */
     static parameters_type parse(const config::pnode& config,
                                  const config::registry& context,
-                                 const config::type_descriptor& td_for_child);
+                                 const config::type_descriptor& td_for_child =
+                                     config::make_type_descriptor<ValueType>());
 
 protected:
     void apply_impl(const LinOp* b, LinOp* x) const override;

diff --git a/include/ginkgo/core/solver/cgs.hpp b/include/ginkgo/core/solver/cgs.hpp
@@ -73,9 +73,22 @@ class Cgs
     GKO_ENABLE_LIN_OP_FACTORY(Cgs, parameters, Factory);
     GKO_ENABLE_BUILD_METHOD(Factory);
 
+    /**
+     * Create the parameters from the property_tree.
+     * Because this is directly tied to the specific type. The value/index type
+     * settings are ignored and type_descriptor is for children objects.
+     *
+     * @param config  the property tree for setting
+     * @param context  the registry
+     * @param td_for_child  the type descriptor for children objects. The
+     *                      default will directly from the specific type.
+     *
+     * @return parameters
+     */
     static parameters_type parse(const config::pnode& config,
                                  const config::registry& context,
-                                 const config::type_descriptor& td_for_child);
+                                 const config::type_descriptor& td_for_child =
+                                     config::make_type_descriptor<ValueType>());
 
 protected:
     void apply_impl(const LinOp* b, LinOp* x) const override;

diff --git a/include/ginkgo/core/solver/direct.hpp b/include/ginkgo/core/solver/direct.hpp
@@ -67,9 +67,22 @@ class Direct : public EnableLinOp<Direct<ValueType, IndexType>>,
     GKO_ENABLE_LIN_OP_FACTORY(Direct, parameters, Factory);
     GKO_ENABLE_BUILD_METHOD(Factory);
 
-    static parameters_type parse(const config::pnode& config,
-                                 const config::registry& context,
-                                 const config::type_descriptor& td_for_child);
+    /**
+     * Create the parameters from the property_tree.
+     * Because this is directly tied to the specific type. The value/index type
+     * settings are ignored and type_descriptor is for children objects.
+     *
+     * @param config  the property tree for setting
+     * @param context  the registry
+     * @param td_for_child  the type descriptor for children objects. The
+     *                      default will directly from the specific type.
+     *
+     * @return parameters
+     */
+    static parameters_type parse(
+        const config::pnode& config, const config::registry& context,
+        const config::type_descriptor& td_for_child =
+            config::make_type_descriptor<ValueType, IndexType>());
 
     /** Creates a copy of the solver. */
     Direct(const Direct&);

diff --git a/include/ginkgo/core/solver/fcg.hpp b/include/ginkgo/core/solver/fcg.hpp
@@ -81,9 +81,22 @@ class Fcg
     GKO_ENABLE_LIN_OP_FACTORY(Fcg, parameters, Factory);
     GKO_ENABLE_BUILD_METHOD(Factory);
 
+    /**
+     * Create the parameters from the property_tree.
+     * Because this is directly tied to the specific type. The value/index type
+     * settings are ignored and type_descriptor is for children objects.
+     *
+     * @param config  the property tree for setting
+     * @param context  the registry
+     * @param td_for_child  the type descriptor for children objects. The
+     *                      default will directly from the specific type.
+     *
+     * @return parameters
+     */
     static parameters_type parse(const config::pnode& config,
                                  const config::registry& context,
-                                 const config::type_descriptor& td_for_child);
+                                 const config::type_descriptor& td_for_child =
+                                     config::make_type_descriptor<ValueType>());
 
 protected:
     void apply_impl(const LinOp* b, LinOp* x) const override;

diff --git a/include/ginkgo/core/solver/gcr.hpp b/include/ginkgo/core/solver/gcr.hpp
@@ -93,9 +93,22 @@ class Gcr
     GKO_ENABLE_LIN_OP_FACTORY(Gcr, parameters, Factory);
     GKO_ENABLE_BUILD_METHOD(Factory);
 
+    /**
+     * Create the parameters from the property_tree.
+     * Because this is directly tied to the specific type. The value/index type
+     * settings are ignored and type_descriptor is for children objects.
+     *
+     * @param config  the property tree for setting
+     * @param context  the registry
+     * @param td_for_child  the type descriptor for children objects. The
+     *                      default will directly from the specific type.
+     *
+     * @return parameters
+     */
     static parameters_type parse(const config::pnode& config,
                                  const config::registry& context,
-                                 const config::type_descriptor& td_for_child);
+                                 const config::type_descriptor& td_for_child =
+                                     config::make_type_descriptor<ValueType>());
 
 protected:
     void apply_impl(const LinOp* b, LinOp* x) const override;

diff --git a/include/ginkgo/core/solver/gmres.hpp b/include/ginkgo/core/solver/gmres.hpp
@@ -98,9 +98,22 @@ class Gmres
     GKO_ENABLE_LIN_OP_FACTORY(Gmres, parameters, Factory);
     GKO_ENABLE_BUILD_METHOD(Factory);
 
+    /**
+     * Create the parameters from the property_tree.
+     * Because this is directly tied to the specific type. The value/index type
+     * settings are ignored and type_descriptor is for children objects.
+     *
+     * @param config  the property tree for setting
+     * @param context  the registry
+     * @param td_for_child  the type descriptor for children objects. The
+     *                      default will directly from the specific type.
+     *
+     * @return parameters
+     */
     static parameters_type parse(const config::pnode& config,
                                  const config::registry& context,
-                                 const config::type_descriptor& td_for_child);
+                                 const config::type_descriptor& td_for_child =
+                                     config::make_type_descriptor<ValueType>());
 
 protected:
     void apply_impl(const LinOp* b, LinOp* x) const override;

diff --git a/include/ginkgo/core/solver/idr.hpp b/include/ginkgo/core/solver/idr.hpp
@@ -196,9 +196,22 @@ class Idr
     GKO_ENABLE_LIN_OP_FACTORY(Idr, parameters, Factory);
     GKO_ENABLE_BUILD_METHOD(Factory);
 
+    /**
+     * Create the parameters from the property_tree.
+     * Because this is directly tied to the specific type. The value/index type
+     * settings are ignored and type_descriptor is for children objects.
+     *
+     * @param config  the property tree for setting
+     * @param context  the registry
+     * @param td_for_child  the type descriptor for children objects. The
+     *                      default will directly from the specific type.
+     *
+     * @return parameters
+     */
     static parameters_type parse(const config::pnode& config,
                                  const config::registry& context,
-                                 const config::type_descriptor& td_for_child);
+                                 const config::type_descriptor& td_for_child =
+                                     config::make_type_descriptor<ValueType>());
 
 protected:
     void apply_impl(const LinOp* b, LinOp* x) const override;

diff --git a/include/ginkgo/core/solver/ir.hpp b/include/ginkgo/core/solver/ir.hpp
@@ -184,9 +184,22 @@ class Ir : public EnableLinOp<Ir<ValueType>>,
     GKO_ENABLE_LIN_OP_FACTORY(Ir, parameters, Factory);
     GKO_ENABLE_BUILD_METHOD(Factory);
 
+    /**
+     * Create the parameters from the property_tree.
+     * Because this is directly tied to the specific type. The value/index type
+     * settings are ignored and type_descriptor is for children objects.
+     *
+     * @param config  the property tree for setting
+     * @param context  the registry
+     * @param td_for_child  the type descriptor for children objects. The
+     *                      default will directly from the specific type.
+     *
+     * @return parameters
+     */
     static parameters_type parse(const config::pnode& config,
                                  const config::registry& context,
-                                 const config::type_descriptor& td_for_child);
+                                 const config::type_descriptor& td_for_child =
+                                     config::make_type_descriptor<ValueType>());
 
 protected:
     void apply_impl(const LinOp* b, LinOp* x) const override;

diff --git a/include/ginkgo/core/solver/triangular.hpp b/include/ginkgo/core/solver/triangular.hpp
@@ -108,9 +108,22 @@ class LowerTrs : public EnableLinOp<LowerTrs<ValueType, IndexType>>,
     GKO_ENABLE_LIN_OP_FACTORY(LowerTrs, parameters, Factory);
     GKO_ENABLE_BUILD_METHOD(Factory);
 
-    static parameters_type parse(const config::pnode& config,
-                                 const config::registry& context,
-                                 const config::type_descriptor& td_for_child);
+    /**
+     * Create the parameters from the property_tree.
+     * Because this is directly tied to the specific type. The value/index type
+     * settings are ignored and type_descriptor is for children objects.
+     *
+     * @param config  the property tree for setting
+     * @param context  the registry
+     * @param td_for_child  the type descriptor for children objects. The
+     *                      default will directly from the specific type.
+     *
+     * @return parameters
+     */
+    static parameters_type parse(
+        const config::pnode& config, const config::registry& context,
+        const config::type_descriptor& td_for_child =
+            config::make_type_descriptor<ValueType, IndexType>());
 
     /**
      * Copy-assigns a triangular solver. Preserves the executor, shallow-copies
@@ -262,9 +275,22 @@ class UpperTrs : public EnableLinOp<UpperTrs<ValueType, IndexType>>,
     GKO_ENABLE_LIN_OP_FACTORY(UpperTrs, parameters, Factory);
     GKO_ENABLE_BUILD_METHOD(Factory);
 
-    static parameters_type parse(const config::pnode& config,
-                                 const config::registry& context,
-                                 const config::type_descriptor& td_for_child);
+    /**
+     * Create the parameters from the property_tree.
+     * Because this is directly tied to the specific type. The value/index type
+     * settings are ignored and type_descriptor is for children objects.
+     *
+     * @param config  the property tree for setting
+     * @param context  the registry
+     * @param td_for_child  the type descriptor for children objects. The
+     *                      default will directly from the specific type.
+     *
+     * @return parameters
+     */
+    static parameters_type parse(
+        const config::pnode& config, const config::registry& context,
+        const config::type_descriptor& td_for_child =
+            config::make_type_descriptor<ValueType, IndexType>());
 
     /**
      * Copy-assigns a triangular solver. Preserves the executor, shallow-copies