octave: scripts/elfun/cosd.m annotate

annotate scripts/elfun/cosd.m @ 30560:9ed1cf9e446e

doc: Document output for all functions in elfun/ directory (bug #61681) * acosd.m, acot.m, acotd.m, acoth.m, acsc.m, acscd.m, acsch.m, asec.m, asecd.m, asech.m, asind.m, atan2d.m, atand.m, cosd.m, cot.m, cotd.m, coth.m, csc.m, cscd.m, csch.m, sec.m, secd.m, sech.m, sind.m, tand.m: Document output for all functions in elfun/ directory (bug #61681)

author	Rik <rik@octave.org>
date	Mon, 27 Dec 2021 20:04:52 -0800
parents	7854d5752dd2
children	83f9f8bda883

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 ##
29358 0a5b15007766 update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 27978 diff changeset	3 ## Copyright (C) 2006-2021 The Octave Project Developers
27918 b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 26376 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/>.
6239 82185e38eea8 [project @ 2007-01-10 22:53:58 by jwe] jwe parents: diff changeset	7 ##
6440 98ee80702bca [project @ 2007-03-23 15:13:19 by jwe] jwe parents: 6239 diff changeset	8 ## This file is part of Octave.
6239 82185e38eea8 [project @ 2007-01-10 22:53:58 by jwe] jwe parents: diff changeset	9 ##
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23220 diff changeset	10 ## Octave is free software: you can redistribute it and/or modify it
6440 98ee80702bca [project @ 2007-03-23 15:13:19 by jwe] jwe parents: 6239 diff changeset	11 ## under the terms of the GNU General Public License as published by
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23220 diff changeset	12 ## the Free Software Foundation, either version 3 of the License, or
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	13 ## (at your option) any later version.
6440 98ee80702bca [project @ 2007-03-23 15:13:19 by jwe] jwe parents: 6239 diff changeset	14 ##
98ee80702bca [project @ 2007-03-23 15:13:19 by jwe] jwe parents: 6239 diff changeset	15 ## Octave is distributed in the hope that it will be useful, but
98ee80702bca [project @ 2007-03-23 15:13:19 by jwe] jwe parents: 6239 diff changeset	16 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	17 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	18 ## GNU General Public License for more details.
6239 82185e38eea8 [project @ 2007-01-10 22:53:58 by jwe] jwe parents: diff changeset	19 ##
82185e38eea8 [project @ 2007-01-10 22:53:58 by jwe] jwe parents: diff changeset	20 ## You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6440 diff changeset	21 ## along with Octave; see the file COPYING. If not, see
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23220 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 ########################################################################
6239 82185e38eea8 [project @ 2007-01-10 22:53:58 by jwe] jwe parents: diff changeset	25
82185e38eea8 [project @ 2007-01-10 22:53:58 by jwe] jwe parents: diff changeset	26 ## -- texinfo --
30560 9ed1cf9e446e doc: Document output for all functions in elfun/ directory (bug #61681) Rik <rik@octave.org> parents: 29359 diff changeset	27 ## @deftypefn {} {@var{y} =} cosd (@var{x})
20158 7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	28 ## Compute the cosine for each element of @var{x} in degrees.
7503499a252b doc: Update docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	29 ##
29168 8a2449d40f3c cosd.m, sind.m: Extend input to complex inputs. Rik <rik@octave.org> parents: 29164 diff changeset	30 ## The function is more accurate than @code{cos} for large values of @var{x}
8a2449d40f3c cosd.m, sind.m: Extend input to complex inputs. Rik <rik@octave.org> parents: 29164 diff changeset	31 ## and for multiples of 90 degrees (@code{@var{x} = 90 + 180*n} with n an
8a2449d40f3c cosd.m, sind.m: Extend input to complex inputs. Rik <rik@octave.org> parents: 29164 diff changeset	32 ## integer) where @code{cosd} returns 0 rather than a small value on the order
8a2449d40f3c cosd.m, sind.m: Extend input to complex inputs. Rik <rik@octave.org> parents: 29164 diff changeset	33 ## of eps.
9155 ad20b967e1c9 Update section 17.3 (Trigonometry) of arith.txi Rik <rdrider0-list@yahoo.com> parents: 7017 diff changeset	34 ## @seealso{acosd, cos}
6239 82185e38eea8 [project @ 2007-01-10 22:53:58 by jwe] jwe parents: diff changeset	35 ## @end deftypefn
82185e38eea8 [project @ 2007-01-10 22:53:58 by jwe] jwe parents: diff changeset	36
82185e38eea8 [project @ 2007-01-10 22:53:58 by jwe] jwe parents: diff changeset	37 function y = cosd (x)
14220 5a13a75c2457 Use Octave spacing conventions for scripts in elfun/ directory. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	38
28891 de5f2f9a64ff maint: Use same coding style when checking for a minimum of 1 input. Rik <rik@octave.org> parents: 28886 diff changeset	39 if (nargin < 1)
6239 82185e38eea8 [project @ 2007-01-10 22:53:58 by jwe] jwe parents: diff changeset	40 print_usage ();
82185e38eea8 [project @ 2007-01-10 22:53:58 by jwe] jwe parents: diff changeset	41 endif
14220 5a13a75c2457 Use Octave spacing conventions for scripts in elfun/ directory. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	42
29168 8a2449d40f3c cosd.m, sind.m: Extend input to complex inputs. Rik <rik@octave.org> parents: 29164 diff changeset	43 if (! isnumeric (x))
8a2449d40f3c cosd.m, sind.m: Extend input to complex inputs. Rik <rik@octave.org> parents: 29164 diff changeset	44 error ("cosd: X must be numeric");
8a2449d40f3c cosd.m, sind.m: Extend input to complex inputs. Rik <rik@octave.org> parents: 29164 diff changeset	45 endif
8a2449d40f3c cosd.m, sind.m: Extend input to complex inputs. Rik <rik@octave.org> parents: 29164 diff changeset	46
8a2449d40f3c cosd.m, sind.m: Extend input to complex inputs. Rik <rik@octave.org> parents: 29164 diff changeset	47 ## Advance phase by 90 degrees to transform sin to cos and use sind().
29164 b7a4460333c9 cosd.m: Use new improved sind.m for greater accuracy. Rik <rik@octave.org> parents: 28896 diff changeset	48 y = sind (x + 90);
14220 5a13a75c2457 Use Octave spacing conventions for scripts in elfun/ directory. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	49
6239 82185e38eea8 [project @ 2007-01-10 22:53:58 by jwe] jwe parents: diff changeset	50 endfunction
82185e38eea8 [project @ 2007-01-10 22:53:58 by jwe] jwe parents: diff changeset	51
14220 5a13a75c2457 Use Octave spacing conventions for scripts in elfun/ directory. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	52
29164 b7a4460333c9 cosd.m: Use new improved sind.m for greater accuracy. Rik <rik@octave.org> parents: 28896 diff changeset	53 %!assert (cosd (10:20:360), cos ([10:20:360] * pi/180), 5*eps)
b7a4460333c9 cosd.m: Use new improved sind.m for greater accuracy. Rik <rik@octave.org> parents: 28896 diff changeset	54 %!assert (cosd ([-270, -90, 90, 270]) == 0)
b7a4460333c9 cosd.m: Use new improved sind.m for greater accuracy. Rik <rik@octave.org> parents: 28896 diff changeset	55 %!assert (cosd ([-360, -180, 0, 180, 360]), [1, -1, 1, -1, 1])
29168 8a2449d40f3c cosd.m, sind.m: Extend input to complex inputs. Rik <rik@octave.org> parents: 29164 diff changeset	56 %!assert (cosd ([-Inf, NaN, +Inf, 0]), [NaN, NaN, NaN, 1])
8a2449d40f3c cosd.m, sind.m: Extend input to complex inputs. Rik <rik@octave.org> parents: 29164 diff changeset	57 %!assert (cosd (+23) == cosd (-23))
8a2449d40f3c cosd.m, sind.m: Extend input to complex inputs. Rik <rik@octave.org> parents: 29164 diff changeset	58 %!assert (cosd (1e6), 0.17364817766693033, 5*eps)
8a2449d40f3c cosd.m, sind.m: Extend input to complex inputs. Rik <rik@octave.org> parents: 29164 diff changeset	59 %!assert (cosd (90 + 180i), -i*sinh (pi))
29179 576d0bf372a4 cosd.m: Use relative tolerance in BIST. Markus Mützel <markus.muetzel@gmx.de> parents: 29168 diff changeset	60 %!assert (cosd (1e6 + 180i), 2.01292156189451577 + 11.3732880565446539i, -eps)
14220 5a13a75c2457 Use Octave spacing conventions for scripts in elfun/ directory. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	61
28896 90fea9cc9caa test: Add expected error message <Invalid call> to BIST tests for nargin. Rik <rik@octave.org> parents: 28891 diff changeset	62 %!error <Invalid call> cosd ()
29168 8a2449d40f3c cosd.m, sind.m: Extend input to complex inputs. Rik <rik@octave.org> parents: 29164 diff changeset	63 %!error <X must be numeric> cosd ("abc")

Mercurial > octave

annotate scripts/elfun/cosd.m @ 30560:9ed1cf9e446e