octave_packages/m/time/etime.m

   1 ## Copyright (C) 1996-2012 John W. Eaton
   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
   7 ## the Free Software Foundation; either version 3 of the License, or (at
   8 ## your option) any later version.
   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
  16 ## along with Octave; see the file COPYING.  If not, see
  17 ## <http://www.gnu.org/licenses/>.
  18
  19 ## -*- texinfo -*-
  20 ## @deftypefn {Function File} {} etime (@var{t2}, @var{t1})
  21 ## Return the difference in seconds between two time values returned from
  22 ## @code{clock} (@math{@var{t2} - @var{t1}}).  For example:
  23 ##
  24 ## @example
  25 ## @group
  26 ## t0 = clock ();
  27 ## # many computations later@dots{}
  28 ## elapsed_time = etime (clock (), t0);
  29 ## @end group
  30 ## @end example
  31 ##
  32 ## @noindent
  33 ## will set the variable @code{elapsed_time} to the number of seconds since
  34 ## the variable @code{t0} was set.
  35 ## @seealso{tic, toc, clock, cputime, addtodate}
  36 ## @end deftypefn
  37
  38 ## Author: jwe
  39
  40 function secs = etime (t2, t1)
  41
  42   if (nargin != 2)
  43     print_usage ();
  44   endif
  45
  46   [~, s2] = datenum (t2);
  47   [~, s1] = datenum (t1);
  48
  49   secs = s2 - s1;
  50
  51 endfunction
  52
  53
  54 %!assert (etime ([1900,12,31,23,59,59],[1901,1,1,0,0,0]),-1)
  55 %!assert (etime ([1900,2,28,23,59,59],[1900,3,1,0,0,0]),-1)
  56 %!assert (etime ([2000,2,28,23,59,59],[2000,3,1,0,0,0]),-86401)
  57 %!assert (etime ([1996,2,28,23,59,59],[1996,3,1,0,0,0]),-86401)
  58 %!test
  59 %! t1 = [1900,12,31,23,59,59; 1900,2,28,23,59,59];
  60 %! t2 = [1901,1,1,0,0,0; 1900,3,1,0,0,0];
  61 %! assert(etime(t2, t1), [1;1]);
  62
  63 %!test
  64 %! t1 = [1993, 8, 20, 4, 56, 1];
  65 %! t2 = [1993, 8, 21, 4, 56, 1];
  66 %! t3 = [1993, 8, 20, 5, 56, 1];
  67 %! t4 = [1993, 8, 20, 4, 57, 1];
  68 %! t5 = [1993, 8, 20, 4, 56, 14];
  69 %!
  70 %! assert (etime (t2, t1), 86400);
  71 %! assert (etime (t3, t1), 3600);
  72 %! assert (etime (t4, t1), 60);
  73 %! assert (etime (t5, t1), 13);
  74
  75 %% Test input validation
  76 %!error etime ();
  77 %!error etime (1);
  78 %!error etime (1, 2, 3);
  79