clean up comments in solver

2 files changed, 8 insertions, 7 deletions

diff --git a/solver.c b/solver.c
index e5c2899..49b6d29 100644
--- a/solver.c
+++ b/solver.c
@@ -2,11 +2,9 @@
  * solver.c
  * --------
  *
- * gradient-based iterative solver for linear systems of equations
+ * gradient-based iterative solvers for linear systems of equations
  * Ax = b
  *
- * this is the unpreconditioned bicgstab.
- *
  * the return value indicates convergence within max_iter (input) 
  * iterations (0), or no convergence within max_iter iterations (1).
  *
@@ -37,6 +35,11 @@
 
 // ----------------------------------------------------------------------------
 
+/*
+ * preconditioned biconjugate gradient stabilized solver
+ * m    : preconditioner matrix
+ * inout: x0  (in: initial guess, out: final result)
+ */
 int bic(struct diag* a, double* b, double* x0, struct diag* m, double tol)
 {
 
@@ -179,7 +182,6 @@ int bic(struct diag* a, double* b, double* x0, struct diag* m, double tol)
  * symmetric matrices only
  * c    : preconditioner matrix
  * inout: x0  (in: initial guess, out: final result)
- * inout: tol (in: tolerance crit., out: achieved accuracy)
  */
 int pcg(struct diag* a, double* b, double* x0, struct diag* c, double tol)
 {
diff --git a/solver.h b/solver.h
index 964edc3..07c0abb 100644
--- a/solver.h
+++ b/solver.h
@@ -2,11 +2,9 @@
  * solver.h
  * --------
  *
- * gradient-based iterative solver for linear systems of equations
+ * gradient-based iterative solvers for linear systems of equations
  * Ax = b
  *
- * this is the unpreconditioned bicgstab.
- *
  * the return value indicates convergence within max_iter (input) 
  * iterations (0), or no convergence within max_iter iterations (1).
  *
@@ -20,6 +18,7 @@
  * @date 10 apr 17
  * @date 11 apr 17 : add norm function
  * @date 28 apr 17 : add pcg solver
+ * @date  8 jun 17 : add bicgstab solver
  *
  **/