fix typo and move impl

ginkgo-project · May 17, 2024 · 3b4ca2e · 3b4ca2e
1 parent 43e0a79
commit 3b4ca2e
Show file tree

Hide file tree

Showing 6 changed files with 29 additions and 29 deletions.
diff --git a/core/config/config_helper.cpp b/core/config/config_helper.cpp
@@ -18,21 +18,6 @@ namespace gko {
 namespace config {
 
 
-type_descriptor update_type(const pnode& config, const type_descriptor& td)
-{
-    auto value_typestr = td.get_value_typestr();
-    auto index_typestr = td.get_index_typestr();
-
-    if (auto& obj = config.get("value_type")) {
-        value_typestr = obj.get_string();
-    }
-    if (auto& obj = config.get("index_type")) {
-        index_typestr = obj.get_string();
-    }
-    return type_descriptor{value_typestr, index_typestr};
-}
-
-
 template <>
 deferred_factory_parameter<const LinOpFactory> get_factory<const LinOpFactory>(
     const pnode& config, const registry& context, const type_descriptor& td)

diff --git a/core/config/config_helper.hpp b/core/config/config_helper.hpp
@@ -27,7 +27,7 @@ namespace config {
 
 
 /**
- * LinOpFactoryType enum is to avoid forward declartion, linopfactory header,
+ * LinOpFactoryType enum is to avoid forward declaration, linopfactory header,
  * two template versions of parse
  */
 enum class LinOpFactoryType : int { Cg = 0 };

diff --git a/core/config/type_descriptor.cpp b/core/config/type_descriptor.cpp
@@ -12,6 +12,21 @@ namespace gko {
 namespace config {
 
 
+type_descriptor update_type(const pnode& config, const type_descriptor& td)
+{
+    auto value_typestr = td.get_value_typestr();
+    auto index_typestr = td.get_index_typestr();
+
+    if (auto& obj = config.get("value_type")) {
+        value_typestr = obj.get_string();
+    }
+    if (auto& obj = config.get("index_type")) {
+        index_typestr = obj.get_string();
+    }
+    return type_descriptor{value_typestr, index_typestr};
+}
+
+
 template <typename ValueType, typename IndexType>
 type_descriptor make_type_descriptor()
 {

diff --git a/core/test/config/type_descriptor.cpp b/core/test/config/type_descriptor.cpp
@@ -18,7 +18,7 @@ using namespace gko::config;
 TEST(TypeDescriptor, TemplateCreate)
 {
     {
-        SCOPED_TRACE("defaule template");
+        SCOPED_TRACE("default template");
         auto td = make_type_descriptor<>();
 
         ASSERT_EQ(td.get_value_typestr(), "float64");
@@ -51,7 +51,7 @@ TEST(TypeDescriptor, TemplateCreate)
 TEST(TypeDescriptor, Constructor)
 {
     {
-        SCOPED_TRACE("defaule constructor");
+        SCOPED_TRACE("default constructor");
         type_descriptor td;
 
         ASSERT_EQ(td.get_value_typestr(), "float64");

diff --git a/include/ginkgo/core/config/config.hpp b/include/ginkgo/core/config/config.hpp
@@ -43,7 +43,7 @@ class pnode;
  *    enum value. `"baseline": "absolute"` will select the absolute baseline in
  *    ResidualNorm critrion
  * 4. `"type"` is the new key to select the class without template type. We also
- *    prepand the namespace except for gko. For example, we use "solver::Cg" for
+ *    prepend the namespace except for gko. For example, we use "solver::Cg" for
  *    Cg solver. Note. the template type is given by the another entry or from
  *    the type_descriptor.
  * 5. the data type uses fixed-width representation
@@ -89,8 +89,8 @@ class pnode;
  * type_descriptor. For example:
  * ```c++
  * auto gmres_factory =
- *     build_from_config(config, context,
- *                       make_type_descriptor<float32, int32>());
+ *     parse(config, context,
+ *           make_type_descriptor<float32, int32>());
  * ```
  * will lead to a GMRES solver that uses `float` as its value type.
  * Additionally, the config can be used to set these types through the fields:

diff --git a/include/ginkgo/core/config/registry.hpp b/include/ginkgo/core/config/registry.hpp
@@ -168,27 +168,27 @@ class registry final {
      * registry constructor
      *
      * @param additional_map  the additional map to dispatch the class base.
-     * Users can extend this map to fit their own LinOpFactory.
+     *                        Users can extend map to fit their own
+     *                        LinOpFactory.
      */
     registry(const configuration_map& additional_map = {});
 
     /**
      * registry constructor
      *
-     * @param additional_map  the additional map to dispatch the class base.
-     * Users can extend this map to fit their own LinOpFactory.
      * @param stored_map  the map stores the shared pointer of users' objects.
-     * It can hold any type whose base type is
-     * LinOp/LinOpFactory/CriterionFactory. For example,
+     *                    It can hold any type whose base type is
+     *                    LinOp/LinOpFactory/CriterionFactory.
+     * For example,
      * ```
      * {{
      *   {"csr", csr_shared_ptr},
      *   {"cg", cg_shared_ptr}
      * }}
      * ```
-     * @param build_map  the build map to dispatch the class base. Ginkgo
-     * provides `generate_config_map()` in config.hpp to provide the ginkgo
-     * build map. Users can extend this map to fit their own LinOpFactory.
+     * @param additional_map  the additional map to dispatch the class base.
+     *                        Users can extend map to fit their own
+     *                        LinOpFactory.
      */
     registry(
         const std::unordered_map<std::string, detail::allowed_ptr>& stored_map,