Mercurial > octave-nkf
view src/DLD-FUNCTIONS/givens.cc @ 14501:60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
* __contourc__.cc, __delaunayn__.cc, __dispatch__.cc, __dsearchn__.cc,
__fltk_uigetfile__.cc, __glpk__.cc, __lin_interpn__.cc, __magick_read__.cc,
__pchip_deriv__.cc, __qp__.cc, __voronoi__.cc, besselj.cc, betainc.cc,
bsxfun.cc, cellfun.cc, chol.cc, conv2.cc, convhulln.cc, dassl.cc, det.cc,
dlmread.cc, dmperm.cc, dot.cc, eig.cc, eigs.cc, fft.cc, fft2.cc, filter.cc,
find.cc, gammainc.cc, gcd.cc, givens.cc, hess.cc, hex2num.cc, inv.cc, kron.cc,
lookup.cc, lsode.cc, lu.cc, luinc.cc, matrix_type.cc, max.cc, mgorth.cc,
nproc.cc, qr.cc, quad.cc, quadcc.cc, qz.cc, rand.cc, rcond.cc, regexp.cc,
schur.cc, spparms.cc, sqrtm.cc, str2double.cc, strfind.cc, sub2ind.cc, svd.cc,
syl.cc, time.cc, tril.cc, tsearch.cc: Update %!tests in DLD-FUNCTIONS/
directory with Octave coding conventions.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Tue, 27 Mar 2012 22:46:45 -0700 |
parents | 97883071e8e4 |
children |
line wrap: on
line source
/* Copyright (C) 1996-2012 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/>. */ // Originally written by A. S. Hodel <scotte@eng.auburn.edu> #ifdef HAVE_CONFIG_H #include <config.h> #endif #include "defun-dld.h" #include "error.h" #include "oct-obj.h" DEFUN_DLD (givens, args, nargout, "-*- texinfo -*-\n\ @deftypefn {Loadable Function} {@var{g} =} givens (@var{x}, @var{y})\n\ @deftypefnx {Loadable Function} {[@var{c}, @var{s}] =} givens (@var{x}, @var{y})\n\ @tex\n\ Return a $2\\times 2$ orthogonal matrix\n\ $$\n\ G = \\left[\\matrix{c & s\\cr -s'& c\\cr}\\right]\n\ $$\n\ such that\n\ $$\n\ G \\left[\\matrix{x\\cr y}\\right] = \\left[\\matrix{\\ast\\cr 0}\\right]\n\ $$\n\ with $x$ and $y$ scalars.\n\ @end tex\n\ @ifnottex\n\ Return a 2 by 2 orthogonal matrix\n\ @code{@var{g} = [@var{c} @var{s}; -@var{s}' @var{c}]} such that\n\ @code{@var{g} [@var{x}; @var{y}] = [*; 0]} with @var{x} and @var{y} scalars.\n\ @end ifnottex\n\ \n\ For example:\n\ \n\ @example\n\ @group\n\ givens (1, 1)\n\ @result{} 0.70711 0.70711\n\ -0.70711 0.70711\n\ @end group\n\ @end example\n\ @end deftypefn") { octave_value_list retval; int nargin = args.length (); if (nargin != 2 || nargout > 2) { print_usage (); return retval; } else { if (args(0).is_single_type () || args(1).is_single_type ()) { if (args(0).is_complex_type () || args(1).is_complex_type ()) { FloatComplex cx = args(0).float_complex_value (); FloatComplex cy = args(1).float_complex_value (); if (! error_state) { FloatComplexMatrix result = Givens (cx, cy); if (! error_state) { switch (nargout) { case 0: case 1: retval(0) = result; break; case 2: retval(1) = result (0, 1); retval(0) = result (0, 0); break; default: error ("givens: invalid number of output arguments"); break; } } } } else { float x = args(0).float_value (); float y = args(1).float_value (); if (! error_state) { FloatMatrix result = Givens (x, y); if (! error_state) { switch (nargout) { case 0: case 1: retval(0) = result; break; case 2: retval(1) = result (0, 1); retval(0) = result (0, 0); break; default: error ("givens: invalid number of output arguments"); break; } } } } } else { if (args(0).is_complex_type () || args(1).is_complex_type ()) { Complex cx = args(0).complex_value (); Complex cy = args(1).complex_value (); if (! error_state) { ComplexMatrix result = Givens (cx, cy); if (! error_state) { switch (nargout) { case 0: case 1: retval(0) = result; break; case 2: retval(1) = result (0, 1); retval(0) = result (0, 0); break; default: error ("givens: invalid number of output arguments"); break; } } } } else { double x = args(0).double_value (); double y = args(1).double_value (); if (! error_state) { Matrix result = Givens (x, y); if (! error_state) { switch (nargout) { case 0: case 1: retval(0) = result; break; case 2: retval(1) = result (0, 1); retval(0) = result (0, 0); break; default: error ("givens: invalid number of output arguments"); break; } } } } } } return retval; } /* %!assert (givens (1,1), [1, 1; -1, 1] / sqrt (2), 2*eps) %!assert (givens (1,0), eye (2)) %!assert (givens (0,1), [0, 1; -1 0]) %!error givens () %!error givens (1) */