Place the 'omega' parameter to successive_over_relaxation() first -- a more natural...

[octave.git] / iterative / successive_over_relaxation.m

diff --git a/iterative/successive_over_relaxation.m b/iterative/successive_over_relaxation.m
index 2bb96f8f1a2ca6f41f9828ba1df10a01a2367c8e..71b702db271c07ac4e0e74349b0ed39e70251337 100644 (file)
--- a/iterative/successive_over_relaxation.m
+++ b/iterative/successive_over_relaxation.m
@@ -1,5 +1,5 @@
 function [x, iterations, residual_norms] = ...
-        successive_over_relaxation(A, b, omega, x0, ...
+        successive_over_relaxation(omega, A, b, x0, ...
                                    tolerance, max_iterations)
   %
   % Solve the system,
@@ -26,14 +26,14 @@ function [x, iterations, residual_norms] = ...
   %
   % INPUT:
   %
+  %   ``omega`` -- The relaxation factor.
+  %
   %   ``A`` -- The n-by-n coefficient matrix of the system.
   %
   %   ``b`` -- An n-by-1 vector; the right-hand side of the system.
   %
   %   ``x0`` -- An n-by-1 vector; an initial guess to the solution.
   %
-  %   ``omega`` -- The relaxation factor.
-  %
   %   ``tolerance`` -- (optional; default: 1e-10) the stopping tolerance.
   %                    we stop when the relative error (the infinity norm
   %                     of the residual divided by the infinity norm of