Skip to content

Commit

Permalink
update documentation and rename
Browse files Browse the repository at this point in the history
Co-authored-by: Marcel Koch <[email protected]>
  • Loading branch information
yhmtsai and MarcelKoch committed May 17, 2024
1 parent 40ea774 commit 6c71ab4
Show file tree
Hide file tree
Showing 15 changed files with 18 additions and 18 deletions.
4 changes: 2 additions & 2 deletions core/config/solver_config.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,12 @@ inline void common_solver_configure(SolverFactory& params, const pnode& config,
}
if (auto& obj = config.get("criteria")) {
params.with_criteria(
gko::config::build_or_get_factory_vector<
gko::config::parse_or_get_factory_vector<
const stop::CriterionFactory>(obj, context, td_for_child));
}
if (auto& obj = config.get("preconditioner")) {
params.with_preconditioner(
gko::config::build_or_get_factory<const LinOpFactory>(
gko::config::parse_or_get_factory<const LinOpFactory>(
obj, context, td_for_child));
}
}
Expand Down
2 changes: 1 addition & 1 deletion core/solver/direct.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Direct<ValueType, IndexType>::parse(const config::pnode& config,
}
if (auto& obj = config.get("factorization")) {
factory.with_factorization(
gko::config::build_or_get_factory<const LinOpFactory>(
gko::config::parse_or_get_factory<const LinOpFactory>(
obj, context, td_for_child));
}
return factory;
Expand Down
4 changes: 2 additions & 2 deletions core/solver/ir.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,12 @@ typename Ir<ValueType>::parameters_type Ir<ValueType>::parse(
auto factory = solver::Ir<ValueType>::build();
if (auto& obj = config.get("criteria")) {
factory.with_criteria(
gko::config::build_or_get_factory_vector<
gko::config::parse_or_get_factory_vector<
const stop::CriterionFactory>(obj, context, td_for_child));
}
if (auto& obj = config.get("solver")) {
factory.with_solver(
gko::config::build_or_get_factory<const LinOpFactory>(
gko::config::parse_or_get_factory<const LinOpFactory>(
obj, context, td_for_child));
}
if (auto& obj = config.get("generated_solver")) {
Expand Down
2 changes: 1 addition & 1 deletion include/ginkgo/core/solver/bicg.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ class Bicg

/**
* Create the parameters from the property_tree.
* Because this is directly tied to the specific type. The value/index type
* Because this is directly tied to the specific type, the value/index type
* settings within config are ignored and type_descriptor is only used
* for children objects.
*
Expand Down
2 changes: 1 addition & 1 deletion include/ginkgo/core/solver/bicgstab.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ class Bicgstab

/**
* Create the parameters from the property_tree.
* Because this is directly tied to the specific type. The value/index type
* Because this is directly tied to the specific type, the value/index type
* settings within config are ignored and type_descriptor is only used
* for children objects.
*
Expand Down
2 changes: 1 addition & 1 deletion include/ginkgo/core/solver/cb_gmres.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ class CbGmres : public EnableLinOp<CbGmres<ValueType>>,

/**
* Create the parameters from the property_tree.
* Because this is directly tied to the specific type. The value/index type
* Because this is directly tied to the specific type, the value/index type
* settings within config are ignored and type_descriptor is only used
* for children objects.
*
Expand Down
2 changes: 1 addition & 1 deletion include/ginkgo/core/solver/cg.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ class Cg : public EnableLinOp<Cg<ValueType>>,

/**
* Create the parameters from the property_tree.
* Because this is directly tied to the specific type. The value/index type
* Because this is directly tied to the specific type, the value/index type
* settings within config are ignored and type_descriptor is only used
* for children objects.
*
Expand Down
2 changes: 1 addition & 1 deletion include/ginkgo/core/solver/cgs.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ class Cgs

/**
* Create the parameters from the property_tree.
* Because this is directly tied to the specific type. The value/index type
* Because this is directly tied to the specific type, the value/index type
* settings within config are ignored and type_descriptor is only used
* for children objects.
*
Expand Down
2 changes: 1 addition & 1 deletion include/ginkgo/core/solver/direct.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ class Direct : public EnableLinOp<Direct<ValueType, IndexType>>,

/**
* Create the parameters from the property_tree.
* Because this is directly tied to the specific type. The value/index type
* Because this is directly tied to the specific type, the value/index type
* settings within config are ignored and type_descriptor is only used
* for children objects.
*
Expand Down
2 changes: 1 addition & 1 deletion include/ginkgo/core/solver/fcg.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ class Fcg

/**
* Create the parameters from the property_tree.
* Because this is directly tied to the specific type. The value/index type
* Because this is directly tied to the specific type, the value/index type
* settings within config are ignored and type_descriptor is only used
* for children objects.
*
Expand Down
2 changes: 1 addition & 1 deletion include/ginkgo/core/solver/gcr.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ class Gcr

/**
* Create the parameters from the property_tree.
* Because this is directly tied to the specific type. The value/index type
* Because this is directly tied to the specific type, the value/index type
* settings within config are ignored and type_descriptor is only used
* for children objects.
*
Expand Down
2 changes: 1 addition & 1 deletion include/ginkgo/core/solver/gmres.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ class Gmres

/**
* Create the parameters from the property_tree.
* Because this is directly tied to the specific type. The value/index type
* Because this is directly tied to the specific type, the value/index type
* settings within config are ignored and type_descriptor is only used
* for children objects.
*
Expand Down
2 changes: 1 addition & 1 deletion include/ginkgo/core/solver/idr.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ class Idr

/**
* Create the parameters from the property_tree.
* Because this is directly tied to the specific type. The value/index type
* Because this is directly tied to the specific type, the value/index type
* settings within config are ignored and type_descriptor is only used
* for children objects.
*
Expand Down
2 changes: 1 addition & 1 deletion include/ginkgo/core/solver/ir.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ class Ir : public EnableLinOp<Ir<ValueType>>,

/**
* Create the parameters from the property_tree.
* Because this is directly tied to the specific type. The value/index type
* Because this is directly tied to the specific type, the value/index type
* settings within config are ignored and type_descriptor is only used
* for children objects.
*
Expand Down
4 changes: 2 additions & 2 deletions include/ginkgo/core/solver/triangular.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ class LowerTrs : public EnableLinOp<LowerTrs<ValueType, IndexType>>,

/**
* Create the parameters from the property_tree.
* Because this is directly tied to the specific type. The value/index type
* Because this is directly tied to the specific type, the value/index type
* settings within config are ignored and type_descriptor is only used
* for children objects.
*
Expand Down Expand Up @@ -278,7 +278,7 @@ class UpperTrs : public EnableLinOp<UpperTrs<ValueType, IndexType>>,

/**
* Create the parameters from the property_tree.
* Because this is directly tied to the specific type. The value/index type
* Because this is directly tied to the specific type, the value/index type
* settings within config are ignored and type_descriptor is only used
* for children objects.
*
Expand Down

0 comments on commit 6c71ab4

Please sign in to comment.