busdate

Next or previous business day

Syntax

Busday = busdate(Date)

Busday = busdate(___,DirFlag,Holiday,Weekend)

Description

Busday = busdate(Date) returns the scalar, vector, or matrix of the next or previous business days, depending on the definition for Holiday.

Busday = busdate(___,DirFlag,Holiday,Weekend) returns the scalar, vector, or matrix of the next or previous business days, depending on the optional input arguments, including Holiday.

If both Date and Holiday are either serial date numbers or date character vectors, Busday is returned as a serial date number.

However, if either Date or Holiday are datetime arrays, Busday is returned as a datetime array.

Use the function datestr to convert serial date numbers to formatted date character vectors.

Examples

Determine Business Days

Determine the next business day when Date is a character vector.

 Busday = busdate('3-Jul-2001', 1)

Busday = 731037

datestr(Busday)

ans = 
'05-Jul-2001'

Indicate that Saturday is a business day by appropriately setting the Weekend argument. July 4, 2003 falls on a Friday. Use busdate to verify that Saturday, July 5, is actually a business day.

Weekend = [1 0 0 0 0 0 0];
Date = datestr(busdate('3-Jul-2003', 1, [], Weekend))

Date = 
'05-Jul-2003'

If either Date or Holiday are datetime arrays, Busday is returned as a datetime array.

Busday = busdate(datetime('3-Jul-2001','Locale','en_US'), 1)

Busday = datetime
   05-Jul-2001

Input Arguments

Date — Reference business date

serial date number | date character vector | datetime object

Reference business date, specified as a scalar, vector, or matrix using serial date numbers, date character vectors, or datetime arrays.

Data Types: double | char | datetime

DirFlag — Business day convention

follow (default) | date character vector with values of follow, modifiedfollow, previous, or modifiedprevious | cell array of date character vectors with values of follow, modifiedfollow, previous, or modifiedprevious

Business day convention, specified date character vector or cell array of date character vectors with values of follow, modifiedfollow, previous, or modifiedprevious.

Also, DirFlag can be a scalar, vector, or matrix of search directions, where Next is DIREC = 1 (default) or Previous is DIREC = -1.

Data Types: double | char | datetime

Holiday — Holidays and nontrading-day dates

non-trading day vector is determined by the routine holidays (default) | serial date number | date character vector | datetime object

Holidays and nontrading-day dates, specified as vector.

All dates in Holiday must be the same format: either serial date numbers, or date character vectors, or datetime arrays. (Using serial date numbers improves performance.)

Data Types: double | char | datetime

Weekend — Weekend days

[1 0 0 0 0 0 1] (Saturday and Sunday form the weekend) (default) | vector of length 7, containing 0 and 1, where 1 indicates weekend days

Weekend days, specified as a vector of length 7, containing 0 and 1, where 1 indicates weekend days and the first element of this vector corresponds to Sunday.

Data Types: double

Output Arguments

Busday — Next or previous business day

scalar | vector | matrix

Next or previous business day, returned as a scalar, vector, or matrix depending on the definition for Holiday. If Date is a datetime array, Busday returns a datetime array. Otherwise, Busday returns a serial date numbers.