Mercurial > octave

annotate scripts/elfun/sind.m @ 33623:4517f929c59d bytecode-interpreter tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: Merge default to bytecode-interpreter
author Arun Giridhar <arungiridhar@gmail.com>
date Fri, 24 May 2024 16:22:41 -0400
parents 2e484f9f1f18
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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) 2006-2024 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} =} sind (@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 sine 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: 29167
diff changeset
30 ## The function is more accurate than @code{sin} for large values of @var{x}
8a2449d40f3c cosd.m, sind.m: Extend input to complex inputs.
Rik <rik@octave.org>
parents: 29167
diff changeset
31 ## and for multiples of 180 degrees (@code{@var{x}/180} is an integer) where
8a2449d40f3c cosd.m, sind.m: Extend input to complex inputs.
Rik <rik@octave.org>
parents: 29167
diff changeset
32 ## @code{sind} returns 0 rather than a small value on the order of eps.
9155
ad20b967e1c9 Update section 17.3 (Trigonometry) of arith.txi
Rik <rdrider0-list@yahoo.com>
parents: 7017
diff changeset
33 ## @seealso{asind, sin}
6239
82185e38eea8 [project @ 2007-01-10 22:53:58 by jwe]
jwe
parents:
diff changeset
34 ## @end deftypefn
82185e38eea8 [project @ 2007-01-10 22:53:58 by jwe]
jwe
parents:
diff changeset
35
82185e38eea8 [project @ 2007-01-10 22:53:58 by jwe]
jwe
parents:
diff changeset
36 function y = sind (x)
14220
5a13a75c2457 Use Octave spacing conventions for scripts in elfun/ directory.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
37
28891
de5f2f9a64ff maint: Use same coding style when checking for a minimum of 1 input.
Rik <rik@octave.org>
parents: 28886
diff changeset
38 if (nargin < 1)
6239
82185e38eea8 [project @ 2007-01-10 22:53:58 by jwe]
jwe
parents:
diff changeset
39 print_usage ();
82185e38eea8 [project @ 2007-01-10 22:53:58 by jwe]
jwe
parents:
diff changeset
40 endif
14220
5a13a75c2457 Use Octave spacing conventions for scripts in elfun/ directory.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
41
29168
8a2449d40f3c cosd.m, sind.m: Extend input to complex inputs.
Rik <rik@octave.org>
parents: 29167
diff changeset
42 if (! isnumeric (x))
8a2449d40f3c cosd.m, sind.m: Extend input to complex inputs.
Rik <rik@octave.org>
parents: 29167
diff changeset
43 error ("sind: X must be numeric");
8a2449d40f3c cosd.m, sind.m: Extend input to complex inputs.
Rik <rik@octave.org>
parents: 29167
diff changeset
44 endif
8a2449d40f3c cosd.m, sind.m: Extend input to complex inputs.
Rik <rik@octave.org>
parents: 29167
diff changeset
45
8a2449d40f3c cosd.m, sind.m: Extend input to complex inputs.
Rik <rik@octave.org>
parents: 29167
diff changeset
46 x_iscomplex = iscomplex (x);
8a2449d40f3c cosd.m, sind.m: Extend input to complex inputs.
Rik <rik@octave.org>
parents: 29167
diff changeset
47 if (x_iscomplex)
8a2449d40f3c cosd.m, sind.m: Extend input to complex inputs.
Rik <rik@octave.org>
parents: 29167
diff changeset
48 xi = imag (x);
8a2449d40f3c cosd.m, sind.m: Extend input to complex inputs.
Rik <rik@octave.org>
parents: 29167
diff changeset
49 endif
8a2449d40f3c cosd.m, sind.m: Extend input to complex inputs.
Rik <rik@octave.org>
parents: 29167
diff changeset
50 x = real (x);
8a2449d40f3c cosd.m, sind.m: Extend input to complex inputs.
Rik <rik@octave.org>
parents: 29167
diff changeset
51
29167
9193e7c990ea sind.m, sinpi.m, cospi.m: Wrap to interval closer to zero for higher accuracy.
Markus Mützel <markus.muetzel@gmx.de>
parents: 29160
diff changeset
52 ## Wrap multiples so that new domain is [-180, 180)
9193e7c990ea sind.m, sinpi.m, cospi.m: Wrap to interval closer to zero for higher accuracy.
Markus Mützel <markus.muetzel@gmx.de>
parents: 29160
diff changeset
53 x = mod (x-180, 360) - 180;
29160
ee20ff0ceb60 sind.m: Overhaul function for improved accuracy with large inputs.
Rik <rik@octave.org>
parents: 28896
diff changeset
54
29168
8a2449d40f3c cosd.m, sind.m: Extend input to complex inputs.
Rik <rik@octave.org>
parents: 29167
diff changeset
55 if (x_iscomplex)
8a2449d40f3c cosd.m, sind.m: Extend input to complex inputs.
Rik <rik@octave.org>
parents: 29167
diff changeset
56 y = sin (complex (x, xi) / 180 * pi);
8a2449d40f3c cosd.m, sind.m: Extend input to complex inputs.
Rik <rik@octave.org>
parents: 29167
diff changeset
57 ## Integer multiples of pi must be exactly zero
8a2449d40f3c cosd.m, sind.m: Extend input to complex inputs.
Rik <rik@octave.org>
parents: 29167
diff changeset
58 y(x == -180) = complex (0, imag (y(x == -180)));
8a2449d40f3c cosd.m, sind.m: Extend input to complex inputs.
Rik <rik@octave.org>
parents: 29167
diff changeset
59 else
8a2449d40f3c cosd.m, sind.m: Extend input to complex inputs.
Rik <rik@octave.org>
parents: 29167
diff changeset
60 y = sin (x / 180 * pi);
8a2449d40f3c cosd.m, sind.m: Extend input to complex inputs.
Rik <rik@octave.org>
parents: 29167
diff changeset
61 ## Integer multiples of pi must be exactly zero
8a2449d40f3c cosd.m, sind.m: Extend input to complex inputs.
Rik <rik@octave.org>
parents: 29167
diff changeset
62 y(x == -180) = 0;
8a2449d40f3c cosd.m, sind.m: Extend input to complex inputs.
Rik <rik@octave.org>
parents: 29167
diff changeset
63 endif
14220
5a13a75c2457 Use Octave spacing conventions for scripts in elfun/ directory.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
64
6239
82185e38eea8 [project @ 2007-01-10 22:53:58 by jwe]
jwe
parents:
diff changeset
65 endfunction
82185e38eea8 [project @ 2007-01-10 22:53:58 by jwe]
jwe
parents:
diff changeset
66
14220
5a13a75c2457 Use Octave spacing conventions for scripts in elfun/ directory.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
67
29160
ee20ff0ceb60 sind.m: Overhaul function for improved accuracy with large inputs.
Rik <rik@octave.org>
parents: 28896
diff changeset
68 %!assert (sind (10:20:360), sin ([10:20:360] * pi/180), 5*eps)
ee20ff0ceb60 sind.m: Overhaul function for improved accuracy with large inputs.
Rik <rik@octave.org>
parents: 28896
diff changeset
69 %!assert (sind ([-360, -180, 0, 180, 360]) == 0)
ee20ff0ceb60 sind.m: Overhaul function for improved accuracy with large inputs.
Rik <rik@octave.org>
parents: 28896
diff changeset
70 %!assert (sind ([-270, -90, 90, 270]), [1, -1, 1, -1])
29168
8a2449d40f3c cosd.m, sind.m: Extend input to complex inputs.
Rik <rik@octave.org>
parents: 29167
diff changeset
71 %!assert (sind ([-Inf, NaN, +Inf, 0]), [NaN, NaN, NaN, 0])
8a2449d40f3c cosd.m, sind.m: Extend input to complex inputs.
Rik <rik@octave.org>
parents: 29167
diff changeset
72 %!assert (sind (+23) == -sind (-23))
8a2449d40f3c cosd.m, sind.m: Extend input to complex inputs.
Rik <rik@octave.org>
parents: 29167
diff changeset
73 %!assert (sind (1e6), -0.984807753012208, 5*eps)
8a2449d40f3c cosd.m, sind.m: Extend input to complex inputs.
Rik <rik@octave.org>
parents: 29167
diff changeset
74 %!assert (sind (180 + 180i), -i*sinh (pi))
8a2449d40f3c cosd.m, sind.m: Extend input to complex inputs.
Rik <rik@octave.org>
parents: 29167
diff changeset
75 %!assert (sind (1e6 + 180i), -11.415845458288851 + 2.0054175437381652i, 5*eps)
14220
5a13a75c2457 Use Octave spacing conventions for scripts in elfun/ directory.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
76
28896
90fea9cc9caa test: Add expected error message <Invalid call> to BIST tests for nargin.
Rik <rik@octave.org>
parents: 28891
diff changeset
77 %!error <Invalid call> sind ()
29168
8a2449d40f3c cosd.m, sind.m: Extend input to complex inputs.
Rik <rik@octave.org>
parents: 29167
diff changeset
78 %!error <X must be numeric> sind ("abc")