[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [CHANGESET] gmres (Last review of PROJECTS file before release)
|
From: |
John W. Eaton |
|
Subject: |
Re: [CHANGESET] gmres (Last review of PROJECTS file before release) |
|
Date: |
Thu, 10 Feb 2011 13:33:06 -0500 |
On 10-Feb-2011, c. wrote:
|
| On 10 Feb 2011, at 17:47, bpabbott wrote:
|
| > I took a quick glance. It looks to me like the example needs to be fixed.
| > <...>
| > Also, please include some additional deftypefnx's after the deftypefn.
| > <...>
| > Ben
|
|
| Ben,
| Thanks for looking at it, I improved the the docstring a bit, what about this
second version?
| +## @deftypefn {Function File} address@hidden, @var{flag}, @var{relres},
@var{iter}, @var{resvec}] =} pgmres (@var{A}, @var{b}, @var{m}, @var{rtol},
@var{maxit}, @var{M1}, @var{M2}, @var{x0})
| +## @deftypefnx {Function File} address@hidden =} pgmres (@var{A}, @var{b})
| +## @deftypefnx {Function File} address@hidden =} pgmres (@var{A}, @var{b},
@var{m})
| +## @deftypefnx {Function File} address@hidden =} pgmres (@var{A}, @var{b},
@var{m}, @var{rtol})
| +## @deftypefnx {Function File} address@hidden =} pgmres (@var{A}, @var{b},
@var{m}, @var{rtol}, @var{maxit})
| +## @deftypefnx {Function File} address@hidden =} pgmres (@var{A}, @var{b},
@var{m}, @var{rtol}, @var{maxit}, @var{P})
| +## @deftypefnx {Function File} address@hidden =} pgmres (@var{A}, @var{b},
@var{m}, @var{rtol}, @var{maxit}, @var{M1}, @var{M2})
| +## @deftypefnx {Function File} address@hidden, @var{flag}] =} pgmres
(@var{A}, @var{b}, ...)
| +## @deftypefnx {Function File} address@hidden, @var{flag}, @var{relres}] =}
pgmres (@var{A}, @var{b}, ...)
| +## @deftypefnx {Function File} address@hidden, @var{flag}, @var{relres},
@var{iter}] =} pgmres (@var{A}, @var{b}, ...)
| +## @deftypefnx {Function File} address@hidden, @var{flag}, @var{relres},
@var{iter}, @var{resvec}] =} pgmres (@var{A}, @var{b}, ...)
It's not necessary to enumerate every possible combination of input
and output arguments. Just write the ones that are significantly
different. The following description can say what inputs get default
values if they are omitted, and users are expected to know that they
can omit outputs, so we only need to document cases where this is not
true (for example, with svd: s = svd (a) vs. [u, s, v] = svd (a)).
So I think you just need
| +## @deftypefn {Function File} address@hidden, @var{flag}, @var{relres},
@var{iter}, @var{resvec}] =} pgmres (@var{A}, @var{b}, @var{m}, @var{rtol},
@var{maxit}, @var{M1}, @var{M2}, @var{x0})
| +## @deftypefnx {Function File} address@hidden, @var{flag}, @var{relres},
@var{iter}, @var{resvec}] =} pgmres (@var{A}, @var{b}, @var{m}, @var{rtol},
@var{maxit}, @var{P})
Or am I missing something about the way behavior changes based on
nargin and nargout?
jwe