annotate main/time/weekday.m @ 0:6b33357c7561 octave-forge

Initial revision
author pkienzle
date Wed, 10 Oct 2001 19:54:49 +0000
parents
children 4d5773ef926a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
1 ## Copyright (C) 2000 Paul Kienzle
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
2 ##
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
3 ## This program is free software; you can redistribute it and/or modify
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
4 ## it under the terms of the GNU General Public License as published by
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
5 ## the Free Software Foundation; either version 2 of the License, or
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
6 ## (at your option) any later version.
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
7 ##
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
8 ## This program is distributed in the hope that it will be useful,
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
9 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
10 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
11 ## GNU General Public License for more details.
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
12 ##
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
13 ## You should have received a copy of the GNU General Public License
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
14 ## along with this program; if not, write to the Free Software
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
15 ## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
16
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
17 ## -*- texinfo -*-
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
18 ## @deftypefn {Function File} {V =} datevec(date)
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
19 ## @deftypefnx {Function File} {[Y,M,D,h,m,s] =} datevec(date)
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
20 ## Breaks the number of days since Jan 1, 0000 into a year-month-day
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
21 ## hour-minute-second format. By this reckoning, Jan 1, 1970 is day
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
22 ## number 719529. The fractional portion of @code{date} corresponds to the
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
23 ## portion of the given day. If a single return value is requested,
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
24 ## then the components of the date are columns of the matrix @code{V}.
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
25 ##
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
26 ## Note: 32-bit architectures only handle times between Dec 14, 1901
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
27 ## and Jan 19, 2038, with special handling for 0000-01-01. datenum
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
28 ## returns -1 in case of a range error.
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
29 ##
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
30 ## The parameter @code{P} is needed to convert date strings with 2 digit
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
31 ## years into dates with 4 digit years. 2 digit years are assumed to be
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
32 ## between @code{P} and @code{P+99}. If @code{P} is not given then the
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
33 ## current year - 50 is used, so that dates are centered on the present.
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
34 ## For birthdates, you would want @code{P} to be current year - 99. For
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
35 ## appointments, you would want @code{P} to be current year.
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
36 ##
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
37 ## Dates must be represented as mm/dd/yy or dd-mmm-yyyy. Times must
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
38 ## be hh:mm:ss or hh:mm:ss PM, with seconds optional. These correspond
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
39 ## to datestr format codes 0, 1, 2, 3, 13, 14, 15, 16.
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
40 ##
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
41 ## @seealso{date,clock,now,datestr,datenum,calendar,weekday}
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
42 ## @end deftypefn
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
43
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
44 function [d,s] = weekday(date,P)
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
45 if (nargin < 1 || nargin > 2)
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
46 usage("d = weekday(date [, P])");
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
47 endif
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
48 if isstr(date)
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
49 if nargin < 2, P = []; endif
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
50 date = datenum(date, P);
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
51 endif
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
52 d = rem(floor(date)+5,7)+1;
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
53 if nargout == 2,
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
54 global __day_names = ["Sun";"Mon";"Tue";"Wed";"Thu";"Fri";"Sat"];
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
55 s = __day_names(d,:);
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
56 endif
6b33357c7561 Initial revision
pkienzle
parents:
diff changeset
57 endfunction