Mercurial > octave-libtiff
view libinterp/corefcn/rcond.cc @ 20172:4f45eaf83908 stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed libinterp/corefcn directory.
* libinterp/corefcn/__ilu__.cc, libinterp/corefcn/balance.cc,
libinterp/corefcn/besselj.cc, libinterp/corefcn/betainc.cc,
libinterp/corefcn/bitfcns.cc, libinterp/corefcn/bsxfun.cc,
libinterp/corefcn/cellfun.cc, libinterp/corefcn/colloc.cc,
libinterp/corefcn/conv2.cc, libinterp/corefcn/data.cc,
libinterp/corefcn/debug.cc, libinterp/corefcn/defaults.cc,
libinterp/corefcn/det.cc, libinterp/corefcn/dirfns.cc,
libinterp/corefcn/dlmread.cc, libinterp/corefcn/dot.cc,
libinterp/corefcn/eig.cc, libinterp/corefcn/error.cc,
libinterp/corefcn/fft2.cc, libinterp/corefcn/fftn.cc,
libinterp/corefcn/file-io.cc, libinterp/corefcn/filter.cc,
libinterp/corefcn/find.cc, libinterp/corefcn/gammainc.cc,
libinterp/corefcn/gcd.cc, libinterp/corefcn/getgrent.cc,
libinterp/corefcn/getpwent.cc, libinterp/corefcn/getrusage.cc,
libinterp/corefcn/graphics.cc, libinterp/corefcn/help.cc,
libinterp/corefcn/hex2num.cc, libinterp/corefcn/input.cc,
libinterp/corefcn/inv.cc, libinterp/corefcn/kron.cc,
libinterp/corefcn/load-path.cc, libinterp/corefcn/load-save.cc,
libinterp/corefcn/lookup.cc, libinterp/corefcn/ls-oct-ascii.cc,
libinterp/corefcn/lsode.cc, libinterp/corefcn/lu.cc,
libinterp/corefcn/luinc.cc, libinterp/corefcn/mappers.cc,
libinterp/corefcn/matrix_type.cc, libinterp/corefcn/max.cc,
libinterp/corefcn/md5sum.cc, libinterp/corefcn/mgorth.cc,
libinterp/corefcn/nproc.cc, libinterp/corefcn/oct-hist.cc,
libinterp/corefcn/ordschur.cc, libinterp/corefcn/pager.cc,
libinterp/corefcn/pinv.cc, libinterp/corefcn/pr-output.cc,
libinterp/corefcn/pt-jit.cc, libinterp/corefcn/quad.cc,
libinterp/corefcn/quadcc.cc, libinterp/corefcn/qz.cc,
libinterp/corefcn/rand.cc, libinterp/corefcn/rcond.cc,
libinterp/corefcn/regexp.cc, libinterp/corefcn/schur.cc,
libinterp/corefcn/sighandlers.cc, libinterp/corefcn/sparse.cc,
libinterp/corefcn/spparms.cc, libinterp/corefcn/str2double.cc,
libinterp/corefcn/strfind.cc, libinterp/corefcn/strfns.cc,
libinterp/corefcn/sub2ind.cc, libinterp/corefcn/svd.cc,
libinterp/corefcn/symtab.cc, libinterp/corefcn/syscalls.cc,
libinterp/corefcn/sysdep.cc, libinterp/corefcn/time.cc,
libinterp/corefcn/toplev.cc, libinterp/corefcn/tril.cc,
libinterp/corefcn/tsearch.cc, libinterp/corefcn/typecast.cc,
libinterp/corefcn/urlwrite.cc, libinterp/corefcn/utils.cc,
libinterp/corefcn/variables.cc, scripts/polynomial/spline.m:
Update more docstrings to have one sentence summary as first line.
author | Rik <rik@octave.org> |
---|---|
date | Sat, 09 May 2015 17:19:30 -0700 |
parents | 4197fc428c7d |
children | 8bb38ba1bad6 |
line wrap: on
line source
/* Copyright (C) 2008-2015 David Bateman This file is part of Octave. Octave is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. Octave is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with Octave; see the file COPYING. If not, see <http://www.gnu.org/licenses/>. */ #ifdef HAVE_CONFIG_H #include <config.h> #endif #include "defun.h" #include "error.h" #include "gripes.h" #include "oct-obj.h" #include "utils.h" DEFUN (rcond, args, , "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {@var{c} =} rcond (@var{A})\n\ Compute the 1-norm estimate of the reciprocal condition number as returned\n\ by @sc{lapack}.\n\ \n\ If the matrix is well-conditioned then @var{c} will be near 1 and if the\n\ matrix is poorly conditioned it will be close to 0.\n\ \n\ The matrix @var{A} must not be sparse. If the matrix is sparse then\n\ @code{condest (@var{A})} or @code{rcond (full (@var{A}))} should be used\n\ instead.\n\ @seealso{cond, condest}\n\ @end deftypefn") { octave_value retval; int nargin = args.length (); if (nargin != 1) print_usage (); else if (args(0).is_sparse_type ()) error ("rcond: for sparse matrices use 'rcond (full (a))' or 'condest (a)' instead"); else if (args(0).is_single_type ()) { if (args(0).is_complex_type ()) { FloatComplexMatrix m = args(0).float_complex_matrix_value (); MatrixType mattyp; retval = m.rcond (mattyp); args(0).matrix_type (mattyp); } else { FloatMatrix m = args(0).float_matrix_value (); MatrixType mattyp; retval = m.rcond (mattyp); args(0).matrix_type (mattyp); } } else if (args(0).is_complex_type ()) { ComplexMatrix m = args(0).complex_matrix_value (); MatrixType mattyp; retval = m.rcond (mattyp); args(0).matrix_type (mattyp); } else { Matrix m = args(0).matrix_value (); MatrixType mattyp; retval = m.rcond (mattyp); args(0).matrix_type (mattyp); } return retval; } /* %!assert (rcond (eye (2)), 1) %!assert (rcond (ones (2)), 0) %!assert (rcond ([1 1; 2 1]), 1/9) %!assert (rcond (magic (4)), 0, eps) %!shared x, sx %! x = [-5.25, -2.25; -2.25, 1] * eps () + ones (2) / 2; %! sx = [-5.25, -2.25; -2.25, 1] * eps ("single") + ones (2) / 2; %!assert (rcond (x) < eps ()); %!assert (rcond (sx) < eps ('single')); %!assert (rcond (x*i) < eps ()); %!assert (rcond (sx*i) < eps ('single')); */