annotate scripts/specfun/lcm.m @ 30564:796f54d4ddbf stable

update Octave Project Developers copyright for the new year In files that have the "Octave Project Developers" copyright notice, update for 2021. In all .txi and .texi files except gpl.txi and gpl.texi in the doc/liboctave and doc/interpreter directories, change the copyright to "Octave Project Developers", the same as used for other source files. Update copyright notices for 2022 (not done since 2019). For gpl.txi and gpl.texi, change the copyright notice to be "Free Software Foundation, Inc." and leave the date at 2007 only because this file only contains the text of the GPL, not anything created by the Octave Project Developers. Add Paul Thomas to contributors.in.
author John W. Eaton <jwe@octave.org>
date Tue, 28 Dec 2021 18:22:40 -0500
parents 7854d5752dd2
children 5d3faba0342e
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 ##
30564
796f54d4ddbf update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 29359
diff changeset
3 ## Copyright (C) 1994-2022 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/>.
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
7 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
8 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
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
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
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.
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
14 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
15 ## Octave is distributed in the hope that it will be useful, but
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
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.
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
19 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
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: 7001
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 ########################################################################
1026
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
25
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2847
diff changeset
26 ## -*- texinfo -*-
20852
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 19697
diff changeset
27 ## @deftypefn {} {} lcm (@var{x}, @var{y})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 19697
diff changeset
28 ## @deftypefnx {} {} lcm (@var{x}, @var{y}, @dots{})
19100
c5a0b995b996 lcm.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
29 ## Compute the least common multiple of @var{x} and @var{y}, or of the list of
c5a0b995b996 lcm.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
30 ## all arguments.
c5a0b995b996 lcm.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
31 ##
c5a0b995b996 lcm.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
32 ## All elements must be numeric and of the same size or scalar.
c5a0b995b996 lcm.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
33 ## @seealso{factor, gcd, isprime}
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2847
diff changeset
34 ## @end deftypefn
2311
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
35
4870
2cbc6f37b0c2 [project @ 2004-04-21 17:30:51 by jwe]
jwe
parents: 3979
diff changeset
36 function l = lcm (varargin)
904
3470f1e25a79 [project @ 1994-11-09 21:22:15 by jwe]
jwe
parents: 715
diff changeset
37
19100
c5a0b995b996 lcm.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
38 if (nargin < 2)
11028
7d0d28aff7a9 simplify lcm
Jaroslav Hajek <highegg@gmail.com>
parents: 10549
diff changeset
39 print_usage ();
715
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
40 endif
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2313
diff changeset
41
19100
c5a0b995b996 lcm.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
42 if (common_size (varargin{:}) != 0)
c5a0b995b996 lcm.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
43 error ("lcm: all args must be the same size or scalar");
c5a0b995b996 lcm.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
44 elseif (! all (cellfun ("isnumeric", varargin)))
c5a0b995b996 lcm.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
45 error ("lcm: all arguments must be numeric");
c5a0b995b996 lcm.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
46 endif
c5a0b995b996 lcm.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
47
c5a0b995b996 lcm.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
48 l = varargin{1};
c5a0b995b996 lcm.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
49 for i = 2:nargin
c5a0b995b996 lcm.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
50 x = varargin{i};
c5a0b995b996 lcm.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
51 msk = (l == 0 & x == 0);
c5a0b995b996 lcm.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
52 l .*= x ./ gcd (l, x);
c5a0b995b996 lcm.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
53 l(msk) = 0;
c5a0b995b996 lcm.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
54 endfor
c5a0b995b996 lcm.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
55
715
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
56 endfunction
7385
8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe]
jwe
parents: 7017
diff changeset
57
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
58
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
59 %!assert (lcm (3, 5, 7, 15), 105)
7385
8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe]
jwe
parents: 7017
diff changeset
60
28896
90fea9cc9caa test: Add expected error message <Invalid call> to BIST tests for nargin.
Rik <rik@octave.org>
parents: 27985
diff changeset
61 ## Test input validation
90fea9cc9caa test: Add expected error message <Invalid call> to BIST tests for nargin.
Rik <rik@octave.org>
parents: 27985
diff changeset
62 %!error <Invalid call> lcm ()
90fea9cc9caa test: Add expected error message <Invalid call> to BIST tests for nargin.
Rik <rik@octave.org>
parents: 27985
diff changeset
63 %!error <Invalid call> lcm (1)
19100
c5a0b995b996 lcm.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
64 %!error <same size or scalar> lcm ([1 2], [1 2 3])
c5a0b995b996 lcm.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
65 %!error <arguments must be numeric> lcm ([1 2], {1 2})