octave-lyh: scripts/time/weekday.m annotate

annotate scripts/time/weekday.m @ 13856:d490ca8ab1a5

Modernize function implementations and docstrings in scripts/time. * addtodate.m: Add millisecond functionality. Update docstring and %!tests. * calendar.m: Implement faster way to add '*' to day display. Update docstring. * weekday.m: Use more modern coding stytle. Update docstring. * asctime.m, clock.m, ctime.m, date.m, datenum.m, datestr.m, datevec.m, eomday.m, etime.m, is_leap_year.m: Update docstring and/or use Octave formatting spacing conventions for %!tests.

author	Rik <octave@nomad.inbox5.com>
date	Thu, 10 Nov 2011 13:35:08 -0800
parents	796dc1d75e06
children	050bc580cb60

rev	line source
11523 fd0a3ac60b0e update copyright notices John W. Eaton <jwe@octave.org> parents: 11469 diff changeset	1 ## Copyright (C) 2000-2011 Paul Kienzle
5687 a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	2 ##
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	3 ## This file is part of Octave.
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	4 ##
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
a2902024bc4e [project @ 2006-03-16 20:22:40 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: 5823 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: 5823 diff changeset	8 ## your option) any later version.
5687 a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	9 ##
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	13 ## General Public License for more details.
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	14 ##
a2902024bc4e [project @ 2006-03-16 20:22:40 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: 5823 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: 5823 diff changeset	17 ## <http://www.gnu.org/licenses/>.
5687 a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	18
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	19 ## -- texinfo --
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10549 diff changeset	20 ## @deftypefn {Function File} {[@var{n}, @var{s}] =} weekday (@var{d})
c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10549 diff changeset	21 ## @deftypefnx {Function File} {[@var{n}, @var{s}] =} weekday (@var{d}, @var{format})
13856 d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	22 ## Return the day of the week as a number in @var{n} and as a string in @var{s}.
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	23 ## The days of the week are numbered 1--7 with the first day being Sunday.
5687 a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	24 ##
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	25 ## @var{d} is a serial date number or a date string.
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	26 ##
13856 d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	27 ## If the string @var{format} is not present or is equal to "short" then
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	28 ## @var{s} will contain the abbreviated name of the weekday. If @var{format}
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	29 ## is "long" then @var{s} will contain the full name.
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	30 ##
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	31 ## Table of return values based on @var{format}:
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	32 ##
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	33 ## @multitable @columnfractions .06 .13 .13
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	34 ## @headitem @var{n} @tab "short" @tab "long"
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	35 ## @item 1 @tab Sun @tab Sunday
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	36 ## @item 2 @tab Mon @tab Monday
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	37 ## @item 3 @tab Tue @tab Tuesday
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	38 ## @item 4 @tab Wed @tab Wednesday
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	39 ## @item 5 @tab Thu @tab Thursday
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	40 ## @item 6 @tab Fri @tab Friday
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	41 ## @item 7 @tab Sat @tab Saturday
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	42 ## @end multitable
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	43 ##
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	44 ## @seealso{eomday, is_leap_year, calendar, datenum, datevec}
5687 a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	45 ## @end deftypefn
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	46
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	47 ## Author: pkienzle <pkienzle@users.sf.net>
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	48 ## Created: 10 October 2001 (CVS)
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	49 ## Adapted-By: William Poetra Yoga Hadisoeseno <williampoetra@gmail.com>
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	50
13856 d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	51 function [d, s] = weekday (d, format = "short")
5687 a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	52
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	53 if (nargin < 1 \|\| nargin > 2)
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5687 diff changeset	54 print_usage ();
5687 a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	55 endif
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	56
13856 d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	57 if (iscellstr (d) \|\| isnumeric (d))
7434 600a3af7963e [project @ 2008-02-01 06:32:06 by jwe] jwe parents: 7017 diff changeset	58 endsize = size (d);
600a3af7963e [project @ 2008-02-01 06:32:06 by jwe] jwe parents: 7017 diff changeset	59 elseif (ischar (d))
13856 d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	60 endsize = [rows(d), 1];
7434 600a3af7963e [project @ 2008-02-01 06:32:06 by jwe] jwe parents: 7017 diff changeset	61 endif
13856 d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	62 if (ischar (d) \|\| iscellstr (d))
7434 600a3af7963e [project @ 2008-02-01 06:32:06 by jwe] jwe parents: 7017 diff changeset	63 ## Make sure the date is numeric
600a3af7963e [project @ 2008-02-01 06:32:06 by jwe] jwe parents: 7017 diff changeset	64 d = datenum (d);
600a3af7963e [project @ 2008-02-01 06:32:06 by jwe] jwe parents: 7017 diff changeset	65 endif
600a3af7963e [project @ 2008-02-01 06:32:06 by jwe] jwe parents: 7017 diff changeset	66 ## Find the offset from a known Sunday (2008-Jan-6), mod 7.
13856 d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	67 d = floor (reshape (mod (d - 733048, 7), endsize));
7434 600a3af7963e [project @ 2008-02-01 06:32:06 by jwe] jwe parents: 7017 diff changeset	68 ## Make Saturdays a 7 and not a 0.
600a3af7963e [project @ 2008-02-01 06:32:06 by jwe] jwe parents: 7017 diff changeset	69 d(!d) = 7;
5687 a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	70
13856 d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	71 if (isargout (2))
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10549 diff changeset	72 if (strcmpi (format, "long"))
13856 d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	73 names = {"Sunday" "Monday" "Tuesday" "Wednesday" "Thursday" ...
10549 95c3e38098bf Untabify .m scripts Rik <code@nomad.inbox5.com> parents: 7434 diff changeset	74 "Friday" "Saturday"};
5687 a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	75 else
7434 600a3af7963e [project @ 2008-02-01 06:32:06 by jwe] jwe parents: 7017 diff changeset	76 names = {"Sun" "Mon" "Tue" "Wed" "Thu" "Fri" "Sat"};
5687 a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	77 endif
7434 600a3af7963e [project @ 2008-02-01 06:32:06 by jwe] jwe parents: 7017 diff changeset	78 s = strvcat (names(d));
5687 a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	79 endif
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	80
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	81 endfunction
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	82
13856 d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	83
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	84 %!demo
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	85 %! ## Current weekday
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	86 %! [n, s] = weekday (now ())
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	87 %!demo
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	88 %! ## Weekday from datenum input
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	89 %! [n, s] = weekday (728647)
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	90 %!demo
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	91 %! ## Weekday of new millennium from datestr input
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	92 %! [n, s] = weekday ('1-Jan-2000')
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	93
5687 a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	94 # tests
13856 d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	95 %!assert (weekday (728647), 2)
7434 600a3af7963e [project @ 2008-02-01 06:32:06 by jwe] jwe parents: 7017 diff changeset	96 ## Test vector inputs for both directions
13856 d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	97 %!assert (weekday ([728647 728648]), [2 3])
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	98 %!assert (weekday ([728647;728648]), [2;3])
7434 600a3af7963e [project @ 2008-02-01 06:32:06 by jwe] jwe parents: 7017 diff changeset	99 ## Test a full week before our reference day
13856 d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	100 %!assert (weekday ("19-Dec-1994"), 2)
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	101 %!assert (weekday ("20-Dec-1994"), 3)
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	102 %!assert (weekday ("21-Dec-1994"), 4)
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	103 %!assert (weekday ("22-Dec-1994"), 5)
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	104 %!assert (weekday ("23-Dec-1994"), 6)
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	105 %!assert (weekday ("24-Dec-1994"), 7)
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	106 %!assert (weekday ("25-Dec-1994"), 1)
7434 600a3af7963e [project @ 2008-02-01 06:32:06 by jwe] jwe parents: 7017 diff changeset	107 ## Test our reference day
13856 d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	108 %!assert (weekday ("6-Jan-2008"), 1)
7434 600a3af7963e [project @ 2008-02-01 06:32:06 by jwe] jwe parents: 7017 diff changeset	109 ## Test a full week after our reference day
13856 d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	110 %!assert (weekday ("1-Feb-2008"), 6)
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	111 %!assert (weekday ("2-Feb-2008"), 7)
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	112 %!assert (weekday ("3-Feb-2008"), 1)
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	113 %!assert (weekday ("4-Feb-2008"), 2)
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	114 %!assert (weekday ("5-Feb-2008"), 3)
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	115 %!assert (weekday ("6-Feb-2008"), 4)
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	116 %!assert (weekday ("7-Feb-2008"), 5)
7434 600a3af7963e [project @ 2008-02-01 06:32:06 by jwe] jwe parents: 7017 diff changeset	117 ## Test fractional dates
13856 d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	118 %!assert (weekday (728647.1), 2)
13170 796dc1d75e06 Fix incorrect newline in weekday.m (bug #34347) Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 11523 diff changeset	119 ## Test "long" option
796dc1d75e06 Fix incorrect newline in weekday.m (bug #34347) Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 11523 diff changeset	120 %!test
13856 d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	121 %! [n, s] = weekday ("25-Dec-1994", "long");
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	122 %! assert (n, 1);
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 13170 diff changeset	123 %! assert (s, "Sunday");
13170 796dc1d75e06 Fix incorrect newline in weekday.m (bug #34347) Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 11523 diff changeset	124

Mercurial > hg > octave-lyh

annotate scripts/time/weekday.m @ 13856:d490ca8ab1a5