1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
|
########################################################################
##
## Copyright (C) 2008-2024 The Octave Project Developers
##
## See the file COPYRIGHT.md in the top-level directory of this
## distribution or <https://octave.org/copyright/>.
##
## This file is part of Octave.
##
## Octave is free software: you can redistribute it and/or modify it
## under the terms of the GNU General Public License as published by
## the Free Software Foundation, either version 3 of the License, or
## (at your option) any later version.
##
## Octave is distributed in the hope that it will be useful, but
## WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with Octave; see the file COPYING. If not, see
## <https://www.gnu.org/licenses/>.
##
########################################################################
## -*- texinfo -*-
## @deftypefn {} {@var{d} =} addtodate (@var{d}, @var{q}, @var{f})
## Add @var{q} amount of time (with units @var{f}) to the serial datenum,
## @var{d}.
##
## @var{f} must be one of @qcode{"year"}, @qcode{"month"}, @qcode{"day"},
## @qcode{"hour"}, @qcode{"minute"}, @qcode{"second"}, or
## @qcode{"millisecond"}.
## @seealso{datenum, datevec, etime}
## @end deftypefn
function d = addtodate (d, q, f)
persistent mult = struct ("day", 1, "hour", 1/24, "minute", 1/1440, ...
"second", 1/86400, "millisecond", 1/86400000);
if (nargin != 3)
print_usage ();
elseif (! (ischar (f) && isrow (f)))
error ("addtodate: F must be a single character string");
endif
if (isscalar (d) && ! isscalar (q))
## expand d to size of q to make later addition easier.
d = repmat (d, size (q));
endif
## in case the user gives f as a plural, remove the 's'
if ("s" == f(end))
f(end) = [];
endif
if (any (strcmpi ({"year" "month"}, f)))
dtmp = datevec (d);
if (strcmpi ("year", f))
dtmp(:,1) += q(:);
elseif (strcmpi ("month", f))
dtmp(:,2) += q(:);
## adjust the years and months if the date rolls over a year
dtmp(:,1) += floor ((dtmp(:,2)-1)/12);
dtmp(:,2) = mod (dtmp(:,2)-1, 12) + 1;
## avoid days beyond end of month
beyondEOM = dtmp(:,3) > eomday (dtmp(:,1), dtmp(:,2));
dtmp(beyondEOM,3) = eomday (dtmp(beyondEOM,1), dtmp(beyondEOM,2));
endif
dnew = datenum (dtmp);
## make the output the right shape
if (numel (d) == numel (dnew))
d = reshape (dnew, size (d));
else
d = reshape (dnew, size (q));
endif
elseif (any (strcmpi ({"day" "hour" "minute" "second", "millisecond"}, f)))
d += q .* mult.(f);
else
error ("addtodate: Invalid time unit: %s", f);
endif
endfunction
## tests
%!shared d
%! d = datenum (2008, 1, 1);
## Identity
%!assert (addtodate (d, 0, "year"), d)
%!assert (addtodate (d, 0, "month"), d)
%!assert (addtodate (d, 0, "day"), d)
%!assert (addtodate (d, 0, "hour"), d)
%!assert (addtodate (d, 0, "minute"), d)
%!assert (addtodate (d, 0, "second"), d)
%!assert (addtodate (d, 0, "millisecond"), d)
## Add one of each
## leap year
%!assert (addtodate (d, 1, "year"), d+366)
%!assert (addtodate (d, 1, "month"), d+31)
%!assert (addtodate (d, 1, "day"), d+1)
%!assert (addtodate (d, 1, "hour"), d+1/24)
%!assert (addtodate (d, 1, "minute"), d+1/1440)
%!assert (addtodate (d, 1, "second"), d+1/86400)
%!assert (addtodate (d, 1, "millisecond"), d+1/86400000)
## subtract one of each
%!assert (addtodate (d, -1, "year"), d-365)
%!assert (addtodate (d, -1, "month"), d-31)
%!assert (addtodate (d, -1, "day"), d-1)
%!assert (addtodate (d, -1, "hour"), d-1/24)
%!assert (addtodate (d, -1, "minute"), d-1/1440)
%!assert (addtodate (d, -1, "second"), d-1/86400)
%!assert (addtodate (d, -1, "millisecond"), d-1/86400000)
## rollover
%!assert (addtodate (d, 12, "month"), d+366)
%!assert (addtodate (d, 13, "month"), d+366+31)
## multiple inputs and output orientation
%!assert (addtodate ([d d], [1 13], "month"), [d+31 d+366+31])
%!assert (addtodate ([d;d], [1;13], "month"), [d+31;d+366+31])
%!assert (addtodate (d, [1;13], "month"), [d+31;d+366+31])
%!assert (addtodate (d, [1 13], "month"), [d+31 d+366+31])
%!assert (addtodate ([d;d+1], 1, "month"), [d+31;d+1+31])
%!assert (addtodate ([d d+1], 1, "month"), [d+31 d+1+31])
## end of month days
%!assert <*60671> (addtodate (datenum ("2020-12-31"), -1, "month"), 738125)
%!assert <*60671> (addtodate (datenum ("2020-12-30"), -1, "month"), 738125)
%!assert <*60671> (addtodate (datenum ("2020-12-29"), -1, "month"), 738124)
%!assert <*60671> (addtodate (datenum ("2021-03-31"), -1, "month"), 738215)
%!assert <*60671> (addtodate (datenum ("2021-03-29"), -1, "month"), 738215)
%!assert <*60671> (addtodate (datenum ("2020-03-30"), -1, "month"), 737850)
%!assert <*60671> (addtodate (datenum ("2020-03-29"), -1, "month"), 737850)
%!assert <*60671> (addtodate (datenum ("2020-03-28"), -1, "month"), 737849)
%!assert <*60671> (addtodate (datenum ("2020-02-29"), -1, "month"), 737819)
%!assert <*60671> (addtodate (datenum ("2020-02-28"), -1, "month"), 737818)
%!assert <*60671> (addtodate (datenum ("2020-01-31"), +1, "month"), 737850)
## Test input validation
%!error <Invalid call> addtodate ()
%!error <Invalid call> addtodate (1)
%!error <Invalid call> addtodate (1,2)
%!error <F must be a single character string> addtodate (1,2,3)
%!error <F must be a single character string> addtodate (1,2,"month"')
%!error <Invalid time unit> addtodate (1,2,"abc")
|
