octave-antonio: scripts/time/etime.m annotate

annotate scripts/time/etime.m @ 20162:2645f9ef8c88 stable

doc: Update more docstrings to have one sentence summary as first line. Reviewed specfun, special-matrix, testfun, and time script directories. * scripts/specfun/expint.m, scripts/specfun/isprime.m, scripts/specfun/legendre.m, scripts/specfun/primes.m, scripts/specfun/reallog.m, scripts/specfun/realsqrt.m, scripts/special-matrix/gallery.m, scripts/special-matrix/hadamard.m, scripts/special-matrix/hankel.m, scripts/special-matrix/hilb.m, scripts/special-matrix/invhilb.m, scripts/special-matrix/magic.m, scripts/special-matrix/pascal.m, scripts/special-matrix/rosser.m, scripts/special-matrix/toeplitz.m, scripts/special-matrix/vander.m, scripts/special-matrix/wilkinson.m, scripts/testfun/assert.m, scripts/testfun/demo.m, scripts/testfun/example.m, scripts/testfun/fail.m, scripts/testfun/rundemos.m, scripts/testfun/runtests.m, scripts/testfun/speed.m, scripts/time/asctime.m, scripts/time/calendar.m, scripts/time/clock.m, scripts/time/ctime.m, scripts/time/datenum.m, scripts/time/datestr.m, scripts/time/datevec.m, scripts/time/etime.m, scripts/time/is_leap_year.m, scripts/time/now.m, scripts/time/weekday.m: Update more docstrings to have one sentence summary as first line.

author	Rik <rik@octave.org>
date	Sun, 03 May 2015 17:00:11 -0700
parents	9fc020886ae9
children

rev	line source
19697 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 17744 diff changeset	1 ## Copyright (C) 1996-2015 John W. Eaton
5596 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 --
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 9245 diff changeset	20 ## @deftypefn {Function File} {} etime (@var{t2}, @var{t1})
c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 9245 diff changeset	21 ## Return the difference in seconds between two time values returned from
20162 2645f9ef8c88 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	22 ## @code{clock} (@math{@var{t2} - @var{t1}}).
2645f9ef8c88 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	23 ##
2645f9ef8c88 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	24 ## For example:
5596 6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe] jwe parents: diff changeset	25 ##
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe] jwe parents: diff changeset	26 ## @example
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	27 ## @group
5596 6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe] jwe parents: diff changeset	28 ## t0 = clock ();
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	29 ## # many computations later@dots{}
5596 6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe] jwe parents: diff changeset	30 ## elapsed_time = etime (clock (), t0);
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	31 ## @end group
5596 6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe] jwe parents: diff changeset	32 ## @end example
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe] jwe parents: diff changeset	33 ##
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe] jwe parents: diff changeset	34 ## @noindent
20162 2645f9ef8c88 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	35 ## will set the variable @code{elapsed_time} to the number of seconds since the
2645f9ef8c88 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	36 ## variable @code{t0} was set.
13856 d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	37 ## @seealso{tic, toc, clock, cputime, addtodate}
5596 6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe] jwe parents: diff changeset	38 ## @end deftypefn
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 ## Author: jwe
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe] jwe parents: diff changeset	41
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 9245 diff changeset	42 function secs = etime (t2, t1)
5596 6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe] jwe parents: diff changeset	43
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe] jwe parents: diff changeset	44 if (nargin != 2)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5660 diff changeset	45 print_usage ();
5596 6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe] jwe parents: diff changeset	46 endif
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe] jwe parents: diff changeset	47
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 9245 diff changeset	48 [~, s2] = datenum (t2);
c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 9245 diff changeset	49 [~, s1] = datenum (t1);
5596 6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe] jwe parents: diff changeset	50
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 9245 diff changeset	51 secs = s2 - s1;
5596 6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe] jwe parents: diff changeset	52
6c4e4bffa622 [project @ 2006-01-13 20:05:51 by jwe] jwe parents: diff changeset	53 endfunction
5660 4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe] jwe parents: 5642 diff changeset	54
13856 d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	55
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	56 %!assert (etime ([1900,12,31,23,59,59], [1901,1,1,0,0,0]), -1)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	57 %!assert (etime ([1900,2,28,23,59,59], [1900,3,1,0,0,0]), -1)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	58 %!assert (etime ([2000,2,28,23,59,59], [2000,3,1,0,0,0]), -86401)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	59 %!assert (etime ([1996,2,28,23,59,59], [1996,3,1,0,0,0]), -86401)
5660 4c4d31ecb0e4 [project @ 2006-03-10 17:27:50 by jwe] jwe parents: 5642 diff changeset	60 %!test
13856 d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	61 %! t1 = [1900,12,31,23,59,59; 1900,2,28,23,59,59];
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	62 %! t2 = [1901,1,1,0,0,0; 1900,3,1,0,0,0];
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	63 %! assert (etime (t2, t1), [1;1]);
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	64
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	65 %!test
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	66 %! t1 = [1993, 8, 20, 4, 56, 1];
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	67 %! t2 = [1993, 8, 21, 4, 56, 1];
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	68 %! t3 = [1993, 8, 20, 5, 56, 1];
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	69 %! t4 = [1993, 8, 20, 4, 57, 1];
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	70 %! t5 = [1993, 8, 20, 4, 56, 14];
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	71 %!
13856 d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	72 %! assert (etime (t2, t1), 86400);
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	73 %! assert (etime (t3, t1), 3600);
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	74 %! assert (etime (t4, t1), 60);
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	75 %! assert (etime (t5, t1), 13);
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	76
19833 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	77 ## Test input validation
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	78 %!error etime ();
13856 d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	79 %!error etime (1);
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	80 %!error etime (1, 2, 3);
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	81

Mercurial > octave-antonio

annotate scripts/time/etime.m @ 20162:2645f9ef8c88 stable