Mercurial > octave-antonio
view scripts/general/sph2cart.m @ 20164:df437a52bcaf stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed miscellaneous, sparse, strings in scripts directory.
* scripts/miscellaneous/bzip2.m, scripts/miscellaneous/citation.m,
scripts/miscellaneous/compare_versions.m, scripts/miscellaneous/computer.m,
scripts/miscellaneous/debug.m, scripts/miscellaneous/dir.m,
scripts/miscellaneous/edit.m, scripts/miscellaneous/error_ids.m,
scripts/miscellaneous/fileattrib.m, scripts/miscellaneous/fullfile.m,
scripts/miscellaneous/genvarname.m, scripts/miscellaneous/gzip.m,
scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/news.m,
scripts/miscellaneous/open.m, scripts/miscellaneous/parseparams.m,
scripts/miscellaneous/recycle.m, scripts/miscellaneous/run.m,
scripts/miscellaneous/swapbytes.m, scripts/miscellaneous/tar.m,
scripts/miscellaneous/tmpnam.m, scripts/miscellaneous/unpack.m,
scripts/miscellaneous/what.m, scripts/sparse/bicg.m, scripts/sparse/bicgstab.m,
scripts/sparse/cgs.m, scripts/sparse/colperm.m, scripts/sparse/eigs.m,
scripts/sparse/etreeplot.m, scripts/sparse/gmres.m, scripts/sparse/gplot.m,
scripts/sparse/ichol.m, scripts/sparse/ilu.m, scripts/sparse/pcg.m,
scripts/sparse/pcr.m, scripts/sparse/qmr.m, scripts/sparse/spaugment.m,
scripts/sparse/spconvert.m, scripts/sparse/spdiags.m, scripts/sparse/spfun.m,
scripts/sparse/spones.m, scripts/sparse/sprandsym.m, scripts/sparse/spstats.m,
scripts/sparse/spy.m, scripts/sparse/svds.m, scripts/sparse/treelayout.m,
scripts/sparse/treeplot.m, scripts/strings/base2dec.m,
scripts/strings/bin2dec.m, scripts/strings/blanks.m, scripts/strings/cstrcat.m,
scripts/strings/deblank.m, scripts/strings/dec2base.m,
scripts/strings/dec2bin.m, scripts/strings/dec2hex.m,
scripts/strings/findstr.m, scripts/strings/hex2dec.m, scripts/strings/index.m,
scripts/strings/isletter.m, scripts/strings/isstrprop.m,
scripts/strings/mat2str.m, scripts/strings/ostrsplit.m,
scripts/strings/regexptranslate.m, scripts/strings/rindex.m,
scripts/strings/str2num.m, scripts/strings/strcat.m, scripts/strings/strchr.m,
scripts/strings/strjoin.m, scripts/strings/strjust.m,
scripts/strings/strmatch.m, scripts/strings/strsplit.m,
scripts/strings/strtok.m, scripts/strings/strtrim.m,
scripts/strings/strtrunc.m, scripts/strings/substr.m,
scripts/strings/untabify.m, scripts/time/datenum.m:
Update more docstrings to have one sentence summary as first line.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 04 May 2015 14:22:02 -0700 |
parents | 7503499a252b |
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{x}, @var{y}, @var{z}] =} sph2cart (@var{theta}, @var{phi}, @var{r}) ## @deftypefnx {Function File} {[@var{x}, @var{y}, @var{z}] =} sph2cart (@var{S}) ## @deftypefnx {Function File} {@var{C} =} sph2cart (@dots{}) ## Transform spherical coordinates to Cartesian coordinates. ## ## The inputs @var{theta}, @var{phi}, and @var{r} must be the same shape, or ## scalar. If called with a single matrix argument then each row of @var{S} ## represents the spherical coordinate (@var{theta}, @var{phi}, @var{r}). ## ## @var{theta} describes the angle relative to the positive x-axis. ## ## @var{phi} is the angle relative to the xy-plane. ## ## @var{r} is the distance to the origin @w{(0, 0, 0)}. ## ## If only a single return argument is requested then return a matrix @var{C} ## where each row represents one Cartesian coordinate ## (@var{x}, @var{y}, @var{z}). ## @seealso{cart2sph, pol2cart, cart2pol} ## @end deftypefn ## Author: Kai Habel <kai.habel@gmx.de> ## Adapted-by: jwe function [x, y, z] = sph2cart (theta, phi, r) if (nargin != 1 && nargin != 3) print_usage (); endif if (nargin == 1) if (ismatrix (theta) && columns (theta) == 3) r = theta(:,3); phi = theta(:,2); theta = theta(:,1); else error ("sph2cart: matrix input must have 3 columns [THETA, PHI, R]"); endif elseif (nargin == 3) if (! ((ismatrix (theta) && ismatrix (phi) && ismatrix (r)) && (size_equal (theta, phi) || isscalar (theta) || isscalar (phi)) && (size_equal (theta, r) || isscalar (theta) || isscalar (r)) && (size_equal (phi, r) || isscalar (phi) || isscalar (r)))) error ("sph2cart: THETA, PHI, and R must be matrices of the same size, or scalar"); endif endif x = r .* cos (phi) .* cos (theta); y = r .* cos (phi) .* sin (theta); z = r .* sin (phi); if (nargout <= 1) x = [x(:), y(:), z(:)]; endif endfunction %!test %! t = [0, 0, 0]; %! p = [0, 0, 0]; %! r = [0, 1, 2]; %! [x, y, z] = sph2cart (t, p, r); %! assert (x, r); %! assert (y, [0, 0, 0]); %! assert (z, [0, 0, 0]); %!test %! t = 0; %! p = [0, 0, 0]; %! r = [0, 1, 2]; %! C = sph2cart (t, p, r); %! assert (C(:,1), r(:)); %! assert (C(:,2), [0; 0; 0]); %! assert (C(:,3), [0; 0; 0]); %!test %! t = [0, 0, 0]; %! p = 0; %! r = [0, 1, 2]; %! [x, y, z] = sph2cart (t, p, r); %! assert (x, r); %! assert (y, [0, 0, 0]); %! assert (z, [0, 0, 0]); %!test %! t = [0, 0.5, 1]*pi; %! p = [0, 0, 0]; %! r = 1; %! [x, y, z] = sph2cart (t, p, r); %! assert (x, [1, 0, -1], eps); %! assert (y, [0, 1, 0], eps); %! assert (z, [0, 0, 0], eps); %!test %! S = [ 0, 0, 1; 0.5*pi, 0, 1; pi, 0, 1]; %! C = [ 1, 0, 0; 0, 1, 0; -1, 0, 0]; %! assert (sph2cart (S), C, eps);