Mercurial > octave
view libinterp/corefcn/det.cc @ 20909:03e4ddd49396
omit unnecessary nargout checks
* paramdemo.cc, __ichol__.cc, __ilu__.cc, balance.cc, dassl.cc,
eig.cc, ellipj.cc, filter.cc, givens.cc, hess.cc, lsode.cc, lu.cc,
mgorth.cc, nproc.cc, pr-output.cc, quad.cc, quadcc.cc, sylvester.cc,
urlwrite.cc, variables.cc, ccolamd.cc, colamd.cc, qr.cc: Don't call
print_usage based on value of nargout. If nargout doesn't alter
function behavior and returning extra values is inexpensive, simply
return them instead of checking nargout.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Wed, 16 Dec 2015 11:41:11 -0500 |
parents | 8da80da1ac37 |
children | 48b2ad5ee801 |
line wrap: on
line source
/* Copyright (C) 1996-2015 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 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 "DET.h" #include "defun.h" #include "error.h" #include "gripes.h" #include "oct-obj.h" #include "utils.h" #include "ops.h" #include "ov-re-mat.h" #include "ov-cx-mat.h" #include "ov-flt-re-mat.h" #include "ov-flt-cx-mat.h" #include "ov-re-diag.h" #include "ov-cx-diag.h" #include "ov-flt-re-diag.h" #include "ov-flt-cx-diag.h" #include "ov-perm.h" #define MAYBE_CAST(VAR, CLASS) \ const CLASS *VAR = arg.type_id () == CLASS::static_type_id () ? \ dynamic_cast<const CLASS *> (&arg.get_rep ()) : 0 DEFUN (det, args, nargout, "-*- texinfo -*-\n\ @deftypefn {} {} det (@var{A})\n\ @deftypefnx {} {[@var{d}, @var{rcond}] =} det (@var{A})\n\ Compute the determinant of @var{A}.\n\ \n\ Return an estimate of the reciprocal condition number if requested.\n\ \n\ Programming Notes: Routines from @sc{lapack} are used for full matrices and\n\ code from @sc{umfpack} is used for sparse matrices.\n\ \n\ The determinant should not be used to check a matrix for singularity.\n\ For that, use any of the condition number functions: @code{cond},\n\ @code{condest}, @code{rcond}.\n\ @seealso{cond, condest, rcond}\n\ @end deftypefn") { if (args.length () != 1) print_usage (); octave_value arg = args(0); octave_idx_type nr = arg.rows (); octave_idx_type nc = arg.columns (); if (nr == 0 && nc == 0) return octave_value (1.0); int arg_is_empty = empty_arg ("det", nr, nc); if (arg_is_empty < 0) return octave_value_list (); if (arg_is_empty > 0) return octave_value (1.0); if (nr != nc) { gripe_square_matrix_required ("det"); return octave_value_list (); } octave_value_list retval (2); bool isfloat = arg.is_single_type (); if (arg.is_diag_matrix ()) { if (nargout <= 1) retval.resize (1); if (arg.is_complex_type ()) { if (isfloat) { retval(0) = arg.float_complex_diag_matrix_value () .determinant ().value (); if (nargout > 1) retval(1) = arg.float_complex_diag_matrix_value ().rcond (); } else { retval(0) = arg.complex_diag_matrix_value () .determinant ().value (); if (nargout > 1) retval(1) = arg.complex_diag_matrix_value ().rcond (); } } else { if (isfloat) { retval(0) = arg.float_diag_matrix_value () .determinant ().value (); if (nargout > 1) retval(1) = arg.float_diag_matrix_value ().rcond (); } else { retval(0) = arg.diag_matrix_value ().determinant ().value (); if (nargout > 1) retval(1) = arg.diag_matrix_value ().rcond (); } } } else if (arg.is_perm_matrix ()) { if (nargout <= 1) retval.resize (1); retval(0) = static_cast<double> (arg.perm_matrix_value ().determinant ()); if (nargout > 1) retval(1) = 1.0; } else if (arg.is_single_type ()) { if (arg.is_real_type ()) { octave_idx_type info; float rcond = 0.0; // Always compute rcond, so we can detect singular matrices. FloatMatrix m = arg.float_matrix_value (); MAYBE_CAST (rep, octave_float_matrix); MatrixType mtype = rep ? rep -> matrix_type () : MatrixType (); FloatDET det = m.determinant (mtype, info, rcond); retval(0) = info == -1 ? 0.0f : det.value (); retval(1) = rcond; if (rep) rep->matrix_type (mtype); } else if (arg.is_complex_type ()) { octave_idx_type info; float rcond = 0.0; // Always compute rcond, so we can detect singular matrices. FloatComplexMatrix m = arg.float_complex_matrix_value (); MAYBE_CAST (rep, octave_float_complex_matrix); MatrixType mtype = rep ? rep -> matrix_type () : MatrixType (); FloatComplexDET det = m.determinant (mtype, info, rcond); retval(0) = info == -1 ? FloatComplex (0.0) : det.value (); retval(1) = rcond; if (rep) rep->matrix_type (mtype); } } else { if (arg.is_real_type ()) { octave_idx_type info; double rcond = 0.0; // Always compute rcond, so we can detect singular matrices. if (arg.is_sparse_type ()) { SparseMatrix m = arg.sparse_matrix_value (); DET det = m.determinant (info, rcond); retval(0) = info == -1 ? 0.0 : det.value (); retval(1) = rcond; } else { Matrix m = arg.matrix_value (); MAYBE_CAST (rep, octave_matrix); MatrixType mtype = rep ? rep -> matrix_type () : MatrixType (); DET det = m.determinant (mtype, info, rcond); retval(0) = info == -1 ? 0.0 : det.value (); retval(1) = rcond; if (rep) rep->matrix_type (mtype); } } else if (arg.is_complex_type ()) { octave_idx_type info; double rcond = 0.0; // Always compute rcond, so we can detect singular matrices. if (arg.is_sparse_type ()) { SparseComplexMatrix m = arg.sparse_complex_matrix_value (); ComplexDET det = m.determinant (info, rcond); retval(0) = info == -1 ? Complex (0.0) : det.value (); retval(1) = rcond; } else { ComplexMatrix m = arg.complex_matrix_value (); MAYBE_CAST (rep, octave_complex_matrix); MatrixType mtype = rep ? rep -> matrix_type () : MatrixType (); ComplexDET det = m.determinant (mtype, info, rcond); retval(0) = info == -1 ? Complex (0.0) : det.value (); retval(1) = rcond; if (rep) rep->matrix_type (mtype); } } else gripe_wrong_type_arg ("det", arg); } return retval; } /* %!assert (det ([1, 2; 3, 4]), -2, 10*eps) %!assert (det (single ([1, 2; 3, 4])), single (-2), 10*eps ("single")) %!error det () %!error det (1, 2) %!error <argument must be a square matrix> det ([1, 2; 3, 4; 5, 6]) */