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

annotate scripts/time/now.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	4197fc428c7d
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) 2000-2015 Paul Kienzle
5687 a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	2 ##
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	3 ## This file is part of Octave.
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	4 ##
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
a2902024bc4e [project @ 2006-03-16 20:22:40 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: 5687 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: 5687 diff changeset	8 ## your option) any later version.
5687 a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	9 ##
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	13 ## General Public License for more details.
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	14 ##
a2902024bc4e [project @ 2006-03-16 20:22:40 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: 5687 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: 5687 diff changeset	17 ## <http://www.gnu.org/licenses/>.
5687 a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	18
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	19 ## -- texinfo --
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	20 ## @deftypefn {Function File} {t =} now ()
13856 d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 12837 diff changeset	21 ## Return the current local date/time as a serial day number
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 12837 diff changeset	22 ## (see @code{datenum}).
5687 a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	23 ##
13856 d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 12837 diff changeset	24 ## The integral part, @code{floor (now)} corresponds to the number of days
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 12837 diff changeset	25 ## between today and Jan 1, 0000.
5687 a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	26 ##
20162 2645f9ef8c88 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	27 ## The fractional part, @code{rem (now, 1)} corresponds to the current time.
5687 a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	28 ## @seealso{clock, date, datenum}
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	29 ## @end deftypefn
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	30
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	31 ## Author: pkienzle <pkienzle@users.sf.net>
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	32 ## Created: 10 October 2001 (CVS)
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	33 ## Adapted-By: William Poetra Yoga Hadisoeseno <williampoetra@gmail.com>
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	34
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	35 function t = now ()
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	36
13856 d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 12837 diff changeset	37 if (nargin != 0)
12836 e9b4de878a9c codesprint: new tests for now function John W. Eaton <jwe@octave.org> parents: 12575 diff changeset	38 print_usage ();
e9b4de878a9c codesprint: new tests for now function John W. Eaton <jwe@octave.org> parents: 12575 diff changeset	39 endif
5687 a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	40
13856 d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 12837 diff changeset	41 t = datenum (clock ());
d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 12837 diff changeset	42
5687 a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	43 ## The following doesn't work (e.g., one hour off on 2005-10-04):
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	44 ##
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	45 ## seconds since 1970-1-1 corrected by seconds from GMT to local time
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	46 ## divided by 86400 sec/day plus day num for 1970-1-1
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	47 ## t = (time - mktime(gmtime(0)))/86400 + 719529;
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	48 ##
14868 5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory Rik <octave@nomad.inbox5.com> parents: 14363 diff changeset	49 ## mktime (gmtime (0)) does indeed return the offset from Greenwich to the
5687 a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	50 ## local time zone, but we need to account for daylight savings time
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	51 ## changing by an hour the offset from CUT for part of the year.
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	52
a2902024bc4e [project @ 2006-03-16 20:22:40 by jwe] jwe parents: diff changeset	53 endfunction
12836 e9b4de878a9c codesprint: new tests for now function John W. Eaton <jwe@octave.org> parents: 12575 diff changeset	54
13856 d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 12837 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 (isnumeric (now ()))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	57 %!assert (now () > 0)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	58 %!assert (now () <= now ())
13856 d490ca8ab1a5 Modernize function implementations and docstrings in scripts/time. Rik <octave@nomad.inbox5.com> parents: 12837 diff changeset	59
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	60 %!error now (1)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	61

Mercurial > octave-antonio

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