Mercurial > octave-antonio
annotate scripts/time/is_leap_year.m @ 11523:fd0a3ac60b0e
update copyright notices
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Fri, 14 Jan 2011 05:47:45 -0500 |
parents | 0d9640d755b1 |
children | d490ca8ab1a5 |
rev | line source |
---|---|
11523 | 1 ## Copyright (C) 1996-2011 John W. Eaton |
5596 | 2 ## |
3 ## This file is part of Octave. | |
4 ## | |
5 ## Octave is free software; you can redistribute it and/or modify it | |
6 ## under the terms of the GNU General Public License as published by | |
7016 | 7 ## the Free Software Foundation; either version 3 of the License, or (at |
8 ## your option) any later version. | |
5596 | 9 ## |
10 ## Octave is distributed in the hope that it will be useful, but | |
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
13 ## General Public License for more details. | |
14 ## | |
15 ## You should have received a copy of the GNU General Public License | |
7016 | 16 ## along with Octave; see the file COPYING. If not, see |
17 ## <http://www.gnu.org/licenses/>. | |
5596 | 18 |
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}) |
0d9640d755b1
Improve docstrings for all isXXX functions.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
22 ## Return true if the given year is a leap year and false otherwise. If no |
0d9640d755b1
Improve docstrings for all isXXX functions.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
23 ## year is provided, @code{is_leap_year} will use the current year. |
10821
693e22af08ae
Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents:
8920
diff
changeset
|
24 ## For example: |
5596 | 25 ## |
26 ## @example | |
27 ## @group | |
28 ## is_leap_year (2000) | |
29 ## @result{} 1 | |
30 ## @end group | |
31 ## @end example | |
32 ## @end deftypefn | |
33 | |
34 ## Author: jwe | |
35 | |
36 function retval = is_leap_year (year) | |
37 | |
38 if (nargin > 1) | |
6046 | 39 print_usage (); |
5596 | 40 endif |
41 | |
42 if (nargin == 0) | |
43 t = clock (); | |
44 year = t (1); | |
45 endif | |
46 | |
47 retval = ((rem (year, 4) == 0 & rem (year, 100) != 0) ... | |
48 | rem (year, 400) == 0); | |
49 | |
50 endfunction | |
7411 | 51 |
52 %!assert((is_leap_year (2000) == 1 && is_leap_year (1976) == 1 | |
53 %! && is_leap_year (1000) == 0 && is_leap_year (1800) == 0 | |
54 %! && is_leap_year (1600) == 1)); | |
55 | |
56 %!error is_leap_year (1, 2); | |
57 |