Mercurial > octave-antonio

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

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
comparison
equal deleted inserted replaced
20160:03b9d17a2d95 20162:2645f9ef8c88
17 ## <http://www.gnu.org/licenses/>. 17 ## <http://www.gnu.org/licenses/>.
18 18
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {} etime (@var{t2}, @var{t1}) 20 ## @deftypefn {Function File} {} etime (@var{t2}, @var{t1})
21 ## Return the difference in seconds between two time values returned from 21 ## Return the difference in seconds between two time values returned from
22 ## @code{clock} (@math{@var{t2} - @var{t1}}). For example: 22 ## @code{clock} (@math{@var{t2} - @var{t1}}).
23 ##
24 ## For example:
23 ## 25 ##
24 ## @example 26 ## @example
25 ## @group 27 ## @group
26 ## t0 = clock (); 28 ## t0 = clock ();
27 ## # many computations later@dots{} 29 ## # many computations later@dots{}
28 ## elapsed_time = etime (clock (), t0); 30 ## elapsed_time = etime (clock (), t0);
29 ## @end group 31 ## @end group
30 ## @end example 32 ## @end example
31 ## 33 ##
32 ## @noindent 34 ## @noindent
33 ## will set the variable @code{elapsed_time} to the number of seconds since 35 ## will set the variable @code{elapsed_time} to the number of seconds since the
34 ## the variable @code{t0} was set. 36 ## variable @code{t0} was set.
35 ## @seealso{tic, toc, clock, cputime, addtodate} 37 ## @seealso{tic, toc, clock, cputime, addtodate}
36 ## @end deftypefn 38 ## @end deftypefn
37 39
38 ## Author: jwe 40 ## Author: jwe
39 41