Mercurial > hg > octave-lojdl
view scripts/linear-algebra/planerot.m @ 9211:f0c3d3fc4903
Simplify Texinfo documentation in .m scripts by removing redundant @iftex calls
author | Rik <rdrider0-list@yahoo.com> |
---|---|
date | Sun, 17 May 2009 14:39:39 -0700 |
parents | 23c248d415b5 |
children | 16f53d29049f |
line wrap: on
line source
## Copyright (C) 2008 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/>. ## -*- texinfo -*- ## @deftypefn {Function File} {[@var{g}, @var{y}] =} planerot (@var{x}) ## Given a two-element column vector, returns the ## @tex ## $2 \times 2$ orthogonal matrix ## @end tex ## @ifnottex ## 2 by 2 orthogonal matrix ## @end ifnottex ## @var{G} such that ## @code{@var{y} = @var{g} * @var{x}} and @code{@var{y}(2) = 0}. ## @seealso{givens} ## @end deftypefn function [G, y] = planerot (x) G = givens (x(1), x(2)); y = G * x(:); endfunction