update packages

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

diff --git a/octave_packages/m/time/clock.m b/octave_packages/m/time/clock.m
new file mode 100644 (file)
index 0000000..22e89e7
--- /dev/null
+++ b/octave_packages/m/time/clock.m
@@ -0,0 +1,61 @@
+## 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} {} clock ()
+## Return the current local date and time as a date vector.  The date vector
+## contains the following fields: current year, month (1-12), day (1-31),
+## hour (0-23), minute (0-59), and second (0-61).  The seconds field has
+## a fractional part after the decimal point for extended accuracy.
+##
+## For example:
+##
+## @example
+## @group
+## fix (clock ())
+##      @result{} [ 1993, 8, 20, 4, 56, 1 ]
+## @end group
+## @end example
+##
+## The function clock is more accurate on systems that have the
+## @code{gettimeofday} function.
+## @seealso{now, date, datevec}
+## @end deftypefn
+
+## Author: jwe
+
+function retval = clock ()
+
+  tm = localtime (time ());
+
+  retval = zeros (1, 6);
+
+  retval(1) = tm.year + 1900;
+  retval(2) = tm.mon + 1;
+  retval(3) = tm.mday;
+  retval(4) = tm.hour;
+  retval(5) = tm.min;
+  retval(6) = tm.sec + tm.usec / 1e6;
+
+endfunction
+
+%!test
+%! t1 = clock;
+%! t2 = str2num (strftime ("[%Y, %m, %d, %H, %M, %S]", localtime (time ())));
+%! assert(etime (t1, t2) < 1);
+