Mercurial > hg > octave-lyh
annotate scripts/time/ctime.m @ 12575:d0b799dafede
Grammarcheck files for 3.4.1 release.
| author | Rik <octave@nomad.inbox5.com> |
|---|---|
| date | Mon, 04 Apr 2011 15:33:46 -0700 |
| parents | fd0a3ac60b0e |
| children | d490ca8ab1a5 |
| 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 |
| 3295 | 19 ## -*- texinfo -*- |
| 20 ## @deftypefn {Function File} {} ctime (@var{t}) | |
|
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
21 ## Convert a value returned from @code{time} (or any other non-negative |
| 3295 | 22 ## integer), to the local time and return a string of the same form as |
| 23 ## @code{asctime}. The function @code{ctime (time)} is equivalent to | |
|
10821
693e22af08ae
Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents:
9245
diff
changeset
|
24 ## @code{asctime (localtime (time))}. For example: |
| 3426 | 25 ## |
| 3295 | 26 ## @example |
| 27 ## @group | |
| 28 ## ctime (time ()) | |
| 4003 | 29 ## @result{} "Mon Feb 17 01:15:06 1997\n" |
| 3295 | 30 ## @end group |
| 31 ## @end example | |
| 32 ## @end deftypefn | |
| 1183 | 33 |
| 2314 | 34 ## Author: jwe |
| 35 | |
| 2311 | 36 function retval = ctime (t) |
| 1183 | 37 |
| 38 if (nargin == 1) | |
| 39 retval = asctime (localtime (t)); | |
| 40 else | |
| 6046 | 41 print_usage (); |
| 1183 | 42 endif |
| 43 | |
| 44 endfunction | |
| 7411 | 45 |
| 46 %!test | |
| 47 %! t = time (); | |
| 48 %! assert(strcmp (asctime (localtime (t)), ctime (t))); | |
| 49 | |
| 50 %!error ctime (); | |
| 51 | |
| 52 %!error ctime (1, 2); | |
| 53 |