comparison libinterp/corefcn/pinv.cc @ 30888:32d2b6604a9f

doc: Ensure documentation lists output argument when it exists for functions in libinterp/ For new users of Octave it is best to show explicit calling forms in the documentation and to show a return argument when it exists. * __ftp__.cc, __magick_read__.cc, __pchip_deriv__.cc, bitfcns.cc, bsxfun.cc, call-stack.cc, cellfun.cc, chol.cc, conv2.cc, data.cc, debug.cc, defaults.cc, det.cc, dirfns.cc, display.cc, dot.cc, error.cc, event-manager.cc, fft.cc, fft2.cc, fftn.cc, file-io.cc, getgrent.cc, getpwent.cc, getrusage.cc, graphics.cc, hash.cc, help.cc, input.cc, interpreter.cc, kron.cc, load-path.cc, mappers.cc, max.cc, nproc.cc, oct-hist.cc, pager.cc, pinv.cc, psi.cc, rand.cc, settings.cc, sighandlers.cc, stream-euler.cc, strfns.cc, symtab.cc, syscalls.cc, sysdep.cc, time.cc, toplev.cc, utils.cc, variables.cc, __fltk_uigetfile__.cc, audiodevinfo.cc, audioread.cc, fftw.cc, ov-bool-mat.cc, ov-cell.cc, ov-class.cc, ov-classdef.cc, ov-fcn-handle.cc, ov-java.cc, ov-struct.cc, ov-typeinfo.cc, ov-usr-fcn.cc, ov.cc, octave.cc, profiler.cc: Add return arguments to @deftypefn macros where they were missing. Attempt to use standard naming convention for return variables. Occasionally improved the docstring itself by re-wording or adding code examples.
author Rik <rik@octave.org>
date Mon, 04 Apr 2022 10:31:48 -0700
parents 09012191bb0c
children 24e45a79bf3c
comparison
equal deleted inserted replaced
30887:4bab8d3fce79 30888:32d2b6604a9f
40 40
41 OCTAVE_NAMESPACE_BEGIN 41 OCTAVE_NAMESPACE_BEGIN
42 42
43 DEFUN (pinv, args, , 43 DEFUN (pinv, args, ,
44 doc: /* -*- texinfo -*- 44 doc: /* -*- texinfo -*-
45 @deftypefn {} {} pinv (@var{x}) 45 @deftypefn {} {@var{B} =} pinv (@var{A})
46 @deftypefnx {} {} pinv (@var{x}, @var{tol}) 46 @deftypefnx {} {@var{B} =} pinv (@var{A}, @var{tol})
47 Return the @nospell{Moore-Penrose} pseudoinverse of @var{x}. 47 Return the @nospell{Moore-Penrose} pseudoinverse of @var{A}.
48 48
49 Singular values less than @var{tol} are ignored. 49 Singular values less than @var{tol} are ignored.
50 50
51 If the second argument is omitted, it is taken to be 51 If the second argument is omitted, it is taken to be
52 52