annotate scripts/time/asctime.m @ 7411:83a8781b529d

[project @ 2008-01-22 21:52:25 by jwe]
author jwe
date Tue, 22 Jan 2008 21:52:26 +0000
parents e8c94e473c68
children eb63fbe60fab
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7017
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
1 ## Copyright (C) 1995, 1996, 1997, 1999, 2000, 2005, 2006, 2007
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
2 ## John W. Eaton
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
3 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
4 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
5 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
6 ## Octave is free software; you can redistribute it and/or modify it
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
7 ## 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
8 ## 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
9 ## your option) any later version.
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
10 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
11 ## Octave is distributed in the hope that it will be useful, but
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
14 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
15 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
16 ## 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
17 ## 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
18 ## <http://www.gnu.org/licenses/>.
1183
8d45d63ecbc8 [project @ 1995-03-30 04:50:34 by jwe]
jwe
parents:
diff changeset
19
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 2847
diff changeset
20 ## -*- texinfo -*-
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 2847
diff changeset
21 ## @deftypefn {Function File} {} asctime (@var{tm_struct})
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 2847
diff changeset
22 ## Convert a time structure to a string using the following five-field
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 2847
diff changeset
23 ## format: Thu Mar 28 08:40:14 1996. For example,
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3301
diff changeset
24 ##
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 2847
diff changeset
25 ## @example
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 2847
diff changeset
26 ## @group
7097
e8c94e473c68 [project @ 2007-11-02 17:24:23 by jwe]
jwe
parents: 7017
diff changeset
27 ## asctime (localtime (time ()))
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 2847
diff changeset
28 ## @result{} "Mon Feb 17 01:15:06 1997\n"
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 2847
diff changeset
29 ## @end group
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 2847
diff changeset
30 ## @end example
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3301
diff changeset
31 ##
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 2847
diff changeset
32 ## This is equivalent to @code{ctime (time ())}.
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 2847
diff changeset
33 ## @end deftypefn
1183
8d45d63ecbc8 [project @ 1995-03-30 04:50:34 by jwe]
jwe
parents:
diff changeset
34
2314
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
35 ## Author: jwe
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
36
2311
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
37 function retval = asctime (t)
1183
8d45d63ecbc8 [project @ 1995-03-30 04:50:34 by jwe]
jwe
parents:
diff changeset
38
8d45d63ecbc8 [project @ 1995-03-30 04:50:34 by jwe]
jwe
parents:
diff changeset
39 if (nargin == 1)
8d45d63ecbc8 [project @ 1995-03-30 04:50:34 by jwe]
jwe
parents:
diff changeset
40 retval = strftime ("%a %b %d %H:%M:%S %Y\n", t);
8d45d63ecbc8 [project @ 1995-03-30 04:50:34 by jwe]
jwe
parents:
diff changeset
41 else
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5307
diff changeset
42 print_usage ();
1183
8d45d63ecbc8 [project @ 1995-03-30 04:50:34 by jwe]
jwe
parents:
diff changeset
43 endif
8d45d63ecbc8 [project @ 1995-03-30 04:50:34 by jwe]
jwe
parents:
diff changeset
44
8d45d63ecbc8 [project @ 1995-03-30 04:50:34 by jwe]
jwe
parents:
diff changeset
45 endfunction
7411
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7097
diff changeset
46
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7097
diff changeset
47 %!test
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7097
diff changeset
48 %! t = time ();
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7097
diff changeset
49 %! assert(strcmp (asctime (localtime (t)), ctime (t)));
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7097
diff changeset
50
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7097
diff changeset
51 %!error asctime ();
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7097
diff changeset
52
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7097
diff changeset
53 %!error asctime (1, 2);
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7097
diff changeset
54