Mercurial > octave
view src/DLD-FUNCTIONS/pinv.cc @ 3365:7ed630f7b7be
[project @ 1999-11-20 03:11:17 by jwe]
author | jwe |
---|---|
date | Sat, 20 Nov 1999 03:12:52 +0000 |
parents | 38de16594cb4 |
children | f16c2ce14886 |
line wrap: on
line source
/* Copyright (C) 1996, 1997 John W. Eaton 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 2, 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, write to the Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ #ifdef HAVE_CONFIG_H #include <config.h> #endif #include "defun-dld.h" #include "error.h" #include "gripes.h" #include "oct-obj.h" #include "utils.h" DEFUN_DLD (pinv, args, , "-*- texinfo -*-\n\ @deftypefn {Function File } { } pinv (@var{X}, @var{tol})\n\ Returns the pseudoinverse of X; singular values less than tol are ignored.\n\ \n\ If the second arguement is ommited , it is assummed that\n\ @example\n\ tol = max (size (X)) * sigma_max (X) * eps,\n\ @end example\n\ where sigma_max(X) is the maximal singular value of X.\n\ @end deftypefn") { octave_value_list retval; int nargin = args.length (); if (nargin < 1 || nargin > 2) { print_usage ("pinv"); return retval; } octave_value arg = args(0); double tol = 0.0; if (nargin == 2) tol = args(1).double_value (); if (error_state) return retval; if (tol < 0.0) { error ("pinv: tol must be greater than zero"); return retval; } int arg_is_empty = empty_arg ("pinv", arg.rows (), arg.columns ()); if (arg_is_empty < 0) return retval; else if (arg_is_empty > 0) return Matrix (); if (arg.is_real_type ()) { Matrix m = arg.matrix_value (); if (! error_state) retval = m.pseudo_inverse (tol); } else if (arg.is_complex_type ()) { ComplexMatrix m = arg.complex_matrix_value (); if (! error_state) retval = m.pseudo_inverse (tol); } else { gripe_wrong_type_arg ("pinv", arg); } return retval; } /* ;;; Local Variables: *** ;;; mode: C++ *** ;;; End: *** */