review updates

pratikvn · yhmtsai · pratikvn · commit 2260c8faa25a · 2023-10-31T23:46:54.000+01:00
Co-authored-by: Yu-Hsiang Tsai &lt;yhmtsai@gmail.com&gt;
diff --git a/include/ginkgo/core/log/batch_logger.hpp b/include/ginkgo/core/log/batch_logger.hpp
@@ -76,7 +76,7 @@ struct log_data final {
     }
 
     log_data(std::shared_ptr<const Executor> exec, size_type num_batch_items,
-             array<unsigned char> workspace)
+             array<unsigned char>& workspace)
         : res_norms(exec), iter_counts(exec)
     {
         const size_type workspace_size =
diff --git a/include/ginkgo/core/solver/batch_solver_base.hpp b/include/ginkgo/core/solver/batch_solver_base.hpp
@@ -431,8 +431,9 @@ class EnableBatchSolver
         if (b->get_common_size()[1] > 1) {
             GKO_NOT_IMPLEMENTED;
         }
+        auto workspace_view = workspace_.as_view();
         auto log_data_ = std::make_unique<log::detail::log_data<real_type>>(
-            exec, b->get_num_batch_items(), workspace_.as_view());
+            exec, b->get_num_batch_items(), workspace_view);
 
         this->solver_apply(b, x, log_data_.get());
 
diff --git a/include/ginkgo/core/stop/batch_stop_enum.hpp b/include/ginkgo/core/stop/batch_stop_enum.hpp
@@ -44,13 +44,13 @@ namespace stop {
  * solver.
  *
  * `absolute` tolerance implies that the convergence criteria check is
- * against the computed residual ($||r|| <= \tau$)
+ * against the computed residual ($||r|| \leq \tau$)
  *
  * With the `relative` tolerance type, the solver
  * convergence criteria checks against the relative residual norm
- * ($\frac{||r||}{||b||} <= \tau$, where $||b||$$ is the L2 norm of the rhs).
+ * ($||r|| \leq ||b|| \times \tau$, where $||b||$$ is the L2 norm of the rhs).
  *
- * @note the compute residual norm, $||r||$ may be implicit or explicit
+ * @note the computed residual norm, $||r||$ may be implicit or explicit
  * depending on the solver algorithm.
  */
 enum class tolerance_type { absolute, relative };

Original file line number	Diff line number	Diff line change
`@@ -76,7 +76,7 @@ struct log_data final {`
`76`	`76`	`}`
`77`	`77`
`78`	`78`	`log_data(std::shared_ptr<const Executor> exec, size_type num_batch_items,`
`79`		`- array<unsigned char> workspace)`
	`79`	`+ array<unsigned char>& workspace)`
`80`	`80`	`: res_norms(exec), iter_counts(exec)`
`81`	`81`	`{`
`82`	`82`	`const size_type workspace_size =`
Original file line number	Diff line number	Diff line change
`@@ -431,8 +431,9 @@ class EnableBatchSolver`
`431`	`431`	`if (b->get_common_size()[1] > 1) {`
`432`	`432`	`GKO_NOT_IMPLEMENTED;`
`433`	`433`	`}`
	`434`	`+ auto workspace_view = workspace_.as_view();`
`434`	`435`	`auto log_data_ = std::make_unique<log::detail::log_data<real_type>>(`
`435`		`- exec, b->get_num_batch_items(), workspace_.as_view());`
	`436`	`+ exec, b->get_num_batch_items(), workspace_view);`
`436`	`437`
`437`	`438`	`this->solver_apply(b, x, log_data_.get());`
`438`	`439`
Original file line number	Diff line number	Diff line change
`@@ -44,13 +44,13 @@ namespace stop {`
`44`	`44`	`* solver.`
`45`	`45`	`*`
`46`	`46`	* `absolute` tolerance implies that the convergence criteria check is
`47`		`- * against the computed residual ($\|\|r\|\| <= \tau$)`
	`47`	`+ * against the computed residual ($\|\|r\|\| \leq \tau$)`
`48`	`48`	`*`
`49`	`49`	* With the `relative` tolerance type, the solver
`50`	`50`	`* convergence criteria checks against the relative residual norm`
`51`		`- * ($\frac{\|\|r\|\|}{\|\|b\|\|} <= \tau$, where $\|\|b\|\|$$ is the L2 norm of the rhs).`
	`51`	`+ * ($\|\|r\|\| \leq \|\|b\|\| \times \tau$, where $\|\|b\|\|$$ is the L2 norm of the rhs).`
`52`	`52`	`*`
`53`		`- * @note the compute residual norm, $\|\|r\|\|$ may be implicit or explicit`
	`53`	`+ * @note the computed residual norm, $\|\|r\|\|$ may be implicit or explicit`
`54`	`54`	`* depending on the solver algorithm.`
`55`	`55`	`*/`
`56`	`56`	`enum class tolerance_type { absolute, relative };`