Mercurial > octave-nkf

comparison src/DLD-FUNCTIONS/inv.cc @ 12546:39ca02387a32

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Improve docstrings for a number of functions.
author Rik <octave@nomad.inbox5.com>
date Mon, 28 Mar 2011 16:38:13 -0700
parents 12df7854fa7c
children 5fa482628bf6
comparison
equal deleted inserted replaced
12545:e4a22302dc97 12546:39ca02387a32
36 #include "ov-perm.h" 36 #include "ov-perm.h"
37 #include "utils.h" 37 #include "utils.h"
38 38
39 DEFUN_DLD (inv, args, nargout, 39 DEFUN_DLD (inv, args, nargout,
40 "-*- texinfo -*-\n\ 40 "-*- texinfo -*-\n\
41 @deftypefn {Loadable Function} {[@var{x} =} inv (@var{A})\n\ 41 @deftypefn {Loadable Function} {@var{x} =} inv (@var{A})\n\
42 @deftypefnx {Loadable Function} {[@var{x}, @var{rcond}] =} inv (@var{A})\n\ 42 @deftypefnx {Loadable Function} {[@var{x}, @var{rcond}] =} inv (@var{A})\n\
43 Compute the inverse of the square matrix @var{A}. Return an estimate\n\ 43 Compute the inverse of the square matrix @var{A}. Return an estimate\n\
44 of the reciprocal condition number if requested, otherwise warn of an\n\ 44 of the reciprocal condition number if requested, otherwise warn of an\n\
45 ill-conditioned matrix if the reciprocal condition number is small.\n\ 45 ill-conditioned matrix if the reciprocal condition number is small.\n\
46 \n\ 46 \n\
238 // alias_builtin() won't do the right thing if we are actually using 238 // alias_builtin() won't do the right thing if we are actually using
239 // dynamic linking. 239 // dynamic linking.
240 240
241 DEFUN_DLD (inverse, args, nargout, 241 DEFUN_DLD (inverse, args, nargout,
242 "-*- texinfo -*-\n\ 242 "-*- texinfo -*-\n\
243 @deftypefn {Loadable Function} {[@var{x} =} inverse (@var{A})\n\ 243 @deftypefn {Loadable Function} {@var{x} =} inverse (@var{A})\n\
244 @deftypefnx {Loadable Function} {[@var{x}, @var{rcond}] =} inverse (@var{A})\n\ 244 @deftypefnx {Loadable Function} {[@var{x}, @var{rcond}] =} inverse (@var{A})\n\
245 This in an alias for @code{inv}.\n\ 245 Compute the inverse of the square matrix @var{A}.\n\
246 \n\
247 This is an alias for @code{inv}.\n\
246 @seealso{inv}\n\ 248 @seealso{inv}\n\
247 @end deftypefn") 249 @end deftypefn")
248 { 250 {
249 return Finv (args, nargout); 251 return Finv (args, nargout);
250 } 252 }