datetime.caldiff
datetime: D = caldiff (A)
datetime: D = caldiff (A, components)
datetime: D = caldiff (A, components, dim)
Calendar differences between successive datetime elements.
D = caldiff (A) returns a calendarDuration array
holding the calendar difference between successive elements of A
along its first non-singleton dimension. Unlike diff, the result
is expressed in whole calendar units (years, months, days) plus a leftover
time, so it is aware of month lengths and, for a zoned array, of daylight
saving time. Not-A-Time elements yield NaN.
D = caldiff (A, components) expresses each
difference using only the requested calendar components.
components is one of 'Years', 'Quarters',
'Months', 'Weeks', 'Days', or 'Time', or a
cell array or string array containing several of them. The default is
{'Years', 'Months', 'Days', 'Time'}.
D = caldiff (A, components, dim) operates
along dimension dim.
Source Code: datetime
caldiff returns the successive differences as calendar amounts — here one month between each element, even though the months differ in length.
t = datetime (2024, [1, 2, 3], 15)
t =
1x3 datetime array
15-Jan-2024 15-Feb-2024 15-Mar-2024
caldiff (t)
ans =
1x2 calendarDuration array
1mo 1mo