update packages

[CreaPhase.git] / octave_packages / m / time / asctime.m

diff --git a/octave_packages/m/time/asctime.m b/octave_packages/m/time/asctime.m
new file mode 100644 (file)
index 0000000..468e865
--- /dev/null
+++ b/octave_packages/m/time/asctime.m
@@ -0,0 +1,54 @@
+## Copyright (C) 1995-2012 John W. Eaton
+##
+## This file is part of Octave.
+##
+## Octave is free software; you can redistribute it and/or modify it
+## under the terms of the GNU General Public License as published by
+## the Free Software Foundation; either version 3 of the License, or (at
+## your option) any later version.
+##
+## Octave is distributed in the hope that it will be useful, but
+## WITHOUT ANY WARRANTY; without even the implied warranty of
+## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+## General Public License for more details.
+##
+## You should have received a copy of the GNU General Public License
+## along with Octave; see the file COPYING.  If not, see
+## <http://www.gnu.org/licenses/>.
+
+## -*- texinfo -*-
+## @deftypefn {Function File} {} asctime (@var{tm_struct})
+## Convert a time structure to a string using the following 
+## format: "ddd mmm mm HH:MM:SS yyyy".  For example:
+##
+## @example
+## @group
+## asctime (localtime (time ()))
+##      @result{} "Mon Feb 17 01:15:06 1997"
+## @end group
+## @end example
+##
+## This is equivalent to @code{ctime (time ())}.
+## @seealso{ctime, localtime, time}
+## @end deftypefn
+
+## Author: jwe
+
+function retval = asctime (tm_struct)
+
+  if (nargin != 1)
+    print_usage ();
+  endif
+
+  retval = strftime ("%a %b %d %H:%M:%S %Y\n", tm_struct);
+
+endfunction
+
+
+%!test
+%! t = time ();
+%! assert(strcmp (asctime (localtime (t)), ctime (t)));
+
+%!error asctime ();
+%!error asctime (1, 2);
+