octave-antonio: scripts/time/is_leap

annotate scripts/time/is_leap_year.m @ 20162:2645f9ef8c88 stable

doc: Update more docstrings to have one sentence summary as first line. Reviewed specfun, special-matrix, testfun, and time script directories. * scripts/specfun/expint.m, scripts/specfun/isprime.m, scripts/specfun/legendre.m, scripts/specfun/primes.m, scripts/specfun/reallog.m, scripts/specfun/realsqrt.m, scripts/special-matrix/gallery.m, scripts/special-matrix/hadamard.m, scripts/special-matrix/hankel.m, scripts/special-matrix/hilb.m, scripts/special-matrix/invhilb.m, scripts/special-matrix/magic.m, scripts/special-matrix/pascal.m, scripts/special-matrix/rosser.m, scripts/special-matrix/toeplitz.m, scripts/special-matrix/vander.m, scripts/special-matrix/wilkinson.m, scripts/testfun/assert.m, scripts/testfun/demo.m, scripts/testfun/example.m, scripts/testfun/fail.m, scripts/testfun/rundemos.m, scripts/testfun/runtests.m, scripts/testfun/speed.m, scripts/time/asctime.m, scripts/time/calendar.m, scripts/time/clock.m, scripts/time/ctime.m, scripts/time/datenum.m, scripts/time/datestr.m, scripts/time/datevec.m, scripts/time/etime.m, scripts/time/is_leap_year.m, scripts/time/now.m, scripts/time/weekday.m: Update more docstrings to have one sentence summary as first line.

author	Rik <rik@octave.org>
date	Sun, 03 May 2015 17:00:11 -0700
parents	4197fc428c7d
children

rev	line source
19697 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 17744 diff changeset	1 ## Copyright (C) 1996-2015 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})
20162 2645f9ef8c88 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	22 ## Return true if @var{year} is a leap year and false otherwise.
2645f9ef8c88 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	23 ##
2645f9ef8c88 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	24 ## If no year is specified, @code{is_leap_year} uses the current year.
2645f9ef8c88 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	25 ##
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 8920 diff changeset	26 ## For example:
5596 6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe] jwe parents: diff changeset	27 ##
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe] jwe parents: diff changeset	28 ## @example
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe] jwe parents: diff changeset	29 ## @group
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe] jwe parents: diff changeset	30 ## 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	31 ## @result{} 1
5596 6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe] jwe parents: diff changeset	32 ## @end group
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe] jwe parents: diff changeset	33 ## @end example
13856 d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	34 ## @seealso{weekday, eomday, calendar}
5596 6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe] jwe parents: diff changeset	35 ## @end deftypefn
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 ## Author: jwe
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 function retval = is_leap_year (year)
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe] jwe parents: diff changeset	40
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe] jwe parents: diff changeset	41 if (nargin > 1)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5596 diff changeset	42 print_usage ();
5596 6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe] jwe parents: diff changeset	43 endif
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe] jwe parents: diff changeset	44
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe] jwe parents: diff changeset	45 if (nargin == 0)
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe] jwe parents: diff changeset	46 t = clock ();
13856 d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	47 year = t(1);
5596 6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe] jwe parents: diff changeset	48 endif
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe] jwe parents: diff changeset	49
13856 d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	50 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	51
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe] jwe parents: diff changeset	52 endfunction
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	53
13856 d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	54
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	55 %!assert (is_leap_year (2000), true)
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	56 %!assert (is_leap_year (1976), true)
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	57 %!assert (is_leap_year (1000), false)
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	58 %!assert (is_leap_year (1800), false)
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	59 %!assert (is_leap_year (1600), true)
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	60
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14327 diff changeset	61 %!error is_leap_year (1, 2)
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	62

Mercurial > octave-antonio

annotate scripts/time/is_leap_year.m @ 20162:2645f9ef8c88 stable