Mercurial > octave-antonio

annotate scripts/time/is_leap_year.m @ 14327:4d917a6a858b stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Use Octave coding conventions in @example blocks of docstrings. * accumarray.m, accumdim.m, bar.m, base2dec.m, bincoeff.m, bitcmp.m, bitset.m, celldisp.m, chop.m, clabel.m, cloglog.m, colon.m, compass.m, computer.m, contour3.m, contourc.m, corr.m, cstrcat.m, ctime.m, cylinder.m, date.m, dec2base.m, demo.m, dir.m, dlmwrite.m, expm.m, ezcontourf.m, ezcontour.m, ezmeshc.m, ezmesh.m, ezplot.m, ezsurfc.m, ezsurf.m, feather.m, findobj.m, flipdim.m, fplot.m, genvarname.m, getfield.m, hankel.m, hilb.m, hist.m, idivide.m, index.m, int2str.m, interp1.m, is_leap_year.m, ismember.m, isocolors.m, isonormals.m, isosurface.m, kurtosis.m, legendre.m, linkprop.m, logit.m, logm.m, __makeinfo__.m, __marching_cube__.m, median.m, mkoctfile.m, moment.m, mpoles.m, orderfields.m, pcg.m, pcr.m, plot3.m, plotmatrix.m, polyaffine.m, polygcd.m, poly.m, polyout.m, print.m, qp.m, quadgk.m, qzhess.m, randi.m, rat.m, refreshdata.m, residue.m, rose.m, rot90.m, saveas.m, saveobj.m, shiftdim.m, skewness.m, spaugment.m, spdiags.m, sqp.m, stem.m, str2num.m, strcat.m, strjust.m, strread.m, strsplit.m, structfun.m, subplot.m, subsindex.m, substruct.m, surfl.m, surfnorm.m, svds.m, uimenu.m, union.m, voronoi.m, warning_ids.m, wblpdf.m: Use Octave coding conventions in @example blocks of docstrings.
author Rik <octave@nomad.inbox5.com>
date Sat, 04 Feb 2012 22:12:50 -0800
parents 72c96de7a403
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: 13856
diff changeset
1 ## Copyright (C) 1996-2012 John W. Eaton
5596
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
2 ##
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
4 ##
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
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: 6046
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: 6046
diff changeset
8 ## your option) any later version.
5596
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
9 ##
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
14 ##
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
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: 6046
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: 6046
diff changeset
17 ## <http://www.gnu.org/licenses/>.
5596
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
18
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
11431
0d9640d755b1 Improve docstrings for all isXXX functions.
Rik <octave@nomad.inbox5.com>
parents: 10821
diff changeset
20 ## @deftypefn {Function File} {} is_leap_year ()
0d9640d755b1 Improve docstrings for all isXXX functions.
Rik <octave@nomad.inbox5.com>
parents: 10821
diff changeset
21 ## @deftypefnx {Function File} {} is_leap_year (@var{year})
13856
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
22 ## Return true if @var{year} is a leap year and false otherwise. If no
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
23 ## year is specified, @code{is_leap_year} uses the current year.
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 8920
diff changeset
24 ## For example:
5596
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
25 ##
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
26 ## @example
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
27 ## @group
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
28 ## is_leap_year (2000)
14327
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
29 ## @result{} 1
5596
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
30 ## @end group
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
31 ## @end example
13856
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
32 ## @seealso{weekday, eomday, calendar}
5596
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
33 ## @end deftypefn
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
34
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
35 ## Author: jwe
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
36
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
37 function retval = is_leap_year (year)
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
38
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
39 if (nargin > 1)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5596
diff changeset
40 print_usage ();
5596
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
41 endif
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
42
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
43 if (nargin == 0)
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
44 t = clock ();
13856
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
45 year = t(1);
5596
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
46 endif
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
47
13856
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
48 retval = (rem (year, 4) == 0 & rem (year, 100) != 0) | (rem (year, 400) == 0);
5596
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
49
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
50 endfunction
7411
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
51
13856
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
52
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
53 %!assert (is_leap_year (2000), true)
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
54 %!assert (is_leap_year (1976), true)
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
55 %!assert (is_leap_year (1000), false)
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
56 %!assert (is_leap_year (1800), false)
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
57 %!assert (is_leap_year (1600), true)
7411
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
58
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
59 %!error is_leap_year (1, 2);
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
60