calD = calendarDuration (X) returns an array of calendar durations from numeric matrix X, which must have either three or six columns, representing years, months, days, hours, minutes, and seconds, accordingly. All but seconds must be represented as whole duration units by integer values.

calD = calendarDuration (Y, MO, D) returns an array of calendar durations from numeric arrays Y, MO, and D, which correspond to years, months, and days, respectively. The size of calD is the common size of the numeric input arguments, which must be of the same size or scalars. A scalar input functions as a constant array of the same size as the other inputs.

calD = calendarDuration (Y, MO, D, H, MI, S) returns an array of calendar durations from numeric arrays Y, MO, D, H, MI, and S, which correspond to years, months, days, hours, minutes, and seconds, respectively. The size of calD is the common size of the numeric input arguments, which must be of the same size or scalars. A scalar input functions as a constant array of the same size as the other inputs.

calD = calendarDuration (Y, MO, D, T) returns an array of calendar durations from numeric arrays Y, MO, and D, which correspond to years, months, and days, as well as a time duration array T. The size of calD is the common size of the data input arguments, which must be of the same size or scalars. A scalar input functions as a constant array of the same size as the other inputs.

Numeric input arrays Y, MO, D, H, and MI must contain integer values corresponding to whole calendar units. S can also be contain fractions of seconds.

calD = calendarDuration (calD2) returns a copy of the calendarDuration array calD2, which keeps its size as well as its 'Format' property unless a new format is specified.

calD = calendarDuration (…, 'Format', FMT) specifies the format in which calD is displayed. FMT must be a character vector or a string scalar containing the following letters.

• 'y' years
• 'q' quarters of a year
• 'm' months
• 'w' weeks
• 'd' days
• 't' time duration

Each character must be specified only once in the same order as they appear in the above list. 'm', 'd', and 't' characters must always be included in the format specification. No other character is accepted.

Note: MATLAB does not reject a format that omits a required character. It warns and silently substitutes a repaired format, so that 'ymd' becomes 'ymdt'. An invalid format is an error here, because rewriting what the user asked for hides the typo that caused it.

Note: MATLAB also accepts a numeric array in place of T, which it reads as a count of milliseconds, thereby exposing the internal storage of its duration type. This is undocumented and contradicts MATLAB’s own documentation, which requires T to be a duration array, and it is not reproduced here. Use milliseconds (N) to say so explicitly.

calD = calendarDuration () returns a scalar array of calendar durations with a value of zero days. To create an empty calendarDuration array, use calendarDuration ([], [], []). A 'Format' may be given on its own, as in calendarDuration ('Format', 'mdt'), which returns the same zero scalar in that format. MATLAB requires data alongside the option and rejects this.

See also: calyears, calquarters, calmonths, calweeks, caldays, calendarDuration, iscalendarduration, datetime, duration

Source Code: calendarDuration