annotate scripts/time/datenum.m @ 13848:40e32fe44aaa

Ugrade time functions to accept millisecond format string FFF (Bug #34586) * datestr.m: Add millisecond FFF format. Change numerical formats 21,22,29 to match Matlab. Remove unused persistent variables. Vectorize some for loops. Use strrep rather than regexp where possible for speed. * datevec.m: Add millisecond FFF format. Use strrep rather than regexp where possible for speed. * datenum.m: Update docstring. Use modern coding style. Only calculate second output argument if requested. Allow cellstr inputs.
author Rik <octave@nomad.inbox5.com>
date Wed, 09 Nov 2011 14:49:09 -0800
parents b80b18f537ca
children d490ca8ab1a5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
11523
fd0a3ac60b0e update copyright notices
John W. Eaton <jwe@octave.org>
parents: 11472
diff changeset
1 ## Copyright (C) 2006-2011 Paul Kienzle
5661
13be36ec8279 [project @ 2006-03-10 17:43:38 by jwe]
jwe
parents: 5660
diff changeset
2 ##
13be36ec8279 [project @ 2006-03-10 17:43:38 by jwe]
jwe
parents: 5660
diff changeset
3 ## This file is part of Octave.
13be36ec8279 [project @ 2006-03-10 17:43:38 by jwe]
jwe
parents: 5660
diff changeset
4 ##
13be36ec8279 [project @ 2006-03-10 17:43:38 by jwe]
jwe
parents: 5660
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
13be36ec8279 [project @ 2006-03-10 17:43:38 by jwe]
jwe
parents: 5660
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.
5661
13be36ec8279 [project @ 2006-03-10 17:43:38 by jwe]
jwe
parents: 5660
diff changeset
9 ##
13be36ec8279 [project @ 2006-03-10 17:43:38 by jwe]
jwe
parents: 5660
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
13be36ec8279 [project @ 2006-03-10 17:43:38 by jwe]
jwe
parents: 5660
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
13be36ec8279 [project @ 2006-03-10 17:43:38 by jwe]
jwe
parents: 5660
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13be36ec8279 [project @ 2006-03-10 17:43:38 by jwe]
jwe
parents: 5660
diff changeset
13 ## General Public License for more details.
13be36ec8279 [project @ 2006-03-10 17:43:38 by jwe]
jwe
parents: 5660
diff changeset
14 ##
13be36ec8279 [project @ 2006-03-10 17:43:38 by jwe]
jwe
parents: 5660
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/>.
5661
13be36ec8279 [project @ 2006-03-10 17:43:38 by jwe]
jwe
parents: 5660
diff changeset
18
5660
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
13848
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
20 ## @deftypefn {Function File} {@var{days} =} datenum (@var{datevec})
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
21 ## @deftypefnx {Function File} {@var{days} =} datenum (@var{year}, @var{month}, @var{day})
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
22 ## @deftypefnx {Function File} {@var{days} =} datenum (@var{year}, @var{month}, @var{day}, @var{hour})
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
23 ## @deftypefnx {Function File} {@var{days} =} datenum (@var{year}, @var{month}, @var{day}, @var{hour}, @var{minute})
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
24 ## @deftypefnx {Function File} {@var{days} =} datenum (@var{year}, @var{month}, @var{day}, @var{hour}, @var{minute}, @var{second})
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
25 ## @deftypefnx {Function File} {@var{days} =} datenum ("datestr")
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
26 ## @deftypefnx {Function File} {@var{days} =} datenum ("datestr", @var{p})
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
27 ## @deftypefnx {Function File} {[@var{days}, @var{secs}] =} datenum (@dots{})
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
28 ## Return the date/time input as a serial day number, with Jan 1, 0000
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
29 ## being day 1. The fractional portion of @var{days} corresponds to the time
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
30 ## on the given day. The input may be a date vector (see @code{datevec}),
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
31 ## datestr (see @code{datestr}), or directly specified as input.
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
32 ##
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
33 ## When processing datestrings, @var{p} is the year at the start of the century
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
34 ## to which two-digit years will be referenced. If not specified, it defaults
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
35 ## to the current year minus 50.
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
36 ##
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
37 ## The optional output @var{secs} holds the time on the specified day with greater
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
38 ## precision than @var{days}.
5660
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents:
diff changeset
39 ##
5661
13be36ec8279 [project @ 2006-03-10 17:43:38 by jwe]
jwe
parents: 5660
diff changeset
40 ## Notes:
13be36ec8279 [project @ 2006-03-10 17:43:38 by jwe]
jwe
parents: 5660
diff changeset
41 ##
13be36ec8279 [project @ 2006-03-10 17:43:38 by jwe]
jwe
parents: 5660
diff changeset
42 ## @itemize
13be36ec8279 [project @ 2006-03-10 17:43:38 by jwe]
jwe
parents: 5660
diff changeset
43 ## @item
5660
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents:
diff changeset
44 ## Years can be negative and/or fractional.
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
45 ##
5661
13be36ec8279 [project @ 2006-03-10 17:43:38 by jwe]
jwe
parents: 5660
diff changeset
46 ## @item
5660
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents:
diff changeset
47 ## Months below 1 are considered to be January.
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
48 ##
5661
13be36ec8279 [project @ 2006-03-10 17:43:38 by jwe]
jwe
parents: 5660
diff changeset
49 ## @item
5660
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents:
diff changeset
50 ## Days of the month start at 1.
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
51 ##
5661
13be36ec8279 [project @ 2006-03-10 17:43:38 by jwe]
jwe
parents: 5660
diff changeset
52 ## @item
5660
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents:
diff changeset
53 ## Days beyond the end of the month go into subsequent months.
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
54 ##
5661
13be36ec8279 [project @ 2006-03-10 17:43:38 by jwe]
jwe
parents: 5660
diff changeset
55 ## @item
5660
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents:
diff changeset
56 ## Days before the beginning of the month go to the previous month.
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
57 ##
5661
13be36ec8279 [project @ 2006-03-10 17:43:38 by jwe]
jwe
parents: 5660
diff changeset
58 ## @item
5660
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents:
diff changeset
59 ## Days can be fractional.
5661
13be36ec8279 [project @ 2006-03-10 17:43:38 by jwe]
jwe
parents: 5660
diff changeset
60 ## @end itemize
5660
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents:
diff changeset
61 ##
12973
b80b18f537ca doc: Correct various Texinfo warnings about incorrect use of macros.
Rik <octave@nomad.inbox5.com>
parents: 12681
diff changeset
62 ## @strong{Caution:} this function does not attempt to handle Julian
5660
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents:
diff changeset
63 ## calendars so dates before Octave 15, 1582 are wrong by as much
13848
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
64 ## as eleven days. Also, be aware that only Roman Catholic countries
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
65 ## adopted the calendar in 1582. It took until 1924 for it to be
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
66 ## adopted everywhere. See the Wikipedia entry on the Gregorian
5660
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents:
diff changeset
67 ## calendar for more details.
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents:
diff changeset
68 ##
5661
13be36ec8279 [project @ 2006-03-10 17:43:38 by jwe]
jwe
parents: 5660
diff changeset
69 ## @strong{Warning:} leap seconds are ignored. A table of leap seconds
5660
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents:
diff changeset
70 ## is available on the Wikipedia entry for leap seconds.
13848
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
71 ## @seealso{datestr, datevec, date, clock, now, calendar, weekday}
5660
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents:
diff changeset
72 ## @end deftypefn
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents:
diff changeset
73
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents:
diff changeset
74 ## Algorithm: Peter Baum (http://vsg.cape.com/~pbaum/date/date0.htm)
5687
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents: 5661
diff changeset
75 ## Author: pkienzle <pkienzle@users.sf.net>
5660
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents:
diff changeset
76
13848
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
77 function [days, secs] = datenum (year, month = [], day = [], hour = 0, minute = 0, second = 0)
5661
13be36ec8279 [project @ 2006-03-10 17:43:38 by jwe]
jwe
parents: 5660
diff changeset
78
5660
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents:
diff changeset
79 ## Days until start of month assuming year starts March 1.
5661
13be36ec8279 [project @ 2006-03-10 17:43:38 by jwe]
jwe
parents: 5660
diff changeset
80 persistent monthstart = [306; 337; 0; 31; 61; 92; 122; 153; 184; 214; 245; 275];
5660
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents:
diff changeset
81
13848
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
82 if (nargin == 0 || nargin > 6 ||
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
83 (nargin > 2 && (ischar (year) || iscellstr (year))))
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5973
diff changeset
84 print_usage ();
5660
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents:
diff changeset
85 endif
13848
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
86
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
87 if (ischar (year) || iscellstr (year))
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 10821
diff changeset
88 [year, month, day, hour, minute, second] = datevec (year, month);
5660
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents:
diff changeset
89 else
5661
13be36ec8279 [project @ 2006-03-10 17:43:38 by jwe]
jwe
parents: 5660
diff changeset
90 if (nargin == 1)
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 10821
diff changeset
91 nc = columns (year);
5661
13be36ec8279 [project @ 2006-03-10 17:43:38 by jwe]
jwe
parents: 5660
diff changeset
92 if (nc > 6 || nc < 3)
11472
1740012184f9 Use uppercase for variable names in error() strings to match Info documentation. Only m-files done.
Rik <octave@nomad.inbox5.com>
parents: 11469
diff changeset
93 error ("datenum: expected date vector containing [YEAR, MONTH, DAY, HOUR, MINUTE, SECOND]");
5660
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents:
diff changeset
94 endif
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 10821
diff changeset
95 if (nc >= 6) second = year(:,6); endif
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 10821
diff changeset
96 if (nc >= 5) minute = year(:,5); endif
13848
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
97 if (nc >= 4) hour = year(:,4); endif
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
98 day = year(:,3);
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 10821
diff changeset
99 month = year(:,2);
13848
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
100 year = year(:,1);
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
101 endif
5660
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents:
diff changeset
102 endif
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents:
diff changeset
103
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 10821
diff changeset
104 month(month<1) = 1; ## For compatibility. Otherwise allow negative months.
5660
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents:
diff changeset
105
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents:
diff changeset
106 ## Set start of year to March by moving Jan. and Feb. to previous year.
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents:
diff changeset
107 ## Correct for months > 12 by moving to subsequent years.
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 10821
diff changeset
108 year += fix ((month-14)/12);
5660
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents:
diff changeset
109
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents:
diff changeset
110 ## Lookup number of days since start of the current year.
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 10821
diff changeset
111 if (numel (month) == 1 || numel (day) == 1)
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 10821
diff changeset
112 ## Allow month or day to be scalar while other values may be vectors or
7782
bfd8d804e6d3 datenum\: fixed combination of scalar and vector/matrix input bug
bill@denney.ws
parents: 7659
diff changeset
113 ## matrices.
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 10821
diff changeset
114 day += monthstart (mod (month-1,12) + 1) + 60;
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 10821
diff changeset
115 if (numel (month) > 1)
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 10821
diff changeset
116 day = reshape (day, size (month));
7782
bfd8d804e6d3 datenum\: fixed combination of scalar and vector/matrix input bug
bill@denney.ws
parents: 7659
diff changeset
117 endif
bfd8d804e6d3 datenum\: fixed combination of scalar and vector/matrix input bug
bill@denney.ws
parents: 7659
diff changeset
118 else
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 10821
diff changeset
119 day += reshape (monthstart (mod (month-1,12) + 1), size (day)) + 60;
7782
bfd8d804e6d3 datenum\: fixed combination of scalar and vector/matrix input bug
bill@denney.ws
parents: 7659
diff changeset
120 endif
5660
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents:
diff changeset
121
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents:
diff changeset
122 ## Add number of days to the start of the current year. Correct
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents:
diff changeset
123 ## for leap year every 4 years except centuries not divisible by 400.
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 10821
diff changeset
124 day += 365*year + floor (year/4) - floor (year/100) + floor (year/400);
5660
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents:
diff changeset
125
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents:
diff changeset
126 ## Add fraction representing current second of the day.
13848
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
127 days = day + (hour + (minute + second/60)/60)/24;
5660
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents:
diff changeset
128
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents:
diff changeset
129 ## Output seconds if asked so that etime can be more accurate
13848
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
130 if (isargout (2))
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
131 secs = day*86400 + hour*3600 + minute*60 + second;
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
132 endif
5660
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents:
diff changeset
133
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents:
diff changeset
134 endfunction
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents:
diff changeset
135
13848
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
136
5660
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents:
diff changeset
137 %!shared part
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents:
diff changeset
138 %! part = 0.514623842592593;
13848
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
139 %!assert (datenum (2001,5,19), 730990)
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
140 %!assert (datenum ([1417,6,12]), 517712)
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
141 %!assert (datenum ([2001,5,19;1417,6,12]), [730990;517712])
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
142 %!assert (datenum (2001,5,19,12,21,3.5), 730990+part, eps)
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
143 %!assert (datenum ([1417,6,12,12,21,3.5]), 517712+part, eps)
7659
4ab2488ab2b4 datenum: allow vector inputs in any orientation
Bill Denny
parents: 7017
diff changeset
144 ## Test vector inputs
5660
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents:
diff changeset
145 %!test
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents:
diff changeset
146 %! t = [2001,5,19,12,21,3.5; 1417,6,12,12,21,3.5];
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents:
diff changeset
147 %! n = [730990; 517712] + part;
13848
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
148 %! assert (datenum (t), n, 2*eps);
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
149 %! ## Check that vectors can have either orientation
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
150 %! t = t';
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
151 %! n = n';
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
152 %! assert (datenum (t(1,:), t(2,:), t(3,:), t(4,:), t(5,:), t(6,:)), n, 2*eps);
7782
bfd8d804e6d3 datenum\: fixed combination of scalar and vector/matrix input bug
bill@denney.ws
parents: 7659
diff changeset
153
bfd8d804e6d3 datenum\: fixed combination of scalar and vector/matrix input bug
bill@denney.ws
parents: 7659
diff changeset
154 ## Test mixed vectors and scalars
bfd8d804e6d3 datenum\: fixed combination of scalar and vector/matrix input bug
bill@denney.ws
parents: 7659
diff changeset
155 %!assert (datenum([2008;2009], 1, 1), [datenum(2008, 1, 1);datenum(2009, 1, 1)]);
bfd8d804e6d3 datenum\: fixed combination of scalar and vector/matrix input bug
bill@denney.ws
parents: 7659
diff changeset
156 %!assert (datenum(2008, [1;2], 1), [datenum(2008, 1, 1);datenum(2008, 2, 1)]);
bfd8d804e6d3 datenum\: fixed combination of scalar and vector/matrix input bug
bill@denney.ws
parents: 7659
diff changeset
157 %!assert (datenum(2008, 1, [1;2]), [datenum(2008, 1, 1);datenum(2008, 1, 2)]);
bfd8d804e6d3 datenum\: fixed combination of scalar and vector/matrix input bug
bill@denney.ws
parents: 7659
diff changeset
158 %!assert (datenum([2008;2009], [1;2], 1), [datenum(2008, 1, 1);datenum(2009, 2, 1)]);
bfd8d804e6d3 datenum\: fixed combination of scalar and vector/matrix input bug
bill@denney.ws
parents: 7659
diff changeset
159 %!assert (datenum([2008;2009], 1, [1;2]), [datenum(2008, 1, 1);datenum(2009, 1, 2)]);
bfd8d804e6d3 datenum\: fixed combination of scalar and vector/matrix input bug
bill@denney.ws
parents: 7659
diff changeset
160 %!assert (datenum(2008, [1;2], [1;2]), [datenum(2008, 1, 1);datenum(2008, 2, 2)]);
bfd8d804e6d3 datenum\: fixed combination of scalar and vector/matrix input bug
bill@denney.ws
parents: 7659
diff changeset
161 ## And the other orientation
bfd8d804e6d3 datenum\: fixed combination of scalar and vector/matrix input bug
bill@denney.ws
parents: 7659
diff changeset
162 %!assert (datenum([2008 2009], 1, 1), [datenum(2008, 1, 1) datenum(2009, 1, 1)]);
bfd8d804e6d3 datenum\: fixed combination of scalar and vector/matrix input bug
bill@denney.ws
parents: 7659
diff changeset
163 %!assert (datenum(2008, [1 2], 1), [datenum(2008, 1, 1) datenum(2008, 2, 1)]);
bfd8d804e6d3 datenum\: fixed combination of scalar and vector/matrix input bug
bill@denney.ws
parents: 7659
diff changeset
164 %!assert (datenum(2008, 1, [1 2]), [datenum(2008, 1, 1) datenum(2008, 1, 2)]);
bfd8d804e6d3 datenum\: fixed combination of scalar and vector/matrix input bug
bill@denney.ws
parents: 7659
diff changeset
165 %!assert (datenum([2008 2009], [1 2], 1), [datenum(2008, 1, 1) datenum(2009, 2, 1)]);
bfd8d804e6d3 datenum\: fixed combination of scalar and vector/matrix input bug
bill@denney.ws
parents: 7659
diff changeset
166 %!assert (datenum([2008 2009], 1, [1 2]), [datenum(2008, 1, 1) datenum(2009, 1, 2)]);
bfd8d804e6d3 datenum\: fixed combination of scalar and vector/matrix input bug
bill@denney.ws
parents: 7659
diff changeset
167 %!assert (datenum(2008, [1 2], [1 2]), [datenum(2008, 1, 1) datenum(2008, 2, 2)]);
13848
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
168 ## Test string and cellstr inputs
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
169 %!assert (datenum ("5/19/2001"), 730990)
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
170 %!assert (datenum ({"5/19/2001"}), 730990)
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
171 %!assert (datenum (char ("5/19/2001", "6/6/1944")), [730990; 710189])
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
172 %!assert (datenum ({"5/19/2001", "6/6/1944"}), [730990; 710189])
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
173
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
174 %% Test input validation
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
175 %!error datenum ()
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
176 %!error datenum (1,2,3,4,5,6,7)
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
177 %!error datenum ([1, 2])
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 12973
diff changeset
178 %!error datenum ([1,2,3,4,5,6,7])