Mercurial > octave
diff libinterp/corefcn/inv.cc @ 27253:7f5008aec7a1 stable
doc: Add function index entry for alias "inverse" bug #56629).
* inv.cc (Finv): Add @deftypefnx entry for "inverse". Add note to
documentation explaining that "inverse" is alias for "inv"
* expr.txi, invhilb.m: Use "inv" rather than "inverse" in @code examples.
| author | Rik <rik@octave.org> |
|---|---|
| date | Mon, 15 Jul 2019 13:57:14 -0700 |
| parents | 00f796120a6d |
| children | 85efcc8f2f89 |
line wrap: on
line diff
--- a/libinterp/corefcn/inv.cc Sat Jul 13 13:06:16 2019 -0700 +++ b/libinterp/corefcn/inv.cc Mon Jul 15 13:57:14 2019 -0700 @@ -39,6 +39,7 @@ doc: /* -*- texinfo -*- @deftypefn {} {@var{x} =} inv (@var{A}) @deftypefnx {} {[@var{x}, @var{rcond}] =} inv (@var{A}) +@deftypefnx {} {[@dots{}] =} inverse (@dots{}) Compute the inverse of the square matrix @var{A}. Return an estimate of the reciprocal condition number if requested, @@ -54,6 +55,8 @@ If called with a sparse matrix, then in general @var{x} will be a full matrix requiring significantly more storage. Avoid forming the inverse of a sparse matrix if possible. + +@code{inverse} is an alias and may be used identically in place of @code{inv}. @seealso{ldivide, rdivide, pinv} @end deftypefn */) {