Mercurial > octave-antonio
view scripts/general/cart2pol.m @ 20158:7503499a252b stable
doc: Update docstrings to have one sentence summary as first line.
Update scripts in audio, elfun, general, geometry, and image directories.
* scripts/audio/@audioplayer/__get_properties__.m,
scripts/audio/@audioplayer/audioplayer.m, scripts/audio/@audioplayer/get.m,
scripts/audio/@audioplayer/isplaying.m, scripts/audio/@audioplayer/play.m,
scripts/audio/@audioplayer/playblocking.m, scripts/audio/@audioplayer/set.m,
scripts/audio/@audioplayer/subsasgn.m, scripts/audio/@audioplayer/subsref.m,
scripts/audio/@audiorecorder/audiorecorder.m,
scripts/audio/@audiorecorder/get.m,
scripts/audio/@audiorecorder/getaudiodata.m,
scripts/audio/@audiorecorder/getplayer.m,
scripts/audio/@audiorecorder/isrecording.m,
scripts/audio/@audiorecorder/play.m, scripts/audio/@audiorecorder/record.m,
scripts/audio/@audiorecorder/recordblocking.m,
scripts/audio/@audiorecorder/set.m, scripts/audio/@audiorecorder/stop.m,
scripts/audio/@audiorecorder/subsasgn.m,
scripts/audio/@audiorecorder/subsref.m, scripts/audio/lin2mu.m,
scripts/audio/mu2lin.m, scripts/audio/record.m, scripts/audio/sound.m,
scripts/audio/soundsc.m, scripts/audio/wavread.m, scripts/audio/wavwrite.m,
scripts/elfun/cosd.m, scripts/elfun/sind.m, scripts/elfun/tand.m,
scripts/general/accumarray.m, scripts/general/accumdim.m,
scripts/general/bitcmp.m, scripts/general/bitget.m, scripts/general/bitset.m,
scripts/general/blkdiag.m, scripts/general/cart2pol.m,
scripts/general/cart2sph.m, scripts/general/cell2mat.m,
scripts/general/celldisp.m, scripts/general/chop.m,
scripts/general/circshift.m, scripts/general/common_size.m,
scripts/general/cplxpair.m, scripts/general/cumtrapz.m,
scripts/general/dblquad.m, scripts/general/deal.m, scripts/general/del2.m,
scripts/general/display.m, scripts/general/divergence.m,
scripts/general/fieldnames.m, scripts/general/flip.m,
scripts/general/flipdim.m, scripts/general/fliplr.m, scripts/general/flipud.m,
scripts/general/gradient.m, scripts/general/interp3.m,
scripts/general/interpft.m, scripts/general/interpn.m,
scripts/general/loadobj.m, scripts/general/logspace.m,
scripts/general/methods.m, scripts/general/nargchk.m,
scripts/general/narginchk.m, scripts/general/nargoutchk.m,
scripts/general/nextpow2.m, scripts/general/nthargout.m,
scripts/general/num2str.m, scripts/general/pol2cart.m,
scripts/general/polyarea.m, scripts/general/postpad.m,
scripts/general/prepad.m, scripts/general/profile.m, scripts/general/quadgk.m,
scripts/general/quadl.m, scripts/general/quadv.m, scripts/general/randi.m,
scripts/general/rat.m, scripts/general/repmat.m, scripts/general/rot90.m,
scripts/general/rotdim.m, scripts/general/saveobj.m, scripts/general/shift.m,
scripts/general/shiftdim.m, scripts/general/sortrows.m,
scripts/general/sph2cart.m, scripts/general/structfun.m,
scripts/general/subsindex.m, scripts/general/trapz.m,
scripts/general/triplequad.m, scripts/geometry/delaunayn.m,
scripts/geometry/dsearch.m, scripts/geometry/dsearchn.m,
scripts/geometry/griddata.m, scripts/geometry/griddata3.m,
scripts/geometry/griddatan.m, scripts/geometry/inpolygon.m,
scripts/geometry/rectint.m, scripts/geometry/tsearchn.m,
scripts/geometry/voronoi.m, scripts/geometry/voronoin.m,
scripts/help/__unimplemented__.m, scripts/help/doc.m,
scripts/help/doc_cache_create.m, scripts/help/get_first_help_sentence.m,
scripts/help/help.m, scripts/help/lookfor.m, scripts/help/print_usage.m,
scripts/help/type.m, scripts/help/which.m, scripts/image/autumn.m,
scripts/image/bone.m, scripts/image/brighten.m, scripts/image/cmpermute.m,
scripts/image/colorcube.m, scripts/image/contrast.m, scripts/image/cool.m,
scripts/image/copper.m, scripts/image/cubehelix.m, scripts/image/flag.m,
scripts/image/gmap40.m, scripts/image/gray.m, scripts/image/gray2ind.m,
scripts/image/hot.m, scripts/image/hsv.m, scripts/image/image.m,
scripts/image/imagesc.m, scripts/image/imfinfo.m, scripts/image/imformats.m,
scripts/image/imread.m, scripts/image/imshow.m, scripts/image/imwrite.m,
scripts/image/iscolormap.m, scripts/image/jet.m, scripts/image/lines.m,
scripts/image/ntsc2rgb.m, scripts/image/ocean.m, scripts/image/pink.m,
scripts/image/prism.m, scripts/image/rainbow.m, scripts/image/rgb2ntsc.m,
scripts/image/spinmap.m, scripts/image/spring.m, scripts/image/summer.m,
scripts/image/white.m, scripts/image/winter.m:
Update docstrings to have one sentence summary as first line.
Re-structure to have line lengths <= 80 chars.
author | Rik <rik@octave.org> |
---|---|
date | Sun, 03 May 2015 09:36:20 -0700 |
parents | 4197fc428c7d |
children |
line wrap: on
line source
## Copyright (C) 2000-2015 Kai Habel ## ## 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{theta}, @var{r}] =} cart2pol (@var{x}, @var{y}) ## @deftypefnx {Function File} {[@var{theta}, @var{r}, @var{z}] =} cart2pol (@var{x}, @var{y}, @var{z}) ## @deftypefnx {Function File} {[@var{theta}, @var{r}] =} cart2pol (@var{C}) ## @deftypefnx {Function File} {[@var{theta}, @var{r}, @var{z}] =} cart2pol (@var{C}) ## @deftypefnx {Function File} {@var{P} =} cart2pol (@dots{}) ## ## Transform Cartesian coordinates to polar or cylindrical coordinates. ## ## The inputs @var{x}, @var{y} (, and @var{z}) must be the same shape, or ## scalar. If called with a single matrix argument then each row of @var{C} ## represents the Cartesian coordinate (@var{x}, @var{y} (, @var{z})). ## ## @var{theta} describes the angle relative to the positive x-axis. ## ## @var{r} is the distance to the z-axis @w{(0, 0, z)}. ## ## If only a single return argument is requested then return a matrix @var{P} ## where each row represents one polar/(cylindrical) coordinate ## (@var{theta}, @var{phi} (, @var{z})). ## @seealso{pol2cart, cart2sph, sph2cart} ## @end deftypefn ## Author: Kai Habel <kai.habel@gmx.de> ## Adapted-by: jwe function [theta, r, z] = cart2pol (x, y, z = []) if (nargin < 1 || nargin > 3) print_usage (); endif if (nargin == 1) if (ismatrix (x) && (columns (x) == 2 || columns (x) == 3)) if (columns (x) == 3) z = x(:,3); endif y = x(:,2); x = x(:,1); else error ("cart2pol: matrix input must have 2 or 3 columns [X, Y (, Z)]"); endif elseif (nargin == 2) if (! ((ismatrix (x) && ismatrix (y)) && (size_equal (x, y) || isscalar (x) || isscalar (y)))) error ("cart2pol: arguments must be matrices of same size, or scalar"); endif elseif (nargin == 3) if (! ((ismatrix (x) && ismatrix (y) && ismatrix (z)) && (size_equal (x, y) || isscalar (x) || isscalar (y)) && (size_equal (x, z) || isscalar (x) || isscalar (z)) && (size_equal (y, z) || isscalar (y) || isscalar (z)))) error ("cart2pol: arguments must be matrices of same size, or scalar"); endif endif theta = atan2 (y, x); r = sqrt (x .^ 2 + y .^ 2); if (nargout <= 1) theta = [theta(:), r(:), z(:)]; endif endfunction %!test %! x = [0, 1, 2]; %! y = 0; %! [t, r] = cart2pol (x, y); %! assert (t, [0, 0, 0]); %! assert (r, x); %!test %! x = [0, 1, 2]; %! y = [0, 1, 2]; %! P = cart2pol (x, y); %! assert (P(:,1), [0; pi/4; pi/4], sqrt (eps)); %! assert (P(:,2), sqrt (2)*[0; 1; 2], sqrt (eps)); %!test %! x = [0, 1, 2]; %! y = [0, 1, 2]; %! z = [0, 1, 2]; %! [t, r, z2] = cart2pol (x, y, z); %! assert (t, [0, pi/4, pi/4], sqrt (eps)); %! assert (r, sqrt (2)*[0, 1, 2], sqrt (eps)); %! assert (z, z2); %!test %! x = [0, 1, 2]; %! y = 0; %! z = 0; %! [t, r, z2] = cart2pol (x, y, z); %! assert (t, [0, 0, 0], eps); %! assert (r, x, eps); %! assert (z, z2); %!test %! x = 0; %! y = [0, 1, 2]; %! z = 0; %! [t, r, z2] = cart2pol (x, y, z); %! assert (t, [0, 1, 1]*pi/2, eps); %! assert (r, y, eps); %! assert (z, z2); %!test %! x = 0; %! y = 0; %! z = [0, 1, 2]; %! [t, r, z2] = cart2pol (x, y, z); %! assert (t, 0); %! assert (r, 0); %! assert (z, z2); %!test %! C = [0, 0; 1, 1; 2, 2]; %! P = [0, 0; pi/4, sqrt(2); pi/4, 2*sqrt(2)]; %! assert (cart2pol (C), P, sqrt (eps)); %!test %! C = [0, 0, 0; 1, 1, 1; 2, 2, 2]; %! P = [0, 0, 0; pi/4, sqrt(2), 1; pi/4, 2*sqrt(2), 2]; %! assert (cart2pol (C), P, sqrt (eps));