Mercurial > octave
view scripts/general/pol2cart.m @ 28789:28de41192f3c
Eliminate unneeded verification of nargin, nargout in m-files.
* FIRfilter.m, FIRfilter_aggregation.m, get.m, polynomial.m,
polynomial_superiorto.m, polynomial2.m, makeUniqueStrings.m, base64decode.m,
base64encode.m, cd.m, lin2mu.m, record.m, sound.m, soundsc.m, accumarray.m,
accumdim.m, bitcmp.m, bitset.m, cart2pol.m, celldisp.m, circshift.m,
cplxpair.m, cumtrapz.m, flip.m, idivide.m, interpft.m, logspace.m, pol2cart.m,
polyarea.m, postpad.m, prepad.m, rat.m, rot90.m, rotdim.m, shift.m, shiftdim.m,
sortrows.m, trapz.m, dsearch.m, dsearchn.m, getappdata.m, getpixelposition.m,
guidata.m, guihandles.m, isappdata.m, listfonts.m, uigetdir.m,
waitforbuttonpress.m, __makeinfo__.m, doc.m, get_first_help_sentence.m,
autumn.m, bone.m, brighten.m, cmpermute.m, cmunique.m, colorcube.m, contrast.m,
cool.m, copper.m, cubehelix.m, flag.m, gray.m, gray2ind.m, hot.m, hsv.m,
im2double.m, im2frame.m, imformats.m, jet.m, lines.m, ocean.m, pink.m, prism.m,
rainbow.m, rgbplot.m, spinmap.m, spring.m, summer.m, viridis.m, white.m,
winter.m, beep.m, importdata.m, is_valid_file_id.m, javachk.m, javaclasspath.m,
findstr.m, genvarname.m, strmatch.m, bandwidth.m, commutation_matrix.m, cond.m,
cross.m, isdefinite.m, ishermitian.m, issymmetric.m, krylov.m, linsolve.m,
logm.m, lscov.m, null.m, ordeig.m, orth.m, rank.m, rref.m, vecnorm.m,
bunzip2.m, citation.m, computer.m, copyfile.m, dir.m, dos.m, fileattrib.m,
gunzip.m, inputParser.m, inputname.m, ismac.m, ispc.m, isunix.m, license.m,
list_primes.m, methods.m, mkdir.m, movefile.m, nargchk.m, news.m,
orderfields.m, recycle.m, tar.m, unix.m, unpack.m, untar.m, unzip.m, ver.m,
version.m, what.m, zip.m, decic.m, fminbnd.m, fminunc.m, fsolve.m, fzero.m,
glpk.m, humps.m, lsqnonneg.m, optimget.m, pqpnonneg.m, sqp.m, pathdef.m,
camlookat.m, hidden.m, specular.m, plotmatrix.m, smooth3.m, sombrero.m,
stemleaf.m, __gnuplot_drawnow__.m, __opengl_info__.m, ancestor.m, cla.m,
close.m, closereq.m, copyobj.m, gca.m, gcf.m, ginput.m, graphics_toolkit.m,
groot.m, hgload.m, hgsave.m, isgraphics.m, ishold.m, linkaxes.m, meshgrid.m,
newplot.m, refresh.m, refreshdata.m, rotate.m, saveas.m, struct2hdl.m, conv.m,
mkpp.m, mpoles.m, padecoef.m, pchip.m, polyder.m, polyfit.m, polygcd.m,
polyint.m, polyout.m, polyval.m, ppder.m, ppint.m, getpref.m, ispref.m,
rmpref.m, profexport.m, profshow.m, powerset.m, arch_fit.m, arma_rnd.m,
blackman.m, detrend.m, diffpara.m, fftconv.m, fftfilt.m, filter2.m, freqz.m,
freqz_plot.m, hamming.m, hanning.m, sinetone.m, sinewave.m, spectral_adf.m,
spectral_xdf.m, stft.m, unwrap.m, gplot.m, ichol.m, ilu.m, spdiags.m, sprand.m,
sprandn.m, spstats.m, svds.m, treelayout.m, treeplot.m, betainc.m,
betaincinv.m, ellipke.m, gammainc.m, gammaincinv.m, legendre.m, pow2.m,
hankel.m, pascal.m, rosser.m, toeplitz.m, bounds.m, corr.m, cov.m, histc.m,
kendall.m, kurtosis.m, mad.m, mode.m, moment.m, prctile.m, quantile.m, range.m,
ranks.m, run_count.m, skewness.m, spearman.m, std.m, var.m, zscore.m,
dec2base.m, dec2bin.m, dec2hex.m, index.m, mat2str.m, native2unicode.m,
ostrsplit.m, strjoin.m, strjust.m, strtok.m, substr.m, unicode2native.m,
untabify.m, __debug_octave__.m, demo.m, example.m, fail.m, oruntests.m,
dump_demos.m, speed.m, test.m, date.m, datenum.m, datestr.m, datevec.m,
is_leap_year.m, now.m, weekday.m:
Eliminate unneeded verification of nargin, nargout in m-files now that
the interpreter checks these values.
author | Rik <rik@octave.org> |
---|---|
date | Thu, 24 Sep 2020 14:44:58 -0700 |
parents | e82484e1b2f6 |
children | 90fea9cc9caa |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2000-2020 The Octave Project Developers ## ## See the file COPYRIGHT.md in the top-level directory of this ## distribution or <https://octave.org/copyright/>. ## ## 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 ## <https://www.gnu.org/licenses/>. ## ######################################################################## ## -*- texinfo -*- ## @deftypefn {} {[@var{x}, @var{y}] =} pol2cart (@var{theta}, @var{r}) ## @deftypefnx {} {[@var{x}, @var{y}, @var{z}] =} pol2cart (@var{theta}, @var{r}, @var{z}) ## @deftypefnx {} {[@var{x}, @var{y}] =} pol2cart (@var{P}) ## @deftypefnx {} {[@var{x}, @var{y}, @var{z}] =} pol2cart (@var{P}) ## Transform polar or cylindrical coordinates to Cartesian coordinates. ## ## The inputs @var{theta}, @var{r}, (and @var{z}) must be the same shape, or ## scalar. If called with a single matrix argument then each row of @var{P} ## represents the polar coordinate pair (@var{theta}, @var{r}) or the ## cylindrical triplet (@var{theta}, @var{r}, @var{z}). ## ## The outputs @var{x}, @var{y} (, and @var{z}) match the shape of the inputs. ## For a matrix input @var{P} the outputs will be column vectors with rows ## corresponding to the rows of the input matrix. ## ## @var{theta} describes the angle relative to the positive x-axis measured in ## the xy-plane. ## ## @var{r} is the distance to the z-axis @w{(0, 0, z)}. ## ## @var{z}, if present, is unchanged by the transformation. ## ## The coordinate transformation is computed using: ## ## @tex ## $$ x = r \cos \theta $$ ## $$ y = r \sin \theta $$ ## $$ z = z $$ ## @end tex ## @ifnottex ## ## @example ## @group ## @var{x} = @var{r} * cos (@var{theta}) ## @var{y} = @var{r} * sin (@var{theta}) ## @var{z} = @var{z} ## @end group ## @end example ## ## @end ifnottex ## @c FIXME: Remove this note in Octave 9.1 (two releases after 7.1). ## Note: For @sc{matlab} compatibility, this function no longer returns a full ## coordinate matrix when called with a single return argument. ## @seealso{cart2pol, sph2cart, cart2sph} ## @end deftypefn function [x, y, z] = pol2cart (theta, r, z = []) if (nargin < 1) print_usage (); endif if (nargin == 1) if (! (isnumeric (theta) && ismatrix (theta))) error ("cart2pol: matrix input P must be 2-D numeric array"); endif if (isvector (theta)) n = numel (theta); if (n != 2 && n != 3) error ("cart2pol: matrix input must be a 2- or 3-element vector or a 2- or 3-column array"); endif if (n == 3) z = theta(3); endif r = theta(2); theta = theta(1); else ncols = columns(theta); if (ncols != 2 && ncols != 3) error ("cart2pol: matrix input must be a 2- or 3-element vector or a 2- or 3-column array"); endif if (ncols == 3) z = theta(:,3); endif r = theta(:,2); theta = theta(:,1); endif elseif (nargin == 2) if (! (isnumeric (theta) && isnumeric (r))) error ("pol2cart: THETA, R must be numeric arrays or scalars"); endif [err, theta, r] = common_size (theta, r); if (err) error ("pol2cart: THETA, R must be the same size or scalars"); endif elseif (nargin == 3) if (! (isnumeric (theta) && isnumeric (r) && isnumeric (z))) error ("pol2cart: THETA, R, Z must be numeric arrays or scalars"); endif [err, theta, r, z] = common_size (theta, r, z); if (err) error ("pol2cart: THETA, R, Z must be the same size or scalars"); endif endif x = r .* cos (theta); y = r .* sin (theta); endfunction %!test %! t = [0, 0.5, 1] * pi; %! r = 1; %! [x, y] = pol2cart (t, r); %! assert (x, [1, 0, -1], eps); %! assert (y, [0, 1, 0], eps); %!test %! t = [0, 1, 1] * pi/4; %! r = sqrt (2) * [0, 1, 2]; %! [x, y] = pol2cart (t, r); %! assert (x, [0, 1, 2], 2*eps); %! assert (y, [0, 1, 2], 2*eps); %!test %! t = [0, 1, 1] * pi/4; %! r = sqrt (2) * [0, 1, 2]; %! z = [0, 1, 2]; %! [x, y, z2] = pol2cart (t, r, z); %! assert (x, [0, 1, 2], 2*eps); %! assert (y, [0, 1, 2], 2*eps); %! assert (z2, z); %!test %! t = [0; 1; 1] * pi/4; %! r = sqrt (2) * [0; 1; 2]; %! z = [0; 1; 2]; %! [x, y, z2] = pol2cart (t, r, z); %! assert (x, [0; 1; 2], 2*eps); %! assert (y, [0; 1; 2], 2*eps); %! assert (z2, z); %!test %! t = 0; %! r = [0, 1, 2]; %! z = [0, 1, 2]; %! [x, y, z2] = pol2cart (t, r, z); %! assert (x, [0, 1, 2], eps); %! assert (y, [0, 0, 0], eps); %! assert (z2, z); %!test %! t = [1, 1, 1]*pi/4; %! r = 1; %! z = [0, 1, 2]; %! [x, y, z2] = pol2cart (t, r, z); %! assert (x, [1, 1, 1] / sqrt (2), eps); %! assert (y, [1, 1, 1] / sqrt (2), eps); %! assert (z2, z); %!test %! t = 0; %! r = [1, 2, 3]; %! z = 1; %! [x, y, z2] = pol2cart (t, r, z); %! assert (x, [1, 2, 3], eps); %! assert (y, [0, 0, 0] / sqrt (2), eps); %! assert (z2, [1, 1, 1]); %!test %! P = [0, 0; pi/4, sqrt(2); pi/4, 2*sqrt(2)]; %! [x, y] = pol2cart(P); %! assert (x, [0; 1; 2], 2*eps); %! assert (y, [0; 1; 2], 2*eps); %!test %! P = [0, 0, 0; pi/4, sqrt(2), 1; pi/4, 2*sqrt(2), 2]; %! [x, y, z] = pol2cart(P); %! assert (x, [0; 1; 2], 2*eps); %! assert (y, [0; 1; 2], 2*eps); %! assert (z, P(:,3), 2*eps); %!test %! P = [0, 0, 0; pi/4, sqrt(2), 1; pi/4, 2*sqrt(2), 2; 0, 0, 0]; %! [x, y, z] = pol2cart(P); %! assert (x, [0; 1; 2; 0], 2*eps); %! assert (y, [0; 1; 2; 0], 2*eps); %! assert (z, P(:,3), 2*eps); %!test %! r = ones (1, 1, 1, 2); %! r(1, 1, 1, 2) = 2; %! t = pi/2 * r; %! [x, y] = pol2cart (t, r); %! X = zeros (1, 1, 1, 2); %! X(1, 1, 1, 2) = -2; %! Y = zeros (1, 1, 1, 2); %! Y(1, 1, 1, 1) = 1; %! assert (x, X, 2*eps); %! assert (y, Y, 2*eps); %!test %! [t, r, Z] = meshgrid ([0, pi/2], [1, 2], [0, 1]); %! [x, y, z] = pol2cart (t, r, Z); %! X = zeros(2, 2, 2); %! X(:, 1, 1) = [1; 2]; %! X(:, 1, 2) = [1; 2]; %! Y = zeros(2, 2, 2); %! Y(:, 2, 1) = [1; 2]; %! Y(:, 2, 2) = [1; 2]; %! assert (x, X, eps); %! assert (y, Y, eps); %! assert (z, Z); ## Test input validation %!error pol2cart () %!error pol2cart (1,2,3,4) %!error <matrix input P must be 2-D numeric array> pol2cart ({1,2,3}) %!error <matrix input P must be 2-D numeric array> pol2cart (ones (3,3,2)) %!error <matrix input must be a 2- or 3-element> pol2cart ([1]) %!error <matrix input must be a 2- or 3-element> pol2cart ([1,2,3,4]) %!error <must be numeric arrays or scalars> pol2cart ({1,2,3}, [1,2,3]) %!error <must be numeric arrays or scalars> pol2cart ([1,2,3], {1,2,3}) %!error <must be the same size or scalars> pol2cart (ones (3,3,3), ones (3,2,3)) %!error <must be the same size or scalars> pol2cart ([1; 1], [2, 2]) %!error <must be the same size or scalars> pol2cart ([1; 1], [2, 2], [3, 3]) %!error <must be numeric arrays or scalars> pol2cart ({1,2,3}, [1,2,3], [1,2,3]) %!error <must be numeric arrays or scalars> pol2cart ([1,2,3], {1,2,3}, [1,2,3]) %!error <must be numeric arrays or scalars> pol2cart ([1,2,3], [1,2,3], {1,2,3}) %!error <must be the same size or scalars> pol2cart (ones (3,3,3), 1, ones (3,2,3)) %!error <must be the same size or scalars> pol2cart (ones (3,3,3), ones (3,2,3), 1)