annotate scripts/time/etime.m @ 7016:93c65f2a5668

[project @ 2007-10-12 06:40:56 by jwe]
author jwe
date Fri, 12 Oct 2007 06:41:26 +0000
parents 34f96dd5441b
children a1dbe9d80eee
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5596
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
1 ## Copyright (C) 1996, 1997 John W. Eaton
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
2 ##
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
4 ##
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
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: 6046
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: 6046
diff changeset
8 ## your option) any later version.
5596
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
9 ##
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
14 ##
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
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: 6046
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: 6046
diff changeset
17 ## <http://www.gnu.org/licenses/>.
5596
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
18
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
20 ## @deftypefn {Function File} {} etime (@var{t1}, @var{t2})
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
21 ## Return the difference (in seconds) between two time values returned from
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
22 ## @code{clock}. For example:
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
23 ##
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
24 ## @example
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
25 ## t0 = clock ();
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
26 ## # many computations later...
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
27 ## elapsed_time = etime (clock (), t0);
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
28 ## @end example
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
29 ##
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
30 ## @noindent
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
31 ## will set the variable @code{elapsed_time} to the number of seconds since
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
32 ## the variable @code{t0} was set.
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5596
diff changeset
33 ## @seealso{tic, toc, clock, cputime}
5596
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
34 ## @end deftypefn
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
35
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
36 ## Author: jwe
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
37
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
38 function secs = etime (t1, t0)
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
39
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
40 if (nargin != 2)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5660
diff changeset
41 print_usage ();
5596
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
42 endif
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
43
5660
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents: 5642
diff changeset
44 [d1, s1] = datenum (t1);
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents: 5642
diff changeset
45 [d0, s0] = datenum (t0);
5596
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
46
5660
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents: 5642
diff changeset
47 secs = s1 - s0;
5596
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
48
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe]
jwe
parents:
diff changeset
49 endfunction
5660
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents: 5642
diff changeset
50
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents: 5642
diff changeset
51 %!assert(etime([1900,12,31,23,59,59],[1901,1,1,0,0,0]),-1)
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents: 5642
diff changeset
52 %!assert(etime([1900,2,28,23,59,59],[1900,3,1,0,0,0]),-1)
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents: 5642
diff changeset
53 %!assert(etime([2000,2,28,23,59,59],[2000,3,1,0,0,0]),-86401)
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents: 5642
diff changeset
54 %!assert(etime([1996,2,28,23,59,59],[1996,3,1,0,0,0]),-86401)
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents: 5642
diff changeset
55 %!test
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents: 5642
diff changeset
56 %! t1 = [1900,12,31,23,59,59; 1900,2,28,23,59,59];
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents: 5642
diff changeset
57 %! t2 = [1901,1,1,0,0,0; 1900,3,1,0,0,0];
4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe]
jwe
parents: 5642
diff changeset
58 %! assert(etime(t2, t1), [1;1]);