Mercurial > octave-nkf
annotate scripts/time/asctime.m @ 13856:d490ca8ab1a5
Modernize function implementations and docstrings in scripts/time.
* addtodate.m: Add millisecond functionality. Update docstring and %!tests.
* calendar.m: Implement faster way to add '*' to day display. Update docstring.
* weekday.m: Use more modern coding stytle. Update docstring.
* asctime.m, clock.m, ctime.m, date.m, datenum.m, datestr.m, datevec.m,
eomday.m, etime.m, is_leap_year.m: Update docstring and/or use Octave formatting
spacing conventions for %!tests.
| author | Rik <octave@nomad.inbox5.com> |
|---|---|
| date | Thu, 10 Nov 2011 13:35:08 -0800 |
| parents | fd0a3ac60b0e |
| children | 72c96de7a403 |
| rev | line source |
|---|---|
| 11523 | 1 ## Copyright (C) 1995-2011 John W. Eaton |
| 2313 | 2 ## |
| 3 ## This file is part of Octave. | |
| 4 ## | |
| 5 ## Octave is free software; you can redistribute it and/or modify it | |
| 6 ## under the terms of the GNU General Public License as published by | |
| 7016 | 7 ## the Free Software Foundation; either version 3 of the License, or (at |
| 8 ## your option) any later version. | |
| 2313 | 9 ## |
| 10 ## Octave is distributed in the hope that it will be useful, but | |
| 11 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 13 ## General Public License for more details. | |
| 14 ## | |
| 15 ## You should have received a copy of the GNU General Public License | |
| 7016 | 16 ## along with Octave; see the file COPYING. If not, see |
| 17 ## <http://www.gnu.org/licenses/>. | |
| 1183 | 18 |
| 3301 | 19 ## -*- texinfo -*- |
| 20 ## @deftypefn {Function File} {} asctime (@var{tm_struct}) | |
|
13856
d490ca8ab1a5
Modernize function implementations and docstrings in scripts/time.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
21 ## Convert a time structure to a string using the following |
|
d490ca8ab1a5
Modernize function implementations and docstrings in scripts/time.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
22 ## format: "ddd mmm mm HH:MM:SS yyyy". For example: |
| 3426 | 23 ## |
| 3301 | 24 ## @example |
| 25 ## @group | |
| 7097 | 26 ## asctime (localtime (time ())) |
|
13856
d490ca8ab1a5
Modernize function implementations and docstrings in scripts/time.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
27 ## @result{} "Mon Feb 17 01:15:06 1997" |
| 3301 | 28 ## @end group |
| 29 ## @end example | |
| 3426 | 30 ## |
| 3301 | 31 ## This is equivalent to @code{ctime (time ())}. |
|
13856
d490ca8ab1a5
Modernize function implementations and docstrings in scripts/time.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
32 ## @seealso{ctime, localtime, time} |
| 3301 | 33 ## @end deftypefn |
| 1183 | 34 |
| 2314 | 35 ## Author: jwe |
| 36 | |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
37 function retval = asctime (tm_struct) |
| 1183 | 38 |
|
13856
d490ca8ab1a5
Modernize function implementations and docstrings in scripts/time.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
39 if (nargin != 1) |
| 6046 | 40 print_usage (); |
| 1183 | 41 endif |
| 42 | |
|
13856
d490ca8ab1a5
Modernize function implementations and docstrings in scripts/time.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
43 retval = strftime ("%a %b %d %H:%M:%S %Y\n", tm_struct); |
|
d490ca8ab1a5
Modernize function implementations and docstrings in scripts/time.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
44 |
| 1183 | 45 endfunction |
| 7411 | 46 |
|
13856
d490ca8ab1a5
Modernize function implementations and docstrings in scripts/time.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
47 |
| 7411 | 48 %!test |
| 49 %! t = time (); | |
| 50 %! assert(strcmp (asctime (localtime (t)), ctime (t))); | |
| 51 | |
| 52 %!error asctime (); | |
| 53 %!error asctime (1, 2); | |
| 54 |