add doc for unsupported parameters, and uniform the error message

ginkgo-project · May 30, 2024 · 8eae9e1 · 8eae9e1
1 parent fa82235
commit 8eae9e1
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 4 deletions.
diff --git a/core/config/config_helper.cpp b/core/config/config_helper.cpp
@@ -30,7 +30,7 @@ parse_or_get_factory<const LinOpFactory>(const pnode& config,
     } else if (config.get_tag() == pnode::tag_t::map) {
         return parse(config, context, td);
     } else {
-        GKO_INVALID_STATE("The data of config is not valid.");
+        GKO_INVALID_STATE("The type of config is not valid.");
     }
 }
 
@@ -57,7 +57,7 @@ parse_or_get_factory<const stop::CriterionFactory>(const pnode& config,
         return criterion_map.at(config.get("type").get_string())(config,
                                                                  context, td);
     } else {
-        GKO_INVALID_STATE("The data of config is not valid.");
+        GKO_INVALID_STATE("The type of config is not valid.");
     }
 }
 

diff --git a/core/config/config_helper.hpp b/core/config/config_helper.hpp
@@ -119,7 +119,7 @@ parse_or_get_specific_factory(const pnode& config, const registry& context,
     } else if (config.get_tag() == pnode::tag_t::map) {
         return T_non_const::parse(config, context, td);
     } else {
-        GKO_INVALID_STATE("The data of config is not valid.");
+        GKO_INVALID_STATE("The type of config is not valid.");
     }
 }
 

diff --git a/core/config/trisolver_config.hpp b/core/config/trisolver_config.hpp
@@ -37,7 +37,7 @@ inline void common_trisolver_parse(SolverParam& params, const pnode& config,
         } else if (str == "syncfree") {
             params.with_algorithm(trisolve_algorithm::syncfree);
         } else {
-            GKO_INVALID_STATE("Wrong value for algorithm");
+            GKO_INVALID_CONFIG_VALUE("algorithm", str);
         }
     }
 }

diff --git a/core/preconditioner/jacobi.cpp b/core/preconditioner/jacobi.cpp
@@ -71,6 +71,12 @@ Jacobi<ValueType, IndexType>::parse(const config::pnode& config,
     if (auto& obj = config.get("skip_sorting")) {
         params.with_skip_sorting(gko::config::get_value<bool>(obj));
     }
+    // No array support
+    if (config.get("block_pointers")) {
+        GKO_INVALID_STATE(
+            "preconditioner::Jacobi does not support block_pointers in file "
+            "config.");
+    }
     // storage_optimization_type is not public. It uses precision_reduction
     // as input. It allows value and array input, but we only support the value
     // input [x, y] -> one precision_reduction (value mode)

diff --git a/include/ginkgo/core/preconditioner/jacobi.hpp b/include/ginkgo/core/preconditioner/jacobi.hpp
@@ -513,6 +513,9 @@ class Jacobi : public EnableLinOp<Jacobi<ValueType, IndexType>>,
      *                      default uses the value/index type of this class.
      *
      * @return parameters
+     *
+     * @note Jacobi does not support block_pointers and storage_optimization
+     *       array.
      */
     static parameters_type parse(
         const config::pnode& config, const config::registry& context,

diff --git a/include/ginkgo/core/solver/multigrid.hpp b/include/ginkgo/core/solver/multigrid.hpp
@@ -393,6 +393,8 @@ class Multigrid : public EnableLinOp<Multigrid>,
      * @param td_for_child  the type descriptor for children configs
      *
      * @return parameters
+     *
+     * @note Multigrid does not support the selector option in file config
      */
     static parameters_type parse(const config::pnode& config,
                                  const config::registry& context,