Mercurial > hg > octave-nkf

annotate scripts/time/clock.m @ 14138:72c96de7a403 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: update copyright notices for 2012
author John W. Eaton <jwe@octave.org>
date Mon, 02 Jan 2012 14:25:41 -0500
parents d490ca8ab1a5
children f3d52523cde1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 13856
diff changeset
1 ## Copyright (C) 1995-2012 John W. Eaton
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
2 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
3 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
4 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
5 ## 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
6 ## 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: 5307
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5307
diff changeset
8 ## your option) any later version.
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
9 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
10 ## 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
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
12 ## 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
13 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
14 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
15 ## 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: 5307
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5307
diff changeset
17 ## <http://www.gnu.org/licenses/>.
1183
8d45d63ecbc8 [project @ 1995-03-30 04:50:34 by jwe]
jwe
parents:
diff changeset
18
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 2847
diff changeset
19 ## -*- texinfo -*-
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 2847
diff changeset
20 ## @deftypefn {Function File} {} clock ()
13856
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
21 ## Return the current local date and time as a date vector. The date vector
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
22 ## contains the following fields: current year, month (1-12), day (1-31),
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
23 ## hour (0-23), minute (0-59), and second (0-61). The seconds field has
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
24 ## a fractional part after the decimal point for extended accuracy.
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
25 ##
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
26 ## For example:
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3301
diff changeset
27 ##
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 2847
diff changeset
28 ## @example
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 2847
diff changeset
29 ## @group
13856
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
30 ## fix (clock ())
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 2847
diff changeset
31 ## @result{} [ 1993, 8, 20, 4, 56, 1 ]
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 2847
diff changeset
32 ## @end group
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 2847
diff changeset
33 ## @end example
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3301
diff changeset
34 ##
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 2847
diff changeset
35 ## The function clock is more accurate on systems that have the
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 2847
diff changeset
36 ## @code{gettimeofday} function.
13856
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
37 ## @seealso{now, date, datevec}
3301
02866242d3ae [project @ 1999-10-20 04:10:46 by jwe]
jwe
parents: 2847
diff changeset
38 ## @end deftypefn
1183
8d45d63ecbc8 [project @ 1995-03-30 04:50:34 by jwe]
jwe
parents:
diff changeset
39
2314
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
40 ## Author: jwe
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
41
2311
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
42 function retval = clock ()
1183
8d45d63ecbc8 [project @ 1995-03-30 04:50:34 by jwe]
jwe
parents:
diff changeset
43
8d45d63ecbc8 [project @ 1995-03-30 04:50:34 by jwe]
jwe
parents:
diff changeset
44 tm = localtime (time ());
8d45d63ecbc8 [project @ 1995-03-30 04:50:34 by jwe]
jwe
parents:
diff changeset
45
8d45d63ecbc8 [project @ 1995-03-30 04:50:34 by jwe]
jwe
parents:
diff changeset
46 retval = zeros (1, 6);
8d45d63ecbc8 [project @ 1995-03-30 04:50:34 by jwe]
jwe
parents:
diff changeset
47
1374
674a17e1dbab [project @ 1995-09-11 23:43:20 by jwe]
jwe
parents: 1315
diff changeset
48 retval(1) = tm.year + 1900;
674a17e1dbab [project @ 1995-09-11 23:43:20 by jwe]
jwe
parents: 1315
diff changeset
49 retval(2) = tm.mon + 1;
674a17e1dbab [project @ 1995-09-11 23:43:20 by jwe]
jwe
parents: 1315
diff changeset
50 retval(3) = tm.mday;
674a17e1dbab [project @ 1995-09-11 23:43:20 by jwe]
jwe
parents: 1315
diff changeset
51 retval(4) = tm.hour;
674a17e1dbab [project @ 1995-09-11 23:43:20 by jwe]
jwe
parents: 1315
diff changeset
52 retval(5) = tm.min;
674a17e1dbab [project @ 1995-09-11 23:43:20 by jwe]
jwe
parents: 1315
diff changeset
53 retval(6) = tm.sec + tm.usec / 1e6;
1183
8d45d63ecbc8 [project @ 1995-03-30 04:50:34 by jwe]
jwe
parents:
diff changeset
54
8d45d63ecbc8 [project @ 1995-03-30 04:50:34 by jwe]
jwe
parents:
diff changeset
55 endfunction
7411
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
56
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
57 %!test
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
58 %! t1 = clock;
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
59 %! t2 = str2num (strftime ("[%Y, %m, %d, %H, %M, %S]", localtime (time ())));
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
60 %! assert(etime (t1, t2) < 1);
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe]
jwe
parents: 7017
diff changeset
61