octave: scripts/geometry/roty.m annotate

annotate scripts/geometry/roty.m @ 33632:fed0dc6fd44c default tip

remove unused variable from libgui/module.mk * libgui/module.mk: remove empty variable OCTAVE_GUI_EDITOR_MOC

author	Torsten Lilge <ttl-octave@mailbox.org>
date	Mon, 27 May 2024 19:42:05 +0200
parents	2e484f9f1f18
children

rev	line source
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	1 ########################################################################
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	2 ##
32632 2e484f9f1f18 maint: update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 31706 diff changeset	3 ## Copyright (C) 2019-2024 The Octave Project Developers
27918 b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 27801 diff changeset	4 ##
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	5 ## See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	6 ## distribution or <https://octave.org/copyright/>.
27274 f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	7 ##
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	8 ## This file is part of Octave.
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	9 ##
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	10 ## Octave is free software: you can redistribute it and/or modify it
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	11 ## under the terms of the GNU General Public License as published by
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	12 ## the Free Software Foundation, either version 3 of the License, or
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	13 ## (at your option) any later version.
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	14 ##
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	15 ## Octave is distributed in the hope that it will be useful, but
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	16 ## WITHOUT ANY WARRANTY; without even the implied warranty of
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	17 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	18 ## GNU General Public License for more details.
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	19 ##
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	20 ## You should have received a copy of the GNU General Public License
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	21 ## along with Octave; see the file COPYING. If not, see
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	22 ## <https://www.gnu.org/licenses/>.
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	23 ##
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	24 ########################################################################
27274 f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	25
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	26 ## -- texinfo --
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	27 ## @deftypefn {} {@var{T} =} roty (@var{angle})
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	28 ##
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	29 ## @code{roty} returns the 3x3 transformation matrix corresponding to an active
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	30 ## rotation of a vector about the y-axis by the specified @var{angle}, given in
27794 45ad2127582b doc: grammarcheck scripts before 6.1 release. Rik <rik@octave.org> parents: 27274 diff changeset	31 ## degrees, where a positive angle corresponds to a counterclockwise
27274 f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	32 ## rotation when viewing the z-x plane from the positive y side.
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	33 ##
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	34 ## The form of the transformation matrix is:
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	35 ## @tex
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	36 ## $$
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	37 ## T = \left[\matrix{ \cos(angle) & 0 & \sin(angle) \cr
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	38 ## 0 & 1 & 0 \cr
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	39 ## -\sin(angle) & 0 & \cos(angle)}\right].
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	40 ## $$
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	41 ## @end tex
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	42 ## @ifnottex
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	43 ##
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	44 ## @example
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	45 ## @group
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	46 ## \| cos(@var{angle}) 0 sin(@var{angle}) \|
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	47 ## T = \| 0 1 0 \|
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	48 ## \| -sin(@var{angle}) 0 cos(@var{angle}) \|
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	49 ## @end group
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	50 ## @end example
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	51 ## @end ifnottex
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	52 ##
27801 1d04f049a859 doc: spellcheck documentation ahead of 6.1 release. Rik <rik@octave.org> parents: 27794 diff changeset	53 ## This rotation matrix is intended to be used as a left-multiplying matrix
28920 601b6c7728ed maint: match names in documentation to input parameters in function. Rik <rik@octave.org> parents: 28891 diff changeset	54 ## when acting on a column vector, using the notation
601b6c7728ed maint: match names in documentation to input parameters in function. Rik <rik@octave.org> parents: 28891 diff changeset	55 ## @code{@var{v} = @var{T}*@var{u}}.
27274 f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	56 ## For example, a vector, @var{u}, pointing along the positive z-axis, rotated
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	57 ## 90-degrees about the y-axis, will result in a vector pointing along the
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	58 ## positive x-axis:
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	59 ##
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	60 ## @example
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	61 ## @group
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	62 ## >> u = [0 0 1]'
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	63 ## u =
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	64 ## 0
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	65 ## 0
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	66 ## 1
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	67 ##
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	68 ## >> T = roty (90)
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	69 ## T =
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	70 ## 0.00000 0.00000 1.00000
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	71 ## 0.00000 1.00000 0.00000
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	72 ## -1.00000 0.00000 0.00000
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	73 ##
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	74 ## >> v = T*u
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	75 ## v =
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	76 ## 1.00000
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	77 ## 0.00000
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	78 ## 0.00000
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	79 ## @end group
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	80 ## @end example
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	81 ##
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	82 ## @seealso{rotx, rotz}
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	83 ## @end deftypefn
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	84
28920 601b6c7728ed maint: match names in documentation to input parameters in function. Rik <rik@octave.org> parents: 28891 diff changeset	85 function T = roty (angle)
27274 f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	86
28920 601b6c7728ed maint: match names in documentation to input parameters in function. Rik <rik@octave.org> parents: 28891 diff changeset	87 if (nargin < 1 \|\| ! isscalar (angle))
27274 f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	88 print_usage ();
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	89 endif
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	90
28920 601b6c7728ed maint: match names in documentation to input parameters in function. Rik <rik@octave.org> parents: 28891 diff changeset	91 angle *= pi / 180;
27274 f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	92
28920 601b6c7728ed maint: match names in documentation to input parameters in function. Rik <rik@octave.org> parents: 28891 diff changeset	93 s = sin (angle);
601b6c7728ed maint: match names in documentation to input parameters in function. Rik <rik@octave.org> parents: 28891 diff changeset	94 c = cos (angle);
27274 f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	95
28920 601b6c7728ed maint: match names in documentation to input parameters in function. Rik <rik@octave.org> parents: 28891 diff changeset	96 T = [c 0 s; 0 1 0; -s 0 c];
27274 f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	97
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	98 endfunction
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	99
28886 d8318c12d903 test: remove unnecessary BIST tests in m-files checking for excessive number of inputs. Rik <rik@octave.org> parents: 27985 diff changeset	100
27274 f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	101 ## Function output tests
28886 d8318c12d903 test: remove unnecessary BIST tests in m-files checking for excessive number of inputs. Rik <rik@octave.org> parents: 27985 diff changeset	102 %!assert (roty (0), [1 0 0; 0 1 0; 0 0 1])
d8318c12d903 test: remove unnecessary BIST tests in m-files checking for excessive number of inputs. Rik <rik@octave.org> parents: 27985 diff changeset	103 %!assert (roty (45), [sqrt(2) 0 sqrt(2); 0 2 0; -sqrt(2) 0 sqrt(2)]./2, 1e-12)
d8318c12d903 test: remove unnecessary BIST tests in m-files checking for excessive number of inputs. Rik <rik@octave.org> parents: 27985 diff changeset	104 %!assert (roty (90), [0 0 1; 0 1 0; -1 0 0], 1e-12)
d8318c12d903 test: remove unnecessary BIST tests in m-files checking for excessive number of inputs. Rik <rik@octave.org> parents: 27985 diff changeset	105 %!assert (roty (180), [-1 0 0; 0 1 0; 0 0 -1], 1e-12)
27274 f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	106
f49226d21c26 Implement missing functions rotx, roty, and rotz (bug #50772, patch #9310) Nicholas R. Jankowski <jankowskin@asme.org> parents: diff changeset	107 ## Test input validation
28886 d8318c12d903 test: remove unnecessary BIST tests in m-files checking for excessive number of inputs. Rik <rik@octave.org> parents: 27985 diff changeset	108 %!error <Invalid call> roty ()
d8318c12d903 test: remove unnecessary BIST tests in m-files checking for excessive number of inputs. Rik <rik@octave.org> parents: 27985 diff changeset	109 %!error <Invalid call> roty ([1 2 3])

Mercurial > octave

annotate scripts/geometry/roty.m @ 33632:fed0dc6fd44c default tip