annotate scripts/time/datestr.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 e9f89866074c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19697
4197fc428c7d maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents: 19418
diff changeset
1 ## Copyright (C) 2000-2015 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: 6555
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: 6555
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: 6555
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: 6555
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: 11329
diff changeset
20 ## @deftypefn {Function File} {@var{str} =} datestr (@var{date})
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 11329
diff changeset
21 ## @deftypefnx {Function File} {@var{str} =} datestr (@var{date}, @var{f})
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 11329
diff changeset
22 ## @deftypefnx {Function File} {@var{str} =} datestr (@var{date}, @var{f}, @var{p})
5687
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
23 ## Format the given date/time according to the format @code{f} and return
20162
2645f9ef8c88 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19865
diff changeset
24 ## the result in @var{str}.
2645f9ef8c88 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19865
diff changeset
25 ##
2645f9ef8c88 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19865
diff changeset
26 ## @var{date} is a serial date number (see @code{datenum}) or a date vector
2645f9ef8c88 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19865
diff changeset
27 ## (see @code{datevec}). The value of @var{date} may also be a string or cell
2645f9ef8c88 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19865
diff changeset
28 ## array of strings.
5687
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
29 ##
20162
2645f9ef8c88 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19865
diff changeset
30 ## @var{f} can be an integer which corresponds to one of the codes in the table
2645f9ef8c88 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19865
diff changeset
31 ## below, or a date format string.
5687
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
32 ##
20162
2645f9ef8c88 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19865
diff changeset
33 ## @var{p} is the year at the start of the century in which two-digit years are
2645f9ef8c88 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19865
diff changeset
34 ## to be interpreted in. If not specified, it defaults to the current year
2645f9ef8c88 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19865
diff changeset
35 ## minus 50.
5687
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
36 ##
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
37 ## For example, the date 730736.65149 (2000-09-07 15:38:09.0934) would be
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
38 ## formatted as follows:
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
39 ##
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
40 ## @multitable @columnfractions 0.1 0.45 0.35
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
41 ## @headitem Code @tab Format @tab Example
19418
06931d787450 doc: Align columns in @multitable in datestr.m docstring.
Rik <rik@octave.org>
parents: 19414
diff changeset
42 ## @item 0 @tab dd-mmm-yyyy HH:MM:SS @tab 07-Sep-2000 15:38:09
06931d787450 doc: Align columns in @multitable in datestr.m docstring.
Rik <rik@octave.org>
parents: 19414
diff changeset
43 ## @item 1 @tab dd-mmm-yyyy @tab 07-Sep-2000
06931d787450 doc: Align columns in @multitable in datestr.m docstring.
Rik <rik@octave.org>
parents: 19414
diff changeset
44 ## @item 2 @tab mm/dd/yy @tab 09/07/00
06931d787450 doc: Align columns in @multitable in datestr.m docstring.
Rik <rik@octave.org>
parents: 19414
diff changeset
45 ## @item 3 @tab mmm @tab Sep
06931d787450 doc: Align columns in @multitable in datestr.m docstring.
Rik <rik@octave.org>
parents: 19414
diff changeset
46 ## @item 4 @tab m @tab S
06931d787450 doc: Align columns in @multitable in datestr.m docstring.
Rik <rik@octave.org>
parents: 19414
diff changeset
47 ## @item 5 @tab mm @tab 09
06931d787450 doc: Align columns in @multitable in datestr.m docstring.
Rik <rik@octave.org>
parents: 19414
diff changeset
48 ## @item 6 @tab mm/dd @tab 09/07
06931d787450 doc: Align columns in @multitable in datestr.m docstring.
Rik <rik@octave.org>
parents: 19414
diff changeset
49 ## @item 7 @tab dd @tab 07
06931d787450 doc: Align columns in @multitable in datestr.m docstring.
Rik <rik@octave.org>
parents: 19414
diff changeset
50 ## @item 8 @tab ddd @tab Thu
06931d787450 doc: Align columns in @multitable in datestr.m docstring.
Rik <rik@octave.org>
parents: 19414
diff changeset
51 ## @item 9 @tab d @tab T
5687
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
52 ## @item 10 @tab yyyy @tab 2000
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
53 ## @item 11 @tab yy @tab 00
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
54 ## @item 12 @tab mmmyy @tab Sep00
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
55 ## @item 13 @tab HH:MM:SS @tab 15:38:09
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
56 ## @item 14 @tab HH:MM:SS PM @tab 03:38:09 PM
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
57 ## @item 15 @tab HH:MM @tab 15:38
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
58 ## @item 16 @tab HH:MM PM @tab 03:38 PM
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
59 ## @item 17 @tab QQ-YY @tab Q3-00
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
60 ## @item 18 @tab QQ @tab Q3
14723
3fd6f637c573 doc: Correct errors and improve docstring for datestr.m
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
61 ## @item 19 @tab dd/mm @tab 07/09
3fd6f637c573 doc: Correct errors and improve docstring for datestr.m
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
62 ## @item 20 @tab dd/mm/yy @tab 07/09/00
3fd6f637c573 doc: Correct errors and improve docstring for datestr.m
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
63 ## @item 21 @tab mmm.dd,yyyy HH:MM:SS @tab Sep.07,2000 15:38:08
3fd6f637c573 doc: Correct errors and improve docstring for datestr.m
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
64 ## @item 22 @tab mmm.dd,yyyy @tab Sep.07,2000
3fd6f637c573 doc: Correct errors and improve docstring for datestr.m
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
65 ## @item 23 @tab mm/dd/yyyy @tab 09/07/2000
3fd6f637c573 doc: Correct errors and improve docstring for datestr.m
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
66 ## @item 24 @tab dd/mm/yyyy @tab 07/09/2000
3fd6f637c573 doc: Correct errors and improve docstring for datestr.m
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
67 ## @item 25 @tab yy/mm/dd @tab 00/09/07
3fd6f637c573 doc: Correct errors and improve docstring for datestr.m
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
68 ## @item 26 @tab yyyy/mm/dd @tab 2000/09/07
3fd6f637c573 doc: Correct errors and improve docstring for datestr.m
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
69 ## @item 27 @tab QQ-YYYY @tab Q3-2000
3fd6f637c573 doc: Correct errors and improve docstring for datestr.m
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
70 ## @item 28 @tab mmmyyyy @tab Sep2000
3fd6f637c573 doc: Correct errors and improve docstring for datestr.m
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
71 ## @item 29 @tab yyyy-mm-dd @tab 2000-09-07
3fd6f637c573 doc: Correct errors and improve docstring for datestr.m
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
72 ## @item 30 @tab yyyymmddTHHMMSS @tab 20000907T153808
3fd6f637c573 doc: Correct errors and improve docstring for datestr.m
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
73 ## @item 31 @tab yyyy-mm-dd HH:MM:SS @tab 2000-09-07 15:38:08
5687
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
74 ## @end multitable
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
75 ##
9079
4d610aba7347 Cleanup documentation for system.texi, package.texi
Rik <rdrider0-list@yahoo.com>
parents: 9051
diff changeset
76 ## If @var{f} is a format string, the following symbols are recognized:
5687
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
77 ##
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
78 ## @multitable @columnfractions 0.1 0.7 0.2
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
79 ## @headitem Symbol @tab Meaning @tab Example
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
80 ## @item yyyy @tab Full year @tab 2005
14723
3fd6f637c573 doc: Correct errors and improve docstring for datestr.m
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
81 ## @item yy @tab Two-digit year @tab 05
5687
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
82 ## @item mmmm @tab Full month name @tab December
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
83 ## @item mmm @tab Abbreviated month name @tab Dec
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
84 ## @item mm @tab Numeric month number (padded with zeros) @tab 01, 08, 12
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
85 ## @item m @tab First letter of month name (capitalized) @tab D
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
86 ## @item dddd @tab Full weekday name @tab Sunday
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
87 ## @item ddd @tab Abbreviated weekday name @tab Sun
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
88 ## @item dd @tab Numeric day of month (padded with zeros) @tab 11
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
89 ## @item d @tab First letter of weekday name (capitalized) @tab S
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
90 ## @item HH @tab Hour of day, padded with zeros if PM is set @tab 09:00
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
91 ## @item @tab and not padded with zeros otherwise @tab 9:00 AM
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
92 ## @item MM @tab Minute of hour (padded with zeros) @tab 10:05
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
93 ## @item SS @tab Second of minute (padded with zeros) @tab 10:05:03
13848
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
94 ## @item FFF @tab Milliseconds of second (padded with zeros) @tab 10:05:03.012
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
95 ## @item AM @tab Use 12-hour time format @tab 11:30 AM
5687
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
96 ## @item PM @tab Use 12-hour time format @tab 11:30 PM
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
97 ## @end multitable
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
98 ##
20162
2645f9ef8c88 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19865
diff changeset
99 ## If @var{f} is not specified or is @code{-1}, then use 0, 1 or 16, depending
2645f9ef8c88 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19865
diff changeset
100 ## on whether the date portion or the time portion of @var{date} is empty.
5687
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
101 ##
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
102 ## If @var{p} is nor specified, it defaults to the current year minus 50.
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
103 ##
13848
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
104 ## If a matrix or cell array of dates is given, a column vector of date strings
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
105 ## is returned.
5687
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
106 ##
13856
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time.
Rik <octave@nomad.inbox5.com>
parents: 13848
diff changeset
107 ## @seealso{datenum, datevec, date, now, clock}
5687
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
108 ## @end deftypefn
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
109
8202
cf59d542f33e replace all TODOs and XXXs with FIXMEs
Jaroslav Hajek <highegg@gmail.com>
parents: 8112
diff changeset
110 ## FIXME: parse arbitrary code strings.
cf59d542f33e replace all TODOs and XXXs with FIXMEs
Jaroslav Hajek <highegg@gmail.com>
parents: 8112
diff changeset
111 ## e.g., for Wednesday 2001-03-05 09:04:06 AM, use
cf59d542f33e replace all TODOs and XXXs with FIXMEs
Jaroslav Hajek <highegg@gmail.com>
parents: 8112
diff changeset
112 ## yy 01
cf59d542f33e replace all TODOs and XXXs with FIXMEs
Jaroslav Hajek <highegg@gmail.com>
parents: 8112
diff changeset
113 ## yyyy 2001
cf59d542f33e replace all TODOs and XXXs with FIXMEs
Jaroslav Hajek <highegg@gmail.com>
parents: 8112
diff changeset
114 ## m M
cf59d542f33e replace all TODOs and XXXs with FIXMEs
Jaroslav Hajek <highegg@gmail.com>
parents: 8112
diff changeset
115 ## mm 03
cf59d542f33e replace all TODOs and XXXs with FIXMEs
Jaroslav Hajek <highegg@gmail.com>
parents: 8112
diff changeset
116 ## mmm Mar
cf59d542f33e replace all TODOs and XXXs with FIXMEs
Jaroslav Hajek <highegg@gmail.com>
parents: 8112
diff changeset
117 ## d W
cf59d542f33e replace all TODOs and XXXs with FIXMEs
Jaroslav Hajek <highegg@gmail.com>
parents: 8112
diff changeset
118 ## dd 05
cf59d542f33e replace all TODOs and XXXs with FIXMEs
Jaroslav Hajek <highegg@gmail.com>
parents: 8112
diff changeset
119 ## ddd Wed
cf59d542f33e replace all TODOs and XXXs with FIXMEs
Jaroslav Hajek <highegg@gmail.com>
parents: 8112
diff changeset
120 ## HH 09
cf59d542f33e replace all TODOs and XXXs with FIXMEs
Jaroslav Hajek <highegg@gmail.com>
parents: 8112
diff changeset
121 ## MM 04
cf59d542f33e replace all TODOs and XXXs with FIXMEs
Jaroslav Hajek <highegg@gmail.com>
parents: 8112
diff changeset
122 ## SS 06
cf59d542f33e replace all TODOs and XXXs with FIXMEs
Jaroslav Hajek <highegg@gmail.com>
parents: 8112
diff changeset
123 ## PM AM
cf59d542f33e replace all TODOs and XXXs with FIXMEs
Jaroslav Hajek <highegg@gmail.com>
parents: 8112
diff changeset
124 ## FIXME: Vectorize. It is particularly easy since all the codes are
cf59d542f33e replace all TODOs and XXXs with FIXMEs
Jaroslav Hajek <highegg@gmail.com>
parents: 8112
diff changeset
125 ## fixed width. Just generate the parts in separate arrays and
cf59d542f33e replace all TODOs and XXXs with FIXMEs
Jaroslav Hajek <highegg@gmail.com>
parents: 8112
diff changeset
126 ## concatenate.
5687
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
127
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
128 ## Author: pkienzle <pkienzle@users.sf.net>
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
129 ## Created: 10 October 2001 (CVS)
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
130 ## Adapted-By: William Poetra Yoga Hadisoeseno <williampoetra@gmail.com>
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
131
13848
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
132 function retval = datestr (date, f = [], p = [])
5687
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
133
13848
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
134 persistent dateform names_mmmm names_m names_d;
5687
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
135
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
136 if (isempty (dateform))
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
137 dateform = cell (32, 1);
13848
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
138 dateform{1} = "dd-mmm-yyyy HH:MM:SS";
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
139 dateform{2} = "dd-mmm-yyyy";
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
140 dateform{3} = "mm/dd/yy";
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
141 dateform{4} = "mmm";
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
142 dateform{5} = "m";
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
143 dateform{6} = "mm";
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
144 dateform{7} = "mm/dd";
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
145 dateform{8} = "dd";
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
146 dateform{9} = "ddd";
5687
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
147 dateform{10} = "d";
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
148 dateform{11} = "yyyy";
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
149 dateform{12} = "yy";
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
150 dateform{13} = "mmmyy";
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
151 dateform{14} = "HH:MM:SS";
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
152 dateform{15} = "HH:MM:SS PM";
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
153 dateform{16} = "HH:MM";
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
154 dateform{17} = "HH:MM PM";
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
155 dateform{18} = "QQ-YY";
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
156 dateform{19} = "QQ";
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
157 dateform{20} = "dd/mm";
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
158 dateform{21} = "dd/mm/yy";
13848
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
159 dateform{22} = "mmm.dd,yyyy HH:MM:SS";
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
160 dateform{23} = "mmm.dd,yyyy";
5687
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
161 dateform{24} = "mm/dd/yyyy";
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
162 dateform{25} = "dd/mm/yyyy";
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
163 dateform{26} = "yy/mm/dd";
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
164 dateform{27} = "yyyy/mm/dd";
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
165 dateform{28} = "QQ-YYYY";
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
166 dateform{29} = "mmmyyyy";
13848
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
167 dateform{30} = "yyyy-mm-dd";
5687
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
168 dateform{31} = "yyyymmddTHHMMSS";
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
169 dateform{32} = "yyyy-mm-dd HH:MM:SS";
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
170
13848
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
171 names_m = {"J", "F", "M", "A", "M", "J", "J", "A", "S", "O", "N", "D"};
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
172 names_d = {"S", "M", "T", "W", "T", "F", "S"};
5687
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
173 endif
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
174
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
175 if (nargin < 1 || nargin > 3)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5687
diff changeset
176 print_usage ();
5687
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
177 endif
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
178
13848
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
179 ## Guess input type. We might be wrong.
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
180 if (ischar (date) || iscellstr (date) || columns (date) != 6)
5687
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
181 v = datevec (date, p);
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
182 else
7492
bd1168732c95 datestr.m: fix 6 datenum vector bug
bill@denney.ws
parents: 7017
diff changeset
183 v = [];
7493
f1bce8450fd0 [mq]: tmp-patch
John W. Eaton <jwe@octave.org>
parents: 7492
diff changeset
184 if (columns (date) == 6)
f1bce8450fd0 [mq]: tmp-patch
John W. Eaton <jwe@octave.org>
parents: 7492
diff changeset
185 ## Make sure that the input really is a datevec.
f1bce8450fd0 [mq]: tmp-patch
John W. Eaton <jwe@octave.org>
parents: 7492
diff changeset
186 maxdatevec = [Inf, 12, 31, 23, 59, 60];
19865
e9f89866074c maint: Cleanup some .m files to follow Octave coding conventions.
John W. Eaton <jwe@octave.org>
parents: 19833
diff changeset
187 if (any (max (date, 1) > maxdatevec)
e9f89866074c maint: Cleanup some .m files to follow Octave coding conventions.
John W. Eaton <jwe@octave.org>
parents: 19833
diff changeset
188 || any (date(:,1:5) != floor (date(:,1:5))))
13848
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
189 v = datevec (date, p);
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
190 endif
7492
bd1168732c95 datestr.m: fix 6 datenum vector bug
bill@denney.ws
parents: 7017
diff changeset
191 endif
7493
f1bce8450fd0 [mq]: tmp-patch
John W. Eaton <jwe@octave.org>
parents: 7492
diff changeset
192 if (isempty (v))
7492
bd1168732c95 datestr.m: fix 6 datenum vector bug
bill@denney.ws
parents: 7017
diff changeset
193 v = date;
bd1168732c95 datestr.m: fix 6 datenum vector bug
bill@denney.ws
parents: 7017
diff changeset
194 endif
5687
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
195 endif
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
196
19414
a2a79462b7b8 datestr.m: Clean up use of []/"" and single/double quotes (bug #43841).
Rik <rik@octave.org>
parents: 18857
diff changeset
197 retval = "";
13848
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
198 for i = 1 : rows (v)
5687
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
199
13848
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
200 if (isempty (f))
5687
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
201 if (v(i,4:6) == 0)
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
202 f = 1;
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
203 elseif (v(i,1:3) == [-1, 12, 31])
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
204 f = 16;
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
205 else
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
206 f = 0;
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
207 endif
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
208 endif
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
209
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
210 if (isnumeric (f))
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
211 df = dateform{f + 1};
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
212 else
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
213 df = f;
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
214 endif
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
215
8098
229bd50e6e8f datestr.m: convert format and use strtftime for most of the actual conversion
John W. Eaton <jwe@octave.org>
parents: 7969
diff changeset
216 df_orig = df;
19414
a2a79462b7b8 datestr.m: Clean up use of []/"" and single/double quotes (bug #43841).
Rik <rik@octave.org>
parents: 18857
diff changeset
217 df = strrep (df, "AM", "%p");
a2a79462b7b8 datestr.m: Clean up use of []/"" and single/double quotes (bug #43841).
Rik <rik@octave.org>
parents: 18857
diff changeset
218 df = strrep (df, "PM", "%p");
8098
229bd50e6e8f datestr.m: convert format and use strtftime for most of the actual conversion
John W. Eaton <jwe@octave.org>
parents: 7969
diff changeset
219 if (strcmp (df, df_orig))
229bd50e6e8f datestr.m: convert format and use strtftime for most of the actual conversion
John W. Eaton <jwe@octave.org>
parents: 7969
diff changeset
220 ## PM not set.
229bd50e6e8f datestr.m: convert format and use strtftime for most of the actual conversion
John W. Eaton <jwe@octave.org>
parents: 7969
diff changeset
221 df = strrep (df, "HH", "%H");
229bd50e6e8f datestr.m: convert format and use strtftime for most of the actual conversion
John W. Eaton <jwe@octave.org>
parents: 7969
diff changeset
222 else
229bd50e6e8f datestr.m: convert format and use strtftime for most of the actual conversion
John W. Eaton <jwe@octave.org>
parents: 7969
diff changeset
223 df = strrep (df, "HH", sprintf ("%2d", v(i,4)));
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
224 endif
8098
229bd50e6e8f datestr.m: convert format and use strtftime for most of the actual conversion
John W. Eaton <jwe@octave.org>
parents: 7969
diff changeset
225
19414
a2a79462b7b8 datestr.m: Clean up use of []/"" and single/double quotes (bug #43841).
Rik <rik@octave.org>
parents: 18857
diff changeset
226 df = regexprep (df, "[Yy][Yy][Yy][Yy]", "%Y");
8098
229bd50e6e8f datestr.m: convert format and use strtftime for most of the actual conversion
John W. Eaton <jwe@octave.org>
parents: 7969
diff changeset
227
19414
a2a79462b7b8 datestr.m: Clean up use of []/"" and single/double quotes (bug #43841).
Rik <rik@octave.org>
parents: 18857
diff changeset
228 df = regexprep (df, "[Yy][Yy]", "%y");
8098
229bd50e6e8f datestr.m: convert format and use strtftime for most of the actual conversion
John W. Eaton <jwe@octave.org>
parents: 7969
diff changeset
229
19414
a2a79462b7b8 datestr.m: Clean up use of []/"" and single/double quotes (bug #43841).
Rik <rik@octave.org>
parents: 18857
diff changeset
230 df = regexprep (df, "[Dd][Dd][Dd][Dd]", "%A");
8098
229bd50e6e8f datestr.m: convert format and use strtftime for most of the actual conversion
John W. Eaton <jwe@octave.org>
parents: 7969
diff changeset
231
19414
a2a79462b7b8 datestr.m: Clean up use of []/"" and single/double quotes (bug #43841).
Rik <rik@octave.org>
parents: 18857
diff changeset
232 df = regexprep (df, "[Dd][Dd][Dd]", "%a");
8098
229bd50e6e8f datestr.m: convert format and use strtftime for most of the actual conversion
John W. Eaton <jwe@octave.org>
parents: 7969
diff changeset
233
19414
a2a79462b7b8 datestr.m: Clean up use of []/"" and single/double quotes (bug #43841).
Rik <rik@octave.org>
parents: 18857
diff changeset
234 df = regexprep (df, "[Dd][Dd]", "%d");
8098
229bd50e6e8f datestr.m: convert format and use strtftime for most of the actual conversion
John W. Eaton <jwe@octave.org>
parents: 7969
diff changeset
235
11328
f286a874617c datestr: handle dates before 1970-01-01
John W. Eaton <jwe@octave.org>
parents: 11149
diff changeset
236 wday = weekday (datenum (v(i,1), v(i,2), v(i,3)));
f286a874617c datestr: handle dates before 1970-01-01
John W. Eaton <jwe@octave.org>
parents: 11149
diff changeset
237 tmp = names_d{wday};
19414
a2a79462b7b8 datestr.m: Clean up use of []/"" and single/double quotes (bug #43841).
Rik <rik@octave.org>
parents: 18857
diff changeset
238 df = regexprep (df, "([^%])[Dd]", sprintf ("$1%s", tmp));
a2a79462b7b8 datestr.m: Clean up use of []/"" and single/double quotes (bug #43841).
Rik <rik@octave.org>
parents: 18857
diff changeset
239 df = regexprep (df, "^[Dd]", sprintf ("%s", tmp));
8098
229bd50e6e8f datestr.m: convert format and use strtftime for most of the actual conversion
John W. Eaton <jwe@octave.org>
parents: 7969
diff changeset
240
229bd50e6e8f datestr.m: convert format and use strtftime for most of the actual conversion
John W. Eaton <jwe@octave.org>
parents: 7969
diff changeset
241 df = strrep (df, "mmmm", "%B");
5687
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
242
8098
229bd50e6e8f datestr.m: convert format and use strtftime for most of the actual conversion
John W. Eaton <jwe@octave.org>
parents: 7969
diff changeset
243 df = strrep (df, "mmm", "%b");
229bd50e6e8f datestr.m: convert format and use strtftime for most of the actual conversion
John W. Eaton <jwe@octave.org>
parents: 7969
diff changeset
244
229bd50e6e8f datestr.m: convert format and use strtftime for most of the actual conversion
John W. Eaton <jwe@octave.org>
parents: 7969
diff changeset
245 df = strrep (df, "mm", "%m");
229bd50e6e8f datestr.m: convert format and use strtftime for most of the actual conversion
John W. Eaton <jwe@octave.org>
parents: 7969
diff changeset
246
229bd50e6e8f datestr.m: convert format and use strtftime for most of the actual conversion
John W. Eaton <jwe@octave.org>
parents: 7969
diff changeset
247 tmp = names_m{v(i,2)};
19414
a2a79462b7b8 datestr.m: Clean up use of []/"" and single/double quotes (bug #43841).
Rik <rik@octave.org>
parents: 18857
diff changeset
248 pos = regexp (df, "[^%]m") + 1;
8098
229bd50e6e8f datestr.m: convert format and use strtftime for most of the actual conversion
John W. Eaton <jwe@octave.org>
parents: 7969
diff changeset
249 df(pos) = tmp;
19414
a2a79462b7b8 datestr.m: Clean up use of []/"" and single/double quotes (bug #43841).
Rik <rik@octave.org>
parents: 18857
diff changeset
250 df = regexprep (df, "^m", tmp);
8098
229bd50e6e8f datestr.m: convert format and use strtftime for most of the actual conversion
John W. Eaton <jwe@octave.org>
parents: 7969
diff changeset
251
229bd50e6e8f datestr.m: convert format and use strtftime for most of the actual conversion
John W. Eaton <jwe@octave.org>
parents: 7969
diff changeset
252 df = strrep (df, "MM", "%M");
229bd50e6e8f datestr.m: convert format and use strtftime for most of the actual conversion
John W. Eaton <jwe@octave.org>
parents: 7969
diff changeset
253
19414
a2a79462b7b8 datestr.m: Clean up use of []/"" and single/double quotes (bug #43841).
Rik <rik@octave.org>
parents: 18857
diff changeset
254 df = regexprep (df, "[Ss][Ss]", "%S");
8098
229bd50e6e8f datestr.m: convert format and use strtftime for most of the actual conversion
John W. Eaton <jwe@octave.org>
parents: 7969
diff changeset
255
18650
491b0adfec95 compatibility fixes for printf integer format specifiers
John W. Eaton <jwe@octave.org>
parents: 17839
diff changeset
256 df = strrep (df, "FFF", sprintf ("%03d",
491b0adfec95 compatibility fixes for printf integer format specifiers
John W. Eaton <jwe@octave.org>
parents: 17839
diff changeset
257 round (1000 * (v(i,6) - fix (v(i,6))))));
13848
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
258
19414
a2a79462b7b8 datestr.m: Clean up use of []/"" and single/double quotes (bug #43841).
Rik <rik@octave.org>
parents: 18857
diff changeset
259 df = strrep (df, "QQ", sprintf ("Q%d", fix ((v(i,2) + 2) / 3)));
8098
229bd50e6e8f datestr.m: convert format and use strtftime for most of the actual conversion
John W. Eaton <jwe@octave.org>
parents: 7969
diff changeset
260
229bd50e6e8f datestr.m: convert format and use strtftime for most of the actual conversion
John W. Eaton <jwe@octave.org>
parents: 7969
diff changeset
261 vi = v(i,:);
229bd50e6e8f datestr.m: convert format and use strtftime for most of the actual conversion
John W. Eaton <jwe@octave.org>
parents: 7969
diff changeset
262 tm.year = vi(1) - 1900;
229bd50e6e8f datestr.m: convert format and use strtftime for most of the actual conversion
John W. Eaton <jwe@octave.org>
parents: 7969
diff changeset
263 tm.mon = vi(2) - 1;
229bd50e6e8f datestr.m: convert format and use strtftime for most of the actual conversion
John W. Eaton <jwe@octave.org>
parents: 7969
diff changeset
264 tm.mday = vi(3);
229bd50e6e8f datestr.m: convert format and use strtftime for most of the actual conversion
John W. Eaton <jwe@octave.org>
parents: 7969
diff changeset
265 tm.hour = vi(4);
229bd50e6e8f datestr.m: convert format and use strtftime for most of the actual conversion
John W. Eaton <jwe@octave.org>
parents: 7969
diff changeset
266 tm.min = vi(5);
229bd50e6e8f datestr.m: convert format and use strtftime for most of the actual conversion
John W. Eaton <jwe@octave.org>
parents: 7969
diff changeset
267 sec = vi(6);
229bd50e6e8f datestr.m: convert format and use strtftime for most of the actual conversion
John W. Eaton <jwe@octave.org>
parents: 7969
diff changeset
268 tm.sec = fix (sec);
13848
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
269 tm.usec = fix ((sec - tm.sec) * 1e6);
11328
f286a874617c datestr: handle dates before 1970-01-01
John W. Eaton <jwe@octave.org>
parents: 11149
diff changeset
270 tm.wday = wday - 1;
18857
7bbe3658c5ef maint: Use "FIXME:" coding convention in m-files.
Rik <rik@octave.org>
parents: 18650
diff changeset
271 ## FIXME: Do we need YDAY and DST? How should they be computed?
11328
f286a874617c datestr: handle dates before 1970-01-01
John W. Eaton <jwe@octave.org>
parents: 11149
diff changeset
272 ## We don't want to use "localtime (mktime (tm))" because that
f286a874617c datestr: handle dates before 1970-01-01
John W. Eaton <jwe@octave.org>
parents: 11149
diff changeset
273 ## doesn't correctly handle dates before 1970-01-01 on some systems.
f286a874617c datestr: handle dates before 1970-01-01
John W. Eaton <jwe@octave.org>
parents: 11149
diff changeset
274 ## tm.yday = ?;
f286a874617c datestr: handle dates before 1970-01-01
John W. Eaton <jwe@octave.org>
parents: 11149
diff changeset
275 ## tm.isdst = ?;
f286a874617c datestr: handle dates before 1970-01-01
John W. Eaton <jwe@octave.org>
parents: 11149
diff changeset
276
f286a874617c datestr: handle dates before 1970-01-01
John W. Eaton <jwe@octave.org>
parents: 11149
diff changeset
277 str = strftime (df, tm);
5687
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
278
13848
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
279 retval = [retval; str];
5687
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
280
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
281 endfor
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
282
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
283 endfunction
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
284
13848
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
285
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
286 %!demo
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
287 %! ## Current date and time in default format
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
288 %! datestr (now ())
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
289
13848
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
290 %!demo
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
291 %! ## Current date (integer portion of datenum)
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
292 %! datestr (fix (now ()))
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
293
13848
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
294 %!demo
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
295 %! ## Current time (fractional portion of datenum)
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
296 %! datestr (rem (now (), 1))
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
297
5687
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
298 %!shared testtime
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe]
jwe
parents:
diff changeset
299 %! testtime = [2005.0000, 12.0000, 18.0000, 2.0000, 33.0000, 17.3822];
13848
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
300 %!assert (datestr (testtime,0), "18-Dec-2005 02:33:17")
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
301 %!assert (datestr (testtime,1), "18-Dec-2005")
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
302 %!assert (datestr (testtime,2), "12/18/05")
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
303 %!assert (datestr (testtime,3), "Dec")
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
304 %!assert (datestr (testtime,4), "D")
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
305 %!assert (datestr (testtime,5), "12")
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
306 %!assert (datestr (testtime,6), "12/18")
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
307 %!assert (datestr (testtime,7), "18")
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
308 %!assert (datestr (testtime,8), "Sun")
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
309 %!assert (datestr (testtime,9), "S")
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
310 %!assert (datestr (testtime,10), "2005")
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
311 %!assert (datestr (testtime,11), "05")
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
312 %!assert (datestr (testtime,12), "Dec05")
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
313 %!assert (datestr (testtime,13), "02:33:17")
17839
2ff47214de72 datestr.m: Accomodate Mac OS X odd support of %p in strftime.
Rik <rik@octave.org>
parents: 17744
diff changeset
314 ## Mac OS X interprets %p parameter to strftime as lower case am/pm indicator.
2ff47214de72 datestr.m: Accomodate Mac OS X odd support of %p in strftime.
Rik <rik@octave.org>
parents: 17744
diff changeset
315 ## Accomodate this, although no other UNIX-based OS does this.
2ff47214de72 datestr.m: Accomodate Mac OS X odd support of %p in strftime.
Rik <rik@octave.org>
parents: 17744
diff changeset
316 %!test
2ff47214de72 datestr.m: Accomodate Mac OS X odd support of %p in strftime.
Rik <rik@octave.org>
parents: 17744
diff changeset
317 %! obs = toupper (datestr (testtime,14));
2ff47214de72 datestr.m: Accomodate Mac OS X odd support of %p in strftime.
Rik <rik@octave.org>
parents: 17744
diff changeset
318 %! assert (obs, " 2:33:17 AM");
13848
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
319 %!assert (datestr (testtime,15), "02:33")
17839
2ff47214de72 datestr.m: Accomodate Mac OS X odd support of %p in strftime.
Rik <rik@octave.org>
parents: 17744
diff changeset
320 %!test
2ff47214de72 datestr.m: Accomodate Mac OS X odd support of %p in strftime.
Rik <rik@octave.org>
parents: 17744
diff changeset
321 %! obs = toupper (datestr (testtime,16));
2ff47214de72 datestr.m: Accomodate Mac OS X odd support of %p in strftime.
Rik <rik@octave.org>
parents: 17744
diff changeset
322 %! assert (obs, " 2:33 AM");
13848
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
323 %!assert (datestr (testtime,17), "Q4-05")
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
324 %!assert (datestr (testtime,18), "Q4")
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
325 %!assert (datestr (testtime,19), "18/12")
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
326 %!assert (datestr (testtime,20), "18/12/05")
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
327 %!assert (datestr (testtime,21), "Dec.18,2005 02:33:17")
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
328 %!assert (datestr (testtime,22), "Dec.18,2005")
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
329 %!assert (datestr (testtime,23), "12/18/2005")
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
330 %!assert (datestr (testtime,24), "18/12/2005")
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
331 %!assert (datestr (testtime,25), "05/12/18")
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
332 %!assert (datestr (testtime,26), "2005/12/18")
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
333 %!assert (datestr (testtime,27), "Q4-2005")
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
334 %!assert (datestr (testtime,28), "Dec2005")
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
335 %!assert (datestr (testtime,29), "2005-12-18")
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
336 %!assert (datestr (testtime,30), "20051218T023317")
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
337 %!assert (datestr (testtime,31), "2005-12-18 02:33:17")
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
338 %!assert (datestr (testtime+[0 0 3 0 0 0], "dddd"), "Wednesday")
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
339 ## Test possible bug where input is a vector of datenums that is exactly 6 wide
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
340 %!assert (datestr ([1944, 6, 6, 6, 30, 0], 0), "06-Jun-1944 06:30:00")
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
341 ## Test fractional millisecond time extension
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
342 %!assert (datestr (testtime, "HH:MM:SS:FFF"), "02:33:17:382")
11329
6b073da9d7fc ChangeLog fix and new datestr test omitted from previous change
John W. Eaton <jwe@octave.org>
parents: 11328
diff changeset
343
19833
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19697
diff changeset
344 ## Test input validation
13848
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
345 %!error datestr ()
40e32fe44aaa Ugrade time functions to accept millisecond format string FFF (Bug #34586)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
346 %!error datestr (1, 2, 3, 4)
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
347