annotate scripts/specfun/lcm.m @ 27985:9f9ac219896d

maint: Remove remaining "Author:" instances from code base. * __ftp__.cc, load-save.cc, urlwrite.cc, xnorm.cc, xnorm.h, cconv2.f, cdotc3.f, cmatm3.f, csconv2.f, dconv2.f, ddot3.f, dmatm3.f, sconv2.f, sdot3.f, smatm3.f, zconv2.f, zdconv2.f, zdotc3.f, zmatm3.f, crsf2csf.f, zrsf2csf.f, oct-norm.cc, oct-norm.h, lin2mu.m, mu2lin.m, bincoeff.m, blkdiag.m, deal.m, gradient.m, interpft.m, nextpow2.m, postpad.m, prepad.m, repmat.m, shift.m, xor.m, griddata.m, rotx.m, roty.m, rotz.m, voronoin.m, getappdata.m, isappdata.m, rmappdata.m, setappdata.m, colormap.m, gray.m, gray2ind.m, im2double.m, image.m, imagesc.m, imread.m, imshow.m, ind2gray.m, ind2rgb.m, ocean.m, __imread__.m, rgb2ind.m, javachk.m, ClassHelper.java, usejava.m, findstr.m, commutation_matrix.m, cross.m, gls.m, housh.m, isdefinite.m, ishermitian.m, issymmetric.m, logm.m, null.m, ols.m, orth.m, qzhess.m, rref.m, dos.m, nargoutchk.m, orderfields.m, parseparams.m, __w2mpth__.m, unix.m, untar.m, unzip.m, expand_rel_paths.m, make_rel_paths.m, daspect.m, orient.m, pbaspect.m, rticks.m, thetaticks.m, xticklabels.m, xticks.m, yticklabels.m, yticks.m, zticklabels.m, zticks.m, comet.m, contourf.m, plot3.m, cla.m, copyobj.m, findfigs.m, hdl2struct.m, linkaxes.m, __ghostscript__.m, __gnuplot_get_var__.m, __gnuplot_has_feature__.m, __gnuplot_has_terminal__.m, __gnuplot_open_stream__.m, __gnuplot_print__.m, struct2hdl.m, subplot.m, compan.m, conv.m, deconv.m, mpoles.m, poly.m, polyder.m, polyfit.m, polyint.m, polyout.m, polyreduce.m, polyval.m, polyvalm.m, residue.m, roots.m, ismember.m, __parse_movargs__.m, detrend.m, fftconv.m, fftfilt.m, fftshift.m, filter2.m, movfun.m, movslice.m, ichol.m, pcg.m, beta.m, ellipke.m, lcm.m, nchoosek.m, pow2.m, primes.m, pascal.m, rosser.m, wilkinson.m, corr.m, kurtosis.m, skewness.m, base2dec.m, bin2dec.m, blanks.m, deblank.m, dec2base.m, dec2bin.m, dec2hex.m, hex2dec.m, index.m, rindex.m, strjoin.m, substr.m, untabify.m, calendar.m, datestr.m, eomday.m, now.m, weekday.m: Remove remaining "Author:" instances from code base.
author Rik <rik@octave.org>
date Tue, 21 Jan 2020 14:35:03 -0800
parents 7f1cec12c240
children 90fea9cc9caa 0a5b15007766
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 ##
27919
1891570abac8 update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 27918
diff changeset
3 ## Copyright (C) 1994-2020 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
19100
c5a0b995b996 lcm.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
61 %!error lcm ()
c5a0b995b996 lcm.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
62 %!error lcm (1)
c5a0b995b996 lcm.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
63 %!error <same size or scalar> lcm ([1 2], [1 2 3])
c5a0b995b996 lcm.m: Overhaul function.
Rik <rik@octave.org>
parents: 17744
diff changeset
64 %!error <arguments must be numeric> lcm ([1 2], {1 2})