annotate scripts/specfun/lcm.m @ 14138:72c96de7a403 stable

maint: update copyright notices for 2012
author John W. Eaton <jwe@octave.org>
date Mon, 02 Jan 2012 14:25:41 -0500
parents cefd568ea073
children f3d52523cde1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 12931
diff changeset
1 ## Copyright (C) 1994-2012 John W. Eaton
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
2 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
3 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
4 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
6 ## under the terms of the GNU General Public License as published by
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7001
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7001
diff changeset
8 ## your option) any later version.
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
9 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
10 ## 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
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
13 ## General Public License for more details.
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 ## 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
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7001
diff changeset
17 ## <http://www.gnu.org/licenses/>.
1026
9fc405c8c06c [project @ 1995-01-11 21:17:01 by jwe]
jwe
parents: 904
diff changeset
18
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2847
diff changeset
19 ## -*- texinfo -*-
11028
7d0d28aff7a9 simplify lcm
Jaroslav Hajek <highegg@gmail.com>
parents: 10549
diff changeset
20 ## @deftypefn {Mapping Function} {} lcm (@var{x}, @var{y})
7d0d28aff7a9 simplify lcm
Jaroslav Hajek <highegg@gmail.com>
parents: 10549
diff changeset
21 ## @deftypefnx {Mapping Function} {} lcm (@var{x}, @var{y}, @dots{})
7d0d28aff7a9 simplify lcm
Jaroslav Hajek <highegg@gmail.com>
parents: 10549
diff changeset
22 ## Compute the least common multiple of @var{x} and @var{y},
11563
3c6e8aaa9555 Grammarcheck m-files before 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
23 ## or of the list of all arguments. All elements must be the same size or
3c6e8aaa9555 Grammarcheck m-files before 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
24 ## scalar.
9141
c1fff751b5a8 Update section 17.1 (Utility Functions) of arith.txi
Rik <rdrider0-list@yahoo.com>
parents: 9051
diff changeset
25 ## @seealso{factor, gcd}
3321
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe]
jwe
parents: 2847
diff changeset
26 ## @end deftypefn
2311
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
27
5428
2a16423e4aa0 [project @ 2005-08-23 18:38:27 by jwe]
jwe
parents: 5307
diff changeset
28 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
2312
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe]
jwe
parents: 2311
diff changeset
29 ## Created: 16 September 1994
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe]
jwe
parents: 2311
diff changeset
30 ## Adapted-By: jwe
204cc7db6f4a [project @ 1996-07-11 21:20:36 by jwe]
jwe
parents: 2311
diff changeset
31
4870
2cbc6f37b0c2 [project @ 2004-04-21 17:30:51 by jwe]
jwe
parents: 3979
diff changeset
32 function l = lcm (varargin)
904
3470f1e25a79 [project @ 1994-11-09 21:22:15 by jwe]
jwe
parents: 715
diff changeset
33
11028
7d0d28aff7a9 simplify lcm
Jaroslav Hajek <highegg@gmail.com>
parents: 10549
diff changeset
34 if (nargin > 1)
7d0d28aff7a9 simplify lcm
Jaroslav Hajek <highegg@gmail.com>
parents: 10549
diff changeset
35 if (common_size (varargin{:}) != 0)
7d0d28aff7a9 simplify lcm
Jaroslav Hajek <highegg@gmail.com>
parents: 10549
diff changeset
36 error ("lcm: all args must be of the same size or scalar");
12931
cefd568ea073 Replace function handles with function names in cellfun calls for 15% speedup.
Rik <octave@nomad.inbox5.com>
parents: 12635
diff changeset
37 elseif (! all (cellfun ("isnumeric", varargin)))
11028
7d0d28aff7a9 simplify lcm
Jaroslav Hajek <highegg@gmail.com>
parents: 10549
diff changeset
38 error ("lcm: all arguments must be numeric");
4870
2cbc6f37b0c2 [project @ 2004-04-21 17:30:51 by jwe]
jwe
parents: 3979
diff changeset
39 endif
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2313
diff changeset
40
4870
2cbc6f37b0c2 [project @ 2004-04-21 17:30:51 by jwe]
jwe
parents: 3979
diff changeset
41 l = varargin{1};
8507
cadc73247d65 style fixes
John W. Eaton <jwe@octave.org>
parents: 7385
diff changeset
42 for i = 2:nargin
11028
7d0d28aff7a9 simplify lcm
Jaroslav Hajek <highegg@gmail.com>
parents: 10549
diff changeset
43 x = varargin{i};
7d0d28aff7a9 simplify lcm
Jaroslav Hajek <highegg@gmail.com>
parents: 10549
diff changeset
44 msk = l == 0 & x == 0;
7d0d28aff7a9 simplify lcm
Jaroslav Hajek <highegg@gmail.com>
parents: 10549
diff changeset
45 l .*= x ./ gcd (l, x);
7d0d28aff7a9 simplify lcm
Jaroslav Hajek <highegg@gmail.com>
parents: 10549
diff changeset
46 l(msk) = 0;
715
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
47 endfor
11028
7d0d28aff7a9 simplify lcm
Jaroslav Hajek <highegg@gmail.com>
parents: 10549
diff changeset
48 else
7d0d28aff7a9 simplify lcm
Jaroslav Hajek <highegg@gmail.com>
parents: 10549
diff changeset
49 print_usage ();
715
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
50 endif
2325
b5568c31ee2c [project @ 1996-07-15 22:20:21 by jwe]
jwe
parents: 2313
diff changeset
51
715
6544b83ef9e9 [project @ 1994-09-20 18:40:02 by jwe]
jwe
parents:
diff changeset
52 endfunction
7385
8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe]
jwe
parents: 7017
diff changeset
53
11028
7d0d28aff7a9 simplify lcm
Jaroslav Hajek <highegg@gmail.com>
parents: 10549
diff changeset
54 %!assert(lcm (3, 5, 7, 15) == 105);
7385
8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe]
jwe
parents: 7017
diff changeset
55
8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe]
jwe
parents: 7017
diff changeset
56 %!error lcm ();
8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe]
jwe
parents: 7017
diff changeset
57
8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe]
jwe
parents: 7017
diff changeset
58 %!test
8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe]
jwe
parents: 7017
diff changeset
59 %! s.a = 1;
8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe]
jwe
parents: 7017
diff changeset
60 %! fail("lcm (s)");
8b7b4f58199f [project @ 2008-01-15 20:49:09 by jwe]
jwe
parents: 7017
diff changeset
61