From: Michael Orlitzky Date: Tue, 7 May 2013 17:56:20 +0000 (-0400) Subject: Place the 'omega' parameter to successive_over_relaxation() first -- a more natural... X-Git-Url: http://gitweb.michael.orlitzky.com/?p=octave.git;a=commitdiff_plain;h=cd4c36a426fb5a9105e0b834e69cfd78960337ce Place the 'omega' parameter to successive_over_relaxation() first -- a more natural position. --- diff --git a/iterative/gauss_seidel.m b/iterative/gauss_seidel.m index a844142..62826fb 100644 --- a/iterative/gauss_seidel.m +++ b/iterative/gauss_seidel.m @@ -13,9 +13,9 @@ function [x, iterations, residual_norms] = ... if (nargout > 2) [x, iterations, residual_norms] = ... - successive_over_relaxation(A, b, omega, x0, tolerance, max_iterations); + successive_over_relaxation(omega, A, b, x0, tolerance, max_iterations); else [x, iterations] = ... - successive_over_relaxation(A, b, omega, x0, tolerance, max_iterations); + successive_over_relaxation(omega, A, b, x0, tolerance, max_iterations); end end diff --git a/iterative/successive_over_relaxation.m b/iterative/successive_over_relaxation.m index 2bb96f8..71b702d 100644 --- 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